Immunization UI Mapping

id

Logical id of the immunization record.

Required

N

identifier[]

External identifier for this record.

Optional

N

meta

Resource metadata (version, tags, profiles).

Optional

N

status

The status of the vaccine

Required

Y

Status:

Note: All statuses are displayed in the UI without any filtering or sorting.

statusReason

Reason for error or non-administration.

Optional

N

vaccineCode.text

Vaccine product administered.

Required

Y

The vaccine name is shown as title of vaccine information

Note: If both the vaccineCode.text and vaccineCode.coding are present, PKB displays vaccineCode.text

vaccineCode.coding

Vaccine code

Required

Y (unless the vaccineCode.text field is also included)

The vaccine name is shown as title of vaccine information

Note:

• If both the vaccineCode.text and vaccineCode.coding are present, PKB displays vaccineCode.text

• If only vaccineCode.coding is sent:

  • You should send in a code, system and display for the name to appear in PKB’s UI.

  • If only a system, code, or system/code is supplied (no display or text), PKB displays “Unknown Vaccine”.

  • If you are sending more than one code, you should utilise text to send a textual representation of all codes being sent because PKB’s UI only shows the first code’s display name.

patient

Who received the vaccine.

Required

N

encounter

Related clinical encounter.

Optional

N

occurrence [x]

occurrenceDateTime | occurrenceString

When the vaccine was administered. May be supplied as a precise date/time or free text.

Required

Note: Supply either occurrenceDateTime or occurrenceString, but not both.

Y

Date administered:

occurrenceDateTime

Open

occurrenceString

Open

recorded

When the record was entered.

Optional

N

primarySource

Whether the information came from the administering source.

Optional

N

reportOrigin

Type of source reporting this record.

Optional

N

location

Where the vaccination took place.

Optional

Y (unless the administered by field is also included)

Location:

Note:

• If both location and performer (referencing an Organization resource) are present, the performer ('Administered by:') will display in the UI showing the name of the Organization resource.

• If both location and performer (referencing anything other than an Organization resource) are present, the location ('Location’) will display in the UI showing the name of the Location resource.

manufacturer

Vaccine manufacturer organization.

Optional

Y

Manufacturer:

Note: If a manufacturer is present as an Organization reference, we will display its display field.

lotNumber

Lot number of the vaccine.

Optional

N

expirationDate

Vaccine expiration date.

Optional

N

site

E.g., “Left arm.”

Optional

N

route

E.g., “Intramuscular.”

Optional

N

doseQuantity

Numeric amount of vaccine given.

Optional

N

performer.function

What type of performance was done

Optional

N

performer.actor

Who performed the action.

Optional

Y

Administered by:

Note:

• If both location and performer (referencing an Organization resource) are present, the performer ('Administered by:') will display in the UI showing the name of the Organization resource.

• If both location and performer (referencing anything other than an Organization resource) are present, the location ('Location:’) will display in the UI showing the name of the Location resource.

note[]

Free-text comments.

Optional

N

reasonCode[]

Clinical or public health reason for vaccination.

Optional

N

reasonReference[]

Reference to a condition or observation.

Optional

N

isSubpotent

Whether the dose was less effective.

Optional

N

subpotentReason[]

Why the dose was subpotent.

Optional

N

education[]

Educational resources provided.

Optional

N

education.documentType

Type of educational material.

Optional - subfield

N

education.reference

URL or reference.

Optional - subfield

N

education.publicationDate

When the material was published.

Optional - subfield

N

education.presentationDate

When material was shown to patient.

Optional - subfield

N

programEligibility[]

Eligibility under a vaccination program.

Optional

N

fundingSource

E.g., public or private funding.

Optional

N

reaction[]

Adverse reactions reported.

Optional

Y

Reaction:

Note:

• If only a date is provided AND/OR reported is populated (either true or false), PKB displays Reaction: Recorded (no details)

reaction.date

When reaction occurred.

Optional - subfield

N

Note:

• If only a date is provided AND/OR reported is populated (either true or false), PKB displays Reaction: Recorded (no details), but the actual date is not displayed in the UI.

reaction.detail

Reference to AdverseEvent or notes.

Optional - subfield

Y

Text follows above ‘Reaction’ label, eg Reaction: Vertigo, Soreness

Note:

• If Observation.code[CodeableConcept].text is present in the referenced Observation, that text displays with the reaction on the Immunization. Example: Reaction: Hives

• If

  Observation.code[CodeableConcept].text is not present in the referenced Observation resource, Reaction: Recorded (no details) displays on the Immunization.

• Other Observation details are not displayed in the UI (e.g., code.display, code, date, etc.)

reaction.reported

Whether the patient/clinician reported it.

Optional - subfield

N

Note:

• If only a date is provided AND/OR reported is populated (either true or false), PKB displays Reaction: Recorded (no details), but the reported true/false value is not displayed in the UI.

protocolApplied[]

Series and dose details.

Optional

Y

Dose:

Note: If a protocolApplied is sent, a doseNumber must be included.

protocolApplied.series

Name of vaccination series. E.g., “Polio vaccination series”

Optional - subfield

Y

Dose:

protocolApplied.authority

Org defining the vaccination schedule.

Optional - subfield

N

protocolApplied.targetDisease[]

Disease prevented by vaccine.

Optional - subfield

N

protocolApplied.doseNumberPositiveInt

Dose given. E.g., “1”

Optional - subfield

Y

Dose: