Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Review and Updates to Procedure #1016

Merged
merged 7 commits into from
Nov 30, 2023
Merged

Review and Updates to Procedure #1016

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3f561a8
review and updates to procedure
RicardoCrespo-ora Nov 9, 2023
e9629b5
Addressing comments
RicardoCrespo-ora Nov 17, 2023
8c69f25
Removed id note
RicardoCrespo-ora Nov 17, 2023
50e8fb2
changed position of disclaimer and errors
RicardoCrespo-ora Nov 17, 2023
aef3d78
PRODOC-203452: Style edits.
Nov 20, 2023
6913913
PRODOC-203452: Style edits.
Nov 20, 2023
62fb1b0
Merge branch 'main' into procedure-docs-migrate
RicardoCrespo-ora Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions content/millennium/dstu2/general-clinical/procedure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ The Procedure resource returns current and historical procedures performed on a

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 (completed, entered-in-error)](https://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.status){:target="_blank"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can drop the parentheses on Status here. Just saying the field can return is enough.

* [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"}

## Terminology Bindings

Expand All @@ -43,18 +43,19 @@ _Implementation Notes_

### 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. Example: `_id=7891`
`patient` | Conditionally | [`reference`] | The patient of the Procedure. Example: `patient=12345`
`subject` | Conditionally | [`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` | No | [`dateTime`] | The date/time when the Procedure's `performedDateTime` was performed. Must use the `ge` and/or `le` 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 `_id` parameter may not be provided at the same time as the `patient`, `subject`, or `date` parameters.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drop the conditional requirement line here, and use the descriptions in the R4 resource's table over on this DSTU2 resource, please. Your fixes in the R4 file match what the technical writers are looking for.

* 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

Expand Down
29 changes: 16 additions & 13 deletions content/millennium/r4/clinical/summary/procedure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ The Procedure resource returns medical and surgical procedures performed on or f

The following fields are returned if valued:

* [Id](https://hl7.org/fhir/R4/resource-definitions.html#Resource.id){:target="_blank"}
* [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"}
* [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"})
* [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"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as on DSTU2 - drop the Status field's parenthetical values, please

* [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"}
Expand Down Expand Up @@ -52,21 +52,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` are not used.
`patient` | Conditionally | [`reference`] | Who the Procedure is for. This parameter is required if `_id` or `subject` are not used. Example: `12345`
`subject` | Conditionally | [`reference`] | Who the Procedure is for. This parameter is required if `_id` or `patient` are not used. Example: `Patient/12345`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wording on the parameters here should be used in DSTU2 resource's table as well.

`date` | No | [`dateTime`] | Date range in which 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`] | 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you still use date if _id is used?

I thought it flipped over to basically:
If searching with the _id parameter, you cannot use any other parameters (except for _revinclude as detailed)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the id note to avoid confusion

* 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 `user/Provenance.read` scope.
* 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 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`
* 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 and hence `_revinclude` cannot be utilised for patient persona.**

### Headers
Expand Down
Loading