Australian Base Implementation Guide (AU Base 2)
This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
AU Base Immunisation [FMM Level 3]
This profile defines an immunisation structure including core localisation concepts for use in an Australian context.
Examples
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
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-immunization
This profile defines an immunisation structure including core localisation concepts for use in an Australian context.
This profile builds on Immunization.
This profile was published on Tue Oct 22 00:00:00 AEDT 2019 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 | 1..1 | CodeableConcept | Vaccine product for administration | |
   coding | 0..* | (Slice Definition) | 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 | |
| patient | 1..1 | Reference(Patient) | Patient immunised | |
| primarySource | 0..1 | boolean | Optional information source | |
| manufacturer | 0..1 | Reference(Organization) | Vaccine product manufacturer | |
| site | 0..1 | CodeableConcept | Body site vaccine was administered | |
| coding | 0..1 | Coding | Code defined by a terminology system Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required) | |
| route | 0..1 | CodeableConcept | Route of vaccination | |
| coding | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:snomedRoute | 0..1 | Coding | Immunisation Route of Administration (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required) | |
| performer | 0..* | (Slice Definition) | Who performed event Slice: Unordered, Open by value:function | |
| performer:All Slices | Content/Rules for all slices | |||
| function | 0..1 | CodeableConcept | What type of performance was done Binding: v2 Provider Role - AU Extended (extensible) | |
| performer:administeredBy | 0..1 | BackboneElement | Immunisation Administered By | |
 function | 1..1 | CodeableConcept | Administering role | |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Administering Provider | |
| text | 1..1 | string | Plain text representation of the concept Fixed Value: Administering Provider | |
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | |
| performer:approvedBy | 0..1 | BackboneElement | Immunisation Approved By | |
| function | 1..1 | CodeableConcept | Approver role | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Ordering Provider | |
| text | 1..1 | string | Plain text representation of the concept Fixed Value: Ordering Provider | |
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approving practitioner | |
| reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) | |
| protocolApplied | 0..* | BackboneElement | Vaccination protocol | |
| targetDisease | 0..* | CodeableConcept | Vaccine disease target | |
| coding | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:snomedTargetDisease | 0..1 | Coding | Vaccination Target Disease (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required) | |
| coding:targetDiseaseNoInformation | 0..1 | Coding | No Information for Target Disease Fixed Value: As shown | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v3/NullFlavor | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | |
| display | 1..1 | string | Representation defined by the system Fixed Value: NoInformation | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | I | 0..* | Immunization | An immunisation statement in an Australian healthcare context |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | I | 0..* | Identifier | Business identifier |
| status | ?!ΣI | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) |
| statusReason | I | 0..1 | CodeableConcept | Reason not done Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred) |
| vaccineCode | ΣI | 1..1 | CodeableConcept | Vaccine product for administration Binding: VaccineAdministeredValueSet (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:amtVaccineCode | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 0..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:airVaccineCode | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 0..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
 patient | ΣI | 1..1 | Reference(Patient) | Patient immunised |
| encounter | I | 0..1 | Reference(Encounter) | Encounter immunization was part of |
 occurrence[x] | ΣI | 1..1 | Vaccine administration date | |
| occurrenceDateTime | dateTime | |||
| occurrenceString | string | |||
| recorded | I | 0..1 | dateTime | When the immunization was first captured in the subject's record |
| primarySource | ΣI | 0..1 | boolean | Optional information source |
| reportOrigin | I | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example) |
| location | I | 0..1 | Reference(Location) | Where immunization occurred |
| manufacturer | I | 0..1 | Reference(Organization) | Vaccine product manufacturer |
| lotNumber | I | 0..1 | string | Vaccine lot number |
| expirationDate | I | 0..1 | date | Vaccine expiration date |
| site | I | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..1 | Coding | Code defined by a terminology system Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required) |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| route | I | 0..1 | CodeableConcept | Route of vaccination Binding: ImmunizationRouteCodes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedRoute | ΣI | 0..1 | Coding | Immunisation Route of Administration (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required) |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| doseQuantity | I | 0..1 | SimpleQuantity | Amount of vaccine administered |
| performer | ΣI | 0..* | (Slice Definition) | Who performed event Slice: Unordered, Open by value:function |
| performer:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | ΣI | 0..1 | CodeableConcept | What type of performance was done Binding: v2 Provider Role - AU Extended (extensible) |
| actor | ΣI | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
| performer:administeredBy | ΣI | 0..1 | BackboneElement | Immunisation Administered By |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | ΣI | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0443 | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Administering Provider | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | ΣI | 1..1 | string | Plain text representation of the concept Fixed Value: Administering Provider |
| actor | ΣI | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer |
| performer:approvedBy | ΣI | 0..1 | BackboneElement | Immunisation Approved By |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | ΣI | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0443 | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Ordering Provider | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | ΣI | 1..1 | string | Plain text representation of the concept Fixed Value: Ordering Provider |
| actor | ΣI | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approving practitioner |
| note | ΣI | 0..* | Annotation | Additional immunization notes |
| reasonCode | I | 0..* | CodeableConcept | Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) |
| reasonReference | I | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred |
| isSubpotent | ?!ΣI | 0..1 | boolean | Dose potency |
| subpotentReason | I | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example) |
| education | I | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| documentType | I | 0..1 | string | Educational material document identifier |
| reference | I | 0..1 | uri | Educational material reference pointer |
| publicationDate | I | 0..1 | dateTime | Educational material publication date |
| presentationDate | I | 0..1 | dateTime | Educational material presentation date |
| programEligibility | I | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example) |
| fundingSource | I | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example) |
| reaction | I | 0..* | BackboneElement | Details of a reaction that follows immunization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| date | I | 0..1 | dateTime | When reaction started |
| detail | I | 0..1 | Reference(Observation) | Additional information on reaction |
| reported | I | 0..1 | boolean | Indicates self-reported reaction |
| protocolApplied | I | 0..* | BackboneElement | Vaccination protocol |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| series | I | 0..1 | string | Name of vaccine series |
| authority | I | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations |
| targetDisease | I | 0..* | CodeableConcept | Vaccine disease target Binding: ImmunizationTargetDiseaseCodes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedTargetDisease | ΣI | 0..1 | Coding | Vaccination Target Disease (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required) |
| coding:targetDiseaseNoInformation | ΣI | 0..1 | Coding | No Information for Target Disease Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v3/NullFlavor | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | |
| display | 1..1 | string | Representation defined by the system Fixed Value: NoInformation | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| doseNumber[x] | I | 1..1 | Dose number within series | |
| doseNumberPositiveInt | positiveInt | |||
| doseNumberString | string | |||
| seriesDoses[x] | I | 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 | 1..1 | CodeableConcept | Vaccine product for administration | |
| coding | 0..* | (Slice Definition) | 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 | |
| patient | 1..1 | Reference(Patient) | Patient immunised | |
| primarySource | 0..1 | boolean | Optional information source | |
| manufacturer | 0..1 | Reference(Organization) | Vaccine product manufacturer | |
| site | 0..1 | CodeableConcept | Body site vaccine was administered | |
| coding | 0..1 | Coding | Code defined by a terminology system Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required) | |
| route | 0..1 | CodeableConcept | Route of vaccination | |
| coding | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:snomedRoute | 0..1 | Coding | Immunisation Route of Administration (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required) | |
| performer | 0..* | (Slice Definition) | Who performed event Slice: Unordered, Open by value:function | |
| performer:All Slices | Content/Rules for all slices | |||
| function | 0..1 | CodeableConcept | What type of performance was done Binding: v2 Provider Role - AU Extended (extensible) | |
| performer:administeredBy | 0..1 | BackboneElement | Immunisation Administered By | |
| function | 1..1 | CodeableConcept | Administering role | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Administering Provider | |
| text | 1..1 | string | Plain text representation of the concept Fixed Value: Administering Provider | |
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | |
| performer:approvedBy | 0..1 | BackboneElement | Immunisation Approved By | |
| function | 1..1 | CodeableConcept | Approver role | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Ordering Provider | |
| text | 1..1 | string | Plain text representation of the concept Fixed Value: Ordering Provider | |
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approving practitioner | |
| reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) | |
| protocolApplied | 0..* | BackboneElement | Vaccination protocol | |
| targetDisease | 0..* | CodeableConcept | Vaccine disease target | |
| coding | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:snomedTargetDisease | 0..1 | Coding | Vaccination Target Disease (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required) | |
| coding:targetDiseaseNoInformation | 0..1 | Coding | No Information for Target Disease Fixed Value: As shown | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v3/NullFlavor | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | |
| display | 1..1 | string | Representation defined by the system Fixed Value: NoInformation | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | I | 0..* | Immunization | An immunisation statement in an Australian healthcare context |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | I | 0..* | Identifier | Business identifier |
| status | ?!ΣI | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) |
| statusReason | I | 0..1 | CodeableConcept | Reason not done Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred) |
| vaccineCode | ΣI | 1..1 | CodeableConcept | Vaccine product for administration Binding: VaccineAdministeredValueSet (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:amtVaccineCode | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 0..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:airVaccineCode | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 0..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| patient | ΣI | 1..1 | Reference(Patient) | Patient immunised |
| encounter | I | 0..1 | Reference(Encounter) | Encounter immunization was part of |
| occurrence[x] | ΣI | 1..1 | Vaccine administration date | |
| occurrenceDateTime | dateTime | |||
| occurrenceString | string | |||
| recorded | I | 0..1 | dateTime | When the immunization was first captured in the subject's record |
| primarySource | ΣI | 0..1 | boolean | Optional information source |
| reportOrigin | I | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example) |
| location | I | 0..1 | Reference(Location) | Where immunization occurred |
| manufacturer | I | 0..1 | Reference(Organization) | Vaccine product manufacturer |
| lotNumber | I | 0..1 | string | Vaccine lot number |
| expirationDate | I | 0..1 | date | Vaccine expiration date |
| site | I | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..1 | Coding | Code defined by a terminology system Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required) |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| route | I | 0..1 | CodeableConcept | Route of vaccination Binding: ImmunizationRouteCodes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedRoute | ΣI | 0..1 | Coding | Immunisation Route of Administration (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required) |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| doseQuantity | I | 0..1 | SimpleQuantity | Amount of vaccine administered |
| performer | ΣI | 0..* | (Slice Definition) | Who performed event Slice: Unordered, Open by value:function |
| performer:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | ΣI | 0..1 | CodeableConcept | What type of performance was done Binding: v2 Provider Role - AU Extended (extensible) |
| actor | ΣI | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
| performer:administeredBy | ΣI | 0..1 | BackboneElement | Immunisation Administered By |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | ΣI | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0443 | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Administering Provider | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | ΣI | 1..1 | string | Plain text representation of the concept Fixed Value: Administering Provider |
| actor | ΣI | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer |
| performer:approvedBy | ΣI | 0..1 | BackboneElement | Immunisation Approved By |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | ΣI | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0443 | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Ordering Provider | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | ΣI | 1..1 | string | Plain text representation of the concept Fixed Value: Ordering Provider |
| actor | ΣI | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approving practitioner |
| note | ΣI | 0..* | Annotation | Additional immunization notes |
| reasonCode | I | 0..* | CodeableConcept | Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) |
| reasonReference | I | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred |
| isSubpotent | ?!ΣI | 0..1 | boolean | Dose potency |
| subpotentReason | I | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example) |
| education | I | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| documentType | I | 0..1 | string | Educational material document identifier |
| reference | I | 0..1 | uri | Educational material reference pointer |
| publicationDate | I | 0..1 | dateTime | Educational material publication date |
| presentationDate | I | 0..1 | dateTime | Educational material presentation date |
| programEligibility | I | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example) |
| fundingSource | I | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example) |
| reaction | I | 0..* | BackboneElement | Details of a reaction that follows immunization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| date | I | 0..1 | dateTime | When reaction started |
| detail | I | 0..1 | Reference(Observation) | Additional information on reaction |
| reported | I | 0..1 | boolean | Indicates self-reported reaction |
| protocolApplied | I | 0..* | BackboneElement | Vaccination protocol |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| series | I | 0..1 | string | Name of vaccine series |
| authority | I | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations |
| targetDisease | I | 0..* | CodeableConcept | Vaccine disease target Binding: ImmunizationTargetDiseaseCodes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedTargetDisease | ΣI | 0..1 | Coding | Vaccination Target Disease (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required) |
| coding:targetDiseaseNoInformation | ΣI | 0..1 | Coding | No Information for Target Disease Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v3/NullFlavor | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | |
| display | 1..1 | string | Representation defined by the system Fixed Value: NoInformation | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| doseNumber[x] | I | 1..1 | Dose number within series | |
| doseNumberPositiveInt | positiveInt | |||
| doseNumberString | string | |||
| seriesDoses[x] | I | 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 2 on FHIR R4 (IG Publisher v4.0.1-a53ec6ee1b) generated on Thu, Jul 30, 2020 13:57+1000. |
