| Australian Digital Health Agency Medicare Records FHIR Implementation Guide 2.2.0

Australian Digital Health Agency Medicare Records FHIR Implementation Guide. This is the current published version. It is based on FHIR® version 3.0.2. See the Directory of published versions for a list of available versions.

### StructureDefinition: ADHA Australian Immunisation Register Immunization [Active]

The purpose of this profile is to define a representation of an administered vaccination, for an individual, held in the Australian Immunisation Register (AIR) for the electronic exchange of digital health information between Medicare repositories and the My Health Record system infrastructure in Australia.

##### Usage scenarios

The following are the usage scenarios expected:

- An individual’s Australian Immunisation Register record is uploaded to the My Health Record system from a Medicare repository

##### Each Immunization SHALL have

1. a profile assertion to this profile
2. an identifier for this immunisation record
3. a status of the vaccination event set to completed
4. a flag to indicate that the vaccine was administered
5. a vaccine
6. a patient
7. a date that the vaccine was administered
8. a flag to indicate this data is based on information from the person who administered the vaccine
9. an antigen administered according to the vaccine administered
10. a dose status data set to NAVU Not Available

##### Must Support

In the context of this profile Must Support SHALL be interpreted as follows.

- The system SHALL be able to store and retrieve the following elements:
  - serialNumber
  - status
  - notGiven
  - vaccineCode
  - date
  - primarySource
  - lotNumber
  - vaccinationProtocol
  - vaccinationProtocol.doseSequence
  - vaccinationProtocol.targetDisease
- The system SHALL be able to take the following elements into account when performing processing:
  - identifier
  - patient

##### Profile-specific implementation guidance

- The patient resource should be identified in the patient element with a logical reference, i.e. an Australian IHI

#### Formal Views of Profile Content

The official URL for this profile is:

    http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air

The purpose of this profile is to define a representation of an administered vaccination, for an individual, held in the Australian Immunisation Register (AIR) for the electronic exchange of digital health information between Medicare repositories and the My Health Record system infrastructure in Australia.

This profile builds on Immunization.

This profile was published on 2023-04-14 04:08:50+0000 as a active by Australian Digital Health Agency.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

- Differential Table
- Snapshot Table
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Record of administered vaccine held in the AIR
meta | C | 1..1 | Meta | Metadata about the resource inv-dh-imm-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air'
profile |  | 1..* | uri | Profiles this resource claims to conform to
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
serialNumber | S | 0..1 | string | Serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1
identifier | S | 1..1 | Identifier | Business identifier
status | S | 1..1 | code | completed | entered-in-error Fixed Value: completed
notGiven | S | 1..1 | boolean | Flag for whether immunization was given Fixed Value: false
vaccineCode | S | 1..1 | CodeableConcept | Brand name given Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-1 (required)
patient | S | 1..1 | Reference(AU Base Patient) | Who was immunized
date | S | 1..1 | dateTime | Date given
primarySource | S | 1..1 | boolean | Indicates context the data was recorded in Fixed Value: true
lotNumber | S | 0..1 | string | Batch number
vaccinationProtocol | S | 1..1 | BackboneElement | What protocol was followed
doseSequence | S | 0..1 | positiveInt | Dose number within series
targetDisease | S | 1..* | CodeableConcept | Antigen
doseStatus |  | 1..1 | CodeableConcept | Indicates if dose counts towards immunity Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v3/NullFlavor
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NAVU
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization | C | 0..* | Immunization | Record of administered vaccine held in the AIR
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ C | 1..1 | Meta | Metadata about the resource inv-dh-imm-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air'
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
profile | Σ | 1..* | uri | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
Additional Bindings | Purpose
All Languages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
serialNumber | S | 0..1 | string | Serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S | 1..1 | Identifier | Business identifier
status | ?!S Σ | 1..1 | code | completed | entered-in-error Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization Fixed Value: completed
notGiven | ?!S Σ | 1..1 | boolean | Flag for whether immunization was given Fixed Value: false
vaccineCode | S | 1..1 | CodeableConcept | Brand name given Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-1 (required)
patient | S | 1..1 | Reference(AU Base Patient) | Who was immunized
encounter |  | 0..1 | Reference(Encounter) | Encounter administered as part of
date | S | 1..1 | dateTime | Date given
primarySource | S | 1..1 | boolean | Indicates context the data was recorded in Fixed Value: true
reportOrigin |  | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: Immunization Origin Codes (example): The source of the data for a record which is not from a primary source.
location |  | 0..1 | Reference(Location) | Where vaccination occurred
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer
lotNumber | S | 0..1 | string | Batch number
expirationDate |  | 0..1 | date | Vaccine expiration date
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (example): The site at which the vaccine was administered
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: Immunization Route Codes (example): The route by which the vaccine was administered
doseQuantity |  | 0..1 | SimpleQuantity | Amount of vaccine administered
practitioner | Σ | 0..* | BackboneElement | Who performed event
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
role | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: Immunization Role Codes (extensible): The role a practitioner plays in the immunization event
actor | Σ | 1..1 | Reference(Practitioner) | Individual who was performing
note | Σ | 0..* | Annotation | Vaccination notes
explanation |  | 0..1 | BackboneElement | Administration/non-administration reasons
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
reason |  | 0..* | CodeableConcept | Why immunization occurred Binding: Immunization Reason Codes (example): The reason why a vaccine was administered
reasonNotGiven |  | 0..* | CodeableConcept | Why immunization did not occur Binding: Immunization Reasons for Not Immunizing Codes (example): The reason why a vaccine was not administered
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
vaccinationProtocol | S | 1..1 | BackboneElement | What protocol was followed
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
doseSequence | S | 0..1 | positiveInt | Dose number within series
description |  | 0..1 | string | Details of vaccine protocol
authority |  | 0..1 | Reference(Organization) | Who is responsible for protocol
series |  | 0..1 | string | Name of vaccine series
seriesDoses |  | 0..1 | positiveInt | Recommended number of doses for immunity
targetDisease | S | 1..* | CodeableConcept | Antigen Binding: Vaccination Protocol Dose Target Codes (example): The disease target of the vaccination protocol
doseStatus |  | 1..1 | CodeableConcept | Indicates if dose counts towards immunity Binding: Vaccination Protocol Dose Status codes (example): The status of the vaccination protocol (i.e. should this count) Required Pattern: At least the following
id |  | 0..1 | id | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | id | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v3/NullFlavor
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NAVU
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
doseStatusReason |  | 0..1 | CodeableConcept | Why dose does (not) count Binding: Vaccination Protocol Dose Status Reason codes (example): The reason for the determining if a vaccination should count or why vaccination should not count.
Documentation for this format

Differential View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Record of administered vaccine held in the AIR
meta | C | 1..1 | Meta | Metadata about the resource inv-dh-imm-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air'
profile |  | 1..* | uri | Profiles this resource claims to conform to
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
serialNumber | S | 0..1 | string | Serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1
identifier | S | 1..1 | Identifier | Business identifier
status | S | 1..1 | code | completed | entered-in-error Fixed Value: completed
notGiven | S | 1..1 | boolean | Flag for whether immunization was given Fixed Value: false
vaccineCode | S | 1..1 | CodeableConcept | Brand name given Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-1 (required)
patient | S | 1..1 | Reference(AU Base Patient) | Who was immunized
date | S | 1..1 | dateTime | Date given
primarySource | S | 1..1 | boolean | Indicates context the data was recorded in Fixed Value: true
lotNumber | S | 0..1 | string | Batch number
vaccinationProtocol | S | 1..1 | BackboneElement | What protocol was followed
doseSequence | S | 0..1 | positiveInt | Dose number within series
targetDisease | S | 1..* | CodeableConcept | Antigen
doseStatus |  | 1..1 | CodeableConcept | Indicates if dose counts towards immunity Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v3/NullFlavor
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NAVU
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization | C | 0..* | Immunization | Record of administered vaccine held in the AIR
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ C | 1..1 | Meta | Metadata about the resource inv-dh-imm-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air'
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
profile | Σ | 1..* | uri | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
Additional Bindings | Purpose
All Languages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
serialNumber | S | 0..1 | string | Serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S | 1..1 | Identifier | Business identifier
status | ?!S Σ | 1..1 | code | completed | entered-in-error Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization Fixed Value: completed
notGiven | ?!S Σ | 1..1 | boolean | Flag for whether immunization was given Fixed Value: false
vaccineCode | S | 1..1 | CodeableConcept | Brand name given Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-1 (required)
patient | S | 1..1 | Reference(AU Base Patient) | Who was immunized
encounter |  | 0..1 | Reference(Encounter) | Encounter administered as part of
date | S | 1..1 | dateTime | Date given
primarySource | S | 1..1 | boolean | Indicates context the data was recorded in Fixed Value: true
reportOrigin |  | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: Immunization Origin Codes (example): The source of the data for a record which is not from a primary source.
location |  | 0..1 | Reference(Location) | Where vaccination occurred
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer
lotNumber | S | 0..1 | string | Batch number
expirationDate |  | 0..1 | date | Vaccine expiration date
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (example): The site at which the vaccine was administered
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: Immunization Route Codes (example): The route by which the vaccine was administered
doseQuantity |  | 0..1 | SimpleQuantity | Amount of vaccine administered
practitioner | Σ | 0..* | BackboneElement | Who performed event
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
role | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: Immunization Role Codes (extensible): The role a practitioner plays in the immunization event
actor | Σ | 1..1 | Reference(Practitioner) | Individual who was performing
note | Σ | 0..* | Annotation | Vaccination notes
explanation |  | 0..1 | BackboneElement | Administration/non-administration reasons
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
reason |  | 0..* | CodeableConcept | Why immunization occurred Binding: Immunization Reason Codes (example): The reason why a vaccine was administered
reasonNotGiven |  | 0..* | CodeableConcept | Why immunization did not occur Binding: Immunization Reasons for Not Immunizing Codes (example): The reason why a vaccine was not administered
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
vaccinationProtocol | S | 1..1 | BackboneElement | What protocol was followed
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
doseSequence | S | 0..1 | positiveInt | Dose number within series
description |  | 0..1 | string | Details of vaccine protocol
authority |  | 0..1 | Reference(Organization) | Who is responsible for protocol
series |  | 0..1 | string | Name of vaccine series
seriesDoses |  | 0..1 | positiveInt | Recommended number of doses for immunity
targetDisease | S | 1..* | CodeableConcept | Antigen Binding: Vaccination Protocol Dose Target Codes (example): The disease target of the vaccination protocol
doseStatus |  | 1..1 | CodeableConcept | Indicates if dose counts towards immunity Binding: Vaccination Protocol Dose Status codes (example): The status of the vaccination protocol (i.e. should this count) Required Pattern: At least the following
id |  | 0..1 | id | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | id | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v3/NullFlavor
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NAVU
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
doseStatusReason |  | 0..1 | CodeableConcept | Why dose does (not) count Binding: Vaccination Protocol Dose Status Reason codes (example): The reason for the determining if a vaccination should count or why vaccination should not count.
Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

#### 1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-immunization-air

none defined