Procedure

• Overview
• Terminology Bindings
• Search
  • Authorization Types
  • Parameters
  • Headers
  • Example Search by Patient
  • Example Search by ID
  • Errors
• Retrieve by ID
  • Authorization Types
  • Headers
  • Example
  • Errors

Overview

The Procedure resource implementation is limited to a patient’s known procedure history that occured at this site and is recorded in Soarian Clinicals^®. As such, this resource may not be as complete as a procedure list provided as part of the patient’s billing record.

Soarian Clinicals^® supports a read-only Application Programming Interface (API). This API accepts GET and POST based search and GET based read interactions. The response represents the most current information about the patient that is charted in Soarian Clinicals^® at the time of the query.

The search results include the following fields if they contain values:

• Procedure id
• Status (completed, stopped, entered-in-error)
• Code
• Subject (Patient only)
• Encounter
• Performed[x]
  • Performed date time
• Focal Device
  • Action
  • Manipulated

Terminology Bindings

Procedure.code

Description A code to identify a specific procedure. Details: Procedure Codes (SNOMED CT) System: http://snomed.info/sct

Procedure.focalDevice.action

Description A code to identify the kind of change that happened to the device during the procedure. Details: Procedure Device Action Codes System: http://snomed.info/sct

Search

Search for Procedure resources that meet specified query parameters:

GET /Procedure?:parameters

Authorization Types

Implementation Notes

• Soarian Clinicals® reports the procedure code that may have been received from an interfaced financial system. If the financial system supplied a procedure code without identifying its coding system, the coding system will not appear in the procedure FHIR® resource, and should not be assumed to be SNOMED CT®.

Parameters

Name	Required?	Type	Description
_id	This, or patient	token	The logical resource ID associated with the resource.
patient	This, or _id	reference	The patient who has the procedure.
date	No	date	Date range into which the procedure falls. Example: date=gt2014-09-24 or date=lt2015-09-24T12:00:00.000Z
encounter	No	reference	The encounter associated with the procedure record.
_revinclude	No	_revinclude	A request to include any Provenance resource in the bundle that refers to a Procedure resource in the search results. Only supported with Provenance.

Headers

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

Example Search by Patient

Request

GET https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Procedure?patient=A879904FD2FE4B2D90C89FDA84E1285F

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "3ea57196-7e5c-4ad6-9c3b-8761c38430c5",
  "type": "searchset",
  "timestamp": "2022-05-11T04:42:41-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Procedure/A879904FD2FE4B2D90C89FDA84E1285F.8008",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "Procedure",
        "id": "A879904FD2FE4B2D90C89FDA84E1285F.8008",
        "meta": {
          "lastUpdated": "2021-03-02T15:48:45-05:00"
        },
        "status": "completed",
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "10847001",
              "display": "Bronchoscopy"
            }
          ],
          "text": "Bronchoscopy"
        },
        "subject": {
          "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
          "display": "Mcgovern,Astrid Santiago"
        },
        "encounter": {
          "reference": "Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019",
          "display": "Inferno,Initial"
        },
        "performedDateTime": "2020-11-13T02:02:00-05:00",
        "focalDevice": [
          {
            "action": {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "257867005",
                  "display": "Insertion - action"
                }
              ]
            },
            "manipulated": {
              "reference": "Device/A879904FD2FE4B2D90C89FDA84E1285F.9005",
              "display": "700803007 Orthopedic prosthesis implantation instrument, reusable (physical object)"
            }
          },
          {
            "action": {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "257867005",
                  "display": "Insertion - action"
                }
              ]
            },
            "manipulated": {
              "reference": "Device/A879904FD2FE4B2D90C89FDA84E1285F.13004",
              "display": "714547008 Bone matrix implant, human derived (physical object)"
            }
          }
        ],
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Procedure</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Encounter</b>:Inferno,Initial;<br /><b>Status</b>:completed;<br /><b>Code</b>:<br /><b>system</b>:http://snomed.info/sct <b>code</b>:10847001 <b>display</b>:Bronchoscopy;<br /><b>Performed</b>:2020-11-13T02:02:00-05:00;<br /><b>Focal Device</b>: <br /><b>Action</b>: <b>system</b>:http://snomed.info/sct <b>code</b>:257867005 <b>display</b>:Insertion - action;<br /><b>Manipulated</b>:Device/A879904FD2FE4B2D90C89FDA84E1285F.9005,700803007 Orthopedic prosthesis implantation instrument, reusable (physical object);<br /><b>Action</b>: <b>system</b>:http://snomed.info/sct <b>code</b>:257867005 <b>display</b>:Insertion - action;<br /><b>Manipulated</b>:Device/A879904FD2FE4B2D90C89FDA84E1285F.13004,714547008 Bone matrix implant, human derived (physical object);<br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Procedure?patient=A879904FD2FE4B2D90C89FDA84E1285F"
    }
  ]
}

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 Search by ID

Request

GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Procedure?_id=A879904FD2FE4B2D90C89FDA84E1285F.8008

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "3ea57196-7e5c-4ad6-9c3b-8761c38430c5",
  "type": "searchset",
  "timestamp": "2022-05-11T04:42:41-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Procedure/A879904FD2FE4B2D90C89FDA84E1285F.8008",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "Procedure",
        "id": "A879904FD2FE4B2D90C89FDA84E1285F.8008",
        "meta": {
          "lastUpdated": "2021-03-02T15:48:45-05:00"
        },
        "status": "completed",
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "10847001",
              "display": "Bronchoscopy"
            }
          ],
          "text": "Bronchoscopy"
        },
        "subject": {
          "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
          "display": "Mcgovern,Astrid Santiago"
        },
        "encounter": {
          "reference": "Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019",
          "display": "Inferno,Initial"
        },
        "performedDateTime": "2020-11-13T02:02:00-05:00",
        "focalDevice": [
          {
            "action": {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "257867005",
                  "display": "Insertion - action"
                }
              ]
            },
            "manipulated": {
              "reference": "Device/A879904FD2FE4B2D90C89FDA84E1285F.9005",
              "display": "700803007 Orthopedic prosthesis implantation instrument, reusable (physical object)"
            }
          },
          {
            "action": {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "257867005",
                  "display": "Insertion - action"
                }
              ]
            },
            "manipulated": {
              "reference": "Device/A879904FD2FE4B2D90C89FDA84E1285F.13004",
              "display": "714547008 Bone matrix implant, human derived (physical object)"
            }
          }
        ],
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Procedure</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Encounter</b>:Inferno,Initial;<br /><b>Status</b>:completed;<br /><b>Code</b>:<br /><b>system</b>:http://snomed.info/sct <b>code</b>:10847001 <b>display</b>:Bronchoscopy;<br /><b>Performed</b>:2020-11-13T02:02:00-05:00;<br /><b>Focal Device</b>: <br /><b>Action</b>: <b>system</b>:http://snomed.info/sct <b>code</b>:257867005 <b>display</b>:Insertion - action;<br /><b>Manipulated</b>:Device/A879904FD2FE4B2D90C89FDA84E1285F.9005,700803007 Orthopedic prosthesis implantation instrument, reusable (physical object);<br /><b>Action</b>: <b>system</b>:http://snomed.info/sct <b>code</b>:257867005 <b>display</b>:Insertion - action;<br /><b>Manipulated</b>:Device/A879904FD2FE4B2D90C89FDA84E1285F.13004,714547008 Bone matrix implant, human derived (physical object);<br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Procedure?patient=A879904FD2FE4B2D90C89FDA84E1285F"
    }
  ]
}

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 resource by its ID:

GET /Procedure/:id

Authorization Types

Implementation Notes

• Soarian Clinicals® reports the procedure code that may have been received from an interfaced financial system. If the financial system supplied a procedure code without identifying its coding system, the coding system will not appear in the procedure FHIR® resource, and should not be assumed to be SNOMED CT®.

Headers

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

Example

Request

GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Procedure/A879904FD2FE4B2D90C89FDA84E1285F.8008

Response

Status: 200 OK

{
  "resourceType": "Procedure",
  "id": "A879904FD2FE4B2D90C89FDA84E1285F.8008",
  "meta": {
    "lastUpdated": "2021-03-02T15:48:45-05:00"
  },
  "status": "completed",
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "10847001",
        "display": "Bronchoscopy"
      }
    ],
    "text": "Bronchoscopy"
  },
  "subject": {
    "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
    "display": "Mcgovern,Astrid Santiago"
  },
  "encounter": {
    "reference": "Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019",
    "display": "Inferno,Initial"
  },
  "performedDateTime": "2020-11-13T02:02:00-05:00",
  "focalDevice": [
    {
      "action": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "257867005",
            "display": "Insertion - action"
          }
        ]
      },
      "manipulated": {
        "reference": "Device/A879904FD2FE4B2D90C89FDA84E1285F.9005",
        "display": "700803007 Orthopedic prosthesis implantation instrument, reusable (physical object)"
      }
    },
    {
      "action": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "257867005",
            "display": "Insertion - action"
          }
        ]
      },
      "manipulated": {
        "reference": "Device/A879904FD2FE4B2D90C89FDA84E1285F.13004",
        "display": "714547008 Bone matrix implant, human derived (physical object)"
      }
    }
  ],
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Procedure</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Encounter</b>:Inferno,Initial;<br /><b>Status</b>:completed;<br /><b>Code</b>:<br /><b>system</b>:http://snomed.info/sct <b>code</b>:10847001 <b>display</b>:Bronchoscopy;<br /><b>Performed</b>:2020-11-13T02:02:00-05:00;<br /><b>Focal Device</b>: <br /><b>Action</b>: <b>system</b>:http://snomed.info/sct <b>code</b>:257867005 <b>display</b>:Insertion - action;<br /><b>Manipulated</b>:Device/A879904FD2FE4B2D90C89FDA84E1285F.9005,700803007 Orthopedic prosthesis implantation instrument, reusable (physical object);<br /><b>Action</b>: <b>system</b>:http://snomed.info/sct <b>code</b>:257867005 <b>display</b>:Insertion - action;<br /><b>Manipulated</b>:Device/A879904FD2FE4B2D90C89FDA84E1285F.13004,714547008 Bone matrix implant, human derived (physical object);<br /></div>"
  }
}

Request

GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Procedure/7DD361F7EB43448690AABCCC45E62285.4010

Response

Status: 200 OK

{
  "resourceType": "Procedure",
  "id": "7DD361F7EB43448690AABCCC45E62285.4010",
  "meta": {
    "lastUpdated": "2020-07-16T20:32:34-04:00"
  },
  "status": "entered-in-error",
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "429211003",
        "display": "Procedure for Atrial Fib"
      }
    ],
    "text": "Procedure for Atrial Fib"
  },
  "subject": {
    "reference": "Patient/7DD361F7EB43448690AABCCC45E62285",
    "display": "Lansford,Mukesh-Procedure Dianne"
  },
  "encounter": {
    "reference": "Encounter/7DD361F7EB43448690AABCCC45E62285.47027",
    "display": "City General,Initial"
  },
  "performedDateTime": "2020-07-16T02:55:00-04:00",
  "focalDevice": [
    {
      "action": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "386746003",
            "display": "Maintenance - action"
          }
        ]
      },
      "manipulated": {
        "reference": "Device/7DD361F7EB43448690AABCCC45E62285.3007"
      }
    }
  ],
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Procedure</b><br /><b>Patient</b>:Lansford,Mukesh-Procedure Dianne;<br /><b>Encounter</b>:City General,Initial;<br /><b>Status</b>:entered-in-error;<br /><b>Code</b>:<br /><b>system</b>:http://snomed.info/sct <b>code</b>:429211003 <b>display</b>:Procedure for Atrial Fib;<br /><b>Performed</b>:2020-07-16T02:55:00-04:00;<br /><b>Focal Device</b>: <br /><b>Action</b>: <b>system</b>:http://snomed.info/sct <b>code</b>:386746003 <b>display</b>:Maintenance - action;<br /><b>Manipulated</b>:Device/7DD361F7EB43448690AABCCC45E62285.3007;<br /></div>"
  }
}

Request

GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Procedure/7DD361F7EB43448690AABCCC45E62285.503

Response

Status: 200 OK

{
  "resourceType": "Procedure",
  "id": "7DD361F7EB43448690AABCCC45E62285.503",
  "meta": {
    "lastUpdated": "2020-05-20T16:42:12-04:00"
  },
  "status": "stopped",
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "428663009",
        "display": "Ablation of AV Node"
      }
    ],
    "text": "Ablation of AV Node"
  },
  "subject": {
    "reference": "Patient/7DD361F7EB43448690AABCCC45E62285",
    "display": "Lansford,Mukesh-Procedure Dianne"
  },
  "encounter": {
    "reference": "Encounter/7DD361F7EB43448690AABCCC45E62285.38021",
    "display": "City General,Initial"
  },
  "performedDateTime": "2021-05-20T03:57:00-04:00",
  "focalDevice": [
    {
      "action": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "257867005",
            "display": "Insertion - action"
          }
        ]
      },
      "manipulated": {
        "reference": "Device/7DD361F7EB43448690AABCCC45E62285.1003"
      }
    }
  ],
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Procedure</b><br /><b>Patient</b>:Lansford,Mukesh-Procedure Dianne;<br /><b>Encounter</b>:City General,Initial;<br /><b>Status</b>:stopped;<br /><b>Code</b>:<br /><b>system</b>:http://snomed.info/sct <b>code</b>:428663009 <b>display</b>:Ablation of AV Node;<br /><b>Performed</b>:2021-05-20T03:57:00-04:00;<br /><b>Focal Device</b>: <br /><b>Action</b>: <b>system</b>:http://snomed.info/sct <b>code</b>:257867005 <b>display</b>:Insertion - action;<br /><b>Manipulated</b>:Device/7DD361F7EB43448690AABCCC45E62285.1003;<br /></div>"
  }
}

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.