AU Base Implementation Guide
4.2.1-ci-build - CI Build
AU Base Implementation Guide
4.2.1-ci-build - CI Build
AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 4.2.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/StructureDefinition/au-immunization | Version: 4.2.1-ci-build | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: AUBaseImmunisation | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile defines an immunisation structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Immunization |
0..* | Immunization | An immunisation statement in an Australian healthcare context | |
  statusReason |
0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered  (preferred) | |
 vaccineCode |
||||
   Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
   coding:amtVaccineCode |
0..1 | Coding | AMT Vaccine Binding: Australian Medicines Terminology Vaccine (preferred) | |
  system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
 coding:airVaccineCode |
0..1 | Coding | AIR Vaccine Binding: Australian Immunisation Register Vaccine (required) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | |
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Immunisation Anatomical Site (preferred) | |
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (preferred) | |
| Slices for performer |
0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | |
| performer:All Slices |
Content/Rules for all slices | |||
 function |
0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | |
| performer:administeredBy |
0..1 | BackboneElement | Immunisation Administered By | |
 function |
1..1 | CodeableConcept | Administering role Required Pattern: At least the following | |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | |
| performer:approvedBy |
0..1 | BackboneElement | Immunisation Approved By | |
| function |
1..1 | CodeableConcept | Approver role Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | |
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered (preferred) | |
| protocolApplied |
||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccination Target Disease (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.statusReason | preferred | ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 | |
| Immunization.vaccineCode.coding:amtVaccineCode | preferred | AustralianMedicinesTerminologyVaccine https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 | |
| Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | |
| Immunization.site | preferred | ImmunisationAnatomicalSite https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 | |
| Immunization.route | preferred | ImmunisationRouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 | |
| Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0443-extendedfrom this IG | |
| Immunization.reasonCode | preferred | ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 | |
| Immunization.protocolApplied.targetDisease | preferred | VaccinationTargetDisease https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | An immunisation statement in an Australian healthcare context | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
 statusReason |
0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred) | |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
| Slices for coding |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:amtVaccineCode |
Σ | 0..1 | Coding | AMT Vaccine Binding: Australian Medicines Terminology Vaccine (preferred) |
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| coding:airVaccineCode |
Σ | 0..1 | Coding | AIR Vaccine Binding: Australian Immunisation Register Vaccine (required) |
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats |
 patient |
Σ | 1..1 | Reference(Patient) | Who was immunized |
 occurrence[x] |
Σ | 1..1 | Vaccine administration date | |
| occurrenceDateTime |
dateTime | |||
| occurrenceString |
string | |||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Immunisation Anatomical Site (preferred) | |
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (preferred) | |
| Slices for performer |
Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function |
| performer:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) |
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
| performer:administeredBy |
Σ | 0..1 | BackboneElement | Immunisation Administered By |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function |
Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer |
| performer:approvedBy |
Σ | 0..1 | BackboneElement | Immunisation Approved By |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function |
Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver |
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered (preferred) | |
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1from the FHIR Standard | |
| Immunization.statusReason | preferred | ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 | |
| Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codefrom the FHIR Standard | |
| Immunization.vaccineCode.coding:amtVaccineCode | preferred | AustralianMedicinesTerminologyVaccine https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 | |
| Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | |
| Immunization.site | preferred | ImmunisationAnatomicalSite https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 | |
| Immunization.route | preferred | ImmunisationRouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 | |
| Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0443-extendedfrom this IG | |
| Immunization.performer:administeredBy.function | extensible | Pattern: APhttp://hl7.org/fhir/ValueSet/immunization-functionfrom the FHIR Standard | |
| Immunization.performer:approvedBy.function | extensible | Pattern: OPhttp://hl7.org/fhir/ValueSet/immunization-functionfrom the FHIR Standard | |
| Immunization.reasonCode | preferred | ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred) | |||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
| coding:amtVaccineCode |
Σ | 0..1 | Coding | AMT Vaccine Binding: Australian Medicines Terminology Vaccine (preferred) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:airVaccineCode |
Σ | 0..1 | Coding | AIR Vaccine Binding: Australian Immunisation Register Vaccine (required) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| occurrence[x] |
Σ | 1..1 | Vaccine administration date | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrenceString |
string | |||||||
| recorded |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
| primarySource |
Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
| reportOrigin |
0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
| location |
0..1 | Reference(Location) | Where immunization occurred | |||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Immunisation Anatomical Site (preferred) | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (preferred) | |||||
| doseQuantity |
0..1 | SimpleQuantity | Amount of vaccine administered | |||||
| Slices for performer |
Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | ||||
| performer:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | ||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
| performer:administeredBy |
Σ | 0..1 | BackboneElement | Immunisation Administered By | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | ||||
| performer:approvedBy |
Σ | 0..1 | BackboneElement | Immunisation Approved By | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | ||||
| note |
Σ | 0..* | Annotation | Additional immunization notes | ||||
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered (preferred) | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| education |
C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| documentType |
0..1 | string | Educational material document identifier | |||||
| reference |
0..1 | uri | Educational material reference pointer | |||||
| publicationDate |
0..1 | dateTime | Educational material publication date | |||||
| presentationDate |
0..1 | dateTime | Educational material presentation date | |||||
| programEligibility |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
| fundingSource |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
| reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| date |
0..1 | dateTime | When reaction started | |||||
| detail |
0..1 | Reference(Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| series |
0..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccination Target Disease (preferred) | |||||
| doseNumber[x] |
1..1 | Dose number within series | ||||||
| doseNumberPositiveInt |
positiveInt | |||||||
| doseNumberString |
string | |||||||
| seriesDoses[x] |
0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt |
positiveInt | |||||||
| seriesDosesString |
string | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1from the FHIR Standard | ||||
| Immunization.statusReason | preferred | ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 | ||||
| Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codefrom the FHIR Standard | ||||
| Immunization.vaccineCode.coding:amtVaccineCode | preferred | AustralianMedicinesTerminologyVaccine https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 | ||||
| Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | ||||
| Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-originfrom the FHIR Standard | ||||
| Immunization.site | preferred | ImmunisationAnatomicalSite https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 | ||||
| Immunization.route | preferred | ImmunisationRouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 | ||||
| Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0443-extendedfrom this IG | ||||
| Immunization.performer:administeredBy.function | extensible | Pattern: APhttp://hl7.org/fhir/ValueSet/immunization-functionfrom the FHIR Standard | ||||
| Immunization.performer:approvedBy.function | extensible | Pattern: OPhttp://hl7.org/fhir/ValueSet/immunization-functionfrom the FHIR Standard | ||||
| Immunization.reasonCode | preferred | ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 | ||||
| Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reasonfrom the FHIR Standard | ||||
| Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibilityfrom the FHIR Standard | ||||
| Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-sourcefrom the FHIR Standard | ||||
| Immunization.protocolApplied.targetDisease | preferred | VaccinationTargetDisease https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() |
This structure is derived from Immunization
Differential View
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | An immunisation statement in an Australian healthcare context | |
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred) | |
| vaccineCode |
||||
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:amtVaccineCode |
0..1 | Coding | AMT Vaccine Binding: Australian Medicines Terminology Vaccine (preferred) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| coding:airVaccineCode |
0..1 | Coding | AIR Vaccine Binding: Australian Immunisation Register Vaccine (required) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | |
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Immunisation Anatomical Site (preferred) | |
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (preferred) | |
| Slices for performer |
0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | |
| performer:All Slices |
Content/Rules for all slices | |||
| function |
0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | |
| performer:administeredBy |
0..1 | BackboneElement | Immunisation Administered By | |
| function |
1..1 | CodeableConcept | Administering role Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | |
| performer:approvedBy |
0..1 | BackboneElement | Immunisation Approved By | |
| function |
1..1 | CodeableConcept | Approver role Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | |
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered (preferred) | |
| protocolApplied |
||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccination Target Disease (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.statusReason | preferred | ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 | |
| Immunization.vaccineCode.coding:amtVaccineCode | preferred | AustralianMedicinesTerminologyVaccine https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 | |
| Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | |
| Immunization.site | preferred | ImmunisationAnatomicalSite https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 | |
| Immunization.route | preferred | ImmunisationRouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 | |
| Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0443-extendedfrom this IG | |
| Immunization.reasonCode | preferred | ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 | |
| Immunization.protocolApplied.targetDisease | preferred | VaccinationTargetDisease https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | An immunisation statement in an Australian healthcare context | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred) | |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
| Slices for coding |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:amtVaccineCode |
Σ | 0..1 | Coding | AMT Vaccine Binding: Australian Medicines Terminology Vaccine (preferred) |
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| coding:airVaccineCode |
Σ | 0..1 | Coding | AIR Vaccine Binding: Australian Immunisation Register Vaccine (required) |
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats |
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized |
| occurrence[x] |
Σ | 1..1 | Vaccine administration date | |
| occurrenceDateTime |
dateTime | |||
| occurrenceString |
string | |||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Immunisation Anatomical Site (preferred) | |
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (preferred) | |
| Slices for performer |
Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function |
| performer:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) |
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
| performer:administeredBy |
Σ | 0..1 | BackboneElement | Immunisation Administered By |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function |
Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer |
| performer:approvedBy |
Σ | 0..1 | BackboneElement | Immunisation Approved By |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function |
Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver |
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered (preferred) | |
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1from the FHIR Standard | |
| Immunization.statusReason | preferred | ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 | |
| Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codefrom the FHIR Standard | |
| Immunization.vaccineCode.coding:amtVaccineCode | preferred | AustralianMedicinesTerminologyVaccine https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 | |
| Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | |
| Immunization.site | preferred | ImmunisationAnatomicalSite https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 | |
| Immunization.route | preferred | ImmunisationRouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 | |
| Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0443-extendedfrom this IG | |
| Immunization.performer:administeredBy.function | extensible | Pattern: APhttp://hl7.org/fhir/ValueSet/immunization-functionfrom the FHIR Standard | |
| Immunization.performer:approvedBy.function | extensible | Pattern: OPhttp://hl7.org/fhir/ValueSet/immunization-functionfrom the FHIR Standard | |
| Immunization.reasonCode | preferred | ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: Reason Vaccine Not Administered (preferred) | |||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
| coding:amtVaccineCode |
Σ | 0..1 | Coding | AMT Vaccine Binding: Australian Medicines Terminology Vaccine (preferred) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:airVaccineCode |
Σ | 0..1 | Coding | AIR Vaccine Binding: Australian Immunisation Register Vaccine (required) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| occurrence[x] |
Σ | 1..1 | Vaccine administration date | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrenceString |
string | |||||||
| recorded |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
| primarySource |
Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
| reportOrigin |
0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
| location |
0..1 | Reference(Location) | Where immunization occurred | |||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Immunisation Anatomical Site (preferred) | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunisation Route of Administration (preferred) | |||||
| doseQuantity |
0..1 | SimpleQuantity | Amount of vaccine administered | |||||
| Slices for performer |
Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | ||||
| performer:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | ||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
| performer:administeredBy |
Σ | 0..1 | BackboneElement | Immunisation Administered By | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Administering performer | ||||
| performer:approvedBy |
Σ | 0..1 | BackboneElement | Immunisation Approved By | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Approver | ||||
| note |
Σ | 0..* | Annotation | Additional immunization notes | ||||
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: Reason Vaccine Administered (preferred) | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| education |
C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| documentType |
0..1 | string | Educational material document identifier | |||||
| reference |
0..1 | uri | Educational material reference pointer | |||||
| publicationDate |
0..1 | dateTime | Educational material publication date | |||||
| presentationDate |
0..1 | dateTime | Educational material presentation date | |||||
| programEligibility |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
| fundingSource |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
| reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| date |
0..1 | dateTime | When reaction started | |||||
| detail |
0..1 | Reference(Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| series |
0..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccination Target Disease (preferred) | |||||
| doseNumber[x] |
1..1 | Dose number within series | ||||||
| doseNumberPositiveInt |
positiveInt | |||||||
| doseNumberString |
string | |||||||
| seriesDoses[x] |
0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt |
positiveInt | |||||||
| seriesDosesString |
string | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1from the FHIR Standard | ||||
| Immunization.statusReason | preferred | ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 | ||||
| Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codefrom the FHIR Standard | ||||
| Immunization.vaccineCode.coding:amtVaccineCode | preferred | AustralianMedicinesTerminologyVaccine https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 | ||||
| Immunization.vaccineCode.coding:airVaccineCode | required | AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 | ||||
| Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-originfrom the FHIR Standard | ||||
| Immunization.site | preferred | ImmunisationAnatomicalSite https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 | ||||
| Immunization.route | preferred | ImmunisationRouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 | ||||
| Immunization.performer.function | extensible | Hl7VSProviderRoleAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0443-extendedfrom this IG | ||||
| Immunization.performer:administeredBy.function | extensible | Pattern: APhttp://hl7.org/fhir/ValueSet/immunization-functionfrom the FHIR Standard | ||||
| Immunization.performer:approvedBy.function | extensible | Pattern: OPhttp://hl7.org/fhir/ValueSet/immunization-functionfrom the FHIR Standard | ||||
| Immunization.reasonCode | preferred | ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 | ||||
| Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reasonfrom the FHIR Standard | ||||
| Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibilityfrom the FHIR Standard | ||||
| Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-sourcefrom the FHIR Standard | ||||
| Immunization.protocolApplied.targetDisease | preferred | VaccinationTargetDisease https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() |
This structure is derived from Immunization
Other representations of profile: CSV, Excel, Schematron
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.2.1-ci-build based on FHIR 4.0.1. Generated 2024-05-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change