AU Core Implementation Guide
0.1.0-draft - Draft Australia flag

This page is part of the AU Core Implementation Guide 0.1.0 Draft. It is based on AU Base 4.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core Immunization

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-immunization Version: 0.1.0-draft
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreImmunization

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

​This profile sets minimum expectations for an Immunization resource to record, search, and fetch immunisation history associated with a patient. It is based on the AU Base Immunisation profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Immunization resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for a patient’s immunisations
  • Record or update an immunisation record for a patient

Profile specific implementation guidance

  • Use the status code: not-done to represent that an immunization was not given.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseImmunisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccine-serial-number S0..1stringVaccine vial serial number
URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
... identifier S0..*IdentifierBusiness identifier
... statusReason S0..1CodeableConceptReason not done
... vaccineCode S1..1CodeableConceptVaccine product administered
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode S0..1CodingAMT Vaccine
..... coding:airVaccineCode S0..1CodingAIR Vaccine
... patient S1..1Reference(AU Core Patient)Who was immunized
... encounter S0..1Reference(AU Core Encounter)Encounter immunization was part of
... occurrence[x] S1..1dateTime, stringVaccine administration date
... performer S0..*BackboneElementWho performed event
.... function S0..1CodeableConceptWhat type of performance was done
.... actor S1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)Individual or organization who was performing
... note S0..*AnnotationAdditional immunization notes
... reasonCode S0..*CodeableConceptWhy immunization occurred
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... series S0..1stringName of vaccine series
.... targetDisease S0..*CodeableConceptVaccine preventatable disease being targetted
.... doseNumber[x] S1..1positiveInt, stringDose number within series

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccine-serial-number S0..1stringVaccine vial serial number
URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
... identifier S0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S0..1CodeableConceptReason not done
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 (preferred)
... vaccineCode SΣ1..1CodeableConceptVaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode SΣ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 SΣ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
... patient SΣ1..1Reference(AU Core Patient)Who was immunized
... encounter S0..1Reference(AU Core Encounter)Encounter immunization was part of
... occurrence[x] SΣ1..1Vaccine administration date
.... occurrenceDateTimedateTime
.... occurrenceStringstring
... Slices for performer SΣ0..*BackboneElementWho performed event
Slice: Unordered, Open by pattern:function
.... performer:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function SΣ0..1CodeableConceptWhat type of performance was done
Binding: hl7VS-providerRole - AU Extended (extensible)
..... actor SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)Individual or organization who was performing
.... performer:administeredBy Σ0..1BackboneElementImmunisation Administered By
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ1..1CodeableConceptAdministering role
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ1..1CodeableConceptApprover role
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


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
... note SΣ0..*AnnotationAdditional immunization notes
... reasonCode S0..*CodeableConceptWhy immunization occurred
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
... isSubpotent ?!Σ0..1booleanDose potency
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series S0..1stringName of vaccine series
.... targetDisease S0..*CodeableConceptVaccine preventatable disease being targetted
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)
.... doseNumber[x] S1..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
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.performer.functionextensibleHl7VSProviderRoleAUExtended
Immunization.performer:administeredBy.functionextensiblePattern: AP
Immunization.performer:approvedBy.functionextensiblePattern: OP
Immunization.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
Immunization.protocolApplied.targetDiseasepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccine-serial-number S0..1stringVaccine vial serial number
URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S0..1CodeableConceptReason not done
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 (preferred)
... vaccineCode SΣ1..1CodeableConceptVaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode SΣ0..1CodingAMT Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:airVaccineCode SΣ0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(AU Core Patient)Who was immunized
... encounter S0..1Reference(AU Core Encounter)Encounter immunization was part of
... occurrence[x] SΣ1..1Vaccine administration date
.... occurrenceDateTimedateTime
.... occurrenceStringstring
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates 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..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (preferred)
... route 0..1CodeableConceptHow vaccine entered body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... Slices for performer SΣ0..*BackboneElementWho performed event
Slice: Unordered, Open by pattern:function
.... performer:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function SΣ0..1CodeableConceptWhat type of performance was done
Binding: hl7VS-providerRole - AU Extended (extensible)
..... actor SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)Individual or organization who was performing
.... performer:administeredBy Σ0..1BackboneElementImmunisation Administered By
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ1..1CodeableConceptAdministering role
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AP
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Administering performer
.... performer:approvedBy Σ0..1BackboneElementImmunisation Approved By
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ1..1CodeableConceptApprover role
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: OP
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Approver
... note SΣ0..*AnnotationAdditional immunization notes
... reasonCode S0..*CodeableConceptWhy immunization occurred
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series S0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease S0..*CodeableConceptVaccine preventatable disease being targetted
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)
.... doseNumber[x] S1..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
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.reportOriginexampleImmunizationOriginCodes
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.performer:administeredBy.functionextensiblePattern: AP
Immunization.performer:approvedBy.functionextensiblePattern: OP
Immunization.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseasepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

Differential View

This structure is derived from AUBaseImmunisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccine-serial-number S0..1stringVaccine vial serial number
URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
... identifier S0..*IdentifierBusiness identifier
... statusReason S0..1CodeableConceptReason not done
... vaccineCode S1..1CodeableConceptVaccine product administered
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode S0..1CodingAMT Vaccine
..... coding:airVaccineCode S0..1CodingAIR Vaccine
... patient S1..1Reference(AU Core Patient)Who was immunized
... encounter S0..1Reference(AU Core Encounter)Encounter immunization was part of
... occurrence[x] S1..1dateTime, stringVaccine administration date
... performer S0..*BackboneElementWho performed event
.... function S0..1CodeableConceptWhat type of performance was done
.... actor S1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)Individual or organization who was performing
... note S0..*AnnotationAdditional immunization notes
... reasonCode S0..*CodeableConceptWhy immunization occurred
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... series S0..1stringName of vaccine series
.... targetDisease S0..*CodeableConceptVaccine preventatable disease being targetted
.... doseNumber[x] S1..1positiveInt, stringDose number within series

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccine-serial-number S0..1stringVaccine vial serial number
URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
... identifier S0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S0..1CodeableConceptReason not done
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 (preferred)
... vaccineCode SΣ1..1CodeableConceptVaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode SΣ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 SΣ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
... patient SΣ1..1Reference(AU Core Patient)Who was immunized
... encounter S0..1Reference(AU Core Encounter)Encounter immunization was part of
... occurrence[x] SΣ1..1Vaccine administration date
.... occurrenceDateTimedateTime
.... occurrenceStringstring
... Slices for performer SΣ0..*BackboneElementWho performed event
Slice: Unordered, Open by pattern:function
.... performer:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function SΣ0..1CodeableConceptWhat type of performance was done
Binding: hl7VS-providerRole - AU Extended (extensible)
..... actor SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)Individual or organization who was performing
.... performer:administeredBy Σ0..1BackboneElementImmunisation Administered By
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ1..1CodeableConceptAdministering role
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ1..1CodeableConceptApprover role
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


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
... note SΣ0..*AnnotationAdditional immunization notes
... reasonCode S0..*CodeableConceptWhy immunization occurred
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
... isSubpotent ?!Σ0..1booleanDose potency
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series S0..1stringName of vaccine series
.... targetDisease S0..*CodeableConceptVaccine preventatable disease being targetted
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)
.... doseNumber[x] S1..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
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.performer.functionextensibleHl7VSProviderRoleAUExtended
Immunization.performer:administeredBy.functionextensiblePattern: AP
Immunization.performer:approvedBy.functionextensiblePattern: OP
Immunization.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
Immunization.protocolApplied.targetDiseasepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccine-serial-number S0..1stringVaccine vial serial number
URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S0..1CodeableConceptReason not done
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 (preferred)
... vaccineCode SΣ1..1CodeableConceptVaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode SΣ0..1CodingAMT Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:airVaccineCode SΣ0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(AU Core Patient)Who was immunized
... encounter S0..1Reference(AU Core Encounter)Encounter immunization was part of
... occurrence[x] SΣ1..1Vaccine administration date
.... occurrenceDateTimedateTime
.... occurrenceStringstring
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates 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..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (preferred)
... route 0..1CodeableConceptHow vaccine entered body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... Slices for performer SΣ0..*BackboneElementWho performed event
Slice: Unordered, Open by pattern:function
.... performer:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function SΣ0..1CodeableConceptWhat type of performance was done
Binding: hl7VS-providerRole - AU Extended (extensible)
..... actor SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)Individual or organization who was performing
.... performer:administeredBy Σ0..1BackboneElementImmunisation Administered By
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ1..1CodeableConceptAdministering role
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AP
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Administering performer
.... performer:approvedBy Σ0..1BackboneElementImmunisation Approved By
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ1..1CodeableConceptApprover role
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: OP
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Approver
... note SΣ0..*AnnotationAdditional immunization notes
... reasonCode S0..*CodeableConceptWhy immunization occurred
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series S0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease S0..*CodeableConceptVaccine preventatable disease being targetted
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)
.... doseNumber[x] S1..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
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.reportOriginexampleImmunizationOriginCodes
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.performer:administeredBy.functionextensiblePattern: AP
Immunization.performer:approvedBy.functionextensiblePattern: OP
Immunization.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseasepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Name Type Conformance Description Path
TBD TBD TBD TBD TBD

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

Optional Search Parameters

The following search parameters and search parameter combinations SHOULD be supported: