FHIR R4 APIs for Oracle Soarian Clinicals

Get a immunization by ID

get

/Immunization/{ID}

List an individual Immunization resource by its ID.

GET /Immunization/:id

This operation supports the following authorization types:

Provider
Patient
System

Request

Path Parameters

ID(required): string

The logical resource ID associated with the resource.
Type: token.

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 Request

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

Example Response:

{
  "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:
System:http://hl7.org/fhir/sid/cvx <b>Code:107 Display</b>:DTaP, NOS ;<br /><b>Occurrence</b>:2011-10;<br /><b>Primary Source</b>:false;<br /></div>"
  }
}

Patient Authorization Request for Completed Status
Example Request

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

Example Response:

{
  "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:completed;<br /><b>Vaccine Code:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:107 <b>Display</b>:DTaP, NOS ;
<b>Occurrence</b>:2011-10;
<b>Primary Source</b>:false;<br /></div>"
  }
}

Patient Authorization Request for Entered in Error Status
Example Request

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

Example Response:

{
  "resourceType": "Immunization",
  "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000010001",
  "meta": {
    "lastUpdated": "2021-05-24T17:10:00-04:00"
  },
  "status": "entered-in-error",
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "10",
        "display": "IPV"
      }
    ],
    "text": "IPV"
  },
  "patient": {
    "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
    "display": "Lancelot,Kaycee Mason"
  },
  "occurrenceDateTime": "2020-04-07",
  "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>:entered-in-error;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:10 <b>Display</b>:IPV ;<br /><b>Occurrence</b>:2020-04-07;<br /><b>Primary Source</b>:false;<br /></div>"
  }
}

Patient Authorization Request for Not Done Status
Example Request

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

Example Response:

{
  "resourceType": "Immunization",
  "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000088001",
  "meta": {
    "lastUpdated": "2021-05-24T17:04:00-04:00"
  },
  "status": "not-done",
  "statusReason": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "PATOBJ",
        "display": "patient objection"
      }
    ]
  },
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "88",
        "display": "influenza, NOS"
      }
    ],
    "text": "influenza, NOS"
  },
  "patient": {
    "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
    "display": "Lancelot,Kaycee Mason"
  },
  "_occurrenceDateTime": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unknown"
      }
    ]
  },
  "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>:not-done;<br /><b>Reason Not Done</b>:patient objection;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:88 <b>Display</b>:influenza, NOS ;<br /><b>Occurrence</b>:Data absent, Reason: unknown;<br /><b>Primary Source</b>:false;<br /></div>"
  }
}

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.