Review and Updates to Procedure (#1016)

* review and updates to procedure * Addressing comments * Removed id note * changed position of disclaimer and errors * PRODOC-203452: Style edits. * PRODOC-203452: Style edits. --------- Co-authored-by: Deitrich, Casey <[email protected]>
cerner · Nov 30, 2023 · 832c6a1 · 832c6a1
1 parent a927ee4
commit 832c6a1
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 92 deletions.
diff --git a/content/millennium/dstu2/general-clinical/procedure.md b/content/millennium/dstu2/general-clinical/procedure.md
@@ -9,52 +9,58 @@ title: Procedure | DSTU 2 API
 
 ## Overview
 
-The Procedure resource returns current and historical procedures performed on a patient. A procedure can be invasive or non-invasive treatments/procedures and observations. For example, a patient who has breast cancer could have significant & pertinent procedures that include mammograms, BRCA testing, breast examination documentation & lumpectomy. It is up to the user what procedures are clinically significant to document. Surgical and radiology procedures documented in other Cerner solutions will return if manually added by a clinician in the patient's procedure history.
+The Procedure resource returns current and historical procedures performed on a patient. A procedure can be invasive or noninvasive treatments or procedures and observations. For example, a patient who has breast cancer could have significant and pertinent procedures that include mammograms, BRCA testing, breast examination documentation, and lumpectomy. The user decides what procedures are clinically significant to document. Surgical and radiology procedures documented in other Oracle Cerner products are returned if manually added by a clinician in the patient's procedure history.
 
 The following fields are returned if valued:
 
-* [Procedure id](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
-* [Patient](http://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.subject){:target="_blank"}
-* [Status (completed, entered-in-error)](http://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.status){:target="_blank"}
-* [Procedure](http://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.code){:target="_blank"}
-* [Reason performed](http://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.reason_x_){:target="_blank"}
-* [Who performed](http://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.performer){:target="_blank"}
-* [Date performed](http://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.performed_x_){:target="_blank"}
-* [Patient encounter](http://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.encounter){:target="_blank"}
-* [Notes](http://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.notes){:target="_blank"}
+* [ID](https://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
+* [Patient](https://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.subject){:target="_blank"}
+* [Status](https://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.status){:target="_blank"}
+* [Procedure](https://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.code){:target="_blank"}
+* [Reason performed](https://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.reason_x_){:target="_blank"}
+* [Who performed](https://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.performer){:target="_blank"}
+* [Date performed](https://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.performed_x_){:target="_blank"}
+* [Patient encounter](https://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.encounter){:target="_blank"}
+* [Notes](https://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.notes){:target="_blank"}
+
+<%= disclaimer %>
+
+### Errors
+
+The common [errors] and [OperationOutcomes] may be returned.
 
 ## Terminology Bindings
 
 <%= terminology_table(:procedure, :dstu2) %>
 
 ## Search
 
-Search for Procedures that meet supplied query parameters:
+Search for procedures that meet supplied query parameters.
 
     GET /Procedure?:parameters
 
-_Implementation Notes_
+_Notes_
 
-* The [Procedure.notPerformed] modifier element is not supported and will not be returned.
+* The [Procedure.notPerformed] modifier element is not supported and not returned.
 
 ### Authorization Types
 
 <%= authorization_types(provider: true, patient: true, system: true) %>
 
 ### Parameters
 
- Name         | Required?                             | Type          | Description
---------------|---------------------------------------|---------------|------------------------------------------------------------------------------------
- `_id`        | This, or one of `patient` or `subject`| [`token`]     | The logical resource id associated with the resource. Example: `_id=7891`
- `patient`    | This, or one of `_id` or `subject`    | [`reference`] | The patient subject of the Procedure. Example: `patient=12345`
- `subject`    | This, or one of `_id` or `patient`    | [`reference`] | The subject of the Procedure. Must represent a Patient resource. May use the `:Patient` modifier. Example: `subject=Patient/12345` or `subject:Patient=12345`
- `date`       | N                                     | [`date`]      | The date/time when the Procedure was performed. Must use the `ge` and/or `le` prefixes. Example: `date=le2017-02-01T10:30:00Z`
+ Name              | Required?     | Type          | Description
+-------------------|---------------|---------------|-------------------------------------------------------------------------------------
+`_id`              | Conditionally | [`token`]     | The logical resource ID associated with the resource. This parameter is required if `patient` or `subject` is not used. Example: `_id=7891`
+`patient`          | Conditionally | [`reference`] | Who the procedure is for. This parameter is required if `_id` or `subject` is not used. Example: `12345`
+`subject`          | Conditionally | [`reference`] | Who the procedure is for. This parameter is required if `_id` or `patient` is not used. Example: `subject=Patient/12345` or `subject:Patient=12345`
+`date`             | No            | [`dateTime`]  | The date and time when the procedure's `performedDateTime` was performed. Must use the `ge` or `le` prefix, or both prefixes. Example: `date=le2017-02-01T10:30:00Z`
 
 Notes:
 
-  - The `_id` parameter may not be provided at the same time as the `patient`, `subject`, or `date` parameters.
-
-  - The `date` parameter must have a time, may be provided up to two times, and must use the `ge` or `le` prefixes. When provided twice, the lower value must have the `ge` prefix and the higher value must have the `le` prefix.
+* The `date` parameter:
+  * Must have a time, may be provided up to two times, and must use the `ge` or `le` prefixes. 
+  * When provided twice, the lower value must have the `ge` prefix and the higher value must have the `le` prefix.
 
 ### Headers
 
@@ -70,21 +76,16 @@ Notes:
 
 <%= headers status: 200 %>
 <%= json(:dstu2_procedure_bundle) %>
-<%= disclaimer %>
 
-### Errors
+## Retrieve by ID
 
-The common [errors] and [OperationOutcomes] may be returned.
-
-## Retrieve by id
-
-List an individual Procedure by its id:
+List an individual procedure by its ID.
 
     GET /Procedure/:id
 
-_Implementation Notes_
+_Notes_
 
-* The [Procedure.notPerformed] modifier element is not supported and will not be returned.
+* The [Procedure.notPerformed] modifier element is not supported and not returned.
 
 ### Authorization Types
 
@@ -104,15 +105,10 @@ _Implementation Notes_
 
 <%= headers status: 200 %>
 <%= json(:dstu2_procedure_entry) %>
-<%= disclaimer %>
-
-### Errors
-
-The common [errors] and [OperationOutcomes] may be returned.
 
-[`date`]: http://hl7.org/fhir/DSTU2/search.html#date
-[`reference`]: http://hl7.org/fhir/DSTU2/search.html#reference
-[`token`]: http://hl7.org/fhir/DSTU2/search.html#token
-[Procedure.notPerformed]: http://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.notPerformed
+[`dateTime`]: https://hl7.org/fhir/r4/datatypes.html#dateTime
+[`reference`]: https://hl7.org/fhir/DSTU2/search.html#reference
+[`token`]: https://hl7.org/fhir/DSTU2/search.html#token
+[Procedure.notPerformed]: https://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.notPerformed
 [errors]: ../../#client-errors
 [OperationOutcomes]: ../../#operation-outcomes
diff --git a/content/millennium/r4/clinical/summary/procedure.md b/content/millennium/r4/clinical/summary/procedure.md
@@ -9,40 +9,46 @@ title: Procedure | R4 API
 
 ## Overview
 
-The Procedure resource returns medical and surgical procedures performed on or for a patient during their lifetime.   Historical procedures, as well as procedures recorded during a specific visit, are returned. Surgical procedures from finalized surgical cases will be returned as free text procedures, if the solution has been configured to write procedures from finalized cases to Procedure History.
+The Procedure resource returns medical and surgical procedures performed on or for a patient during their lifetime. Historical procedures and procedures recorded during a specific visit are returned. Surgical procedures from finalized surgical cases are returned as free-text procedures if the product is configured to write procedures from finalized cases to procedure history.
 
-* The following [HL7® FHIR® US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/) Profiles are supported by this resource:
-  * [US Core Procedure Profile](http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-procedure.html)
+* This resource supports the following [HL7 FHIR US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/) profiles:
+  * [US Core Procedure Profile](https://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-procedure.html)
 
 The following fields are returned if valued:
 
-* [Id](https://hl7.org/fhir/R4/resource-definitions.html#Resource.id){:target="_blank"}
-* [Status (completed, entered-in-error)](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.status){:target="_blank"}
+* [ID](https://hl7.org/fhir/R4/resource-definitions.html#Resource.id){:target="_blank"}
+* [Status](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.status){:target="_blank"}
 * [Code](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.code){:target="_blank"}
 * [Subject](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.subject){:target="_blank"}
-  * [Reference](http://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Patient](http://hl7.org/fhir/r4/patient.html){:target="_blank"})
+  * [Reference](https://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Patient](https://hl7.org/fhir/r4/patient.html){:target="_blank"})
 * [Encounter](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.encounter){:target="_blank"}
-* [Date performed](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.performed_x_){:target="_blank"}
+* [Performed Period](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.performed_x_){:target="_blank"}
   * [DateTime](https://hl7.org/fhir/R4/datatypes.html#dateTime){:target="_blank"}
   * [Period](https://hl7.org/fhir/R4/datatypes.html#Period){:target="_blank"}
 * [Who recorded](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.recorder){:target="_blank"}
-  * [Reference](http://hl7.org/fhir/r4/references.html#Reference) ([Practitioner](http://hl7.org/fhir/r4/practitioner.html){:target="_blank"})
+  * [Reference](https://hl7.org/fhir/r4/references.html#Reference) ([Practitioner](https://hl7.org/fhir/r4/practitioner.html){:target="_blank"})
 * [Who performed](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.performer.actor){:target="_blank"}
-  * [Reference](http://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Practitioner](http://hl7.org/fhir/r4/practitioner.html){:target="_blank"})
+  * [Reference](https://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Practitioner](https://hl7.org/fhir/r4/practitioner.html){:target="_blank"})
 * [Location](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.location){:target="_blank"}
 * [Reason procedure performed](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.reasonReference){:target="_blank"}
-  * [Reference](http://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Condition](https://hl7.org/fhir/R4/condition.html){:target="_blank"})
+  * [Reference](https://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Condition](https://hl7.org/fhir/R4/condition.html){:target="_blank"})
 * [Comment/Note](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.note){:target="_blank"}
   * [Annotation Author](https://hl7.org/fhir/R4/datatypes-definitions.html#Annotation.author_x_){:target="_blank"}
-    * [Reference](http://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Practitioner](http://hl7.org/fhir/r4/practitioner.html){:target="_blank"})
+    * [Reference](https://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Practitioner](https://hl7.org/fhir/r4/practitioner.html){:target="_blank"})
+
+<%= disclaimer %>
+
+### Errors
+
+The common [errors] and [OperationOutcomes] may be returned.
 
 ## Terminology Bindings
 
 <%= terminology_table(:procedure, :r4) %>
 
 ## Search
 
-Search for Procedures that meet supplied query parameters:
+Search for procedures that meet supplied query parameters.
 
     GET /Procedure?:parameters
 
@@ -52,21 +58,24 @@ Search for Procedures that meet supplied query parameters:
 
 ### Parameters
 
- Name              | Required?                      | Type          | Description
--------------------|--------------------------------|---------------|-----------------------------------------------------------------------
- `_id`             | This or `patient` or `subject` | [`token`]     | The logical resource id associated with the resource.
- `patient`         | This or `_id` or `subject`     | [`reference`] | Who the procedure is for. Example: `12345`
- `subject`         | This or `_id` or `patient`     | [`reference`] | Who the procedure is for. Example: `Patient/12345`
- `date`            | No                              | [`dateTime`]  | Date range into which the procedure falls. Example: `date=gt2015-09-24T12:00:00.000Z&date=le2020-07-15T16:00:00.000Z`
- `_revinclude`     | No                             | [`token`]     | Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target 
+ Name              | Required?     | Type          | Description
+-------------------|---------------|---------------|-----------------------------------------------------------------------
+ `_id`             | Conditionally | [`token`]     | The logical resource ID associated with the resource. This parameter is required if `patient` or `subject` is not used. Example: `_id=7891`
+ `patient`         | Conditionally | [`reference`] | Who the procedure is for. This parameter is required if `_id` or `subject` is not used. Example: `12345`
+ `subject`         | Conditionally | [`reference`] | Who the procedure is for. This parameter is required if `_id` or `patient` is not used. Example: `Patient/12345`
+ `date`            | No            | [`dateTime`]  | The date range that the procedure's `performedPeriod` or `performedDateTime` falls within. Example: `date=gt2015-09-24T12:00:00.000Z&date=le2020-07-15T16:00:00.000Z`
+ `_revinclude`     | No            | [`token`]     | The Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target 
 
 Notes:
 
-* If `_id` is provided, `patient` or `subject` can no longer be provided.
-* A `date` parameter may be provided once with a prefix and time component to imply a date range. Alternately it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes and time component to search for procedures within a specific range. The date and prefix pairs must create a closed range.
-* The `_revinclude` parameter may be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target`
-* The `_revinclude` parameter may be provided in combination with the `_id/patient` parameter. Example: `_id=570007845&_revinclude=Provenance:target` or `patient=12345&_revinclude=Provenance:target`.
-* When `_revinclude` is provided in a request to a closed endpoint, the OAuth2 token must include the scope corresponding to the Authorization Type, such as `user/Provenance.read`, `patient/Provenance.read` or `system/Provenance.read`.
+* The `date` parameter: 
+  * May be provided once with a prefix and time component to imply a date range. Example: `date=gt2015-09-24T00:00:00.000Z`
+  * May otherwise be provided twice with `le`, `lt`, `ge`, or `gt` prefixes and a time component to search for procedures within a specific range. The date and prefix pairs must create a closed range.
+* The `_revinclude` parameter:
+  * May be provided once with the `Provenance:target` value. Example: `_revinclude=Provenance:target`
+  * May be provided in combination with the `_id` or `patient` parameter. Example: `_id=570007845&_revinclude=Provenance:target` or `patient=12345&_revinclude=Provenance:target`.
+  * When provided in a request to a closed endpoint, the OAuth2 token must include the `user/Provenance.read` scope.
+* Currently, the `patient/Provenance.read` scope is not supported; hence, `_revinclude` cannot be used for patient persona.
 
 ### Headers
 
@@ -83,9 +92,7 @@ Notes:
 <%= headers status: 200 %>
 <%= json(:r4_procedure_bundle) %>
 
-<%= disclaimer %>
-
-### Example with RevInclude
+### Example With RevInclude
 
 ### Authorization Types
 
@@ -100,8 +107,6 @@ Notes:
 <%= headers status: 200 %>
 <%= json(:r4_procedure_revinclude_bundle) %>
 
-<%= disclaimer %>
-
 #### Patient Authorization Request
 
     GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure?patient=12724066
@@ -110,15 +115,10 @@ Notes:
 
 <%= headers status: 200 %>
 <%= json(:r4_procedure_patient_bundle) %>
-<%= disclaimer %>
 
-### Errors
-
-The common [errors] and [OperationOutcomes] may be returned.
+## Retrieve by ID
 
-## Retrieve by id
-
-List an individual Procedure by its id:
+List an individual procedure by its ID.
 
     GET /Procedure/:id
 
@@ -141,7 +141,6 @@ List an individual Procedure by its id:
 <%= headers status: 200 %>
 <%= json(:r4_procedure_entry) %>
 
-<%= disclaimer %>
 
 #### Patient Authorization Request
 
@@ -151,7 +150,6 @@ List an individual Procedure by its id:
 
 <%= headers status: 200 %>
 <%= json(:r4_procedure_patient_entry) %>
-<%= disclaimer %>
 
 #### Patient Authorization Request For Entered in Error Status
 
@@ -161,21 +159,16 @@ List an individual Procedure by its id:
 
 <%= headers status: 200 %>
 <%= json(:r4_procedure_entered_in_error_status ) %>
-<%= disclaimer %>
-### Errors
-
-The common [errors] and [OperationOutcomes] may be returned.
 
 ## Create
 
-Create a new Procedure.
+Create a new procedure.
 
     POST /Procedure
 
-_Implementation Notes_
+_Notes_
 
-* Only the body fields mentioned below are supported. Unsupported fields will be ignored.
-* Modifier fields should not be provided, and will cause the transaction to fail.
+* Only the body fields mentioned below are supported. Unsupported fields are ignored.
 
 ### Authorization Types
 
@@ -216,12 +209,6 @@ X-Request-Id: 2e11665d-618d-4017-9a90-c3c1afeeac00
 
 The `ETag` response header indicates the current `If-Match` version to use on a subsequent update.
 
-<%= disclaimer %>
-
-### Errors
-
-The common [errors] and [OperationOutcomes] may be returned.
-
 [`reference`]: https://hl7.org/fhir/r4/search.html#reference
 [`token`]: https://hl7.org/fhir/R4/search.html#token
 [`dateTime`]: https://hl7.org/fhir/r4/datatypes.html#dateTime