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
  • Description
    • A code to identify a specific procedure. Only one terminology system will be returned, depending on configuration.
  • Details: Procedure Codes (SNOMED CT)
    System: http://snomed.info/

  • Details: CPT
    System: http://www.ama-assn.org/go/cpt

  • Details: ICD-10-PCS
    System: http://www.icd10data.com/icd10pcs

Custom Extensions

The bundle extension can be returned, see possible codes in the errors section below.

GET /Procedure?:parameters

Implementation Notes

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:

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-myrecord.sandboxcerner.com/dstu2/123abc/Procedure?patientId=7568F2F3-FC76-4185-A540-1DB56331A387&date=%3E%3D2015-06-01T11%3A18%3A00&date=%3C2015-06-29T11%3A18%3A00

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "d8c30ba8-9285-49b8-8994-e3738e8e2821",
  "meta": {
    "lastUpdated": "2017-03-01T11:41:31.719-05: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."
          }
        ]
      }
    },
    {
      "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": "papi029"
          },
          {
            "url": "Message",
            "valueString": "Information provided is from 2015-06-01 through 2015-06-28 inclusive."
          }
        ]
      }
    },
    {
      "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": "fsp001"
          },
          {
            "url": "Message",
            "valueString": "Date parameter values passed with request were: date=>=2015-06-01T11:18:00&date=<2015-06-29T11:18:00"
          }
        ]
      }
    }
  ],
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "base-url/123abc/Procedure?date=%3E%3D2015-06-01T11%3A18%3A00&date=%3C2015-06-29T11%3A18%3A00&_format=json&patientId=7568F2F3-FC76-4185-A540-1DB56331A387"
    }
  ],
  "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",
              "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",
              "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",
              "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.