AU Patient Summary Implementation Guide
0.1.0-preview - Preview

Publication Build: This will be filled in by the publication tooling

## Resource Profile: AU PS Immunization

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-immunization | Version: 0.1.0-preview
Standards status: Draft | Maturity Level: 0 | Computable Name: AUPSImmunization
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; 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 Base Immunisation profile, and applies the constraints of AU Core Immunization and Immunization (IPS).

See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

Usage:

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

### Formal Views of Profile Content

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

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

This structure is derived from AUBaseImmunisation

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization
status | S | 1..1 | code | completed | entered-in-error | not-done
vaccineCode | S | 1..1 | CodeableConceptIPS | Vaccine product administered
Slices for coding |  | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:amtVaccineCode | S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)
coding:airVaccineCode | S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)
patient | S | 1..1 | Reference(AU PS Patient) | Who was immunized
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL
occurrence[x] | S | 1..1 | dateTime, string | Vaccine administration date
primarySource | S | 0..1 | boolean | Indicates context the data was recorded in
note | S | 0..* | Annotation | Additional immunization notes
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccine `https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from `https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats`) `https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1` from https://tx.ontoserver.csiro.au/fhir

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children
vaccineCode | S Σ | 1..1 | CodeableConceptIPS | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
Additional Bindings | Purpose
Australian Medicines Terminology Vaccine | Preferred
Australian Immunisation Register Vaccine | Preferred
ele-1: All FHIR elements must have a @value or children
Slices for coding | S | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children
coding:amtVaccineCode | S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required) ele-1: All FHIR elements must have a @value or children
coding:airVaccineCode | S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required) ele-1: All FHIR elements must have a @value or children
text | S Σ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
patient | S Σ | 1..1 | Reference(AU PS Patient) | Who was immunized ele-1: All FHIR elements must have a @value or children
reference | S Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
occurrence[x] | S Σ | 1..1 |  | Vaccine administration date ele-1: All FHIR elements must have a @value or children
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
primarySource | S Σ | 0..1 | boolean | Indicates context the data was recorded in ele-1: All FHIR elements must have a @value or children
Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function ele-1: All FHIR elements must have a @value or children
performer:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
performer:administeredBy | Σ | 0..1 | BackboneElement | Immunisation Administered By ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function | Σ | 1..1 | CodeableConcept | Administering role Binding: hl7VS-providerRole - AU Extended (extensible) ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer ele-1: All FHIR elements must have a @value or children
performer:approvedBy | Σ | 0..1 | BackboneElement | Immunisation Approved By ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function | Σ | 1..1 | CodeableConcept | Approver role Binding: hl7VS-providerRole - AU Extended (extensible) ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver ele-1: All FHIR elements must have a @value or children
note | S Σ | 0..* | Annotation | Additional immunization notes ele-1: All FHIR elements must have a @value or children
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Immunization.status | required | ImmunizationStatusCodes `http://hl7.org/fhir/ValueSet/immunization-status|4.0.1` from the FHIR Standard
Immunization.vaccineCode | example | VaccineAdministeredValueSet `http://hl7.org/fhir/ValueSet/vaccine-code` from the FHIR Standard
Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccine `https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from `https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats`) `https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.performer:administeredBy.function | extensible | Pattern: AP `http://terminology.hl7.org.au/ValueSet/v2-0443-extended`
Immunization.performer:approvedBy.function | extensible | Pattern: OP `http://terminology.hl7.org.au/ValueSet/v2-0443-extended`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization
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
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 | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode | S Σ | 1..1 | CodeableConceptIPS | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
Additional Bindings | Purpose
Australian Medicines Terminology Vaccine | Preferred
Australian Immunisation Register Vaccine | Preferred
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 | S | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:amtVaccineCode | S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)
coding:airVaccineCode | S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)
text | S Σ | 0..1 | string | Plain text representation of the concept
patient | S Σ | 1..1 | Reference(AU PS Patient) | Who was immunized
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 | S Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
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] | S Σ | 1..1 |  | Vaccine administration date
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | S Σ | 0..1 | boolean | Indicates context the data was recorded in
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 |  | 0..1 | string | Vaccine lot number
expirationDate |  | 0..1 | date | Vaccine expiration date
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: Immunisation Anatomical Site (preferred)
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (preferred)
doseQuantity |  | 0..1 | SimpleQuantity | Amount of vaccine administered
Slices for performer | Σ | 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 | S Σ | 0..* | Annotation | Additional immunization notes
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 imm-1: One of documentType or reference SHALL be present
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
documentType |  | 0..1 | string | Educational material document identifier
reference |  | 0..1 | uri | Educational material reference pointer
publicationDate |  | 0..1 | dateTime | Educational material publication date
presentationDate |  | 0..1 | dateTime | Educational material presentation date
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
protocolApplied |  | 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 | Conformance | ValueSet / Code | URI
Immunization.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Immunization.status | required | ImmunizationStatusCodes `http://hl7.org/fhir/ValueSet/immunization-status|4.0.1` from the FHIR Standard
Immunization.statusReason | preferred | ReasonVaccineNotAdministered `https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3` from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode | example | VaccineAdministeredValueSet `http://hl7.org/fhir/ValueSet/vaccine-code` from the FHIR Standard
Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccine `https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from `https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats`) `https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.patient.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Immunization.reportOrigin | example | ImmunizationOriginCodes `http://hl7.org/fhir/ValueSet/immunization-origin` from the FHIR Standard
Immunization.site | preferred | ImmunisationAnatomicalSite `https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.route | preferred | ImmunisationRouteOfAdministration `https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtended `http://terminology.hl7.org.au/ValueSet/v2-0443-extended`
Immunization.performer:administeredBy.function | extensible | Pattern: AP `http://terminology.hl7.org.au/ValueSet/v2-0443-extended`
Immunization.performer:approvedBy.function | extensible | Pattern: OP `http://terminology.hl7.org.au/ValueSet/v2-0443-extended`
Immunization.reasonCode | preferred | ReasonVaccineAdministered `https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.subpotentReason | example | ImmunizationSubpotentReason `http://hl7.org/fhir/ValueSet/immunization-subpotent-reason` from the FHIR Standard
Immunization.programEligibility | example | ImmunizationProgramEligibility `http://hl7.org/fhir/ValueSet/immunization-program-eligibility` from the FHIR Standard
Immunization.fundingSource | example | ImmunizationFundingSource `http://hl7.org/fhir/ValueSet/immunization-funding-source` from the FHIR Standard
Immunization.protocolApplied.targetDisease | preferred | VaccinationTargetDisease `https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 AUBaseImmunisation

Summary

Mandatory: 1 element
Must-Support: 9 elements

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)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Immunization.vaccineCode.coding

Maturity: 0

Differential View

This structure is derived from AUBaseImmunisation

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization
status | S | 1..1 | code | completed | entered-in-error | not-done
vaccineCode | S | 1..1 | CodeableConceptIPS | Vaccine product administered
Slices for coding |  | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:amtVaccineCode | S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)
coding:airVaccineCode | S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)
patient | S | 1..1 | Reference(AU PS Patient) | Who was immunized
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL
occurrence[x] | S | 1..1 | dateTime, string | Vaccine administration date
primarySource | S | 0..1 | boolean | Indicates context the data was recorded in
note | S | 0..* | Annotation | Additional immunization notes
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccine `https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from `https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats`) `https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1` from https://tx.ontoserver.csiro.au/fhir

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children
vaccineCode | S Σ | 1..1 | CodeableConceptIPS | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
Additional Bindings | Purpose
Australian Medicines Terminology Vaccine | Preferred
Australian Immunisation Register Vaccine | Preferred
ele-1: All FHIR elements must have a @value or children
Slices for coding | S | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children
coding:amtVaccineCode | S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required) ele-1: All FHIR elements must have a @value or children
coding:airVaccineCode | S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required) ele-1: All FHIR elements must have a @value or children
text | S Σ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
patient | S Σ | 1..1 | Reference(AU PS Patient) | Who was immunized ele-1: All FHIR elements must have a @value or children
reference | S Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
occurrence[x] | S Σ | 1..1 |  | Vaccine administration date ele-1: All FHIR elements must have a @value or children
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
primarySource | S Σ | 0..1 | boolean | Indicates context the data was recorded in ele-1: All FHIR elements must have a @value or children
Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function ele-1: All FHIR elements must have a @value or children
performer:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
performer:administeredBy | Σ | 0..1 | BackboneElement | Immunisation Administered By ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function | Σ | 1..1 | CodeableConcept | Administering role Binding: hl7VS-providerRole - AU Extended (extensible) ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer ele-1: All FHIR elements must have a @value or children
performer:approvedBy | Σ | 0..1 | BackboneElement | Immunisation Approved By ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function | Σ | 1..1 | CodeableConcept | Approver role Binding: hl7VS-providerRole - AU Extended (extensible) ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver ele-1: All FHIR elements must have a @value or children
note | S Σ | 0..* | Annotation | Additional immunization notes ele-1: All FHIR elements must have a @value or children
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Immunization.status | required | ImmunizationStatusCodes `http://hl7.org/fhir/ValueSet/immunization-status|4.0.1` from the FHIR Standard
Immunization.vaccineCode | example | VaccineAdministeredValueSet `http://hl7.org/fhir/ValueSet/vaccine-code` from the FHIR Standard
Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccine `https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from `https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats`) `https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.performer:administeredBy.function | extensible | Pattern: AP `http://terminology.hl7.org.au/ValueSet/v2-0443-extended`
Immunization.performer:approvedBy.function | extensible | Pattern: OP `http://terminology.hl7.org.au/ValueSet/v2-0443-extended`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization
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
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 | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode | S Σ | 1..1 | CodeableConceptIPS | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
Additional Bindings | Purpose
Australian Medicines Terminology Vaccine | Preferred
Australian Immunisation Register Vaccine | Preferred
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 | S | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:amtVaccineCode | S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)
coding:airVaccineCode | S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)
text | S Σ | 0..1 | string | Plain text representation of the concept
patient | S Σ | 1..1 | Reference(AU PS Patient) | Who was immunized
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 | S Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
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] | S Σ | 1..1 |  | Vaccine administration date
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | S Σ | 0..1 | boolean | Indicates context the data was recorded in
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 |  | 0..1 | string | Vaccine lot number
expirationDate |  | 0..1 | date | Vaccine expiration date
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: Immunisation Anatomical Site (preferred)
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (preferred)
doseQuantity |  | 0..1 | SimpleQuantity | Amount of vaccine administered
Slices for performer | Σ | 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 | S Σ | 0..* | Annotation | Additional immunization notes
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 imm-1: One of documentType or reference SHALL be present
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
documentType |  | 0..1 | string | Educational material document identifier
reference |  | 0..1 | uri | Educational material reference pointer
publicationDate |  | 0..1 | dateTime | Educational material publication date
presentationDate |  | 0..1 | dateTime | Educational material presentation date
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
protocolApplied |  | 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 | Conformance | ValueSet / Code | URI
Immunization.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Immunization.status | required | ImmunizationStatusCodes `http://hl7.org/fhir/ValueSet/immunization-status|4.0.1` from the FHIR Standard
Immunization.statusReason | preferred | ReasonVaccineNotAdministered `https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3` from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode | example | VaccineAdministeredValueSet `http://hl7.org/fhir/ValueSet/vaccine-code` from the FHIR Standard
Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccine `https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from `https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats`) `https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.patient.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Immunization.reportOrigin | example | ImmunizationOriginCodes `http://hl7.org/fhir/ValueSet/immunization-origin` from the FHIR Standard
Immunization.site | preferred | ImmunisationAnatomicalSite `https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.route | preferred | ImmunisationRouteOfAdministration `https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtended `http://terminology.hl7.org.au/ValueSet/v2-0443-extended`
Immunization.performer:administeredBy.function | extensible | Pattern: AP `http://terminology.hl7.org.au/ValueSet/v2-0443-extended`
Immunization.performer:approvedBy.function | extensible | Pattern: OP `http://terminology.hl7.org.au/ValueSet/v2-0443-extended`
Immunization.reasonCode | preferred | ReasonVaccineAdministered `https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1` from https://tx.ontoserver.csiro.au/fhir
Immunization.subpotentReason | example | ImmunizationSubpotentReason `http://hl7.org/fhir/ValueSet/immunization-subpotent-reason` from the FHIR Standard
Immunization.programEligibility | example | ImmunizationProgramEligibility `http://hl7.org/fhir/ValueSet/immunization-program-eligibility` from the FHIR Standard
Immunization.fundingSource | example | ImmunizationFundingSource `http://hl7.org/fhir/ValueSet/immunization-funding-source` from the FHIR Standard
Immunization.protocolApplied.targetDisease | preferred | VaccinationTargetDisease `https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 AUBaseImmunisation

Summary

Mandatory: 1 element
Must-Support: 9 elements

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)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Immunization.vaccineCode.coding

Maturity: 0

Other representations of profile: CSV, Excel, Schematron