Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-immunization-air-1 | Version: 1.0.0 | |||
Active as of 2024-09-12 | Computable Name: ADHAImmunizationAIR | |||
Copyright/Legal: Copyright © 2023 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
The purpose of this profile is to represent a record of an immunisation event held by the Australian Immunisation Register for the electronic exchange of digital health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
This profile identifies the additional constraints, extensions, and value sets that build on and extend Immunization that are supported.
This profile is designed to set an Immunization standard for:
This profile may be referred to by APIs, which will be listed here when available.
None.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ADHAImmunizationCore
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | ADHAImmunizationCore | Record of immunisation event held on the Australian Immunisation Register | |
identifier | 1..* | Identifier | Business identifier | |
status | 1..1 | code | completed | entered-in-error | not-done Fixed Value: completed | |
vaccineCode | 1..1 | CodeableConcept | Vaccine product administered | |
coding | 1..* | Coding | Code defined by a terminology system | |
occurrence[x] | 1..1 | dateTime | Vaccine administration date | |
primarySource | S | 1..1 | boolean | Indicates context the data was recorded in Fixed Value: true |
lotNumber | S | 0..1 | string | Batch number |
protocolApplied | 1..* | BackboneElement | Protocol followed by the provider | |
targetDisease | 1..* | CodeableConcept | Antigen | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Immunization | 0..* | ADHAImmunizationCore | Record of immunisation event held on the Australian Immunisation Register | |||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
vaccine-serial-number | S | 0..1 | string | Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | S | 1..* | Identifier | Business identifier | ||||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed | ||||||
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred) | ||||||
vaccineCode | SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
| ||||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||
coding:amtVaccineCode | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||
coding:airVaccineCode | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||
patient | SΣC | 1..1 | Reference(ADHA Core Patient) | Who was immunized inv-dh-imm-01: At least reference or a valid identifier shall be present | ||||||
encounter | S | 0..1 | Reference(ADHA Core Encounter) | Encounter immunization was part of | ||||||
occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date | ||||||
primarySource | SΣ | 1..1 | boolean | Indicates context the data was recorded in Fixed Value: true | ||||||
lotNumber | S | 0..1 | string | Batch number | ||||||
Slices for performer | SΣ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | ||||||
performer:All Slices | Content/Rules for all slices | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | SΣ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | ||||||
actor | SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Organization) | Individual or organization who was performing inv-dh-imm-02: At least reference or a valid identifier shall be present | ||||||
performer:administeredBy | Σ | 0..1 | BackboneElement | Immunisation Administered By | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. 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://terminology.hl7.org/CodeSystem/v2-0443 | |||||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | ||||||
performer:approvedBy | Σ | 0..1 | BackboneElement | Immunisation Approved By | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. 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://terminology.hl7.org/CodeSystem/v2-0443 | |||||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |||||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | ||||||
note | SΣ | 0..* | Annotation | Additional immunization notes | ||||||
reasonCode | S | 0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered (preferred) | ||||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||||
protocolApplied | S | 1..* | BackboneElement | Protocol followed by the provider | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
series | S | 0..1 | string | Name of vaccine series | ||||||
targetDisease | S | 1..* | CodeableConcept | Antigen Binding: Vaccination Target Disease (preferred) | ||||||
doseNumber[x] | S | 1..1 | Dose number within series | |||||||
doseNumberPositiveInt | positiveInt | |||||||||
doseNumberString | string | |||||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | ||||||||
Immunization.status | required | Fixed Value: completedhttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | |||||||||
Immunization.statusReason | preferred | ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 | |||||||||
Immunization.vaccineCode | example | VaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard | |||||||||
Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | |||||||||
Immunization.performer:administeredBy.function | extensible | Pattern: APhttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | |||||||||
Immunization.performer:approvedBy.function | extensible | Pattern: OPhttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | |||||||||
Immunization.reasonCode | preferred | ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 | |||||||||
Immunization.protocolApplied.targetDisease | preferred | VaccinationTargetDisease https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Immunization | 0..* | ADHAImmunizationCore | Record of immunisation event held on the Australian Immunisation Register | |||||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
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 | |||||||
vaccine-serial-number | S | 0..1 | string | Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | S | 1..* | Identifier | Business identifier | ||||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed | ||||||
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred) | ||||||
vaccineCode | SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||
coding:amtVaccineCode | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||
coding:airVaccineCode | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||||
patient | SΣC | 1..1 | Reference(ADHA Core Patient) | Who was immunized inv-dh-imm-01: At least reference or a valid identifier shall be present | ||||||
encounter | S | 0..1 | Reference(ADHA Core Encounter) | Encounter immunization was part of | ||||||
occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date | ||||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||||
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: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||||
location | 0..1 | Reference(Location) | Where immunization 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: Immunisation Anatomical Site (preferred) | |||||||
route | 0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (preferred) | |||||||
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||||
Slices for performer | SΣ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | ||||||
performer:All Slices | Content/Rules for all slices | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | SΣ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | ||||||
actor | SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Organization) | Individual or organization who was performing inv-dh-imm-02: At least reference or a valid identifier shall be present | ||||||
performer:administeredBy | Σ | 0..1 | BackboneElement | Immunisation Administered By | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||||
version | 0..1 | string | Version of the system - if relevant | |||||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||||
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 | |||||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | ||||||
performer:approvedBy | Σ | 0..1 | BackboneElement | Immunisation Approved By | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||||
version | 0..1 | string | Version of the system - if relevant | |||||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |||||||
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 | |||||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | ||||||
note | SΣ | 0..* | Annotation | Additional immunization notes | ||||||
reasonCode | S | 0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered (preferred) | ||||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||||
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
documentType | 0..1 | string | Educational material document identifier | |||||||
reference | 0..1 | uri | Educational material reference pointer | |||||||
publicationDate | 0..1 | dateTime | Educational material publication date | |||||||
presentationDate | 0..1 | dateTime | Educational material presentation date | |||||||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
date | 0..1 | dateTime | When reaction started | |||||||
detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||||
reported | 0..1 | boolean | Indicates self-reported reaction | |||||||
protocolApplied | S | 1..* | BackboneElement | Protocol followed by the provider | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
series | S | 0..1 | string | Name of vaccine series | ||||||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||||
targetDisease | S | 1..* | CodeableConcept | Antigen Binding: Vaccination Target Disease (preferred) | ||||||
doseNumber[x] | S | 1..1 | Dose number within series | |||||||
doseNumberPositiveInt | positiveInt | |||||||||
doseNumberString | string | |||||||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||||
seriesDosesPositiveInt | positiveInt | |||||||||
seriesDosesString | string | |||||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | ||||||||
Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | |||||||||
Immunization.status | required | Fixed Value: completedhttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | |||||||||
Immunization.statusReason | preferred | ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 | |||||||||
Immunization.vaccineCode | example | VaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard | |||||||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard | |||||||||
Immunization.site | preferred | ImmunisationAnatomicalSite https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 | |||||||||
Immunization.route | preferred | ImmunisationRouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 | |||||||||
Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | |||||||||
Immunization.performer:administeredBy.function | extensible | Pattern: APhttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | |||||||||
Immunization.performer:approvedBy.function | extensible | Pattern: OPhttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | |||||||||
Immunization.reasonCode | preferred | ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 | |||||||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard | |||||||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard | |||||||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard | |||||||||
Immunization.protocolApplied.targetDisease | preferred | VaccinationTargetDisease https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 |
This structure is derived from ADHAImmunizationCore
Differential View
This structure is derived from ADHAImmunizationCore
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | ADHAImmunizationCore | Record of immunisation event held on the Australian Immunisation Register | |
identifier | 1..* | Identifier | Business identifier | |
status | 1..1 | code | completed | entered-in-error | not-done Fixed Value: completed | |
vaccineCode | 1..1 | CodeableConcept | Vaccine product administered | |
coding | 1..* | Coding | Code defined by a terminology system | |
occurrence[x] | 1..1 | dateTime | Vaccine administration date | |
primarySource | S | 1..1 | boolean | Indicates context the data was recorded in Fixed Value: true |
lotNumber | S | 0..1 | string | Batch number |
protocolApplied | 1..* | BackboneElement | Protocol followed by the provider | |
targetDisease | 1..* | CodeableConcept | Antigen | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Immunization | 0..* | ADHAImmunizationCore | Record of immunisation event held on the Australian Immunisation Register | |||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
vaccine-serial-number | S | 0..1 | string | Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | S | 1..* | Identifier | Business identifier | ||||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed | ||||||
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred) | ||||||
vaccineCode | SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
| ||||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||
coding:amtVaccineCode | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||
coding:airVaccineCode | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||
patient | SΣC | 1..1 | Reference(ADHA Core Patient) | Who was immunized inv-dh-imm-01: At least reference or a valid identifier shall be present | ||||||
encounter | S | 0..1 | Reference(ADHA Core Encounter) | Encounter immunization was part of | ||||||
occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date | ||||||
primarySource | SΣ | 1..1 | boolean | Indicates context the data was recorded in Fixed Value: true | ||||||
lotNumber | S | 0..1 | string | Batch number | ||||||
Slices for performer | SΣ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | ||||||
performer:All Slices | Content/Rules for all slices | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | SΣ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | ||||||
actor | SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Organization) | Individual or organization who was performing inv-dh-imm-02: At least reference or a valid identifier shall be present | ||||||
performer:administeredBy | Σ | 0..1 | BackboneElement | Immunisation Administered By | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. 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://terminology.hl7.org/CodeSystem/v2-0443 | |||||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | ||||||
performer:approvedBy | Σ | 0..1 | BackboneElement | Immunisation Approved By | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. 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://terminology.hl7.org/CodeSystem/v2-0443 | |||||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |||||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | ||||||
note | SΣ | 0..* | Annotation | Additional immunization notes | ||||||
reasonCode | S | 0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered (preferred) | ||||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||||
protocolApplied | S | 1..* | BackboneElement | Protocol followed by the provider | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
series | S | 0..1 | string | Name of vaccine series | ||||||
targetDisease | S | 1..* | CodeableConcept | Antigen Binding: Vaccination Target Disease (preferred) | ||||||
doseNumber[x] | S | 1..1 | Dose number within series | |||||||
doseNumberPositiveInt | positiveInt | |||||||||
doseNumberString | string | |||||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | ||||||||
Immunization.status | required | Fixed Value: completedhttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | |||||||||
Immunization.statusReason | preferred | ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 | |||||||||
Immunization.vaccineCode | example | VaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard | |||||||||
Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | |||||||||
Immunization.performer:administeredBy.function | extensible | Pattern: APhttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | |||||||||
Immunization.performer:approvedBy.function | extensible | Pattern: OPhttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | |||||||||
Immunization.reasonCode | preferred | ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 | |||||||||
Immunization.protocolApplied.targetDisease | preferred | VaccinationTargetDisease https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Immunization | 0..* | ADHAImmunizationCore | Record of immunisation event held on the Australian Immunisation Register | |||||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
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 | |||||||
vaccine-serial-number | S | 0..1 | string | Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | S | 1..* | Identifier | Business identifier | ||||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed | ||||||
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred) | ||||||
vaccineCode | SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||
coding:amtVaccineCode | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||
coding:airVaccineCode | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||||
patient | SΣC | 1..1 | Reference(ADHA Core Patient) | Who was immunized inv-dh-imm-01: At least reference or a valid identifier shall be present | ||||||
encounter | S | 0..1 | Reference(ADHA Core Encounter) | Encounter immunization was part of | ||||||
occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date | ||||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||||
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: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||||
location | 0..1 | Reference(Location) | Where immunization 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: Immunisation Anatomical Site (preferred) | |||||||
route | 0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (preferred) | |||||||
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||||
Slices for performer | SΣ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | ||||||
performer:All Slices | Content/Rules for all slices | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | SΣ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | ||||||
actor | SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Organization) | Individual or organization who was performing inv-dh-imm-02: At least reference or a valid identifier shall be present | ||||||
performer:administeredBy | Σ | 0..1 | BackboneElement | Immunisation Administered By | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||||
version | 0..1 | string | Version of the system - if relevant | |||||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||||
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 | |||||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | ||||||
performer:approvedBy | Σ | 0..1 | BackboneElement | Immunisation Approved By | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||||
version | 0..1 | string | Version of the system - if relevant | |||||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |||||||
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 | |||||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | ||||||
note | SΣ | 0..* | Annotation | Additional immunization notes | ||||||
reasonCode | S | 0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered (preferred) | ||||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||||
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
documentType | 0..1 | string | Educational material document identifier | |||||||
reference | 0..1 | uri | Educational material reference pointer | |||||||
publicationDate | 0..1 | dateTime | Educational material publication date | |||||||
presentationDate | 0..1 | dateTime | Educational material presentation date | |||||||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
date | 0..1 | dateTime | When reaction started | |||||||
detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||||
reported | 0..1 | boolean | Indicates self-reported reaction | |||||||
protocolApplied | S | 1..* | BackboneElement | Protocol followed by the provider | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
series | S | 0..1 | string | Name of vaccine series | ||||||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||||
targetDisease | S | 1..* | CodeableConcept | Antigen Binding: Vaccination Target Disease (preferred) | ||||||
doseNumber[x] | S | 1..1 | Dose number within series | |||||||
doseNumberPositiveInt | positiveInt | |||||||||
doseNumberString | string | |||||||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||||
seriesDosesPositiveInt | positiveInt | |||||||||
seriesDosesString | string | |||||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | ||||||||
Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | |||||||||
Immunization.status | required | Fixed Value: completedhttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | |||||||||
Immunization.statusReason | preferred | ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 | |||||||||
Immunization.vaccineCode | example | VaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard | |||||||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard | |||||||||
Immunization.site | preferred | ImmunisationAnatomicalSite https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 | |||||||||
Immunization.route | preferred | ImmunisationRouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 | |||||||||
Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | |||||||||
Immunization.performer:administeredBy.function | extensible | Pattern: APhttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | |||||||||
Immunization.performer:approvedBy.function | extensible | Pattern: OPhttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | |||||||||
Immunization.reasonCode | preferred | ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 | |||||||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard | |||||||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard | |||||||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard | |||||||||
Immunization.protocolApplied.targetDisease | preferred | VaccinationTargetDisease https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 |
This structure is derived from ADHAImmunizationCore
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
Name | Type | Conformance | Description | Path |
---|---|---|---|---|
identifier | token | SHALL | Business identifier | Immunization.identifier |
patient:identifier | token | SHALL | The patient for the vaccination record | Immunization.subject.identifier |
vaccine-code | token | SHALL | Vaccine Product Administered | Immunization.vaccineCode |
date | date | SHALL | Vaccination (non)-Administration Date | Immunization.occurrence |
status | token | SHALL | Immunization event status | Immunization.status |
target-disease | token | SHOULD | The target disease the dose is being administered against | Immunization.protocolApplied.targetDisease |
The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching for all immunisations for a patient using the patient:identifier
search parameter:
GET [base]/Immunization?patient:identifier={system|}[code]
Example:
GET [base]/Immunization?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437
Implementation Notes: Fetches a bundle of all Immunization resources for the specified patient (how to search by :identifier)
SHALL support searching using the identifier
search parameter:
GET [base]/Immunization?identifier={system|}[code]
Example:
GET [base]/Immunization?identifier=urn:ietf:rfc:3986|urn:uuid:44a8f148-f5f7-447c-9e68-a9f06635ab6c
Implementation Notes: Fetches a bundle containing any Immunization resources matching the identifier (how to search by token)
patient:identifier
and vaccine-code
and status
search parameter:
status
(e.g.status={system|}[code],{system|}[code],...
)GET [base]/Immunization?patient:identifier={system|}[code]&vaccine-code={system|}[code]&status={system|}[code]
Example:
GET [base]/Immunization?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&vaccine-code=https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats|COMIRN&status=completed
Implementation Notes: Fetches a bundle of all Immunization resources with the vaccine code of an COMIRN (Pfizer Comirnaty) and status for the specified patient (how to search by :identifier and how to search by token)
patient:identifier
and date
and status
search parameters:
status
(e.g.status={system|}[code],{system|}[code],...
)GET [base]/Immunization?patient:identifier={system|}[code]&date=[date]&status={system|}[code]
Example:
GET [base]/Immunization?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&date=ge2013-03-14&status=completed
Implementation Notes: Fetches a bundle of all Immunization resources for the specified patient that have a date greater than or equal to 21st Jan 2013. (how to search by :identifier and how to search by date)
patient:identifier
and target-disease
and status
search parameter:
status
(e.g.status={system|}[code],{system|}[code],...
)GET [base]/Immunization?patient:identifier={system|}[code]&target-disease={system|}[code]&status={system|}[code]
Example:
GET [base]/Immunization?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&target-disease=http://snomed.info/sct|840539006&status=completed
Implementation Notes: Fetches a bundle of all Immunization resources with the target disease of an 840539006 (COVID-19) for the specified patient (how to search by :identifier and how to search by token)