AU Base Immunisation - AU Base Implementation Guide v4.2.2-ballot

AU Base Implementation Guide
4.2.2-ballot - Ballot Australia flag

This page is part of the Australian Base IG (v4.2.2-ballot: AU Base R4.2 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. 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.2.2-ballot
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:

Immunization: Vaccine Vial Serial Number

Usage:

Examples for this Resource Profile: Immunization/example0, Immunization/example1, Immunization/example2 and Immunization/example3

Formal Views of Profile Content

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

This structure is derived from Immunization

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

1..1

CodeableConcept

Vaccine product administered
Binding: VaccineAdministeredValueSet (example)

Additional Bindings

Purpose

Australian Medicines Terminology Vaccine

Preferred

Australian Immunisation Register Vaccine

Preferred

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

Terminology Bindings (Differential)

Path Conformance ValueSet URI

Immunization.statusReason

preferred

ReasonVaccineNotAdministered

https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3

from https://tx.ontoserver.csiro.au/fhir

Immunization.vaccineCode

example

VaccineAdministeredValueSet

Additional Bindings

Purpose

Documentation

Australian Medicines Terminology Vaccine

Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

Australian Immunisation Register Vaccine

Preferred

This value set is for use when AIR (Australian Immunisation Register) codes are preferred.

Immunization.site

preferred

ImmunisationAnatomicalSite

https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.route

preferred

ImmunisationRouteOfAdministration

https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.performer.function

extensible

Hl7VSProviderRoleAUExtended

http://terminology.hl7.org.au/ValueSet/v2-0443-extended

from this IG

Immunization.reasonCode

preferred

ReasonVaccineAdministered

https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.protocolApplied.targetDisease

preferred

VaccinationTargetDisease

https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

from https://tx.ontoserver.csiro.au/fhir

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)

Additional Bindings

Purpose

Australian Medicines Terminology Vaccine

Preferred

Australian Immunisation Register Vaccine

Preferred

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

Terminology Bindings

Path Conformance ValueSet / Code URI

Immunization.status

required

ImmunizationStatusCodes

http://hl7.org/fhir/ValueSet/immunization-status|4.0.1

from the FHIR Standard

Immunization.statusReason

preferred

ReasonVaccineNotAdministered

https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3

from https://tx.ontoserver.csiro.au/fhir

Immunization.vaccineCode

example

VaccineAdministeredValueSet

Additional Bindings

Purpose

Documentation

Australian Medicines Terminology Vaccine

Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

Australian Immunisation Register Vaccine

Preferred

This value set is for use when AIR (Australian Immunisation Register) codes are preferred.

http://hl7.org/fhir/ValueSet/vaccine-code

from the FHIR Standard

Immunization.site

preferred

ImmunisationAnatomicalSite

https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.route

preferred

ImmunisationRouteOfAdministration

https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.performer.function

extensible

Hl7VSProviderRoleAUExtended

http://terminology.hl7.org.au/ValueSet/v2-0443-extended

from this IG

Immunization.performer:administeredBy.function

extensible

Pattern: AP

http://hl7.org/fhir/ValueSet/immunization-function

from the FHIR Standard

Immunization.performer:approvedBy.function

extensible

Pattern: OP

http://hl7.org/fhir/ValueSet/immunization-function

from the FHIR Standard

Immunization.reasonCode

preferred

ReasonVaccineAdministered

https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1

from https://tx.ontoserver.csiro.au/fhir

Constraints

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()

Description & Constraints

Immunization

0..*

Immunization

An immunisation statement in an Australian healthcare context

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet / Code URI

Immunization.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Immunization.status

required

ImmunizationStatusCodes

http://hl7.org/fhir/ValueSet/immunization-status|4.0.1

from the FHIR Standard

Immunization.statusReason

preferred

ReasonVaccineNotAdministered

https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3

from https://tx.ontoserver.csiro.au/fhir

Immunization.vaccineCode

example

VaccineAdministeredValueSet

Additional Bindings

Purpose

Documentation

Australian Medicines Terminology Vaccine

Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

Australian Immunisation Register Vaccine

Preferred

This value set is for use when AIR (Australian Immunisation Register) codes are preferred.

http://hl7.org/fhir/ValueSet/vaccine-code

from the FHIR Standard

Immunization.reportOrigin

example

ImmunizationOriginCodes

http://hl7.org/fhir/ValueSet/immunization-origin

from the FHIR Standard

Immunization.site

preferred

ImmunisationAnatomicalSite

https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.route

preferred

ImmunisationRouteOfAdministration

https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.performer.function

extensible

Hl7VSProviderRoleAUExtended

http://terminology.hl7.org.au/ValueSet/v2-0443-extended

from this IG

Immunization.performer:administeredBy.function

extensible

Pattern: AP

http://hl7.org/fhir/ValueSet/immunization-function

from the FHIR Standard

Immunization.performer:approvedBy.function

extensible

Pattern: OP

http://hl7.org/fhir/ValueSet/immunization-function

from the FHIR Standard

Immunization.reasonCode

preferred

ReasonVaccineAdministered

https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.subpotentReason

example

ImmunizationSubpotentReason

http://hl7.org/fhir/ValueSet/immunization-subpotent-reason

from the FHIR Standard

Immunization.programEligibility

example

ImmunizationProgramEligibility

http://hl7.org/fhir/ValueSet/immunization-program-eligibility

from the FHIR Standard

Immunization.fundingSource

example

ImmunizationFundingSource

http://hl7.org/fhir/ValueSet/immunization-funding-source

from the FHIR Standard

Immunization.protocolApplied.targetDisease

preferred

VaccinationTargetDisease

https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

from https://tx.ontoserver.csiro.au/fhir

Constraints

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()

Differential View

This structure is derived from Immunization

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

1..1

CodeableConcept

Vaccine product administered
Binding: VaccineAdministeredValueSet (example)

Additional Bindings

Purpose

Australian Medicines Terminology Vaccine

Preferred

Australian Immunisation Register Vaccine

Preferred

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

Terminology Bindings (Differential)

Path Conformance ValueSet URI

Immunization.statusReason

preferred

ReasonVaccineNotAdministered

https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3

from https://tx.ontoserver.csiro.au/fhir

Immunization.vaccineCode

example

VaccineAdministeredValueSet

Additional Bindings

Purpose

Documentation

Australian Medicines Terminology Vaccine

Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

Australian Immunisation Register Vaccine

Preferred

This value set is for use when AIR (Australian Immunisation Register) codes are preferred.

Immunization.site

preferred

ImmunisationAnatomicalSite

https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.route

preferred

ImmunisationRouteOfAdministration

https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.performer.function

extensible

Hl7VSProviderRoleAUExtended

http://terminology.hl7.org.au/ValueSet/v2-0443-extended

from this IG

Immunization.reasonCode

preferred

ReasonVaccineAdministered

https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.protocolApplied.targetDisease

preferred

VaccinationTargetDisease

https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

from https://tx.ontoserver.csiro.au/fhir

Key Elements View

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)

Additional Bindings

Purpose

Australian Medicines Terminology Vaccine

Preferred

Australian Immunisation Register Vaccine

Preferred

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

Terminology Bindings

Path Conformance ValueSet / Code URI

Immunization.status

required

ImmunizationStatusCodes

http://hl7.org/fhir/ValueSet/immunization-status|4.0.1

from the FHIR Standard

Immunization.statusReason

preferred

ReasonVaccineNotAdministered

https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3

from https://tx.ontoserver.csiro.au/fhir

Immunization.vaccineCode

example

VaccineAdministeredValueSet

Additional Bindings

Purpose

Documentation

Australian Medicines Terminology Vaccine

Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

Australian Immunisation Register Vaccine

Preferred

This value set is for use when AIR (Australian Immunisation Register) codes are preferred.

http://hl7.org/fhir/ValueSet/vaccine-code

from the FHIR Standard

Immunization.site

preferred

ImmunisationAnatomicalSite

https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.route

preferred

ImmunisationRouteOfAdministration

https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.performer.function

extensible

Hl7VSProviderRoleAUExtended

http://terminology.hl7.org.au/ValueSet/v2-0443-extended

from this IG

Immunization.performer:administeredBy.function

extensible

Pattern: AP

http://hl7.org/fhir/ValueSet/immunization-function

from the FHIR Standard

Immunization.performer:approvedBy.function

extensible

Pattern: OP

http://hl7.org/fhir/ValueSet/immunization-function

from the FHIR Standard

Immunization.reasonCode

preferred

ReasonVaccineAdministered

https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1

from https://tx.ontoserver.csiro.au/fhir

Constraints

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

Description & Constraints

Immunization

0..*

Immunization

An immunisation statement in an Australian healthcare context

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet / Code URI

Immunization.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Immunization.status

required

ImmunizationStatusCodes

http://hl7.org/fhir/ValueSet/immunization-status|4.0.1

from the FHIR Standard

Immunization.statusReason

preferred

ReasonVaccineNotAdministered

https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3

from https://tx.ontoserver.csiro.au/fhir

Immunization.vaccineCode

example

VaccineAdministeredValueSet

Additional Bindings

Purpose

Documentation

Australian Medicines Terminology Vaccine

Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

Australian Immunisation Register Vaccine

Preferred

This value set is for use when AIR (Australian Immunisation Register) codes are preferred.

http://hl7.org/fhir/ValueSet/vaccine-code

from the FHIR Standard

Immunization.reportOrigin

example

ImmunizationOriginCodes

http://hl7.org/fhir/ValueSet/immunization-origin

from the FHIR Standard

Immunization.site

preferred

ImmunisationAnatomicalSite

https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.route

preferred

ImmunisationRouteOfAdministration

https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.performer.function

extensible

Hl7VSProviderRoleAUExtended

http://terminology.hl7.org.au/ValueSet/v2-0443-extended

from this IG

Immunization.performer:administeredBy.function

extensible

Pattern: AP

http://hl7.org/fhir/ValueSet/immunization-function

from the FHIR Standard

Immunization.performer:approvedBy.function

extensible

Pattern: OP

http://hl7.org/fhir/ValueSet/immunization-function

from the FHIR Standard

Immunization.reasonCode

preferred

ReasonVaccineAdministered

https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1

from https://tx.ontoserver.csiro.au/fhir

Immunization.subpotentReason

example

ImmunizationSubpotentReason

http://hl7.org/fhir/ValueSet/immunization-subpotent-reason

from the FHIR Standard

Immunization.programEligibility

example

ImmunizationProgramEligibility

http://hl7.org/fhir/ValueSet/immunization-program-eligibility

from the FHIR Standard

Immunization.fundingSource

example

ImmunizationFundingSource

http://hl7.org/fhir/ValueSet/immunization-funding-source

from the FHIR Standard

Immunization.protocolApplied.targetDisease

preferred

VaccinationTargetDisease

https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

from https://tx.ontoserver.csiro.au/fhir

Constraints

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

Summary

Mandatory: 0 element(2 nested mandatory elements)

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of Immunization.performer

Maturity: 3

Other representations of profile: CSV, Excel, Schematron

IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.2.2-ballot based on FHIR 4.0.1. Generated 2024-08-04
Links: Table of Contents | QA Report | Version History | | Propose a change