Jump to

• Request
• Response

Get a list of immunizations

get

/Immunization

Retrieves a list of immunizations that meet supplied query parameters.

Authorization Types

This operation supports the following authorization types:

• Provider
• Patient
• System

Request

Query Parameters

• _id(required): string
  The logical resource ID associated with the resource.

  • This parameter is required if the patient parameter is not used.
  • May be provided with a single reference or a comma-separated list of references. Example _id=1234 or _id=1234,5678.
  • Must not be provided with any other parameters.

  Example: 12345
• date: string
  The date range for the immunization administration.

  • For a single date occurrence:
  • Must be provided with the le or ge prefix to search for vaccination record administrations earlier or later than the given date.
  • The time component is optional.
  • For two date occurences:
  • Must be provided with le and ge prefixes to search for vaccination records in a specific range.
  • The time component is optional but must be consistent. If one date has a time component, so must the other.

  Example: date=ge2020-01-01T08:00:00.000Z&date=le2020-01-31T17:00:00.000Z
• patient(required): string
  The patient for the vaccination record.

  • This parameter is required if the _id parameter is not used.
  • May be provided with only a single reference. A comma-separated list is not supported.

  Example: 12345

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.

Back to Top

Response

Supported Media Types

• application/fhir+json

Default Response

Example search for immunization records by patient.
Example Request:

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

Example Response:

{
    'resourceType': 'Bundle',
    'id': '13809232-3eab-4d1a-a1a4-42bc9aa6e381',
    'type': 'searchset',
    'total': 2,
    'link': [
      {
        'relation': 'self',
        'url': 'https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization?patient=12724066'
      }
    ],
    'entry': [
      {
        'fullUrl': 'https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197197986',
        'resource': DSTU2_IMMUNIZATION_1
      },
      {
        'fullUrl': 'https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197197982',
        'resource': {
          'resourceType': 'Immunization',
          'id': 'M197197982',
          'meta': {
            'versionId': '1',
            'lastUpdated': '2019-12-26T13:12:59-06:00'
          },
          'text': {
            'status': 'generated',
            'div': '<div><p><b>Immunization</b></p><p><b>Status</b>: Completed</p><p><b>Vaccine</b>: influenza virus vaccine, live</p><p><b>Date</b>: 2019</p><p><b>Patient Name</b>: SMART, NANCY</p><p><b>Given</b>: Yes</p><p><b>Administered by</b>: Graham, Joshua</p><p><b>Reported</b>: Yes</p></div>'
          },
          'status': 'completed',
          'date': '2019',
          'vaccineCode': {
            'coding': [
              {
                'system': 'http://hl7.org/fhir/sid/cvx',
                'code': '111',
                'display': 'influenza, live, intranasal',
                'userSelected': false
              }
            ],
            'text': 'influenza virus vaccine, live'
          },
          'patient': {
            'reference': 'Patient/12724066',
            'display': 'SMART, NANCY'
          },
          'wasNotGiven': false,
          'reported': true,
          'performer': {
            'reference': 'Practitioner/12724045',
            'display': 'Graham, Joshua'
          },
          'encounter': {
            'reference': 'Encounter/97939518'
          },
          '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.

Back to Top