Procedure
Overview
The API returns procedures charted in Soarian Clinicals. Procedures in completed or aborted status are returned; procedures in erroneous status are not returned. Note that traditional charting practices have procedures resolved and charted in coding and billing systems and not interfaced back to the EMR; therefore, the procedure record in Soarian may not be complete nor precise to a procedure list provided as part of a patient’s billing record.
Terminology Bindings
Procedure.code |
|
Custom Extensions
The bundle extension can be returned, see possible codes in the errors section below.
Search
GET /Procedure?:parameters
Implementation Notes
- The API returns the most current procedure list.
- The API returns procedures in a
completed
oraborted
status. It will not return procedures marked asentered-in-error
. - The Narrative includes additional information pertaining to the procedures, and should be shown to the user to ensure completeness of clinical content and context.
Parameters
Name | Required? | Type | Description |
---|---|---|---|
patientId | Y | reference |
The patient identifier provided in a pre-requisite authorization step. |
date | N |
date as adjusted per implementation notes |
Null or specific date or a date range. |
Notes:
- See details regarding special date requirements.
- If the date parameter is null in the query, the API will return all qualifying records.
- If a single date parameter is used in the query, the response will include all qualifying records dated that day.
- If a valid date range is used in the query, the API will return all qualifying records within the dates specified.
- If an invalid date range is used in the query, the API will error with code 500. Please refer to Special information regarding date parameters.
- Developers are strongly encouraged to specify date ranges to prevent an inordinate number of records from being returned.
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-myrecord.sandboxcerner.com/dstu2/123abc/Procedure?patientId=D4292B7B-AEDF-4CEF-B783-BD3AA1B0DD27
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "04849360-4587-4ba8-a804-a2c8488e5eee",
"meta": {
"lastUpdated": "2018-04-10T09:49:00.451-04:00"
},
"extension": [
{
"url": "http://cerner.hs.fhir.com/StructureDefinition/bundle-result-messages",
"valueExtension": {
"url": "http://cerner.hs.fhir.com/StructureDefinition/bundle-result-messages",
"extension": [
{
"url": "Severity",
"valueString": "info"
},
{
"url": "Code",
"valueString": "papi011"
},
{
"url": "Message",
"valueString": "This section represents data charted for a single or set of encounter’s procedures performed. It does not represent a comprehensive procedure list."
}
]
}
}
],
"type": "searchset",
"link": [
{
"relation": "self",
"url": "base-url/123abc/Procedure?patientId=D4292B7B-AEDF-4CEF-B783-BD3AA1B0DD27&_format=json"
}
],
"entry": [
{
"resource": {
"resourceType": "Procedure",
"text": {
"status": "additional",
"div": "<li ccdRefId="ZCCDProcedureList.CCDProcedureList.1503">Completed Bronchoscopy, on 6/22/2015 12:00 AM</li>"
},
"identifier": [
{
"use": "official",
"value": "ZCCDProcedureList.CCDProcedureList.1503"
}
],
"subject": {
"reference": "Patient/7568F2F3-FC76-4185-A540-1DB56331A387"
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "10847001",
"display": "Bronchoscopy"
}
],
"text": "Bronchoscopy"
}
}
},
{
"resource": {
"resourceType": "Procedure",
"text": {
"status": "additional",
"div": "<li ccdRefId="ZCCDProcedureList.CCDProcedureList.3001">Completed Chest X-Ray, PA and Lateral View, on 6/22/2015 12:00 AM</li>"
},
"identifier": [
{
"use": "official",
"value": "ZCCDProcedureList.CCDProcedureList.3001"
}
],
"subject": {
"reference": "Patient/7568F2F3-FC76-4185-A540-1DB56331A387"
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "168731009",
"display": "Chest X-Ray, PA and Lateral View"
}
],
"text": "Chest X-Ray, PA and Lateral View"
}
}
},
{
"resource": {
"resourceType": "Procedure",
"text": {
"status": "additional",
"div": "<li ccdRefId="ZCCDProcedureList.CCDProcedureList.1505">Completed Introduction of Cardiac Pacemaker System via Vein, on 10/5/2011 12:00 AM</li>"
},
"identifier": [
{
"use": "official",
"value": "ZCCDProcedureList.CCDProcedureList.1505"
}
],
"subject": {
"reference": "Patient/7568F2F3-FC76-4185-A540-1DB56331A387"
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "175135009",
"display": "Introduction of Cardiac Pacemaker System via Vein"
}
],
"text": "Introduction of Cardiac Pacemaker System via Vein"
}
}
}
]
}
Errors and Informational messages
The common errors and informational messages can be returned.
These additional informational messages may be returned within the bundle extension:
Code | Message |
---|---|
papi011 | This section represents data charted for a single or set of encounter’s procedures performed. It does not represent a comprehensive procedure list. |
papi012 | No procedure information is available. |
papi028 | Provides the date range that had start date as null. |
papi029 | Provides the date range that was used to run the search. |