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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationRecord of administered vaccine held in the AIR
... meta C1..1MetaMetadata about the resource
inv-dh-imm-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air'
.... profile 1..*uriProfiles this resource claims to conform to
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... serialNumber S0..1stringSerial number
URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1
... identifier S1..1IdentifierBusiness identifier
... status S1..1codecompleted | entered-in-error
Fixed Value: completed
... notGiven S1..1booleanFlag for whether immunization was given
Fixed Value: false
... vaccineCode S1..1CodeableConceptBrand name given
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-1 (required)
... patient S1..1Reference(AU Base Patient)Who was immunized
... date S1..1dateTimeDate given
... primarySource S1..1booleanIndicates context the data was recorded in
Fixed Value: true
... lotNumber S0..1stringBatch number
... vaccinationProtocol S1..1BackboneElementWhat protocol was followed
.... doseSequence S0..1positiveIntDose number within series
.... targetDisease S1..*CodeableConceptAntigen
.... doseStatus 1..1CodeableConceptIndicates if dose counts towards immunity
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v3/NullFlavor
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: NAVU

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C0..*ImmunizationRecord of administered vaccine held in the AIR
... id Σ0..1idLogical id of this artifact
... meta ΣC1..1MetaMetadata about the resource
inv-dh-imm-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air'
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ1..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... serialNumber S0..1stringSerial number
URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..1IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | 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..1booleanFlag for whether immunization was given
Fixed Value: false
... vaccineCode S1..1CodeableConceptBrand name given
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-1 (required)
... patient S1..1Reference(AU Base Patient)Who was immunized
... encounter 0..1Reference(Encounter)Encounter administered as part of
... date S1..1dateTimeDate given
... primarySource S1..1booleanIndicates context the data was recorded in
Fixed Value: true
... reportOrigin 0..1CodeableConceptIndicates 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..1Reference(Location)Where vaccination occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber S0..1stringBatch number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: Codes for Immunization Site of Administration (example): The site at which the vaccine was administered

... route 0..1CodeableConceptHow vaccine entered body
Binding: Immunization Route Codes (example): The route by which the vaccine was administered

... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... practitioner Σ0..*BackboneElementWho performed event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ0..1CodeableConceptWhat type of performance was done
Binding: Immunization Role Codes (extensible): The role a practitioner plays in the immunization event

.... actor Σ1..1Reference(Practitioner)Individual who was performing
... note Σ0..*AnnotationVaccination notes
... explanation 0..1BackboneElementAdministration/non-administration reasons
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... reason 0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example): The reason why a vaccine was administered


.... reasonNotGiven 0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example): The reason why a vaccine was not administered


... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol S1..1BackboneElementWhat protocol was followed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... doseSequence S0..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(Organization)Who is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease S1..*CodeableConceptAntigen
Binding: Vaccination Protocol Dose Target Codes (example): The disease target of the vaccination protocol


.... doseStatus 1..1CodeableConceptIndicates 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
..... id0..1idxml:id (or equivalent in JSON)
..... extension0..*ExtensionAdditional Content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1idxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v3/NullFlavor
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: NAVU
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... doseStatusReason 0..1CodeableConceptWhy 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.


doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationRecord of administered vaccine held in the AIR
... meta C1..1MetaMetadata about the resource
inv-dh-imm-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air'
.... profile 1..*uriProfiles this resource claims to conform to
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... serialNumber S0..1stringSerial number
URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1
... identifier S1..1IdentifierBusiness identifier
... status S1..1codecompleted | entered-in-error
Fixed Value: completed
... notGiven S1..1booleanFlag for whether immunization was given
Fixed Value: false
... vaccineCode S1..1CodeableConceptBrand name given
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-1 (required)
... patient S1..1Reference(AU Base Patient)Who was immunized
... date S1..1dateTimeDate given
... primarySource S1..1booleanIndicates context the data was recorded in
Fixed Value: true
... lotNumber S0..1stringBatch number
... vaccinationProtocol S1..1BackboneElementWhat protocol was followed
.... doseSequence S0..1positiveIntDose number within series
.... targetDisease S1..*CodeableConceptAntigen
.... doseStatus 1..1CodeableConceptIndicates if dose counts towards immunity
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v3/NullFlavor
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: NAVU

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C0..*ImmunizationRecord of administered vaccine held in the AIR
... id Σ0..1idLogical id of this artifact
... meta ΣC1..1MetaMetadata about the resource
inv-dh-imm-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air'
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ1..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... serialNumber S0..1stringSerial number
URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..1IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | 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..1booleanFlag for whether immunization was given
Fixed Value: false
... vaccineCode S1..1CodeableConceptBrand name given
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-1 (required)
... patient S1..1Reference(AU Base Patient)Who was immunized
... encounter 0..1Reference(Encounter)Encounter administered as part of
... date S1..1dateTimeDate given
... primarySource S1..1booleanIndicates context the data was recorded in
Fixed Value: true
... reportOrigin 0..1CodeableConceptIndicates 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..1Reference(Location)Where vaccination occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber S0..1stringBatch number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: Codes for Immunization Site of Administration (example): The site at which the vaccine was administered

... route 0..1CodeableConceptHow vaccine entered body
Binding: Immunization Route Codes (example): The route by which the vaccine was administered

... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... practitioner Σ0..*BackboneElementWho performed event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ0..1CodeableConceptWhat type of performance was done
Binding: Immunization Role Codes (extensible): The role a practitioner plays in the immunization event

.... actor Σ1..1Reference(Practitioner)Individual who was performing
... note Σ0..*AnnotationVaccination notes
... explanation 0..1BackboneElementAdministration/non-administration reasons
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... reason 0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example): The reason why a vaccine was administered


.... reasonNotGiven 0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example): The reason why a vaccine was not administered


... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol S1..1BackboneElementWhat protocol was followed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... doseSequence S0..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(Organization)Who is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease S1..*CodeableConceptAntigen
Binding: Vaccination Protocol Dose Target Codes (example): The disease target of the vaccination protocol


.... doseStatus 1..1CodeableConceptIndicates 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
..... id0..1idxml:id (or equivalent in JSON)
..... extension0..*ExtensionAdditional Content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1idxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v3/NullFlavor
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: NAVU
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... doseStatusReason 0..1CodeableConceptWhy 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.


doco 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