healthcare
immunization

Retrieve an immunization

get/healthcare/{connection_id}/immunization/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/healthcare/{connection_id}/immunization/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Immunization

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the immunization

created_atstring date-time

When the immunization record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the immunization record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

patient_idstring

The patient who was immunized

encounter_idstring

The encounter in which the vaccine was administered

practitioner_idstring

The practitioner who administered the vaccine

location_idstring

Where the vaccine was administered

namestring

Human-readable name of the vaccine

status'COMPLETED' | 'NOT_DONE' | 'ENTERED_IN_ERROR' | 'OTHER'

Status of the immunization

administered_atstring date-time

When the vaccine was administered (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

lot_numberstring

Vaccine lot number

expires_atstring date-time

Vaccine expiration date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

notesstring

Free-text notes about the immunization

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.