Smart Health Checks
0.4.0 - ci-build

Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Smart Health Checks Immunization

Official URL: https://smartforms.csiro.au/ig/StructureDefinition/SHCImmunization | Version: 0.4.0
Draft as of 2025-12-18 | Computable Name: SmartHealthChecksImmunization
Copyright/Legal: Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/.

This profile sets the minimum expectations for an Immunization resource to record, search and save immunization information when used within Smart Health Checks.

Usages:

- Use this Profile: Smart Health Checks Extract Bundle
- CapabilityStatements using this Profile: SHC App and SHC Host FHIR Server

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | AUCoreImmunization | An immunisation statement in an Australian healthcare context
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:vaccineVialSerialNumber |  | 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
status | ?!SO Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Required Pattern: completed
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate | SHC App |
vaccineCode | SO Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
Additional Bindings | Purpose
Australian Medicines Terminology Vaccine | Preferred
Australian Immunisation Register Vaccine | Preferred
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:amtVaccineCode | SO Σ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
coding:airVaccineCode | SO Σ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
text | SO Σ | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHALL:persist | SHC Host FHIR Server
SHALL:populate-if-known & SHALL:process | SHC App
patient | SO Σ | 1..1 | Reference(AU Core Patient) | Who was immunized
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate | SHC App |
Slices for occurrence[x] | SO Σ | 1..1 |  | Vaccine administration date Slice: Unordered, Open by type:$this
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
occurrenceDateTime |  |  | dateTime S |
occurrenceString |  |  | string |
occurrence[x]:occurrenceDateTime | SO Σ | 0..1 | dateTime S | Vaccine administration date
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHOULD:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
primarySource | SO Σ | 0..1 | boolean | Indicates context the data was recorded in
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
lotNumber | SO | 0..1 | string | Vaccine lot number
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
Slices for performer | Σ | 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
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing
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: hl7VS-providerRole - AU Extended (extensible) 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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
function | Σ | 1..1 | CodeableConcept | Approver role Binding: hl7VS-providerRole - AU Extended (extensible) 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 | SO Σ | 0..1 | Annotation | Additional immunization notes
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
text | SO Σ | 1..1 | markdown | The annotation - text content (as markdown)
Obligations | Actor
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server
SHALL:populate-if-known & SHALL:process | SHC App
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std.
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📦4.0.1 | FHIR Std.
Immunization.vaccineCode.​coding:amtVaccineCode | Base | required | Australian Medicines Terminology Vaccine | 📦1.0.2 | This IG
Immunization.vaccineCode.​coding:airVaccineCode | Base | required | Australian Immunisation Register Vaccine | ⏿1.0.2 | tx.hl7.org.au
Immunization.performer:administeredBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0-ballot | AU Base Implementation Guide v6.0
Immunization.performer:approvedBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0-ballot | AU Base Implementation Guide v6.0

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from AUCoreImmunization

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  |  | AUCoreImmunization |
status | O | 1..1 | code | completed | entered-in-error | not-done Required Pattern: completed
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate | SHC App |
vaccineCode | O | 1..1 | CodeableConcept | Vaccine product administered
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
Slices for coding |  |  |  | Content/Rules for all slices
coding:amtVaccineCode | O | 0..1 | Coding | Code defined by a terminology system
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
text | SO | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHALL:persist | SHC Host FHIR Server
SHALL:populate-if-known & SHALL:process | SHC App
patient | O | 1..1 | Reference(AU Core Patient) | Who was immunized
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate | SHC App |
Slices for occurrence[x] |  | 1..1 | dateTime, string | Vaccine administration date Slice: Unordered, Open by type:$this
occurrence[x]:occurrenceDateTime | SO | 0..1 | dateTime S | Vaccine administration date
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHOULD:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
lotNumber | O | 0..1 | string | Vaccine lot number
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
note |  | 0..1 | Annotation | Additional immunization notes
text | SO | 1..1 | markdown | The annotation - text content (as markdown)
Obligations | Actor
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server
SHALL:populate-if-known & SHALL:process | SHC App
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | AUCoreImmunization | An immunisation statement in an Australian healthcare context
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:vaccineVialSerialNumber |  | 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 |  | 0..* | Identifier | Business identifier
status | ?!SO Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Required Pattern: completed
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate | SHC App |
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode | SO Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
Additional Bindings | Purpose
Australian Medicines Terminology Vaccine | Preferred
Australian Immunisation Register Vaccine | Preferred
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
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 | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:amtVaccineCode | SO Σ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
coding:airVaccineCode | SO Σ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
text | SO Σ | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHALL:persist | SHC Host FHIR Server
SHALL:populate-if-known & SHALL:process | SHC App
patient | SO Σ | 1..1 | Reference(AU Core Patient) | Who was immunized
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate | SHC App |
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
Slices for occurrence[x] | SO Σ | 1..1 |  | Vaccine administration date Slice: Unordered, Open by type:$this
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
occurrenceDateTime |  |  | dateTime S |
occurrenceString |  |  | string |
occurrence[x]:occurrenceDateTime | SO Σ | 0..1 | dateTime S | Vaccine administration date
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHOULD:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | SO Σ | 0..1 | boolean | Indicates context the data was recorded in
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
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 | SO | 0..1 | string | Vaccine lot number
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
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 | Σ | 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 | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible)
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing
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: hl7VS-providerRole - AU Extended (extensible) 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: hl7VS-providerRole - AU Extended (extensible) 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 | SO Σ | 0..1 | Annotation | Additional immunization notes
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
author[x] | Σ | 0..1 |  | Individual responsible for the annotation
authorReference |  |  | Reference(Practitioner | Patient | RelatedPerson | Organization) |
authorString |  |  | string |
time | Σ | 0..1 | dateTime | When the annotation was made
text | SO Σ | 1..1 | markdown | The annotation - text content (as markdown)
Obligations | Actor
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server
SHALL:populate-if-known & SHALL:process | SHC App
reasonCode |  | 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 Constraints: imm-1
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 |  | 0..* | 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 |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccination Target Disease (preferred)
doseNumber[x] |  | 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

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std.
Immunization.statusReason | Base | preferred | Reason Vaccine Not Administered | ⏿3.0.0 | tx.hl7.org.au
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📦4.0.1 | FHIR Std.
Immunization.vaccineCode.​coding:amtVaccineCode | Base | required | Australian Medicines Terminology Vaccine | 📦1.0.2 | This IG
Immunization.vaccineCode.​coding:airVaccineCode | Base | required | Australian Immunisation Register Vaccine | ⏿1.0.2 | tx.hl7.org.au
Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📦4.0.1 | FHIR Std.
Immunization.site | Base | preferred | Immunisation Anatomical Site | ⏿1.0.2 | tx.hl7.org.au
Immunization.route | Base | preferred | Immunisation Route of Administration | ⏿1.0.2 | tx.hl7.org.au
Immunization.performer.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0-ballot | AU Base Implementation Guide v6.0
Immunization.performer:administeredBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0-ballot | AU Base Implementation Guide v6.0
Immunization.performer:approvedBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0-ballot | AU Base Implementation Guide v6.0
Immunization.reasonCode | Base | preferred | Reason Vaccine Administered | ⏿1.0.2 | tx.hl7.org.au
Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📦4.0.1 | FHIR Std.
Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📦4.0.1 | FHIR Std.
Immunization.fundingSource | Base | example | Immunization Funding Source | 📦4.0.1 | FHIR Std.
Immunization.protocolApplied.​targetDisease | Base | preferred | Vaccination Target Disease | ⏿1.0.2 | tx.hl7.org.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present | `documentType.exists() or reference.exists()`

This structure is derived from AUCoreImmunization

Summary

Must-Support: 3 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Immunization.occurrence[x]

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | AUCoreImmunization | An immunisation statement in an Australian healthcare context
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:vaccineVialSerialNumber |  | 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
status | ?!SO Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Required Pattern: completed
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate | SHC App |
vaccineCode | SO Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
Additional Bindings | Purpose
Australian Medicines Terminology Vaccine | Preferred
Australian Immunisation Register Vaccine | Preferred
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:amtVaccineCode | SO Σ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
coding:airVaccineCode | SO Σ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
text | SO Σ | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHALL:persist | SHC Host FHIR Server
SHALL:populate-if-known & SHALL:process | SHC App
patient | SO Σ | 1..1 | Reference(AU Core Patient) | Who was immunized
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate | SHC App |
Slices for occurrence[x] | SO Σ | 1..1 |  | Vaccine administration date Slice: Unordered, Open by type:$this
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
occurrenceDateTime |  |  | dateTime S |
occurrenceString |  |  | string |
occurrence[x]:occurrenceDateTime | SO Σ | 0..1 | dateTime S | Vaccine administration date
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHOULD:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
primarySource | SO Σ | 0..1 | boolean | Indicates context the data was recorded in
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
lotNumber | SO | 0..1 | string | Vaccine lot number
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
Slices for performer | Σ | 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
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing
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: hl7VS-providerRole - AU Extended (extensible) 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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
function | Σ | 1..1 | CodeableConcept | Approver role Binding: hl7VS-providerRole - AU Extended (extensible) 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 | SO Σ | 0..1 | Annotation | Additional immunization notes
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
text | SO Σ | 1..1 | markdown | The annotation - text content (as markdown)
Obligations | Actor
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server
SHALL:populate-if-known & SHALL:process | SHC App
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std.
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📦4.0.1 | FHIR Std.
Immunization.vaccineCode.​coding:amtVaccineCode | Base | required | Australian Medicines Terminology Vaccine | 📦1.0.2 | This IG
Immunization.vaccineCode.​coding:airVaccineCode | Base | required | Australian Immunisation Register Vaccine | ⏿1.0.2 | tx.hl7.org.au
Immunization.performer:administeredBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0-ballot | AU Base Implementation Guide v6.0
Immunization.performer:approvedBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0-ballot | AU Base Implementation Guide v6.0

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from AUCoreImmunization

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  |  | AUCoreImmunization |
status | O | 1..1 | code | completed | entered-in-error | not-done Required Pattern: completed
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate | SHC App |
vaccineCode | O | 1..1 | CodeableConcept | Vaccine product administered
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
Slices for coding |  |  |  | Content/Rules for all slices
coding:amtVaccineCode | O | 0..1 | Coding | Code defined by a terminology system
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
text | SO | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHALL:persist | SHC Host FHIR Server
SHALL:populate-if-known & SHALL:process | SHC App
patient | O | 1..1 | Reference(AU Core Patient) | Who was immunized
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate | SHC App |
Slices for occurrence[x] |  | 1..1 | dateTime, string | Vaccine administration date Slice: Unordered, Open by type:$this
occurrence[x]:occurrenceDateTime | SO | 0..1 | dateTime S | Vaccine administration date
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHOULD:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
lotNumber | O | 0..1 | string | Vaccine lot number
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
note |  | 0..1 | Annotation | Additional immunization notes
text | SO | 1..1 | markdown | The annotation - text content (as markdown)
Obligations | Actor
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server
SHALL:populate-if-known & SHALL:process | SHC App
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | AUCoreImmunization | An immunisation statement in an Australian healthcare context
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:vaccineVialSerialNumber |  | 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 |  | 0..* | Identifier | Business identifier
status | ?!SO Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Required Pattern: completed
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate | SHC App |
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode | SO Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
Additional Bindings | Purpose
Australian Medicines Terminology Vaccine | Preferred
Australian Immunisation Register Vaccine | Preferred
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
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 | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:amtVaccineCode | SO Σ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
coding:airVaccineCode | SO Σ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
text | SO Σ | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHALL:persist | SHC Host FHIR Server
SHALL:populate-if-known & SHALL:process | SHC App
patient | SO Σ | 1..1 | Reference(AU Core Patient) | Who was immunized
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate | SHC App |
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
Slices for occurrence[x] | SO Σ | 1..1 |  | Vaccine administration date Slice: Unordered, Open by type:$this
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
occurrenceDateTime |  |  | dateTime S |
occurrenceString |  |  | string |
occurrence[x]:occurrenceDateTime | SO Σ | 0..1 | dateTime S | Vaccine administration date
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHOULD:populate & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | SO Σ | 0..1 | boolean | Indicates context the data was recorded in
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
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 | SO | 0..1 | string | Vaccine lot number
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server |
SHALL:populate-if-known & SHALL:process | SHC App |
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 | Σ | 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 | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible)
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing
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: hl7VS-providerRole - AU Extended (extensible) 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: hl7VS-providerRole - AU Extended (extensible) 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 | SO Σ | 0..1 | Annotation | Additional immunization notes
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
author[x] | Σ | 0..1 |  | Individual responsible for the annotation
authorReference |  |  | Reference(Practitioner | Patient | RelatedPerson | Organization) |
authorString |  |  | string |
time | Σ | 0..1 | dateTime | When the annotation was made
text | SO Σ | 1..1 | markdown | The annotation - text content (as markdown)
Obligations | Actor
SHALL:populate-if-known & SHALL:persist | SHC Host FHIR Server
SHALL:populate-if-known & SHALL:process | SHC App
reasonCode |  | 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 Constraints: imm-1
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 |  | 0..* | 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 |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccination Target Disease (preferred)
doseNumber[x] |  | 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

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std.
Immunization.statusReason | Base | preferred | Reason Vaccine Not Administered | ⏿3.0.0 | tx.hl7.org.au
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📦4.0.1 | FHIR Std.
Immunization.vaccineCode.​coding:amtVaccineCode | Base | required | Australian Medicines Terminology Vaccine | 📦1.0.2 | This IG
Immunization.vaccineCode.​coding:airVaccineCode | Base | required | Australian Immunisation Register Vaccine | ⏿1.0.2 | tx.hl7.org.au
Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📦4.0.1 | FHIR Std.
Immunization.site | Base | preferred | Immunisation Anatomical Site | ⏿1.0.2 | tx.hl7.org.au
Immunization.route | Base | preferred | Immunisation Route of Administration | ⏿1.0.2 | tx.hl7.org.au
Immunization.performer.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0-ballot | AU Base Implementation Guide v6.0
Immunization.performer:administeredBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0-ballot | AU Base Implementation Guide v6.0
Immunization.performer:approvedBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0-ballot | AU Base Implementation Guide v6.0
Immunization.reasonCode | Base | preferred | Reason Vaccine Administered | ⏿1.0.2 | tx.hl7.org.au
Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📦4.0.1 | FHIR Std.
Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📦4.0.1 | FHIR Std.
Immunization.fundingSource | Base | example | Immunization Funding Source | 📦4.0.1 | FHIR Std.
Immunization.protocolApplied.​targetDisease | Base | preferred | Vaccination Target Disease | ⏿1.0.2 | tx.hl7.org.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present | `documentType.exists() or reference.exists()`

This structure is derived from AUCoreImmunization

Summary

Must-Support: 3 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Immunization.occurrence[x]

Other representations of profile: CSV, Excel, Schematron