Australian Base Implementation Guide (AU Base 1.1.1)
This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. 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 Fri Feb 16 17:10:30 AEDT 2018 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 | |
  vaccineCode | 1..1 | CodeableConcept | Vaccine product for administration | |
   coding | 0..* | (Slice Definition) | 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 | 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 | Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | |
| patient | 1..1 | Reference(Patient) | Patient immunised | |
| primarySource | 1..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 | Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required) | |
| route | 0..1 | CodeableConcept | Route of vaccination | |
| coding | 0..* | (Slice Definition) | 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) | |
| practitioner | 0..* | (Slice Definition) | Immunisation performer(s) Slice: Unordered, Open by value:role.coding | |
| practitioner:All Slices | Content/Rules for all slices | |||
| role | 0..1 | CodeableConcept | Binding: v2 Provider Role - AU Extended (extensible) | |
| practitioner:administeredBy | 0..1 | BackboneElement | Immunisation Administered By | |
 role | 1..1 | CodeableConcept | Administering role | |
 coding | 1..* | Coding | 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 | Fixed Value: Administering Provider | |
| actor | 1..1 | Reference(Practitioner) | Administering practitioner | |
| practitioner:approvedBy | 0..1 | BackboneElement | Immunisation Approved By | |
| role | 1..1 | CodeableConcept | Approver role | |
| coding | 1..* | Coding | 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 | Fixed Value: Ordering Provider | |
| actor | 1..1 | Reference(Practitioner) | Approving practitioner | |
| practitioner:witnessedBy | 0..* | BackboneElement | Immunisation Witnessed By | |
| role | 1..1 | CodeableConcept | Witnessing Role | |
| coding | 1..* | Coding | Fixed Value: As shown | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: WIT | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Witness | |
| text | 1..1 | string | Fixed Value: Witness | |
| actor | 1..1 | Reference(Practitioner) | Witnessing practitioner | |
| explanation | 0..1 | BackboneElement | Explanation for (non)vaccination | |
| reason | 0..* | CodeableConcept | Reason vaccine was given Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) | |
| reasonNotGiven | 0..* | CodeableConcept | Reason vaccine not given Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred) | |
| vaccinationProtocol | 0..* | BackboneElement | Vaccination protocol | |
| targetDisease | 1..* | CodeableConcept | Vaccine disease target | |
| coding | 0..* | (Slice Definition) | 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 | |
| doseStatus | 1..1 | CodeableConcept | Vaccine relation to protocol | |
| coding | 0..* | (Slice Definition) | Slice: Unordered, Open by value:coding | |
| coding:doseStatusNotAvailable | 0..1 | Coding | Dose Status Not Available 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: NAVU | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Not available | |
| 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 | id | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 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 Binding: Immunization Status Codes (required) |
| notGiven | ?!Σ | 1..1 | boolean | Flag for whether immunization was given |
| vaccineCode | 1..1 | CodeableConcept | Vaccine product for administration Binding: Vaccine Administered Value Set (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| 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) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 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 | xml:id (or equivalent in JSON) | |
| 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) | Patient immunised | |
| encounter | 0..1 | Reference(Encounter) | Encounter administered as part of | |
| date | 0..1 | dateTime | Vaccination administration date | |
| primarySource | 1..1 | boolean | Optional information source | |
| reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: Immunization Origin Codes (example) | |
| location | 0..1 | Reference(Location) | Where vaccination occurred | |
| manufacturer | 0..1 | Reference(Organization) | Vaccine product 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: Codes for Immunization Site of Administration (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| route | 0..1 | CodeableConcept | Route of vaccination Binding: Immunization Route Codes (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| 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) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |
| practitioner | ΣI | 0..* | (Slice Definition) | Immunisation performer(s) Slice: Unordered, Open by value:role.coding |
| practitioner:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: v2 Provider Role - AU Extended (extensible) |
| actor | Σ | 1..1 | Reference(Practitioner) | Individual who was performing |
| practitioner:administeredBy | ΣI | 0..1 | BackboneElement | Immunisation Administered By |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 1..1 | CodeableConcept | Administering role Binding: Immunization Role Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown |
| id | 0..0 | string | xml:id (or equivalent in JSON) | |
| 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 | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Administering Provider |
| actor | Σ | 1..1 | Reference(Practitioner) | Administering practitioner |
| practitioner:approvedBy | ΣI | 0..1 | BackboneElement | Immunisation Approved By |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 1..1 | CodeableConcept | Approver role Binding: Immunization Role Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown |
| id | 0..0 | string | xml:id (or equivalent in JSON) | |
| 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 | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Ordering Provider |
| actor | Σ | 1..1 | Reference(Practitioner) | Approving practitioner |
| practitioner:witnessedBy | ΣI | 0..* | BackboneElement | Immunisation Witnessed By |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 1..1 | CodeableConcept | Witnessing Role Binding: Immunization Role Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown |
| id | 0..0 | string | xml:id (or equivalent in JSON) | |
| extension | 0..0 | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/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: WIT | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Witness | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Witness |
| actor | Σ | 1..1 | Reference(Practitioner) | Witnessing practitioner |
| note | Σ | 0..* | Annotation | Vaccination notes |
| explanation | I | 0..1 | BackboneElement | Explanation for (non)vaccination |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| reason | 0..* | CodeableConcept | Reason vaccine was given Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) | |
| reasonNotGiven | 0..* | CodeableConcept | Reason vaccine not given Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred) | |
| reaction | I | 0..* | BackboneElement | Details of a reaction that follows immunization |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| date | 0..1 | dateTime | When reaction started | |
| detail | 0..1 | Reference(Observation) | Additional information on reaction | |
| reported | 0..1 | boolean | Indicates self-reported reaction | |
| vaccinationProtocol | I | 0..* | BackboneElement | Vaccination protocol |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| doseSequence | 0..1 | positiveInt | Dose number within series | |
| description | 0..1 | string | Details of vaccine protocol | |
| authority | 0..1 | Reference(Organization) | Who is responsible for protocol | |
| series | 0..1 | string | Name of vaccine series | |
| seriesDoses | 0..1 | positiveInt | Recommended number of doses for immunity | |
| targetDisease | 1..* | CodeableConcept | Vaccine disease target Binding: Vaccination Protocol Dose Target Codes (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| 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 |
| id | 0..0 | string | xml:id (or equivalent in JSON) | |
| 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 | Σ | 0..1 | string | Plain text representation of the concept |
| doseStatus | 1..1 | CodeableConcept | Vaccine relation to protocol Binding: Vaccination Protocol Dose Status codes (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:coding |
| coding:doseStatusNotAvailable | Σ | 0..1 | Coding | Dose Status Not Available Fixed Value: As shown |
| id | 0..0 | string | xml:id (or equivalent in JSON) | |
| 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: NAVU | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Not available | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| doseStatusReason | 0..1 | CodeableConcept | Why dose does (not) count Binding: Vaccination Protocol Dose Status Reason codes (example) | |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | 0..* | Immunization | An immunisation statement in an Australian healthcare context | |
| vaccineCode | 1..1 | CodeableConcept | Vaccine product for administration | |
| coding | 0..* | (Slice Definition) | 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 | 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 | Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | |
| patient | 1..1 | Reference(Patient) | Patient immunised | |
| primarySource | 1..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 | Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required) | |
| route | 0..1 | CodeableConcept | Route of vaccination | |
| coding | 0..* | (Slice Definition) | 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) | |
| practitioner | 0..* | (Slice Definition) | Immunisation performer(s) Slice: Unordered, Open by value:role.coding | |
| practitioner:All Slices | Content/Rules for all slices | |||
| role | 0..1 | CodeableConcept | Binding: v2 Provider Role - AU Extended (extensible) | |
| practitioner:administeredBy | 0..1 | BackboneElement | Immunisation Administered By | |
| role | 1..1 | CodeableConcept | Administering role | |
| coding | 1..* | Coding | 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 | Fixed Value: Administering Provider | |
| actor | 1..1 | Reference(Practitioner) | Administering practitioner | |
| practitioner:approvedBy | 0..1 | BackboneElement | Immunisation Approved By | |
| role | 1..1 | CodeableConcept | Approver role | |
| coding | 1..* | Coding | 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 | Fixed Value: Ordering Provider | |
| actor | 1..1 | Reference(Practitioner) | Approving practitioner | |
| practitioner:witnessedBy | 0..* | BackboneElement | Immunisation Witnessed By | |
| role | 1..1 | CodeableConcept | Witnessing Role | |
| coding | 1..* | Coding | Fixed Value: As shown | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: WIT | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Witness | |
| text | 1..1 | string | Fixed Value: Witness | |
| actor | 1..1 | Reference(Practitioner) | Witnessing practitioner | |
| explanation | 0..1 | BackboneElement | Explanation for (non)vaccination | |
| reason | 0..* | CodeableConcept | Reason vaccine was given Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) | |
| reasonNotGiven | 0..* | CodeableConcept | Reason vaccine not given Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred) | |
| vaccinationProtocol | 0..* | BackboneElement | Vaccination protocol | |
| targetDisease | 1..* | CodeableConcept | Vaccine disease target | |
| coding | 0..* | (Slice Definition) | 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 | |
| doseStatus | 1..1 | CodeableConcept | Vaccine relation to protocol | |
| coding | 0..* | (Slice Definition) | Slice: Unordered, Open by value:coding | |
| coding:doseStatusNotAvailable | 0..1 | Coding | Dose Status Not Available 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: NAVU | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Not available | |
| 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 | id | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 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 Binding: Immunization Status Codes (required) |
| notGiven | ?!Σ | 1..1 | boolean | Flag for whether immunization was given |
| vaccineCode | 1..1 | CodeableConcept | Vaccine product for administration Binding: Vaccine Administered Value Set (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| 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) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 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 | xml:id (or equivalent in JSON) | |
| 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) | Patient immunised | |
| encounter | 0..1 | Reference(Encounter) | Encounter administered as part of | |
| date | 0..1 | dateTime | Vaccination administration date | |
| primarySource | 1..1 | boolean | Optional information source | |
| reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: Immunization Origin Codes (example) | |
| location | 0..1 | Reference(Location) | Where vaccination occurred | |
| manufacturer | 0..1 | Reference(Organization) | Vaccine product 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: Codes for Immunization Site of Administration (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| route | 0..1 | CodeableConcept | Route of vaccination Binding: Immunization Route Codes (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| 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) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |
| practitioner | ΣI | 0..* | (Slice Definition) | Immunisation performer(s) Slice: Unordered, Open by value:role.coding |
| practitioner:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: v2 Provider Role - AU Extended (extensible) |
| actor | Σ | 1..1 | Reference(Practitioner) | Individual who was performing |
| practitioner:administeredBy | ΣI | 0..1 | BackboneElement | Immunisation Administered By |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 1..1 | CodeableConcept | Administering role Binding: Immunization Role Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown |
| id | 0..0 | string | xml:id (or equivalent in JSON) | |
| 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 | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Administering Provider |
| actor | Σ | 1..1 | Reference(Practitioner) | Administering practitioner |
| practitioner:approvedBy | ΣI | 0..1 | BackboneElement | Immunisation Approved By |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 1..1 | CodeableConcept | Approver role Binding: Immunization Role Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown |
| id | 0..0 | string | xml:id (or equivalent in JSON) | |
| 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 | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Ordering Provider |
| actor | Σ | 1..1 | Reference(Practitioner) | Approving practitioner |
| practitioner:witnessedBy | ΣI | 0..* | BackboneElement | Immunisation Witnessed By |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 1..1 | CodeableConcept | Witnessing Role Binding: Immunization Role Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..* | Coding | Code defined by a terminology system Fixed Value: As shown |
| id | 0..0 | string | xml:id (or equivalent in JSON) | |
| extension | 0..0 | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/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: WIT | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Witness | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Witness |
| actor | Σ | 1..1 | Reference(Practitioner) | Witnessing practitioner |
| note | Σ | 0..* | Annotation | Vaccination notes |
| explanation | I | 0..1 | BackboneElement | Explanation for (non)vaccination |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| reason | 0..* | CodeableConcept | Reason vaccine was given Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) | |
| reasonNotGiven | 0..* | CodeableConcept | Reason vaccine not given Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred) | |
| reaction | I | 0..* | BackboneElement | Details of a reaction that follows immunization |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| date | 0..1 | dateTime | When reaction started | |
| detail | 0..1 | Reference(Observation) | Additional information on reaction | |
| reported | 0..1 | boolean | Indicates self-reported reaction | |
| vaccinationProtocol | I | 0..* | BackboneElement | Vaccination protocol |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| doseSequence | 0..1 | positiveInt | Dose number within series | |
| description | 0..1 | string | Details of vaccine protocol | |
| authority | 0..1 | Reference(Organization) | Who is responsible for protocol | |
| series | 0..1 | string | Name of vaccine series | |
| seriesDoses | 0..1 | positiveInt | Recommended number of doses for immunity | |
| targetDisease | 1..* | CodeableConcept | Vaccine disease target Binding: Vaccination Protocol Dose Target Codes (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| 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 |
| id | 0..0 | string | xml:id (or equivalent in JSON) | |
| 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 | Σ | 0..1 | string | Plain text representation of the concept |
| doseStatus | 1..1 | CodeableConcept | Vaccine relation to protocol Binding: Vaccination Protocol Dose Status codes (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:coding |
| coding:doseStatusNotAvailable | Σ | 0..1 | Coding | Dose Status Not Available Fixed Value: As shown |
| id | 0..0 | string | xml:id (or equivalent in JSON) | |
| 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: NAVU | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Not available | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| doseStatusReason | 0..1 | CodeableConcept | Why dose does (not) count Binding: Vaccination Protocol Dose Status Reason codes (example) | |
| 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 1.1.1 on FHIR STU3 (IG Publisher v3.0.2-11200) generated on Wed, Jan 22, 2020 10:17+1100. |
