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

Commit

Permalink
Addressing comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@RicardoCrespo-ora
RicardoCrespo-ora committed Nov 17, 2023
1 parent 3f561a8 commit e9629b5
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 55 deletions.
39 changes: 17 additions & 22 deletions content/millennium/dstu2/general-clinical/procedure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The following fields are returned if valued:

* [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"}
* [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"}
Expand All @@ -27,13 +27,19 @@ The following fields are returned if valued:

<%= terminology_table(:procedure, :dstu2) %>

<%= disclaimer %>

## Errors

The common [errors] and [OperationOutcomes] may be returned.

## Search

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.

Expand All @@ -45,14 +51,13 @@ _Implementation Notes_

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`
`_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if `patient` or `subject` are not used. Example: `_id=7891`
`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: `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.
Expand All @@ -71,15 +76,10 @@ 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

Expand All @@ -105,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
50 changes: 17 additions & 33 deletions content/millennium/r4/clinical/summary/procedure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,34 +12,40 @@ title: Procedure | R4 API
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 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)
* [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"}
* [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"}
* [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"})

## Terminology Bindings

<%= terminology_table(:procedure, :r4) %>

<%= disclaimer %>

## Errors

The common [errors] and [OperationOutcomes] may be returned.

## Search

Search for Procedures that meet supplied query parameters:
Expand All @@ -54,7 +60,7 @@ Search for Procedures that meet supplied query parameters:

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.
`_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if `patient` or `subject` are not used. Example: `_id=7891`
`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`
`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`
Expand Down Expand Up @@ -87,8 +93,6 @@ Notes:
<%= headers status: 200 %>
<%= json(:r4_procedure_bundle) %>

<%= disclaimer %>

### Example with RevInclude

### Authorization Types
Expand All @@ -104,8 +108,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
Expand All @@ -114,15 +116,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

Expand All @@ -145,7 +142,6 @@ List an individual Procedure by its id:
<%= headers status: 200 %>
<%= json(:r4_procedure_entry) %>

<%= disclaimer %>

#### Patient Authorization Request

Expand All @@ -155,7 +151,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

Expand All @@ -165,21 +160,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.

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.

### Authorization Types

Expand Down Expand Up @@ -220,12 +210,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
Expand Down

0 comments on commit e9629b5

Please sign in to comment.