FHIR R4 APIs for Oracle Soarian Clinicals

Get a list of immunizations

get

/Immunization

Search for Immunization resources that meet the specified query parameters.

GET /Immunization?:parameters

This operation supports the following authorization types:

Provider
Patient
System

Request

Query Parameters

_id: string

The logical resource ID associated with the resource.
This parameter is required if patient is not used.
Type: token.
_revinclude: string

A request to include any Provenance resource in the bundle that refers to a Immunization resource in the search results. Only supported with Provenance
Type: _revinclude.
The _revinclude parameter may be provided once with the value Provenance:target. For example, _revinclude=Provenance:target.
When _revinclude is provided in a request, the OAuth2 token must include the patient/Provenance.read system/Provenance.read or user/Provenance.read scope as applicable.
patient: string

The patient for the vaccination record.
This parameter is required if _id.
Type: reference.

Header Parameters

Accept(required): string

The media type to be requested. Refer to what the resource's operation produces for what is supported.
Authorization(required): string

Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

Response

Supported Media Types

application/fhir+json

Default Response

Example Search by Patient
Example Request

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

Example Response:

{
  "resourceType": "Bundle",
  "id": "339048c4-9ff8-4ecb-9260-0136bb3828dd",
  "type": "searchset",
  "timestamp": "2022-05-11T06:04:34-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization/4C05F5F357EE44FC874C0CF4AB249F99.000001001008000083001",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "Immunization",
        "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000083001",
        "meta": {
          "lastUpdated": "2021-05-24T17:13:00-04:00"
        },
        "status": "completed",
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "83",
              "display": "HEPATITIS A VIRUS VACCINE/PF"
            },
            {
              "system": "http://hl7.org/fhir/sid/ndc",
              "code": "58160-0825-43",
              "display": "HEPATITIS A VIRUS VACCINE/PF"
            }
          ],
          "text": "HEPATITIS A VIRUS VACCINE/PF"
        },
        "patient": {
          "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
          "display": "Lancelot,Kaycee Mason"
        },
        "occurrenceDateTime": "2021-05-24T17:13:00-04:00",
        "primarySource": true,
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Immunization</b><br /><b>Patient/b>:Lancelot,Kaycee Mason;<br /><b>Status</b>:completed;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:83 <b>Display</b>:HEPATITIS A VIRUS VACCINE/PF ;<br /><b>System</b>:http://hl7.org/fhir/sid/ndc <b>Code</b>:58160-0825-43 <b>Display</b>:HEPATITIS A VIRUS VACCINE/PF ;<br /><b>Occurrence</b>:2021-05-24T17:13:00-04:00;<br /><b>Primary Source</b>:true;<br /></div>"
        }
      }
    },
    {
      "fullUrl": "https://fhir-myrecord.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization/4C05F5F357EE44FC874C0CF4AB249F99.000001001008000110001",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "Immunization",
        "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000110001",
        "meta": {
          "lastUpdated": "2021-05-24T17:01:00-04:00"
        },
        "status": "completed",
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "110",
              "display": "HEP B VACCINE/DP(A)T-POLIO/PF"
            },
            {
              "system": "http://hl7.org/fhir/sid/ndc",
              "code": "58160-0811-43",
              "display": "HEP B VACCINE/DP(A)T-POLIO/PF"
            }
          ],
          "text": "HEP B VACCINE/DP(A)T-POLIO/PF"
        },
        "patient": {
          "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
          "display": "Lancelot,Kaycee Mason"
        },
        "occurrenceDateTime": "2021-05-24T17:01:00-04:00",
        "primarySource": true,
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Immunization</b><br /><b>Patient</b>:Lancelot,Kaycee Mason;<br /><b>Status</b>:completed;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:110 <b>Display</b>:HEP B VACCINE/DP(A)T-POLIO/PF ;<br /><b>System</b>:http://hl7.org/fhir/sid/ndc <b>Code</b>:58160-0811-43 <b>Display</b>:HEP B VACCINE/DP(A)T-POLIO/PF ;<br /><b>Occurrence</b>:2021-05-24T17:01:00-04:00;<br /><b>Primary Source</b>:true;<br /></div>"
        }
      }
    },
    {
      "fullUrl": "https://fhir-myrecord.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization/4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107002",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "Immunization",
        "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107002",
        "meta": {
          "lastUpdated": "2021-05-24T16:58:00-04:00"
        },
        "status": "completed",
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "107",
              "display": "DTaP, NOS"
            }
          ],
          "text": "DTaP, NOS"
        },
        "patient": {
          "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
          "display": "Lancelot,Kaycee Mason"
        },
        "occurrenceDateTime": "2011-12-14",
        "primarySource": false,
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Immunization</b><br /><b>Patient</b>:Lancelot,Kaycee Mason;
<b>Status</b>:completed;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:107 <b>Display</b>:DTaP, NOS ;<br /><b>Occurrence</b>:2011-12-14;
<b>Primary Source:false;<br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization?patient=4C05F5F357EE44FC874C0CF4AB249F99&_format=json"
    }
  ]
}

x-_id Response

Example Search by ID
Example Request

GET https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization?_id=4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107001&patient=4C05F5F357EE44FC874C0CF4AB249F99

Example Response:

{
  "resourceType": "Bundle",
  "id": "d0624076-0e98-4bad-953e-2bfc5328e591",
  "type": "searchset",
  "timestamp": "2022-05-11T06:09:06-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization/4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107001",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "Immunization",
        "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107001",
        "meta": {
          "lastUpdated": "2021-05-24T16:56:00-04:00"
        },
        "status": "completed",
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "107",
              "display": "DTaP, NOS"
            }
          ],
          "text": "DTaP, NOS"
        },
        "patient": {
          "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
          "display": "Lancelot,Kaycee Mason"
        },
        "occurrenceDateTime": "2011-10",
        "primarySource": false,
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Immunization</b><br /><b>Patient</b>:Lancelot,Kaycee Mason;<br /><b>Status</b>:completed;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:107 <b>Display</b>:DTaP, NOS ;
<b>Occurrence</b>:2011-10;<br /><b>Primary Source</b>:false;<br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization?_id=4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107001&patient=4C05F5F357EE44FC874C0CF4AB249F99&_format=json"
    }
  ]
}

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.