FHIR R4 APIs for Oracle Health Millennium Platform

Get an immunization by ID

get

/Immunization/{ID}

Retrieves an individual immunization by the associated immunization ID.

Authorization Types

This operation supports the following authorization types:

Request

Path Parameters

ID(required): string

The logical resource ID associated with the resource.

Header Parameters

accept(required): string

The media type to be requested. See 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 retrieval of an immunization record.
Example Request:

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197197986

Example Response:

{
    'resourceType': 'Immunization',
    'id': 'M197197986',
    'meta': {
      'versionId': '1',
      'lastUpdated': '2019-12-26T13:12:59-06:00'
    },
    'text': {
      'status': 'generated',
      'div': '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Immunization</b></p><p><b>Vaccine</b>: tetanus toxoid</p><p><b>Occurrence</b>: 1982</p><p><b>Patient</b>: SMART, NANCY</p><p><b>Status</b>: Completed</p></div>'
    },
    'status': 'completed',
    'vaccineCode': {
      'coding': [
        {
          'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72',
          'code': '2798767',
          'display': 'tetanus toxoid',
          'userSelected': true
        },
        {
          'system': 'http://hl7.org/fhir/sid/cvx',
          'code': '112',
          'display': 'tetanus toxoid, unspecified formulation',
          'userSelected': false
        }
      ],
      'text': 'tetanus toxoid'
    },
    'patient': {
      'reference': 'Patient/12724066',
      'display': 'SMART, NANCY'
    },
    'encounter': {
      'reference': 'Encounter/97939518'
    },
    'occurrenceDateTime': '1982',
    'primarySource': false,
    'reportOrigin': {
      'coding': [
        {
          'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/30200',
          'code': '679978',
          'display': 'Self',
          'userSelected': true
        },
        {
          'system': 'http://terminology.hl7.org/CodeSystem/immunization-origin',
          'code': 'recall',
          'display': 'Parent/Guardian/Patient Recall',
          'userSelected': false
        }
      ],
      'text': 'Self'
    },
    'location': {
      'reference': 'Location/32545019',
      'display': 'A'
    },
    'doseQuantity': {
      'value': 0.0,
      'unit': 'unknown unit',
      'system': 'http://unitsofmeasure.org',
      'code': '{unknownunit}'
    },
    'protocolApplied': [
      {
        'targetDisease': [
          {
            'coding': [
              {
                'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4003106',
                'code': '2289043429',
                'display': 'COVID-19',
                'userSelected': true
              },
              {
                'system': 'http://hl7.org/fhir/sid/cvx',
                'code': '213',
                'display': 'SARS-COV-2 (COVID-19) vaccine, UNSPECIFIED',
                'userSelected': false
              }
            ],
            'text': 'COVID-19'
          }
        ],
        'doseNumberString': 'Unknown'
      }
    ]
  }

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-with-patient-auth-completed Response

Example retrieval of an immunization record with completed status using patient authorization.
Example Request:

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197197986

Example Response:

{
    'resourceType': 'Immunization',
    'id': 'M197197986',
    'meta': {
      'versionId': '1',
      'lastUpdated': '2019-12-26T13:12:59-06:00'
    },
    'text': {
      'status': 'generated',
      'div': '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Immunization</b></p><p><b>Vaccine</b>: tetanus toxoid</p><p><b>Occurrence</b>: 1982</p><p><b>Patient</b>: SMART, NANCY</p><p><b>Status</b>: Completed</p></div>'
    },
    'status': 'completed',
    'vaccineCode': {
      'coding': [
        {
          'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72',
          'code': '2798767',
          'display': 'tetanus toxoid',
          'userSelected': true
        },
        {
          'system': 'http://hl7.org/fhir/sid/cvx',
          'code': '112',
          'display': 'tetanus toxoid, unspecified formulation',
          'userSelected': false
        }
      ],
      'text': 'tetanus toxoid'
    },
    'patient': {
      'reference': 'Patient/12724066',
      'display': 'SMART, NANCY'
    },
    'encounter': {
      'reference': 'Encounter/97939518'
    },
    'occurrenceDateTime': '1982',
    'primarySource': false,
    'reportOrigin': {
      'coding': [
        {
          'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/30200',
          'code': '679978',
          'display': 'Self',
          'userSelected': true
        },
        {
          'system': 'http://terminology.hl7.org/CodeSystem/immunization-origin',
          'code': 'recall',
          'display': 'Parent/Guardian/Patient Recall',
          'userSelected': false
        }
      ],
      'text': 'Self'
    },
    'location': {
      'reference': 'Location/32545019',
      'display': 'A'
    },
    'doseQuantity': {
      'value': 0.0,
      'unit': 'unknown unit',
      'system': 'http://unitsofmeasure.org',
      'code': '{unknownunit}'
    }
  }

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-with-patient-auth-inerrored Response

Example retrieval of an immunization record with Entered in Error status using patient authorization.
Example Request:

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M211860902

Example Response:

{
    'resourceType': 'Immunization',
    'id': 'M197197986',
    'meta': {
      'versionId': '1',
      'lastUpdated': '2019-12-26T13:12:59-06:00'
    },
    'text': {
      'status': 'generated',
      'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\'><p><b>Immunization</b></p><p><b>Patient</b>:MARSTON, JACK</p><p><b>Status</b>: Entered in Error</p></div>'
    },
    'status': 'entered-in-error',
    'vaccineCode': {
      'coding': [
        {
          'system': 'http://terminology.hl7.org/CodeSystem/data-absent-reason',
          'code': 'error',
          'display': 'Error'
        }
      ],
      'text': 'Error'
    },
    'patient': {
      'reference': 'Patient/166045489',
      'display': 'MARSTON, JACK'
    },
    '_occurrenceDateTime': {
      'extension': [
        {
          'valueCode': 'error',
          'url': 'http://hl7.org/fhir/StructureDefinition/data-absent-reason'
        }
      ]
    }
  }

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-with-patient-auth-notdone Response

Example retrieval of an immunization record with Not Done status using patient authorization.
Example Request:

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/HM178147794

Example Response:

{
    'resourceType': 'Immunization',
    'id': 'HM178147794',
    'meta': {
      'versionId': '0',
      'lastUpdated': '2020-09-09T12:55:55-05:00'
    },
    'text': {
      'status': 'generated',
      'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Immunization</b></p><p><b>Vaccine</b>: Rotavirus</p><p><b>Occurrence</b>: Sep  9, 2020 12:55 P.M. CDT</p><p><b>Patient</b>: MARSTON, JACK</p><p><b>Status</b>: Not Done</p><p><b>Status Reason</b>: Patient Refuses</p></div>'
    },
    'status': 'not-done',
    'statusReason': {
      'coding': [
        {
          'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/30200',
          'code': '679611',
          'display': 'Patient Refuses',
          'userSelected': true
        },
        {
          'system': 'http://snomed.info/sct',
          'code': '591000119102',
          'display': 'Vaccine refused by patient (situation)',
          'userSelected': false
        }
      ],
      'text': 'Patient Refuses'
    },
    'vaccineCode': {
      'text': 'Rotavirus'
    },
    'patient': {
      'reference': 'Patient/166045489',
      'display': 'MARSTON, JACK'
    },
    'occurrenceDateTime': '2020-09-09T12:55:55-05:00',
    'primarySource': true
  }

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.