Procedure
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 following HL7® FHIR® US Core Implementation Guide STU 4.0.0 Profiles are supported by this resource:
The following fields are returned if valued:
- Id
- Status (completed, entered-in-error)
- Code
- Subject
- Encounter
- Date performed
- Who recorded
- Who performed
- Location
- Reason procedure performed
- Comment/Note
Terminology Bindings
Procedure.status |
|
Procedure.code |
|
Procedure.performer.function |
|
Search
Search for Procedures that meet supplied query parameters:
GET /Procedure?:parameters
Authorization Types
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 |
Notes:
- If
_id
is provided,patient
orsubject
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 withle
,lt
,ge
, orgt
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 valueProvenance:target
. Example:_revinclude=Provenance:target
- The
_revinclude
parameter may be provided in combination with the_id/patient
parameter. Example:_id=570007845&_revinclude=Provenance:target
orpatient=12345&_revinclude=Provenance:target
. - When
_revinclude
is provided in a request to a closed endpoint, the OAuth2 token must include theuser/Provenance.read
scope. - Currently the
patient/Provenance.read
scope is not supported and hence_revinclude
cannot be utilised for patient persona.
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure?patient=12724066
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "3b3b1ce0-3b6e-4a41-bbb4-9696e2f4b8ed",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure?patient=12724066"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure/2572382193",
"resource": {
"resourceType": "Procedure",
"id": "2572382193",
"meta": {
"versionId": "0",
"lastUpdated": "2020-06-11T04:02:54Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Procedure</b></p><p><b>Patient</b>: SMART, NANCY</p><p><b>Procedure</b>: Appendectomy;</p><p><b>Date</b>: 2002</p><p><b>Status</b>: Completed</p><p><b>Recorder</b>: Cerner Test, Physician - Women's Health Cerner</p></div>"
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://www.ama-assn.org/go/cpt",
"code": "44950",
"display": "Appendectomy;",
"userSelected": true
}
],
"text": "Appendectomy;"
},
"subject": {
"reference": "Patient/12724066",
"display": "SMART, NANCY"
},
"encounter": {
"reference": "Encounter/97953477"
},
"performedDateTime": "2002",
"recorder": {
"reference": "Practitioner/4122630",
"display": "Cerner Test, Physician - Women's Health Cerner"
}
}
},
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure/2572383421",
"resource": {
"resourceType": "Procedure",
"id": "2572383421",
"meta": {
"versionId": "0",
"lastUpdated": "2020-06-16T21:09:27Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Procedure</b></p><p><b>Patient</b>: SMART, NANCY</p><p><b>Procedure</b>: Coronary artery bypass, using arterial graft(s); 2 coronary arterial grafts</p><p><b>Date</b>: 2018</p><p><b>Status</b>: Completed</p><p><b>Recorder</b>: Cerner Test, Physician - Oncology Cerner</p></div>"
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://www.ama-assn.org/go/cpt",
"code": "33534",
"display": "Coronary artery bypass, using arterial graft(s); two coronary arterial grafts",
"userSelected": true
}
],
"text": "Coronary artery bypass, using arterial graft(s); 2 coronary arterial grafts"
},
"subject": {
"reference": "Patient/12724066",
"display": "SMART, NANCY"
},
"encounter": {
"reference": "Encounter/97953477"
},
"performedDateTime": "2018",
"recorder": {
"reference": "Practitioner/763923",
"display": "Cerner Test, Physician - Oncology Cerner"
}
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Example with RevInclude
Authorization Types
Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure?_id=570007845&_revinclude=Provenance:target
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "e448772d-7265-48b2-a942-99002b44337d",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure?patient=744104&_revinclude=Provenance%3Atarget"
}
],
"entry": [
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure/570007845",
"resource": {
"resourceType": "Procedure",
"id": "570007845",
"meta": {
"versionId": "0",
"lastUpdated": "2021-05-28T15:02:50Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Procedure</b></p><p><b>Patient</b>: HEATHERJSMITH</p><p><b>Procedure</b>: Adenoid excision (text)</p><p><b>Date</b>: Apr 5, 2019</p><p><b>Status</b>: Completed</p><p><b>Location</b>: Baseline East</p><p><b>Recorder</b>: Powerchart, User</p><p><b>Performer</b>:</p><ul><li>Smith MD, John</li></ul></div>"
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "119954001",
"display": "Adenoid excision (procedure)",
"userSelected": true
}
],
"text": "Adenoid excision (text)"
},
"subject": {
"reference": "Patient/744104",
"display": "HEATHERJSMITH"
},
"encounter": {
"reference": "Encounter/18245662"
},
"performedDateTime": "2019-04-05",
"recorder": {
"reference": "Practitioner/1255969",
"display": "Powerchart, User"
},
"performer": [
{
"actor": {
"reference": "Practitioner/2523932",
"display": "Smith MD, John"
}
}
],
"location": {
"display": "Baseline East"
},
"note": [
{
"authorReference": {
"reference": "Practitioner/2523932",
"display": "Smith MD, John"
},
"time": "2019-04-05T20:21:46Z",
"text": "Procedure comment"
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/proc-13511261",
"resource": {
"resourceType": "Provenance",
"id": "proc-13511261",
"meta": {
"versionId": "13511261",
"lastUpdated": "2021-05-28T10:09:59-05:00"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>Procedure/570007845</li></ul><p><b>Recorded</b>: Oct 25, 2019 9:57 A.M. CDT</p><p><b>Agents</b>:</p><dl><dt>Unknown</dt><dd><b>Agent Type</b>: Transmitter</dd><dd><b>Agent Role</b>: Source</dd></dl><p><b>Entity Source</b>: DocumentReference/S-201</p></div>"
},
"target": [
{
"reference": "Procedure/570007845"
}
],
"recorded": "2019-10-25T09:57:43-05:00",
"agent": [
{
"type": {
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
"code": "transmitter"
}
],
"text": "Transmitter"
},
"role": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
"code": "SOURCE"
}
],
"text": "Source"
}
],
"who": {
"reference": "Organization/619848",
"display": "Unknown"
}
}
],
"entity": [
{
"role": "source",
"what": {
"reference": "DocumentReference/S-201"
}
}
]
},
"search": {
"mode": "include"
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Patient Authorization Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure?patient=12724066
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "53ac99d1-c76b-4a07-90f8-73d13a01459b",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "http://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure?patient=12724066"
}
],
"entry": [
{
"fullUrl": "http://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure/2572581295",
"resource": {
"resourceType": "Procedure",
"id": "2572581295",
"meta": {
"versionId": "0",
"lastUpdated": "2020-09-25T20:13:56Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Procedure</b></p><p><b>Patient</b>: SMART, NANCY</p><p><b>Procedure</b>: Adenoid excision (text)</p><p><b>Date</b>: Apr 5, 2019</p><p><b>Status</b>: Completed</p><p><b>Location</b>: Baseline East</p><p><b>Recorder</b>: SYSTEM, SYSTEM Cerner</p><p><b>Performer</b>:</p><ul><li>Cerner Test, Physician - Women's Health Cerner</li></ul></div>"
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "119954001",
"display": "Adenoid excision (procedure)",
"userSelected": true
}
],
"text": "Adenoid excision (text)"
},
"subject": {
"reference": "Patient/12724066",
"display": "SMART, NANCY"
},
"encounter": {
"reference": "Encounter/97953477"
},
"performedDateTime": "2019-04-05",
"recorder": {
"reference": "Practitioner/1",
"display": "SYSTEM, SYSTEM Cerner"
},
"performer": [
{
"actor": {
"reference": "Practitioner/4122630",
"display": "Cerner Test, Physician - Women's Health Cerner"
}
}
],
"location": {
"display": "Baseline East"
},
"note": [
{
"authorReference": {
"reference": "Practitioner/4122630",
"display": "Cerner Test, Physician - Women's Health Cerner"
},
"time": "2019-04-05T20:21:46Z",
"text": "Procedure comment"
}
]
}
},
{
"fullUrl": "http://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure/2572476121",
"resource": {
"resourceType": "Procedure",
"id": "2572476121",
"meta": {
"versionId": "0",
"lastUpdated": "2020-08-24T08:42:34Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Procedure</b></p><p><b>Patient</b>: SMART, NANCY</p><p><b>Procedure</b>: Adenoid excision (text)</p><p><b>Status</b>: Completed</p><p><b>Recorder</b>: SYSTEM, SYSTEM Cerner</p></div>"
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "119954001",
"display": "Adenoid excision (procedure)",
"userSelected": true
}
],
"text": "Adenoid excision (text)"
},
"subject": {
"reference": "Patient/12724066",
"display": "SMART, NANCY"
},
"encounter": {
"reference": "Encounter/97953477"
},
"_performedDateTime": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
},
"recorder": {
"reference": "Practitioner/1",
"display": "SYSTEM, SYSTEM Cerner"
}
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Retrieve by id
List an individual Procedure by its id:
GET /Procedure/:id
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure/2572382193
Response
Status: 200 OK
{
"resourceType": "Procedure",
"id": "2572382193",
"meta": {
"versionId": "0",
"lastUpdated": "2020-06-11T04:02:54Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Procedure</b></p><p><b>Patient</b>: SMART, NANCY</p><p><b>Procedure</b>: Appendectomy;</p><p><b>Date</b>: 2002</p><p><b>Status</b>: Completed</p><p><b>Recorder</b>: Cerner Test, Physician - Women's Health Cerner</p></div>"
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://www.ama-assn.org/go/cpt",
"code": "44950",
"display": "Appendectomy;",
"userSelected": true
}
],
"text": "Appendectomy;"
},
"subject": {
"reference": "Patient/12724066",
"display": "SMART, NANCY"
},
"encounter": {
"reference": "Encounter/97953477"
},
"performedDateTime": "2002",
"recorder": {
"reference": "Practitioner/4122630",
"display": "Cerner Test, Physician - Women's Health Cerner"
}
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Patient Authorization Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure/2572581295
Response
Status: 200 OK
{
"resourceType": "Procedure",
"id": "2572581295",
"meta": {
"versionId": "0",
"lastUpdated": "2020-09-25T20:13:56Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Procedure</b></p><p><b>Patient</b>: SMART, NANCY</p><p><b>Procedure</b>: Adenoid excision (text)</p><p><b>Date</b>: Apr 5, 2019</p><p><b>Status</b>: Completed</p><p><b>Location</b>: Baseline East</p><p><b>Recorder</b>: SYSTEM, SYSTEM Cerner</p><p><b>Performer</b>:</p><ul><li>Cerner Test, Physician - Women's Health Cerner</li></ul></div>"
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "119954001",
"display": "Adenoid excision (procedure)",
"userSelected": true
}
],
"text": "Adenoid excision (text)"
},
"subject": {
"reference": "Patient/12724066",
"display": "SMART, NANCY"
},
"encounter": {
"reference": "Encounter/97953477"
},
"performedDateTime": "2019-04-05",
"recorder": {
"reference": "Practitioner/1",
"display": "SYSTEM, SYSTEM Cerner"
},
"performer": [
{
"actor": {
"reference": "Practitioner/4122630",
"display": "Cerner Test, Physician - Women's Health Cerner"
}
}
],
"location": {
"display": "Baseline East"
},
"note": [
{
"authorReference": {
"reference": "Practitioner/4122630",
"display": "Cerner Test, Physician - Women's Health Cerner"
},
"time": "2019-04-05T20:21:46Z",
"text": "Procedure comment"
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Patient Authorization Request For Entered in Error Status
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure/1788134987
Response
Status: 200 OK
{
"resourceType": "Procedure",
"id": "1788134987",
"meta": {
"versionId": "0",
"lastUpdated": "2019-09-05T22:38:38Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Procedure</b></p><p><b>Patient</b>: MARSTON, JACK</p><p><b>Procedure</b>: Error</p><p><b>Status</b>: Entered in Error</p></div>"
},
"status": "entered-in-error",
"code": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "error",
"display": "Error"
}
],
"text": "Error"
},
"subject": {
"reference": "Patient/166045489",
"display": "MARSTON, JACK"
}
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Create
Create a new Procedure.
POST /Procedure
Implementation 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
Headers
Authorization: <OAuth2 Bearer Token>
Content-Type: application/fhir+json
Body Fields
Name | Required | Type | |
---|---|---|---|
resourceType
|
Yes |
string |
|
|
|||
status
|
Yes |
code |
|
|
|||
code
|
Yes |
CodeableConcept |
|
|
|||
subject
|
Yes |
Reference |
|
|
|||
encounter
|
No |
Reference |
|
|
|||
performed[x]
|
No |
dateTime |
|
|
|||
performedPeriod
|
No |
Period |
|
|
|||
performer
|
No |
List of BackboneElement |
|
|
|||
performer.function
|
No |
CodeableConcept |
|
|
|||
performer.actor
|
Yes |
Reference |
|
|
|||
location
|
No |
Reference |
|
|
|||
note
|
No |
List of Annotation |
|
|
Example
Request
POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure
Body
{
"resourceType": "Procedure",
"status": "completed",
"subject": {
"reference": "Patient/12724066"
},
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "119954001",
"display": "Adenoid excision (procedure)",
"userSelected": true
}
],
"text": "Adenoid excision (text)"
},
"encounter": {
"reference": "Encounter/97953477"
},
"location": {
"display": "Baseline East"
},
"performedDateTime": "2019-04-05T20:21:46Z",
"performedPeriod": {
"start": "2019-04-05T20:21:46Z",
"end": "2019-04-05T21:21:46Z"
},
"performer": [
{
"function": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "223366009",
"display": "Healthcare professional (occupation)",
"userSelected": true
}
],
"text": "Healthcare professional (occupation)"
},
"actor": {
"reference": "Practitioner/4122630"
}
}
],
"note": [
{
"text": "Procedure comment",
"time": "2019-04-05T20:21:46Z",
"authorReference": {
"reference": "Practitioner/4122630"
}
}
]
}
Response
Status: 201 Created
Cache-Control: no-cache Content-Length: 0 Content-Type: text/html Date: Mon, 06 Apr 2020 19:00:43 GMT Etag: W/"1" Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure/17228728 Last-Modified: Mon, 06 Apr 2020 19:00:43 GMT Vary: Origin X-Request-Id: 2e11665d-618d-4017-9a90-c3c1afeeac00
The ETag
response header indicates the current If-Match
version to use on a subsequent update.
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.