AU Base Implementation Guide
4.1.1-preview - Preview Australia flag

This page is part of the AU Base Implementation Guide 4.1.1-preview based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Base Immunisation

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-immunization Version: 4.1.1-preview
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 Notes

Potentially useful extensions:

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationAn immunisation statement in an Australian healthcare context
... statusReason 0..1CodeableConceptReason not done
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 (preferred)
... vaccineCode
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode 0..1CodingAMT Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... coding:airVaccineCode 0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... route 0..1CodeableConceptHow vaccine entered body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred)
... Slices for performer 0..*BackboneElementWho performed event
Slice: Unordered, Open by pattern:function
.... performer:All Slices Content/Rules for all slices
..... function 0..1CodeableConceptWhat type of performance was done
Binding: hl7VS-providerRole - AU Extended (extensible)
.... performer:administeredBy 0..1BackboneElementImmunisation Administered By
..... function 1..1CodeableConceptAdministering role
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AP
..... actor 1..1Reference(Practitioner | PractitionerRole | Organization)Administering performer
.... performer:approvedBy 0..1BackboneElementImmunisation Approved By
..... function 1..1CodeableConceptApprover role
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: OP
..... actor 1..1Reference(Practitioner | PractitionerRole | Organization)Approver
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
... protocolApplied
.... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Immunization.statusReasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
Immunization.vaccineCode.coding:amtVaccineCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1
Immunization.vaccineCode.coding:airVaccineCoderequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1
Immunization.sitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1
Immunization.routepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1
Immunization.performer.functionextensibleHl7VSProviderRoleAUExtended
Immunization.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
Immunization.protocolApplied.targetDiseasepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

 

Other representations of profile: CSV, Excel, Schematron