AU Patient Summary Implementation Guide
1.0.0-preview - Preview AU

AU Patient Summary Implementation Guide - Downloaded Version 1.0.0-preview See the Directory of published versions

## Resource Profile: AU PS Immunization

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-immunization | Version: 1.0.0-preview
Standards status: Draft | Maturity Level: 2 | Computable Name: AUPSImmunization
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for an Immunization resource in the context of a patient summary in an Australian context. It is based on the AU Core Immunization profile, and applies the additional requirements from Immunization (IPS).

See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.

### Profile Specific Implementation Guidance

- See the guidance on implementing the Immunization resource in AU Core.
- When populating `Immunization.vaccineCode` producers SHALL correctly populate `Immunization.vaccineCode.coding` with either a code from Australian Medicines Terminology Vaccine or Australian Immunisation Register Vaccine, or both, if a coded value is known and MAY populate with a code from another code system.
  - Producers MAY populate with only text if no coded value is known.

The additional obligation on `Immunization.occurrenceDateTime` for AU PS Producer is SHOULD:able-to-populate. This obligation is in addition to the obligation of SHALL:populate-if-known. There is no additional obligation for AU PS Consumer, the obligations of SHALL:handle and SHOULD:display apply.

This additional obligation is present in the underlying structure but due to a tooling limitation is not currently rendered in the Formal Views of Profile Content. See Zulip discussion for more information.

Examples for this Profile: Bundle/aups-gpvisit-retrieval, Bundle/aups-referral-endoconsult-autogen and Bundle/aups-referral-endoconsult-curated

Usages:

- Use this Profile: AU PS Bundle
- Refer to this Profile: AU PS Composition

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 This profile also complies with the profile Immunization (IPS)
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.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
vaccineCode | SO Σ | 1..1 | CodeableConceptIPS | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
Additional Bindings | Purpose
Australian Medicines Terminology Vaccine | Preferred
Australian Immunisation Register Vaccine | Preferred
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
coding:airVaccineCode | SO Σ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
patient | SO Σ | 1..1 | Reference(AU PS Patient) | Who was immunized
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
occurrence[x] | SO Σ | 1..1 |  | Vaccine administration date
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
occurrenceDateTime |  |  | dateTime S |
occurrenceString |  |  | string |
primarySource | SO Σ | 0..1 | boolean | Indicates context the data was recorded in
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
lotNumber | SO | 0..1 | string | Vaccine lot number
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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..* | Annotation | Additional immunization notes
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | tx.hl7.org.au
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 | AU Base Implementation Guide v6.0
Immunization.performer:approvedBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0 | 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 |  | 0..* | AUCoreImmunization | An immunisation statement in an Australian healthcare context This profile also complies with the profile Immunization (IPS)
status | O | 1..1 | code | completed | entered-in-error | not-done
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
vaccineCode | O | 1..1 | CodeableConceptIPS | Vaccine product administered
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Slices for coding |  |  |  | Content/Rules for all slices
coding:amtVaccineCode | O | 0..1 | Coding | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
coding:airVaccineCode | O | 0..1 | Coding | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
patient | O | 1..1 | Reference(AU PS Patient) | Who was immunized
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
occurrence[x] | O | 1..1 |  | Vaccine administration date
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
primarySource | O | 0..1 | boolean | Indicates context the data was recorded in
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
lotNumber | O | 0..1 | string | Vaccine lot number
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
note | O | 0..* | Annotation | Additional immunization notes
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 This profile also complies with the profile Immunization (IPS)
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.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode | SO Σ | 1..1 | CodeableConceptIPS | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
Additional Bindings | Purpose
Australian Medicines Terminology Vaccine | Preferred
Australian Immunisation Register Vaccine | Preferred
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
coding:airVaccineCode | SO Σ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
text | Σ | 0..1 | string | Plain text representation of the concept
patient | SO Σ | 1..1 | Reference(AU PS Patient) | Who was immunized
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
occurrence[x] | SO Σ | 1..1 |  | Vaccine administration date
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
occurrenceDateTime |  |  | dateTime S |
occurrenceString |  |  | string |
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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(4.0.1) | 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..* | Annotation | Additional immunization notes
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | tx.hl7.org.au
Immunization.vaccineCode.​coding:airVaccineCode | Base | required | Australian Immunisation Register Vaccine | ⏿1.0.2 | tx.hl7.org.au
Immunization.patient.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
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 | AU Base Implementation Guide v6.0
Immunization.performer:administeredBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0 | AU Base Implementation Guide v6.0
Immunization.performer:approvedBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0 | 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

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | AUCoreImmunization | An immunisation statement in an Australian healthcare context This profile also complies with the profile Immunization (IPS)
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.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
vaccineCode | SO Σ | 1..1 | CodeableConceptIPS | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
Additional Bindings | Purpose
Australian Medicines Terminology Vaccine | Preferred
Australian Immunisation Register Vaccine | Preferred
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
coding:airVaccineCode | SO Σ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
patient | SO Σ | 1..1 | Reference(AU PS Patient) | Who was immunized
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
occurrence[x] | SO Σ | 1..1 |  | Vaccine administration date
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
occurrenceDateTime |  |  | dateTime S |
occurrenceString |  |  | string |
primarySource | SO Σ | 0..1 | boolean | Indicates context the data was recorded in
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
lotNumber | SO | 0..1 | string | Vaccine lot number
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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..* | Annotation | Additional immunization notes
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | tx.hl7.org.au
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 | AU Base Implementation Guide v6.0
Immunization.performer:approvedBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0 | 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 |  | 0..* | AUCoreImmunization | An immunisation statement in an Australian healthcare context This profile also complies with the profile Immunization (IPS)
status | O | 1..1 | code | completed | entered-in-error | not-done
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
vaccineCode | O | 1..1 | CodeableConceptIPS | Vaccine product administered
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Slices for coding |  |  |  | Content/Rules for all slices
coding:amtVaccineCode | O | 0..1 | Coding | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
coding:airVaccineCode | O | 0..1 | Coding | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
patient | O | 1..1 | Reference(AU PS Patient) | Who was immunized
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
occurrence[x] | O | 1..1 |  | Vaccine administration date
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
primarySource | O | 0..1 | boolean | Indicates context the data was recorded in
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
lotNumber | O | 0..1 | string | Vaccine lot number
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
note | O | 0..* | Annotation | Additional immunization notes
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 This profile also complies with the profile Immunization (IPS)
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.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode | SO Σ | 1..1 | CodeableConceptIPS | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
Additional Bindings | Purpose
Australian Medicines Terminology Vaccine | Preferred
Australian Immunisation Register Vaccine | Preferred
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
coding:airVaccineCode | SO Σ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
text | Σ | 0..1 | string | Plain text representation of the concept
patient | SO Σ | 1..1 | Reference(AU PS Patient) | Who was immunized
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
occurrence[x] | SO Σ | 1..1 |  | Vaccine administration date
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
occurrenceDateTime |  |  | dateTime S |
occurrenceString |  |  | string |
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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(4.0.1) | 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..* | Annotation | Additional immunization notes
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | tx.hl7.org.au
Immunization.vaccineCode.​coding:airVaccineCode | Base | required | Australian Immunisation Register Vaccine | ⏿1.0.2 | tx.hl7.org.au
Immunization.patient.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
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 | AU Base Implementation Guide v6.0
Immunization.performer:administeredBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0 | AU Base Implementation Guide v6.0
Immunization.performer:approvedBy.​function | Base | extensible | hl7VS-providerRole - AU Extended | 📦6.0.0 | 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

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)

Maturity: 2

Other representations of profile: CSV, Excel, Schematron