Medtech ALEX® AU Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-immunisation | Version: 1.0.0 | |||
| Active as of 2025-10-12 | Computable Name: AlexImmunisation | |||
The Immunisation exposed by ALEX
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context Constraints: status-reason-validation, note-validation |
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | string | Vaccine vial serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1 |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: Status for Immunisation (required) |
![]() ![]() |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (required) | |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system Binding: Immunisation Vaccine Value Set (preferred) |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Patient |
![]() ![]() |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Vaccine administration date |
![]() ![]() |
S | 0..1 | dateTime | When the immunization was first captured in the subject's record |
![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() |
S | 0..1 | date | Vaccine expiration date |
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (required) | |
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (required) | |
![]() ![]() |
SΣ | 2..2 | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Immunisation Administered By |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Immunisation Approved By |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver |
![]() ![]() |
SΣ | 0..* | Annotation | Additional immunization notes |
![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Dose number within series |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Status for Immunisation | 📦1.0.0 | This IG |
| Immunization.statusReason | Base | required | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode.coding:mtVaccineCode | Base | preferred | Immunisation Vaccine Value Set | 📦1.0.0 | This IG |
| Immunization.site | Base | required | Codes for Immunization Site of Administration | 📦1.0.0 | This IG |
| Immunization.route | Base | required | Immunisation Route of Administration | 📦1.0.0 | This IG |
| Immunization.performer:administeredBy.function | Base | extensible | Immunization Function Codes | 📦4.0.1 | FHIR Std. |
| Immunization.performer:approvedBy.function | Base | extensible | Immunization Function Codes | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| note-validation | error | Immunization | Note must not exceed 4096 characters |
note.text.empty() or note.text.length() <= 4096
|
| status-reason-validation | error | Immunization | Status reason must be provided if status is 'not-done' |
status.empty() or status = 'completed' or (status = 'not-done' and statusReason.empty().not())
|
This structure is derived from AUBaseImmunisation
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context Constraints: status-reason-validation, note-validation |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | instant | When the resource version last changed |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | string | Vaccine vial serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1 |
![]() ![]() |
0..0 | |||
![]() ![]() |
1..1 | code | completed | entered-in-error | not-done Binding: Status for Immunisation (required) | |
![]() ![]() |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (required) | |
![]() ![]() |
S | 1..1 | CodeableConcept | Vaccine product administered |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system Binding: Immunisation Vaccine Value Set (preferred) | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() |
S | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() ![]() |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
0..1 | string | External Name of Patient | |
![]() ![]() |
1..1 | dateTime | Vaccine administration date Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() |
S | 1..1 | dateTime | Vaccine administration date |
![]() ![]() |
S | 0..1 | dateTime | When the immunization was first captured in the subject's record |
![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() |
S | 0..1 | date | Vaccine expiration date |
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (required) | |
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (required) | |
![]() ![]() |
0..0 | |||
![]() ![]() |
S | 2..2 | BackboneElement | Who performed event |
![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | BackboneElement | Immunisation Administered By | |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer |
![]() ![]() ![]() |
1..1 | BackboneElement | Immunisation Approved By | |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver |
![]() ![]() |
S | 0..* | Annotation | Additional immunization notes |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | positiveInt, string | Dose number within series Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Dose number within series |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Status for Immunisation | 📦1.0.0 | This IG |
| Immunization.statusReason | Base | required | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode.coding:mtVaccineCode | Base | preferred | Immunisation Vaccine Value Set | 📦1.0.0 | This IG |
| Immunization.site | Base | required | Codes for Immunization Site of Administration | 📦1.0.0 | This IG |
| Immunization.route | Base | required | Immunisation Route of Administration | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| note-validation | error | Immunization | Note must not exceed 4096 characters |
note.text.empty() or note.text.length() <= 4096
|
| status-reason-validation | error | Immunization | Status reason must be provided if status is 'not-done' |
status.empty() or status = 'completed' or (status = 'not-done' and statusReason.empty().not())
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context Constraints: status-reason-validation, note-validation |
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from |
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | string | Vaccine vial serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1 |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: Status for Immunisation (required) |
![]() ![]() |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (required) | |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system Binding: Immunisation Vaccine Value Set (preferred) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Patient |
![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | |
![]() ![]() |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Vaccine administration date |
![]() ![]() |
S | 0..1 | dateTime | When the immunization was first captured in the subject's record |
![]() ![]() |
Σ | 0..1 | boolean | Indicates context the data was recorded in |
![]() ![]() |
0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |
![]() ![]() |
0..1 | Reference(Location) | Where immunization occurred | |
![]() ![]() |
0..1 | Reference(Organization) | Vaccine manufacturer | |
![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() |
S | 0..1 | date | Vaccine expiration date |
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (required) | |
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (required) | |
![]() ![]() |
SΣ | 2..2 | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Immunisation Administered By |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Immunisation Approved By |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver |
![]() ![]() |
SΣ | 0..* | Annotation | Additional immunization notes |
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |
![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
0..1 | string | Name of vaccine series | |
![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |
![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccination Target Disease (preferred) | |
![]() ![]() ![]() |
1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Dose number within series |
![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | ||
![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() |
string | |||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Immunization.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Immunization.status | Base | required | Status for Immunisation | 📦1.0.0 | This IG |
| Immunization.statusReason | Base | required | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode.coding:mtVaccineCode | Base | preferred | Immunisation Vaccine Value Set | 📦1.0.0 | This IG |
| Immunization.patient.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📦4.0.1 | FHIR Std. |
| Immunization.site | Base | required | Codes for Immunization Site of Administration | 📦1.0.0 | This IG |
| Immunization.route | Base | required | Immunisation Route of Administration | 📦1.0.0 | This IG |
| Immunization.performer.function | Base | extensible | hl7VS-providerRole - AU Extended | 📦4.1.0 | AU Base Implementation Guide v4.1 |
| Immunization.performer:administeredBy.function | Base | extensible | Immunization Function Codes | 📦4.0.1 | FHIR Std. |
| Immunization.performer:approvedBy.function | Base | extensible | Immunization Function Codes | 📦4.0.1 | FHIR Std. |
| Immunization.fundingSource | Base | example | Immunization Funding Source | 📦4.0.1 | FHIR Std. |
| Immunization.protocolApplied.targetDisease | Base | preferred |
Vaccination Target Disease
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| note-validation | error | Immunization | Note must not exceed 4096 characters |
note.text.empty() or note.text.length() <= 4096
|
| status-reason-validation | error | Immunization | Status reason must be provided if status is 'not-done' |
status.empty() or status = 'completed' or (status = 'not-done' and statusReason.empty().not())
|
This structure is derived from AUBaseImmunisation
Summary
Mandatory: 3 elements(2 nested mandatory elements)
Must-Support: 18 elements
Prohibited: 14 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context Constraints: status-reason-validation, note-validation |
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | string | Vaccine vial serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1 |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: Status for Immunisation (required) |
![]() ![]() |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (required) | |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system Binding: Immunisation Vaccine Value Set (preferred) |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Patient |
![]() ![]() |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Vaccine administration date |
![]() ![]() |
S | 0..1 | dateTime | When the immunization was first captured in the subject's record |
![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() |
S | 0..1 | date | Vaccine expiration date |
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (required) | |
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (required) | |
![]() ![]() |
SΣ | 2..2 | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Immunisation Administered By |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Immunisation Approved By |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver |
![]() ![]() |
SΣ | 0..* | Annotation | Additional immunization notes |
![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Dose number within series |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Status for Immunisation | 📦1.0.0 | This IG |
| Immunization.statusReason | Base | required | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode.coding:mtVaccineCode | Base | preferred | Immunisation Vaccine Value Set | 📦1.0.0 | This IG |
| Immunization.site | Base | required | Codes for Immunization Site of Administration | 📦1.0.0 | This IG |
| Immunization.route | Base | required | Immunisation Route of Administration | 📦1.0.0 | This IG |
| Immunization.performer:administeredBy.function | Base | extensible | Immunization Function Codes | 📦4.0.1 | FHIR Std. |
| Immunization.performer:approvedBy.function | Base | extensible | Immunization Function Codes | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| note-validation | error | Immunization | Note must not exceed 4096 characters |
note.text.empty() or note.text.length() <= 4096
|
| status-reason-validation | error | Immunization | Status reason must be provided if status is 'not-done' |
status.empty() or status = 'completed' or (status = 'not-done' and statusReason.empty().not())
|
Differential View
This structure is derived from AUBaseImmunisation
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context Constraints: status-reason-validation, note-validation |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | instant | When the resource version last changed |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | string | Vaccine vial serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1 |
![]() ![]() |
0..0 | |||
![]() ![]() |
1..1 | code | completed | entered-in-error | not-done Binding: Status for Immunisation (required) | |
![]() ![]() |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (required) | |
![]() ![]() |
S | 1..1 | CodeableConcept | Vaccine product administered |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system Binding: Immunisation Vaccine Value Set (preferred) | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() |
S | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() ![]() |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
0..1 | string | External Name of Patient | |
![]() ![]() |
1..1 | dateTime | Vaccine administration date Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() |
S | 1..1 | dateTime | Vaccine administration date |
![]() ![]() |
S | 0..1 | dateTime | When the immunization was first captured in the subject's record |
![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() |
S | 0..1 | date | Vaccine expiration date |
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (required) | |
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (required) | |
![]() ![]() |
0..0 | |||
![]() ![]() |
S | 2..2 | BackboneElement | Who performed event |
![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | BackboneElement | Immunisation Administered By | |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer |
![]() ![]() ![]() |
1..1 | BackboneElement | Immunisation Approved By | |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver |
![]() ![]() |
S | 0..* | Annotation | Additional immunization notes |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | positiveInt, string | Dose number within series Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Dose number within series |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Status for Immunisation | 📦1.0.0 | This IG |
| Immunization.statusReason | Base | required | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode.coding:mtVaccineCode | Base | preferred | Immunisation Vaccine Value Set | 📦1.0.0 | This IG |
| Immunization.site | Base | required | Codes for Immunization Site of Administration | 📦1.0.0 | This IG |
| Immunization.route | Base | required | Immunisation Route of Administration | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| note-validation | error | Immunization | Note must not exceed 4096 characters |
note.text.empty() or note.text.length() <= 4096
|
| status-reason-validation | error | Immunization | Status reason must be provided if status is 'not-done' |
status.empty() or status = 'completed' or (status = 'not-done' and statusReason.empty().not())
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context Constraints: status-reason-validation, note-validation |
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from |
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | string | Vaccine vial serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1 |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: Status for Immunisation (required) |
![]() ![]() |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (required) | |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system Binding: Immunisation Vaccine Value Set (preferred) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Patient |
![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | |
![]() ![]() |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Vaccine administration date |
![]() ![]() |
S | 0..1 | dateTime | When the immunization was first captured in the subject's record |
![]() ![]() |
Σ | 0..1 | boolean | Indicates context the data was recorded in |
![]() ![]() |
0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |
![]() ![]() |
0..1 | Reference(Location) | Where immunization occurred | |
![]() ![]() |
0..1 | Reference(Organization) | Vaccine manufacturer | |
![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() |
S | 0..1 | date | Vaccine expiration date |
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (required) | |
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (required) | |
![]() ![]() |
SΣ | 2..2 | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Immunisation Administered By |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Immunisation Approved By |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver |
![]() ![]() |
SΣ | 0..* | Annotation | Additional immunization notes |
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |
![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
0..1 | string | Name of vaccine series | |
![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |
![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccination Target Disease (preferred) | |
![]() ![]() ![]() |
1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Dose number within series |
![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | ||
![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() |
string | |||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Immunization.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Immunization.status | Base | required | Status for Immunisation | 📦1.0.0 | This IG |
| Immunization.statusReason | Base | required | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode.coding:mtVaccineCode | Base | preferred | Immunisation Vaccine Value Set | 📦1.0.0 | This IG |
| Immunization.patient.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📦4.0.1 | FHIR Std. |
| Immunization.site | Base | required | Codes for Immunization Site of Administration | 📦1.0.0 | This IG |
| Immunization.route | Base | required | Immunisation Route of Administration | 📦1.0.0 | This IG |
| Immunization.performer.function | Base | extensible | hl7VS-providerRole - AU Extended | 📦4.1.0 | AU Base Implementation Guide v4.1 |
| Immunization.performer:administeredBy.function | Base | extensible | Immunization Function Codes | 📦4.0.1 | FHIR Std. |
| Immunization.performer:approvedBy.function | Base | extensible | Immunization Function Codes | 📦4.0.1 | FHIR Std. |
| Immunization.fundingSource | Base | example | Immunization Funding Source | 📦4.0.1 | FHIR Std. |
| Immunization.protocolApplied.targetDisease | Base | preferred |
Vaccination Target Disease
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| note-validation | error | Immunization | Note must not exceed 4096 characters |
note.text.empty() or note.text.length() <= 4096
|
| status-reason-validation | error | Immunization | Status reason must be provided if status is 'not-done' |
status.empty() or status = 'completed' or (status = 'not-done' and statusReason.empty().not())
|
This structure is derived from AUBaseImmunisation
Summary
Mandatory: 3 elements(2 nested mandatory elements)
Must-Support: 18 elements
Prohibited: 14 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron