AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build Australia flag

AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-ps/ and changes regularly. 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.1-ci-build
Standards status: Trial-use 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

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:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* AUCoreImmunization An immunisation statement in an Australian healthcare context
This profile also complies with the profile Immunization (IPS)
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.Slices for extension Content/Rules for all slices
Immunization.Slices for extension.extension:vaccineVialSerialNumber 0..1 string Vaccine vial serial number
URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.status This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.vaccineCode This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConceptIPS Vaccine product administered
Binding: VaccineAdministeredValueSet (example)
Additional BindingsPurpose
Australian Medicines Terminology Vaccine Preferred
Australian Immunisation Register Vaccine Preferred
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.vaccineCode.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
Immunization.vaccineCode.Slices for coding.coding:amtVaccineCode This element has obligations and must be supported. This element is included in summaries. 0..1 Coding Code defined by a terminology system
Binding: Australian Medicines Terminology Vaccine (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Immunization.vaccineCode.Slices for coding.coding:airVaccineCode This element has obligations and must be supported. This element is included in summaries. 0..1 Coding Code defined by a terminology system
Binding: Australian Immunisation Register Vaccine (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Immunization.patient This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) Who was immunized
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.patient.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
Immunization.occurrence[x] This element has obligations and must be supported. This element is included in summaries. 1..1 Vaccine administration date
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.occurrence[x].occurrenceDateTime dateTime This target must be supported.
Immunization.occurrence[x].occurrenceString string
Immunization.primarySource This element has obligations and must be supported. This element is included in summaries. 0..1 boolean Indicates context the data was recorded in
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.lotNumber This element has obligations and must be supported. 0..1 string Vaccine lot number
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.Slices for performer This element is included in summaries. 0..* BackboneElement Who performed event
Slice: Unordered, Open by pattern:function

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for performer.performer:All Slices Content/Rules for all slices
Immunization.Slices for performer.performer:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.performer:All Slices.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
Immunization.Slices for performer.performer:administeredBy This element is included in summaries. 0..1 BackboneElement Immunisation Administered By
Immunization.Slices for performer.performer:administeredBy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.performer:administeredBy.function This element is included in summaries. 1..1 CodeableConcept Administering role
Binding: hl7VS-providerRole - AU Extended (extensible)
Required Pattern: At least the following
Immunization.Slices for performer.performer:administeredBy.function.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeredBy.function.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeredBy.function.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Immunization.Slices for performer.performer:administeredBy.function.coding.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeredBy.function.coding.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeredBy.function.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
Immunization.Slices for performer.performer:administeredBy.function.coding.version 0..1 string Version of the system - if relevant
Immunization.Slices for performer.performer:administeredBy.function.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
Immunization.Slices for performer.performer:administeredBy.function.coding.display 0..1 string Representation defined by the system
Immunization.Slices for performer.performer:administeredBy.function.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Immunization.Slices for performer.performer:administeredBy.function.text 0..1 string Plain text representation of the concept
Immunization.Slices for performer.performer:administeredBy.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Administering performer
Immunization.Slices for performer.performer:approvedBy This element is included in summaries. 0..1 BackboneElement Immunisation Approved By
Immunization.Slices for performer.performer:approvedBy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.performer:approvedBy.function This element is included in summaries. 1..1 CodeableConcept Approver role
Binding: hl7VS-providerRole - AU Extended (extensible)
Required Pattern: At least the following
Immunization.Slices for performer.performer:approvedBy.function.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:approvedBy.function.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:approvedBy.function.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Immunization.Slices for performer.performer:approvedBy.function.coding.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:approvedBy.function.coding.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:approvedBy.function.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
Immunization.Slices for performer.performer:approvedBy.function.coding.version 0..1 string Version of the system - if relevant
Immunization.Slices for performer.performer:approvedBy.function.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: OP
Immunization.Slices for performer.performer:approvedBy.function.coding.display 0..1 string Representation defined by the system
Immunization.Slices for performer.performer:approvedBy.function.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Immunization.Slices for performer.performer:approvedBy.function.text 0..1 string Plain text representation of the concept
Immunization.Slices for performer.performer:approvedBy.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Approver
Immunization.note This element has obligations and must be supported. This element is included in summaries. 0..* Annotation Additional immunization notes
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency

doco 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 📦7.0.0-ci-build AU Base Implementation Guide vnull
Immunization.performer:approvedBy.​function Base extensible hl7VS-providerRole - AU Extended 📦7.0.0-ci-build AU Base Implementation Guide vnull

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* AUCoreImmunization An immunisation statement in an Australian healthcare context
This profile also complies with the profile Immunization (IPS)
Immunization.status This element has obligations. 1..1 code completed | entered-in-error | not-done
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.vaccineCode This element has obligations. 1..1 CodeableConceptIPS Vaccine product administered
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.vaccineCode.Slices for coding Content/Rules for all slices
Immunization.vaccineCode.Slices for coding.coding:amtVaccineCode This element has obligations. 0..1 Coding Code defined by a terminology system
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Immunization.vaccineCode.Slices for coding.coding:airVaccineCode This element has obligations. 0..1 Coding Code defined by a terminology system
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Immunization.patient This element has obligations. 1..1 Reference(AU PS Patient) Who was immunized
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.patient.reference This element has obligations and must be supported. 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.primarySource This element has obligations. 0..1 boolean Indicates context the data was recorded in
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.lotNumber This element has obligations. 0..1 string Vaccine lot number
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.note This element has obligations. 0..* Annotation Additional immunization notes
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* AUCoreImmunization An immunisation statement in an Australian healthcare context
This profile also complies with the profile Immunization (IPS)
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Immunization.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
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:vaccineVialSerialNumber 0..1 string Vaccine vial serial number
URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.identifier 0..* Identifier Business identifier
Immunization.status This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: Reason Vaccine Not Administered (preferred)
Immunization.vaccineCode This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConceptIPS Vaccine product administered
Binding: VaccineAdministeredValueSet (example)
Additional BindingsPurpose
Australian Medicines Terminology Vaccine Preferred
Australian Immunisation Register Vaccine Preferred
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.vaccineCode.id 0..1 string Unique id for inter-element referencing
Immunization.vaccineCode.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
Immunization.vaccineCode.Slices for coding.coding:amtVaccineCode This element has obligations and must be supported. This element is included in summaries. 0..1 Coding Code defined by a terminology system
Binding: Australian Medicines Terminology Vaccine (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Immunization.vaccineCode.Slices for coding.coding:airVaccineCode This element has obligations and must be supported. This element is included in summaries. 0..1 Coding Code defined by a terminology system
Binding: Australian Immunisation Register Vaccine (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Immunization.vaccineCode.text This element is included in summaries. 0..1 string Plain text representation of the concept
Immunization.patient This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) Who was immunized
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.patient.id 0..1 string Unique id for inter-element referencing
Immunization.patient.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.patient.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
Immunization.patient.type This element is included in summaries. 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).
Immunization.patient.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Immunization.patient.display This element is included in summaries. 0..1 string Text alternative for the resource
Immunization.encounter 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element has obligations and must be supported. This element is included in summaries. 1..1 Vaccine administration date
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.occurrence[x].occurrenceDateTime dateTime This target must be supported.
Immunization.occurrence[x].occurrenceString string
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource This element has obligations and must be supported. This element is included in summaries. 0..1 boolean Indicates context the data was recorded in
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
Immunization.location 0..1 Reference(Location) Where immunization occurred
Immunization.manufacturer 0..1 Reference(Organization) Vaccine manufacturer
Immunization.lotNumber This element has obligations and must be supported. 0..1 string Vaccine lot number
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.expirationDate 0..1 date Vaccine expiration date
Immunization.site 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunisation Anatomical Site (preferred)
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: Immunisation Route of Administration (preferred)
Immunization.doseQuantity C 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
Constraints: sqty-1
Immunization.Slices for performer This element is included in summaries. 0..* BackboneElement Who performed event
Slice: Unordered, Open by pattern:function

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for performer.performer:All Slices Content/Rules for all slices
Immunization.Slices for performer.performer:All Slices.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:All Slices.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.performer:All Slices.function This element is included in summaries. 0..1 CodeableConcept What type of performance was done
Binding: hl7VS-providerRole - AU Extended (extensible)
Immunization.Slices for performer.performer:All Slices.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
Immunization.Slices for performer.performer:administeredBy This element is included in summaries. 0..1 BackboneElement Immunisation Administered By
Immunization.Slices for performer.performer:administeredBy.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeredBy.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeredBy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.performer:administeredBy.function This element is included in summaries. 1..1 CodeableConcept Administering role
Binding: hl7VS-providerRole - AU Extended (extensible)
Required Pattern: At least the following
Immunization.Slices for performer.performer:administeredBy.function.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeredBy.function.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeredBy.function.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Immunization.Slices for performer.performer:administeredBy.function.coding.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeredBy.function.coding.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeredBy.function.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
Immunization.Slices for performer.performer:administeredBy.function.coding.version 0..1 string Version of the system - if relevant
Immunization.Slices for performer.performer:administeredBy.function.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
Immunization.Slices for performer.performer:administeredBy.function.coding.display 0..1 string Representation defined by the system
Immunization.Slices for performer.performer:administeredBy.function.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Immunization.Slices for performer.performer:administeredBy.function.text 0..1 string Plain text representation of the concept
Immunization.Slices for performer.performer:administeredBy.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Administering performer
Immunization.Slices for performer.performer:approvedBy This element is included in summaries. 0..1 BackboneElement Immunisation Approved By
Immunization.Slices for performer.performer:approvedBy.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:approvedBy.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:approvedBy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.performer:approvedBy.function This element is included in summaries. 1..1 CodeableConcept Approver role
Binding: hl7VS-providerRole - AU Extended (extensible)
Required Pattern: At least the following
Immunization.Slices for performer.performer:approvedBy.function.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:approvedBy.function.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:approvedBy.function.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Immunization.Slices for performer.performer:approvedBy.function.coding.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:approvedBy.function.coding.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:approvedBy.function.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
Immunization.Slices for performer.performer:approvedBy.function.coding.version 0..1 string Version of the system - if relevant
Immunization.Slices for performer.performer:approvedBy.function.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: OP
Immunization.Slices for performer.performer:approvedBy.function.coding.display 0..1 string Representation defined by the system
Immunization.Slices for performer.performer:approvedBy.function.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Immunization.Slices for performer.performer:approvedBy.function.text 0..1 string Plain text representation of the concept
Immunization.Slices for performer.performer:approvedBy.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Approver
Immunization.note This element has obligations and must be supported. This element is included in summaries. 0..* Annotation Additional immunization notes
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.reasonCode 0..* CodeableConcept Why immunization occurred
Binding: Reason Vaccine Administered (preferred)
Immunization.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
Immunization.education.id 0..1 string Unique id for inter-element referencing
Immunization.education.extension 0..* Extension Additional content defined by implementations
Immunization.education.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType 0..1 string Educational material document identifier
Immunization.education.reference 0..1 uri Educational material reference pointer
Immunization.education.publicationDate 0..1 dateTime Educational material publication date
Immunization.education.presentationDate 0..1 dateTime Educational material presentation date
Immunization.programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.id 0..1 string Unique id for inter-element referencing
Immunization.reaction.extension 0..* Extension Additional content defined by implementations
Immunization.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.detail 0..1 Reference(Observation) Additional information on reaction
Immunization.reaction.reported 0..1 boolean Indicates self-reported reaction
Immunization.protocolApplied 0..* BackboneElement Protocol followed by the provider
Immunization.protocolApplied.id 0..1 string Unique id for inter-element referencing
Immunization.protocolApplied.extension 0..* Extension Additional content defined by implementations
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series 0..1 string Name of vaccine series
Immunization.protocolApplied.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: Vaccination Target Disease (preferred)
Immunization.protocolApplied.doseNumber[x] 1..1 Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString string
Immunization.protocolApplied.seriesDoses[x] 0..1 Recommended number of doses for immunity
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.protocolApplied.seriesDoses[x].seriesDosesString string

doco 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 📦7.0.0-ci-build AU Base Implementation Guide vnull
Immunization.performer:administeredBy.​function Base extensible hl7VS-providerRole - AU Extended 📦7.0.0-ci-build AU Base Implementation Guide vnull
Immunization.performer:approvedBy.​function Base extensible hl7VS-providerRole - AU Extended 📦7.0.0-ci-build AU Base Implementation Guide vnull
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()
sqty-1 error Immunization.doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from AUCoreImmunization

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* AUCoreImmunization An immunisation statement in an Australian healthcare context
This profile also complies with the profile Immunization (IPS)
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.Slices for extension Content/Rules for all slices
Immunization.Slices for extension.extension:vaccineVialSerialNumber 0..1 string Vaccine vial serial number
URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.status This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.vaccineCode This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConceptIPS Vaccine product administered
Binding: VaccineAdministeredValueSet (example)
Additional BindingsPurpose
Australian Medicines Terminology Vaccine Preferred
Australian Immunisation Register Vaccine Preferred
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.vaccineCode.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
Immunization.vaccineCode.Slices for coding.coding:amtVaccineCode This element has obligations and must be supported. This element is included in summaries. 0..1 Coding Code defined by a terminology system
Binding: Australian Medicines Terminology Vaccine (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Immunization.vaccineCode.Slices for coding.coding:airVaccineCode This element has obligations and must be supported. This element is included in summaries. 0..1 Coding Code defined by a terminology system
Binding: Australian Immunisation Register Vaccine (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Immunization.patient This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) Who was immunized
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.patient.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
Immunization.occurrence[x] This element has obligations and must be supported. This element is included in summaries. 1..1 Vaccine administration date
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.occurrence[x].occurrenceDateTime dateTime This target must be supported.
Immunization.occurrence[x].occurrenceString string
Immunization.primarySource This element has obligations and must be supported. This element is included in summaries. 0..1 boolean Indicates context the data was recorded in
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.lotNumber This element has obligations and must be supported. 0..1 string Vaccine lot number
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.Slices for performer This element is included in summaries. 0..* BackboneElement Who performed event
Slice: Unordered, Open by pattern:function

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for performer.performer:All Slices Content/Rules for all slices
Immunization.Slices for performer.performer:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.performer:All Slices.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
Immunization.Slices for performer.performer:administeredBy This element is included in summaries. 0..1 BackboneElement Immunisation Administered By
Immunization.Slices for performer.performer:administeredBy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.performer:administeredBy.function This element is included in summaries. 1..1 CodeableConcept Administering role
Binding: hl7VS-providerRole - AU Extended (extensible)
Required Pattern: At least the following
Immunization.Slices for performer.performer:administeredBy.function.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeredBy.function.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeredBy.function.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Immunization.Slices for performer.performer:administeredBy.function.coding.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeredBy.function.coding.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeredBy.function.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
Immunization.Slices for performer.performer:administeredBy.function.coding.version 0..1 string Version of the system - if relevant
Immunization.Slices for performer.performer:administeredBy.function.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
Immunization.Slices for performer.performer:administeredBy.function.coding.display 0..1 string Representation defined by the system
Immunization.Slices for performer.performer:administeredBy.function.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Immunization.Slices for performer.performer:administeredBy.function.text 0..1 string Plain text representation of the concept
Immunization.Slices for performer.performer:administeredBy.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Administering performer
Immunization.Slices for performer.performer:approvedBy This element is included in summaries. 0..1 BackboneElement Immunisation Approved By
Immunization.Slices for performer.performer:approvedBy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.performer:approvedBy.function This element is included in summaries. 1..1 CodeableConcept Approver role
Binding: hl7VS-providerRole - AU Extended (extensible)
Required Pattern: At least the following
Immunization.Slices for performer.performer:approvedBy.function.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:approvedBy.function.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:approvedBy.function.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Immunization.Slices for performer.performer:approvedBy.function.coding.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:approvedBy.function.coding.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:approvedBy.function.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
Immunization.Slices for performer.performer:approvedBy.function.coding.version 0..1 string Version of the system - if relevant
Immunization.Slices for performer.performer:approvedBy.function.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: OP
Immunization.Slices for performer.performer:approvedBy.function.coding.display 0..1 string Representation defined by the system
Immunization.Slices for performer.performer:approvedBy.function.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Immunization.Slices for performer.performer:approvedBy.function.text 0..1 string Plain text representation of the concept
Immunization.Slices for performer.performer:approvedBy.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Approver
Immunization.note This element has obligations and must be supported. This element is included in summaries. 0..* Annotation Additional immunization notes
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency

doco 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 📦7.0.0-ci-build AU Base Implementation Guide vnull
Immunization.performer:approvedBy.​function Base extensible hl7VS-providerRole - AU Extended 📦7.0.0-ci-build AU Base Implementation Guide vnull

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* AUCoreImmunization An immunisation statement in an Australian healthcare context
This profile also complies with the profile Immunization (IPS)
Immunization.status This element has obligations. 1..1 code completed | entered-in-error | not-done
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.vaccineCode This element has obligations. 1..1 CodeableConceptIPS Vaccine product administered
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.vaccineCode.Slices for coding Content/Rules for all slices
Immunization.vaccineCode.Slices for coding.coding:amtVaccineCode This element has obligations. 0..1 Coding Code defined by a terminology system
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Immunization.vaccineCode.Slices for coding.coding:airVaccineCode This element has obligations. 0..1 Coding Code defined by a terminology system
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Immunization.patient This element has obligations. 1..1 Reference(AU PS Patient) Who was immunized
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.patient.reference This element has obligations and must be supported. 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
Immunization.occurrence[x] This element has obligations. 1..1 Vaccine administration date
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.primarySource This element has obligations. 0..1 boolean Indicates context the data was recorded in
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.lotNumber This element has obligations. 0..1 string Vaccine lot number
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.note This element has obligations. 0..* Annotation Additional immunization notes
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* AUCoreImmunization An immunisation statement in an Australian healthcare context
This profile also complies with the profile Immunization (IPS)
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Immunization.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
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:vaccineVialSerialNumber 0..1 string Vaccine vial serial number
URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.identifier 0..* Identifier Business identifier
Immunization.status This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: Reason Vaccine Not Administered (preferred)
Immunization.vaccineCode This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConceptIPS Vaccine product administered
Binding: VaccineAdministeredValueSet (example)
Additional BindingsPurpose
Australian Medicines Terminology Vaccine Preferred
Australian Immunisation Register Vaccine Preferred
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.vaccineCode.id 0..1 string Unique id for inter-element referencing
Immunization.vaccineCode.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
Immunization.vaccineCode.Slices for coding.coding:amtVaccineCode This element has obligations and must be supported. This element is included in summaries. 0..1 Coding Code defined by a terminology system
Binding: Australian Medicines Terminology Vaccine (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Immunization.vaccineCode.Slices for coding.coding:airVaccineCode This element has obligations and must be supported. This element is included in summaries. 0..1 Coding Code defined by a terminology system
Binding: Australian Immunisation Register Vaccine (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Immunization.vaccineCode.text This element is included in summaries. 0..1 string Plain text representation of the concept
Immunization.patient This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) Who was immunized
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.patient.id 0..1 string Unique id for inter-element referencing
Immunization.patient.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.patient.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
Immunization.patient.type This element is included in summaries. 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).
Immunization.patient.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Immunization.patient.display This element is included in summaries. 0..1 string Text alternative for the resource
Immunization.encounter 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element has obligations and must be supported. This element is included in summaries. 1..1 Vaccine administration date
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.occurrence[x].occurrenceDateTime dateTime This target must be supported.
Immunization.occurrence[x].occurrenceString string
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource This element has obligations and must be supported. This element is included in summaries. 0..1 boolean Indicates context the data was recorded in
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
Immunization.location 0..1 Reference(Location) Where immunization occurred
Immunization.manufacturer 0..1 Reference(Organization) Vaccine manufacturer
Immunization.lotNumber This element has obligations and must be supported. 0..1 string Vaccine lot number
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.expirationDate 0..1 date Vaccine expiration date
Immunization.site 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunisation Anatomical Site (preferred)
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: Immunisation Route of Administration (preferred)
Immunization.doseQuantity C 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
Constraints: sqty-1
Immunization.Slices for performer This element is included in summaries. 0..* BackboneElement Who performed event
Slice: Unordered, Open by pattern:function

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for performer.performer:All Slices Content/Rules for all slices
Immunization.Slices for performer.performer:All Slices.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:All Slices.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.performer:All Slices.function This element is included in summaries. 0..1 CodeableConcept What type of performance was done
Binding: hl7VS-providerRole - AU Extended (extensible)
Immunization.Slices for performer.performer:All Slices.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
Immunization.Slices for performer.performer:administeredBy This element is included in summaries. 0..1 BackboneElement Immunisation Administered By
Immunization.Slices for performer.performer:administeredBy.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeredBy.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeredBy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.performer:administeredBy.function This element is included in summaries. 1..1 CodeableConcept Administering role
Binding: hl7VS-providerRole - AU Extended (extensible)
Required Pattern: At least the following
Immunization.Slices for performer.performer:administeredBy.function.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeredBy.function.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeredBy.function.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Immunization.Slices for performer.performer:administeredBy.function.coding.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeredBy.function.coding.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeredBy.function.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
Immunization.Slices for performer.performer:administeredBy.function.coding.version 0..1 string Version of the system - if relevant
Immunization.Slices for performer.performer:administeredBy.function.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
Immunization.Slices for performer.performer:administeredBy.function.coding.display 0..1 string Representation defined by the system
Immunization.Slices for performer.performer:administeredBy.function.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Immunization.Slices for performer.performer:administeredBy.function.text 0..1 string Plain text representation of the concept
Immunization.Slices for performer.performer:administeredBy.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Administering performer
Immunization.Slices for performer.performer:approvedBy This element is included in summaries. 0..1 BackboneElement Immunisation Approved By
Immunization.Slices for performer.performer:approvedBy.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:approvedBy.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:approvedBy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.performer:approvedBy.function This element is included in summaries. 1..1 CodeableConcept Approver role
Binding: hl7VS-providerRole - AU Extended (extensible)
Required Pattern: At least the following
Immunization.Slices for performer.performer:approvedBy.function.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:approvedBy.function.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:approvedBy.function.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Immunization.Slices for performer.performer:approvedBy.function.coding.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:approvedBy.function.coding.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:approvedBy.function.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
Immunization.Slices for performer.performer:approvedBy.function.coding.version 0..1 string Version of the system - if relevant
Immunization.Slices for performer.performer:approvedBy.function.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: OP
Immunization.Slices for performer.performer:approvedBy.function.coding.display 0..1 string Representation defined by the system
Immunization.Slices for performer.performer:approvedBy.function.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Immunization.Slices for performer.performer:approvedBy.function.text 0..1 string Plain text representation of the concept
Immunization.Slices for performer.performer:approvedBy.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Approver
Immunization.note This element has obligations and must be supported. This element is included in summaries. 0..* Annotation Additional immunization notes
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Immunization.reasonCode 0..* CodeableConcept Why immunization occurred
Binding: Reason Vaccine Administered (preferred)
Immunization.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
Immunization.education.id 0..1 string Unique id for inter-element referencing
Immunization.education.extension 0..* Extension Additional content defined by implementations
Immunization.education.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType 0..1 string Educational material document identifier
Immunization.education.reference 0..1 uri Educational material reference pointer
Immunization.education.publicationDate 0..1 dateTime Educational material publication date
Immunization.education.presentationDate 0..1 dateTime Educational material presentation date
Immunization.programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.id 0..1 string Unique id for inter-element referencing
Immunization.reaction.extension 0..* Extension Additional content defined by implementations
Immunization.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.detail 0..1 Reference(Observation) Additional information on reaction
Immunization.reaction.reported 0..1 boolean Indicates self-reported reaction
Immunization.protocolApplied 0..* BackboneElement Protocol followed by the provider
Immunization.protocolApplied.id 0..1 string Unique id for inter-element referencing
Immunization.protocolApplied.extension 0..* Extension Additional content defined by implementations
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series 0..1 string Name of vaccine series
Immunization.protocolApplied.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: Vaccination Target Disease (preferred)
Immunization.protocolApplied.doseNumber[x] 1..1 Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString string
Immunization.protocolApplied.seriesDoses[x] 0..1 Recommended number of doses for immunity
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.protocolApplied.seriesDoses[x].seriesDosesString string

doco 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 📦7.0.0-ci-build AU Base Implementation Guide vnull
Immunization.performer:administeredBy.​function Base extensible hl7VS-providerRole - AU Extended 📦7.0.0-ci-build AU Base Implementation Guide vnull
Immunization.performer:approvedBy.​function Base extensible hl7VS-providerRole - AU Extended 📦7.0.0-ci-build AU Base Implementation Guide vnull
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()
sqty-1 error Immunization.doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from AUCoreImmunization

 

Other representations of profile: CSV, Excel, Schematron