Smart Health Checks
0.3.0 - ci-build
Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions
Official URL: https://smartforms.csiro.au/ig/StructureDefinition/SHCImmunization | Version: 0.3.0 | |||
Draft as of 2025-09-05 | Computable Name: SmartHealthChecksImmunization | |||
Copyright/Legal: Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/. |
This profile sets the minimum expectations for an Immunization resource to record, search and save immunization information when used within Smart Health Checks.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreImmunization | An immunisation statement in an Australian healthcare context | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||||||||
![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||||
![]() ![]() ![]() |
?!SOΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Immunisation Register Vaccine ![]()
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who was immunized
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this
| ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
dateTime | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | dateTime | Vaccine administration date
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | boolean | Indicates context the data was recorded in
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
SO | 0..1 | string | Vaccine lot number
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Immunisation Administered By | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Administering role Binding: hl7VS-providerRole - AU Extended (extensible) Required Pattern: At least the following | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Immunisation Approved By | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Approver role Binding: hl7VS-providerRole - AU Extended (extensible) Required Pattern: At least the following | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | Annotation | Additional immunization notes
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency | |||||||||||||||||||||||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 From the FHIR Standard | |
Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-code From the FHIR Standard | |
Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccinehttps://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 From this IG | |
Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine ![]() https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats )https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | |
Immunization.performer:administeredBy.function | extensible | Pattern Value: APhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | |
Immunization.performer:approvedBy.function | extensible | Pattern Value: OPhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended |
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() |
This structure is derived from AUCoreImmunization
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreImmunization | An immunisation statement in an Australian healthcare context | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | |||||||||||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||||||||||||
![]() ![]() ![]() |
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 | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | Identifier | Business identifier | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
?!SOΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered ![]() | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Immunisation Register Vaccine ![]()
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who was immunized
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this
| ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
dateTime | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | dateTime | Vaccine administration date
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | When the immunization was first captured in the subject's record | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | boolean | Indicates context the data was recorded in
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
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. | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Where immunization occurred | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Vaccine manufacturer | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
SO | 0..1 | string | Vaccine lot number
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | date | Vaccine expiration date | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Immunisation Anatomical Site ![]() | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration ![]() | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | SimpleQuantity | Amount of vaccine administered | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Immunisation Administered By | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Administering role Binding: hl7VS-providerRole - AU Extended (extensible) Required Pattern: At least the following | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Immunisation Approved By | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Approver role Binding: hl7VS-providerRole - AU Extended (extensible) Required Pattern: At least the following | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | Annotation | Additional immunization notes
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the annotation was made | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered ![]() | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency | |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Educational material document identifier | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | uri | Educational material reference pointer | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Educational material publication date | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Educational material presentation date | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | BackboneElement | Details of a reaction that follows immunization | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When reaction started | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Observation) | Additional information on reaction | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Indicates self-reported reaction | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Name of vaccine series | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccination Target Disease ![]() | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | Dose number within series | |||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | |||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||||||||||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Immunization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 From the FHIR Standard | ||||
Immunization.statusReason | preferred | ReasonVaccineNotAdministered ![]() https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 | ||||
Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-code From the FHIR Standard | ||||
Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccinehttps://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 From this IG | ||||
Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine ![]() https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats )https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin From the FHIR Standard | ||||
Immunization.site | preferred | ImmunisationAnatomicalSite ![]() https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 | ||||
Immunization.route | preferred | ImmunisationRouteOfAdministration ![]() https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 | ||||
Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | ||||
Immunization.performer:administeredBy.function | extensible | Pattern Value: APhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | ||||
Immunization.performer:approvedBy.function | extensible | Pattern Value: OPhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | ||||
Immunization.reasonCode | preferred | ReasonVaccineAdministered ![]() https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason From the FHIR Standard | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility From the FHIR Standard | ||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source From the FHIR Standard | ||||
Immunization.protocolApplied.targetDisease | preferred | VaccinationTargetDisease ![]() https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 |
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 AUCoreImmunization
Summary
Must-Support: 3 elements
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreImmunization | An immunisation statement in an Australian healthcare context | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||||||||
![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||||
![]() ![]() ![]() |
?!SOΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Immunisation Register Vaccine ![]()
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who was immunized
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this
| ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
dateTime | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | dateTime | Vaccine administration date
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | boolean | Indicates context the data was recorded in
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
SO | 0..1 | string | Vaccine lot number
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Immunisation Administered By | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Administering role Binding: hl7VS-providerRole - AU Extended (extensible) Required Pattern: At least the following | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Immunisation Approved By | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Approver role Binding: hl7VS-providerRole - AU Extended (extensible) Required Pattern: At least the following | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | Annotation | Additional immunization notes
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency | |||||||||||||||||||||||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 From the FHIR Standard | |
Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-code From the FHIR Standard | |
Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccinehttps://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 From this IG | |
Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine ![]() https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats )https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | |
Immunization.performer:administeredBy.function | extensible | Pattern Value: APhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | |
Immunization.performer:approvedBy.function | extensible | Pattern Value: OPhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended |
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() |
Differential View
This structure is derived from AUCoreImmunization
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
AUCoreImmunization | |||||||||||||
![]() ![]() ![]() |
O | 1..1 | code | completed | entered-in-error | not-done
| ||||||||||
![]() ![]() ![]() |
O | 1..1 | CodeableConcept | Vaccine product administered
| ||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
O | 0..1 | Coding | Code defined by a terminology system
| ||||||||||
![]() ![]() ![]() |
O | 1..1 | Reference(AU Core Patient) | Who was immunized
| ||||||||||
![]() ![]() ![]() |
1..1 | dateTime, string | Vaccine administration date Slice: Unordered, Open by type:$this | |||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | dateTime | Vaccine administration date
| ||||||||||
![]() ![]() ![]() |
SO | 0..1 | string | Vaccine lot number
| ||||||||||
![]() ![]() ![]() |
||||||||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | markdown | The annotation - text content (as markdown)
| ||||||||||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreImmunization | An immunisation statement in an Australian healthcare context | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | |||||||||||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||||||||||||
![]() ![]() ![]() |
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 | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | Identifier | Business identifier | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
?!SOΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered ![]() | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: Australian Immunisation Register Vaccine ![]()
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who was immunized
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this
| ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
dateTime | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | dateTime | Vaccine administration date
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | When the immunization was first captured in the subject's record | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | boolean | Indicates context the data was recorded in
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
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. | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Where immunization occurred | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Vaccine manufacturer | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
SO | 0..1 | string | Vaccine lot number
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | date | Vaccine expiration date | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Immunisation Anatomical Site ![]() | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration ![]() | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | SimpleQuantity | Amount of vaccine administered | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Immunisation Administered By | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Administering role Binding: hl7VS-providerRole - AU Extended (extensible) Required Pattern: At least the following | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Immunisation Approved By | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Approver role Binding: hl7VS-providerRole - AU Extended (extensible) Required Pattern: At least the following | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | |||||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | Annotation | Additional immunization notes
| |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the annotation was made | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered ![]() | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency | |||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Educational material document identifier | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | uri | Educational material reference pointer | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Educational material publication date | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Educational material presentation date | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | BackboneElement | Details of a reaction that follows immunization | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When reaction started | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Observation) | Additional information on reaction | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Indicates self-reported reaction | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Name of vaccine series | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccination Target Disease ![]() | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | Dose number within series | |||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | |||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | ||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||||||||||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Immunization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 From the FHIR Standard | ||||
Immunization.statusReason | preferred | ReasonVaccineNotAdministered ![]() https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 | ||||
Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-code From the FHIR Standard | ||||
Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccinehttps://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 From this IG | ||||
Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine ![]() https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats )https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin From the FHIR Standard | ||||
Immunization.site | preferred | ImmunisationAnatomicalSite ![]() https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 | ||||
Immunization.route | preferred | ImmunisationRouteOfAdministration ![]() https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 | ||||
Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | ||||
Immunization.performer:administeredBy.function | extensible | Pattern Value: APhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | ||||
Immunization.performer:approvedBy.function | extensible | Pattern Value: OPhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | ||||
Immunization.reasonCode | preferred | ReasonVaccineAdministered ![]() https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason From the FHIR Standard | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility From the FHIR Standard | ||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source From the FHIR Standard | ||||
Immunization.protocolApplied.targetDisease | preferred | VaccinationTargetDisease ![]() https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 |
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 AUCoreImmunization
Summary
Must-Support: 3 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron