Australian Base Implementation Guide
This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions 
AU Base Immunisation [FMM 3]
This profile defines an immunisation structure that localises core concepts, including terminology, for use in an Australian context..
The purpose of this profile is to provide national level agreement on core localised concepts.
This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.
No extensions are used in this profile.
Potentially useful extensions:
Administration of a vaccine - record compliant with Australian Immunisation Register (AIR)
Administration of a vaccine with administering provider and protocol
Non-administration of varicella-zoster live vaccine due to refusal
Administration of Pfizer Comirnaty dose 1 for Sarah Simmons
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-immunization
This profile defines an immunisation structure that localises core concepts, including terminology, for use in an Australian context.
This profile builds on Immunization.
This profile was published on 2022-03-02 as a active by Health Level Seven Australia (Medications WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Immunization | 0..* | Immunization | An immunisation statement in an Australian healthcare context | |
  statusReason | 0..1 | CodeableConcept | Reason not done Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred) | |
| vaccineCode | ||||
   Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
   coding:amtVaccineCode | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred) | |
  system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
 coding:airVaccineCode | 0..1 | Coding | AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | |
| manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |
| site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (preferred) | |
| coding | 0..1 | Coding | Code defined by a terminology system | |
| route | 0..1 | CodeableConcept | How vaccine entered body Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred) | |
| coding | 0..1 | Coding | Code defined by a terminology system | |
| Slices for performer | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | |
| performer:All Slices | Content/Rules for all slices | |||
| function | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | |
| performer:administeredBy | 0..1 | BackboneElement | Immunisation Administered By | |
 function | 1..1 | CodeableConcept | Administering role Required Pattern: At least the following | |
  coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | |
| performer:approvedBy | 0..1 | BackboneElement | Immunisation Approved By | |
| function | 1..1 | CodeableConcept | Approver role Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | |
| reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) | |
| protocolApplied | ||||
| targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization | 0..* | Immunization | An immunisation statement in an Australian healthcare context | |||||
 id | Σ | 0..1 | string | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | Business identifier | |||||
| status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
| statusReason | 0..1 | CodeableConcept | Reason not done Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred) | |||||
| vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
| coding:amtVaccineCode | Σ | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:airVaccineCode | Σ | 0..1 | Coding | AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
 patient | Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
 occurrence[x] | Σ | 1..1 | Vaccine administration date | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrenceString | string | |||||||
| recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
| primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
| reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
| location | 0..1 | Reference(Location) | Where immunization occurred | |||||
| manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| lotNumber | 0..1 | string | Vaccine lot number | |||||
| expirationDate | 0..1 | date | Vaccine expiration date | |||||
| site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (preferred) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| route | 0..1 | CodeableConcept | How vaccine entered body Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||
| Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | ||||
| performer:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | ||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
| performer:administeredBy | Σ | 0..1 | BackboneElement | Immunisation Administered By | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | ||||
| performer:approvedBy | Σ | 0..1 | BackboneElement | Immunisation Approved By | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | ||||
| note | Σ | 0..* | Annotation | Additional immunization notes | ||||
| reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| education | I | 0..* | BackboneElement | Educational material presented to patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| documentType | 0..1 | string | Educational material document identifier | |||||
| reference | 0..1 | uri | Educational material reference pointer | |||||
| publicationDate | 0..1 | dateTime | Educational material publication date | |||||
| presentationDate | 0..1 | dateTime | Educational material presentation date | |||||
| programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
| fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
| reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| date | 0..1 | dateTime | When reaction started | |||||
| detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||
| reported | 0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| series | 0..1 | string | Name of vaccine series | |||||
| authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred) | |||||
| doseNumber[x] | 1..1 | Dose number within series | ||||||
| doseNumberPositiveInt | positiveInt | |||||||
| doseNumberString | string | |||||||
| seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt | positiveInt | |||||||
| seriesDosesString | string | |||||||
| Documentation for this format | ||||||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | 0..* | Immunization | An immunisation statement in an Australian healthcare context | |
| statusReason | 0..1 | CodeableConcept | Reason not done Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred) | |
| vaccineCode | ||||
| Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:amtVaccineCode | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| coding:airVaccineCode | 0..1 | Coding | AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | |
| manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |
| site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (preferred) | |
| coding | 0..1 | Coding | Code defined by a terminology system | |
| route | 0..1 | CodeableConcept | How vaccine entered body Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred) | |
| coding | 0..1 | Coding | Code defined by a terminology system | |
| Slices for performer | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | |
| performer:All Slices | Content/Rules for all slices | |||
| function | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | |
| performer:administeredBy | 0..1 | BackboneElement | Immunisation Administered By | |
| function | 1..1 | CodeableConcept | Administering role Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | |
| performer:approvedBy | 0..1 | BackboneElement | Immunisation Approved By | |
| function | 1..1 | CodeableConcept | Approver role Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | |
| reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) | |
| protocolApplied | ||||
| targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization | 0..* | Immunization | An immunisation statement in an Australian healthcare context | |||||
| id | Σ | 0..1 | string | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | Business identifier | |||||
| status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
| statusReason | 0..1 | CodeableConcept | Reason not done Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred) | |||||
| vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
| coding:amtVaccineCode | Σ | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:airVaccineCode | Σ | 0..1 | Coding | AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| patient | Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| occurrence[x] | Σ | 1..1 | Vaccine administration date | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrenceString | string | |||||||
| recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
| primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
| reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
| location | 0..1 | Reference(Location) | Where immunization occurred | |||||
| manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| lotNumber | 0..1 | string | Vaccine lot number | |||||
| expirationDate | 0..1 | date | Vaccine expiration date | |||||
| site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (preferred) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| route | 0..1 | CodeableConcept | How vaccine entered body Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||
| Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | ||||
| performer:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | ||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
| performer:administeredBy | Σ | 0..1 | BackboneElement | Immunisation Administered By | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | ||||
| performer:approvedBy | Σ | 0..1 | BackboneElement | Immunisation Approved By | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | ||||
| note | Σ | 0..* | Annotation | Additional immunization notes | ||||
| reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| education | I | 0..* | BackboneElement | Educational material presented to patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| documentType | 0..1 | string | Educational material document identifier | |||||
| reference | 0..1 | uri | Educational material reference pointer | |||||
| publicationDate | 0..1 | dateTime | Educational material publication date | |||||
| presentationDate | 0..1 | dateTime | Educational material presentation date | |||||
| programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
| fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
| reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| date | 0..1 | dateTime | When reaction started | |||||
| detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||
| reported | 0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| series | 0..1 | string | Name of vaccine series | |||||
| authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred) | |||||
| doseNumber[x] | 1..1 | Dose number within series | ||||||
| doseNumberPositiveInt | positiveInt | |||||||
| doseNumberString | string | |||||||
| seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt | positiveInt | |||||||
| seriesDosesString | string | |||||||
| Documentation for this format | ||||||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-immunization
none defined
© AU Base on FHIR R4
(IG Publisher v4.0.1-a53ec6ee1b) generated on Mon, May 30, 2022 21:52+1000. |
