FHIR R4 APIs for Oracle Health Millennium Platform

Get a list of procedures

get

/Procedure

Retrieves a list of procedures that meet supplied query parameters.

Note: Currently, the patient/Provenance.read scope is not supported and _revinclude cannot be used for patient persona.

Request

Query Parameters

_id: string

The logical resource ID. This parameter is required if patient or subject is not used.
Example: _id=7891
_lastUpdated: string
The date range in which the procedures was last updated.
- This parameter may be provided up to two times, and must use the eq, ge, gt, le, or lt prefixes.
- When a value is provided without a prefix, an implied eq prefix is used.
- When provided twice, the lower value must have a ge or gt prefix and the higher value must have an le or lt prefix.
- The _lastUpdated parameter may not be provided at the same time as the date parameter.
Example: _lastUpdated=gt2014-09-24 or _lastUpdated=gt2014-09-24T12:00:00.000Z
_revinclude: string
The Provenance resource entries to be returned as part of the bundle.
- May be provided once with the Provenance:target value. For example, _revinclude=Provenance:target.
- May be provided in combination with the _id or patient parameter. For example, _id=570007845&_revinclude=Provenance:target or patient=12345&_revinclude=Provenance:target.
- When provided in a request to a closed endpoint, the OAuth2 token must include the user/Provenance.read scope.
Example: _revinclude=Provenance:target
date: string
The date range that the procedure's performedPeriod or performedDateTime falls within.
- May be provided once with a prefix and time component to imply a date range.
  Example: date=gt2015-09-24T00:00:00.000Z
- May otherwise be provided twice with le, lt, ge, or gt prefixes and a time component to search for procedures within a specific range. The date and prefix pairs must create a closed range.
- The date parameter may not be provided at the same time as the _lastUpdated parameter.
Example: date=gt2015-09-24T12:00:00.000Z&date=le2020-07-15T16:00:00.000Z
patient: string

Who the procedure is for. This parameter is required if _id or subject is not used.
Example: 12345
subject: string

Who the procedure is for. This parameter is required if _id or patient is not used.
Example: Patient/12345

Header Parameters

accept(required): string

The media type to be requested. See what the resource's operation produces for what is supported.

Response

Supported Media Types

application/json+fhir

Default Response

This operation supports the following authorization types:

Example Request:

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure?patient=12724066

Example Response:

{
  "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>Category</b>: SDOH</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",
        "category": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
              "code": "sdoh",
              "display": "SDOH",
              "userSelected": false
            }
          ]
        },
        "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>Category</b>: Education</p><p><b>Status</b>: Completed</p><p><b>Recorder</b>: SYSTEM, SYSTEM Cerner</p></div>"
        },
        "status": "completed",
        "category": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "409073007",
              "display": "Education (procedure)",
              "userSelected": false
            }
          ]
        },
        "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"
        }
      }
    }
  ]
}

Headers

X-Request-Id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-revinclude Response

This operation supports the following authorization types:

Example Request:

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure?_id=570007845&_revinclude=Provenance:target

Example Response:

{
  "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": "Procedure
Patient: HEATHERJSMITH
Procedure: Adenoid excision (text)
<p><b>Category</b>: SDOH</p>Date: Apr  5, 2019
Status: Completed
Location: Baseline East
Recorder: Powerchart, User
Performer:
Smith MD, John"
        },
        "status": "completed",
        "category": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
              "code": "sdoh",
              "display": "SDOH",
              "userSelected": false
            }
          ]
        },
        "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": "Provenance
Target:
Procedure/570007845
Recorded: Oct 25, 2019  9:57 A.M. CDT
Agents:
Unknown
Agent Type: Transmitter
Agent Role: Source
Entity Source: DocumentReference/S-201"
        },
        "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"
      }
    }
  ]
}

Headers

X-Request-Id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.