AU Base Implementation Guide
6.0.0-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 6.0.0-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 Immunization

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-immunization Version: 6.0.0-ci-build
Standards status: Trial-use Maturity Level: 3 Computable Name: AUBaseImmunization

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

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 5.0.0:

  • The resource metadata has changed (name, title)
  • The data elements list has changed

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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
    ... 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
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... 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
    ... 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: hl7VS-providerRole - AU Extended (extensible)
    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
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... function Σ 1..1 CodeableConcept Approver role
    Binding: hl7VS-providerRole - AU Extended (extensible)
    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
    ... reasonCode 0..* CodeableConcept Why immunization occurred
    Binding: Reason Vaccine Administered . (preferred)
    ... isSubpotent ?!Σ 0..1 boolean Dose potency

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
    Immunization.statusReason Base preferred Reason Vaccine Not Administered . ⏿3.0.0 tx.ontoserver.csiro.au
    Immunization.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
    Immunization.site Base preferred Immunisation Anatomical Site . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.route Base preferred Immunisation Route of Administration . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.performer.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.performer:administeredBy.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.performer:approvedBy.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.reasonCode Base preferred Reason Vaccine Administered . ⏿1.0.2 tx.ontoserver.csiro.au

    Constraints

    Id Grade Path(s) Description Expression
    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()

    This structure is derived from Immunization

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)

    Path Status Usage ValueSet Version Source
    Immunization.statusReason Base preferred Reason Vaccine Not Administered . ⏿3.0.0 tx.ontoserver.csiro.au
    Immunization.vaccineCode Base example Not Stated Unknown
    Immunization.site Base preferred Immunisation Anatomical Site . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.route Base preferred Immunisation Route of Administration . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.performer.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.reasonCode Base preferred Reason Vaccine Administered . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.protocolApplied.​targetDisease Base preferred Vaccination Target Disease . ⏿1.0.2 tx.ontoserver.csiro.au
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    ... contained 0..* Resource Contained, inline Resources
    ... 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
    ... 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)
    Additional BindingsPurpose
    Australian Medicines Terminology Vaccine . Preferred
    Australian Immunisation Register Vaccine . Preferred
    ... 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(4.0.1) 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: hl7VS-providerRole - AU Extended (extensible)
    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: hl7VS-providerRole - AU Extended (extensible)
    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
    Constraints: imm-1
    .... 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

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
    Immunization.statusReason Base preferred Reason Vaccine Not Administered . ⏿3.0.0 tx.ontoserver.csiro.au
    Immunization.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
    Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
    Immunization.site Base preferred Immunisation Anatomical Site . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.route Base preferred Immunisation Route of Administration . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.performer.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.performer:administeredBy.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.performer:approvedBy.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.reasonCode Base preferred Reason Vaccine Administered . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
    Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
    Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
    Immunization.protocolApplied.​targetDisease Base preferred Vaccination Target Disease . ⏿1.0.2 tx.ontoserver.csiro.au

    Constraints

    Id Grade Path(s) Description Expression
    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)

    Extensions

    This structure refers to these extensions:

    Slices

    This structure defines the following Slices:

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

    Maturity: 3

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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
    ... 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
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... 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
    ... 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: hl7VS-providerRole - AU Extended (extensible)
    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
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... function Σ 1..1 CodeableConcept Approver role
    Binding: hl7VS-providerRole - AU Extended (extensible)
    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
    ... reasonCode 0..* CodeableConcept Why immunization occurred
    Binding: Reason Vaccine Administered . (preferred)
    ... isSubpotent ?!Σ 0..1 boolean Dose potency

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
    Immunization.statusReason Base preferred Reason Vaccine Not Administered . ⏿3.0.0 tx.ontoserver.csiro.au
    Immunization.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
    Immunization.site Base preferred Immunisation Anatomical Site . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.route Base preferred Immunisation Route of Administration . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.performer.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.performer:administeredBy.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.performer:approvedBy.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.reasonCode Base preferred Reason Vaccine Administered . ⏿1.0.2 tx.ontoserver.csiro.au

    Constraints

    Id Grade Path(s) Description Expression
    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()

    Differential View

    This structure is derived from Immunization

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)

    Path Status Usage ValueSet Version Source
    Immunization.statusReason Base preferred Reason Vaccine Not Administered . ⏿3.0.0 tx.ontoserver.csiro.au
    Immunization.vaccineCode Base example Not Stated Unknown
    Immunization.site Base preferred Immunisation Anatomical Site . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.route Base preferred Immunisation Route of Administration . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.performer.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.reasonCode Base preferred Reason Vaccine Administered . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.protocolApplied.​targetDisease Base preferred Vaccination Target Disease . ⏿1.0.2 tx.ontoserver.csiro.au

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    ... contained 0..* Resource Contained, inline Resources
    ... 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
    ... 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)
    Additional BindingsPurpose
    Australian Medicines Terminology Vaccine . Preferred
    Australian Immunisation Register Vaccine . Preferred
    ... 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(4.0.1) 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: hl7VS-providerRole - AU Extended (extensible)
    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: hl7VS-providerRole - AU Extended (extensible)
    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
    Constraints: imm-1
    .... 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

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
    Immunization.statusReason Base preferred Reason Vaccine Not Administered . ⏿3.0.0 tx.ontoserver.csiro.au
    Immunization.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
    Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
    Immunization.site Base preferred Immunisation Anatomical Site . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.route Base preferred Immunisation Route of Administration . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.performer.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.performer:administeredBy.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.performer:approvedBy.​function Base extensible hl7VS-providerRole - AU Extended 📦6.0.0-ci-build This IG
    Immunization.reasonCode Base preferred Reason Vaccine Administered . ⏿1.0.2 tx.ontoserver.csiro.au
    Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
    Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
    Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
    Immunization.protocolApplied.​targetDisease Base preferred Vaccination Target Disease . ⏿1.0.2 tx.ontoserver.csiro.au

    Constraints

    Id Grade Path(s) Description Expression
    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)

    Extensions

    This structure refers to these extensions:

    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