AU Patient Summary Implementation Guide
0.1.0-preview - Preview
This page is part of the AU Patient Summary (v0.1.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-immunization | Version: 0.1.0-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUPSImmunization | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for an Immunization resource in the context of a patient summary in an Australian context. It is based on the AU Base Immunisation profile, and applies the constraints of AU Core Immunization and Immunization (IPS).
See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseImmunisation
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization | |
![]() ![]() |
S | 1..1 | code | completed | entered-in-error | not-done |
![]() ![]() |
S | 1..1 | CodeableConceptIPS | Vaccine product administered |
![]() ![]() ![]() |
0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() |
S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required) |
![]() ![]() |
S | 1..1 | Reference(AU PS Patient) | Who was immunized |
![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
S | 1..1 | dateTime, string | Vaccine administration date |
![]() ![]() |
S | 0..1 | boolean | Indicates context the data was recorded in |
![]() ![]() |
S | 0..* | Annotation | Additional immunization notes |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccine ![]() https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 | |
| Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() |
0..1 | string | Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() |
?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
SΣ | 1..1 | CodeableConceptIPS | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
S | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
SΣ | 1..1 | Reference(AU PS Patient) | Who was immunized ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
SΣ | 1..1 | Vaccine administration date ele-1: All FHIR elements must have a @value or children | |||||||
![]() ![]() ![]() |
dateTime | |||||||||
![]() ![]() ![]() |
string | |||||||||
![]() ![]() |
SΣ | 0..1 | boolean | Indicates context the data was recorded in ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Immunisation Administered By ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Administering role Binding: hl7VS-providerRole - AU Extended (extensible) ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | ||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Immunisation Approved By ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Approver role Binding: hl7VS-providerRole - AU Extended (extensible) ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | ||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
SΣ | 0..* | Annotation | Additional immunization notes ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency ele-1: All FHIR elements must have a @value or children | ||||||
Documentation for this format | ||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1from the FHIR Standard | |
| Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codefrom the FHIR Standard | |
| Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccine ![]() https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 | |
| Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | |
| Immunization.performer:administeredBy.function | extensible | Pattern: APhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | |
| Immunization.performer:approvedBy.function | extensible | Pattern: 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() |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization | |||||||
![]() ![]() |
Σ | 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 | |||||||
![]() ![]() |
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 | |||||||
![]() ![]() |
?!SΣ | 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 (preferred) | |||||||
![]() ![]() |
SΣ | 1..1 | CodeableConceptIPS | 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 | |||||||
![]() ![]() ![]() |
S | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required) | ||||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required) | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||||
![]() ![]() |
SΣ | 1..1 | Reference(AU PS Patient) | Who was immunized | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
![]() ![]() ![]() |
Σ | 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). | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||||
![]() ![]() |
SΣ | 1..1 | Vaccine administration date | |||||||
![]() ![]() ![]() |
dateTime | |||||||||
![]() ![]() ![]() |
string | |||||||||
![]() ![]() |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||||
![]() ![]() |
SΣ | 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 | |||||||
![]() ![]() |
0..1 | string | Vaccine lot number | |||||||
![]() ![]() |
0..1 | date | Vaccine expiration date | |||||||
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Immunisation Anatomical Site (preferred) | |||||||
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (preferred) | |||||||
![]() ![]() |
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 | ||||||
![]() ![]() |
SΣ | 0..* | Annotation | Additional immunization notes | ||||||
![]() ![]() |
0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered (preferred) | |||||||
![]() ![]() |
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 imm-1: One of documentType or reference SHALL be present | ||||||
![]() ![]() ![]() |
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 (preferred) | |||||||
![]() ![]() ![]() |
1..1 | Dose number within series | ||||||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||||
![]() ![]() ![]() ![]() |
string | |||||||||
![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | ||||||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||||
![]() ![]() ![]() ![]() |
string | |||||||||
Documentation for this format | ||||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Immunization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1from 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-codefrom the FHIR Standard | ||||
| Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccine ![]() https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 | ||||
| Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | ||||
| Immunization.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-originfrom 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: APhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | ||||
| Immunization.performer:approvedBy.function | extensible | Pattern: 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-reasonfrom the FHIR Standard | ||||
| Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibilityfrom the FHIR Standard | ||||
| Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-sourcefrom 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 AUBaseImmunisation
Summary
Mandatory: 1 element
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from AUBaseImmunisation
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization | |
![]() ![]() |
S | 1..1 | code | completed | entered-in-error | not-done |
![]() ![]() |
S | 1..1 | CodeableConceptIPS | Vaccine product administered |
![]() ![]() ![]() |
0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() |
S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required) |
![]() ![]() |
S | 1..1 | Reference(AU PS Patient) | Who was immunized |
![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
S | 1..1 | dateTime, string | Vaccine administration date |
![]() ![]() |
S | 0..1 | boolean | Indicates context the data was recorded in |
![]() ![]() |
S | 0..* | Annotation | Additional immunization notes |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccine ![]() https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 | |
| Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() |
0..1 | string | Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() |
?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
SΣ | 1..1 | CodeableConceptIPS | Vaccine product administered Binding: VaccineAdministeredValueSet (example)
ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
S | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required)ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required)ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
SΣ | 1..1 | Reference(AU PS Patient) | Who was immunized ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
SΣ | 1..1 | Vaccine administration date ele-1: All FHIR elements must have a @value or children | |||||||
![]() ![]() ![]() |
dateTime | |||||||||
![]() ![]() ![]() |
string | |||||||||
![]() ![]() |
SΣ | 0..1 | boolean | Indicates context the data was recorded in ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Immunisation Administered By ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Administering role Binding: hl7VS-providerRole - AU Extended (extensible) ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | ||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Immunisation Approved By ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Approver role Binding: hl7VS-providerRole - AU Extended (extensible) ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | ||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
SΣ | 0..* | Annotation | Additional immunization notes ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency ele-1: All FHIR elements must have a @value or children | ||||||
Documentation for this format | ||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1from the FHIR Standard | |
| Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codefrom the FHIR Standard | |
| Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccine ![]() https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 | |
| Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | |
| Immunization.performer:administeredBy.function | extensible | Pattern: APhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | |
| Immunization.performer:approvedBy.function | extensible | Pattern: 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization | |||||||
![]() ![]() |
Σ | 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 | |||||||
![]() ![]() |
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 | |||||||
![]() ![]() |
?!SΣ | 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 (preferred) | |||||||
![]() ![]() |
SΣ | 1..1 | CodeableConceptIPS | 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 | |||||||
![]() ![]() ![]() |
S | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required) | ||||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodingIPS | A reference to a code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required) | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||||
![]() ![]() |
SΣ | 1..1 | Reference(AU PS Patient) | Who was immunized | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
![]() ![]() ![]() |
Σ | 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). | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||||
![]() ![]() |
SΣ | 1..1 | Vaccine administration date | |||||||
![]() ![]() ![]() |
dateTime | |||||||||
![]() ![]() ![]() |
string | |||||||||
![]() ![]() |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||||
![]() ![]() |
SΣ | 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 | |||||||
![]() ![]() |
0..1 | string | Vaccine lot number | |||||||
![]() ![]() |
0..1 | date | Vaccine expiration date | |||||||
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Immunisation Anatomical Site (preferred) | |||||||
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (preferred) | |||||||
![]() ![]() |
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 | ||||||
![]() ![]() |
SΣ | 0..* | Annotation | Additional immunization notes | ||||||
![]() ![]() |
0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered (preferred) | |||||||
![]() ![]() |
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 imm-1: One of documentType or reference SHALL be present | ||||||
![]() ![]() ![]() |
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 (preferred) | |||||||
![]() ![]() ![]() |
1..1 | Dose number within series | ||||||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||||
![]() ![]() ![]() ![]() |
string | |||||||||
![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | ||||||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||||
![]() ![]() ![]() ![]() |
string | |||||||||
Documentation for this format | ||||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Immunization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1from 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-codefrom the FHIR Standard | ||||
| Immunization.vaccineCode.coding:amtVaccineCode | required | AustralianMedicinesTerminologyVaccine ![]() https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 | ||||
| Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | ||||
| Immunization.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-originfrom 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: APhttp://terminology.hl7.org.au/ValueSet/v2-0443-extended | ||||
| Immunization.performer:approvedBy.function | extensible | Pattern: 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-reasonfrom the FHIR Standard | ||||
| Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibilityfrom the FHIR Standard | ||||
| Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-sourcefrom 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 AUBaseImmunisation
Summary
Mandatory: 1 element
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron