AU Base Implementation Guide
5.0.1-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 5.0.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

Resource Profile: AU Base Immunisation

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

Usage:

Changes since version 5.0.0:

  • The data elements list has changed
  • 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..* Immunization An immunisation statement in an Australian healthcare context
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:vaccineVialSerialNumber 0..1 string Vaccine vial serial number
    URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
    ... statusReason 0..1 CodeableConcept Reason not done
    Binding: Reason Vaccine Not Administered . (preferred)
    ... vaccineCode 1..1 CodeableConcept Vaccine product administered
    Binding: VaccineAdministeredValueSet (example)
    Additional BindingsPurpose
    Australian Medicines Terminology Vaccine . Preferred
    Australian Immunisation Register Vaccine . Preferred
    ... 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)

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Immunization.statusReasonpreferredReasonVaccineNotAdministered .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
    Immunization.vaccineCodeexampleVaccineAdministeredValueSet
    Immunization.sitepreferredImmunisationAnatomicalSite .
    https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1
    Immunization.routepreferredImmunisationRouteOfAdministration .
    https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1
    Immunization.performer.functionextensibleHl7VSProviderRoleAUExtended
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.reasonCodepreferredReasonVaccineAdministered .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
    Immunization.protocolApplied.targetDiseasepreferredVaccinationTargetDisease .
    https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

     

    Other representations of profile: CSV, Excel, Schematron