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

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 5.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Resource Profile: AU Base Immunisation

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

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

This profile defines an immunisation structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Usage Notes

Usage:

Changes since version 5.0.0:

  • The data elements list has changed
  • Formal Views of Profile Content

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

    This structure is derived from Immunization

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Immunization 0..* Immunization An immunisation statement in an Australian healthcare context
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:vaccineVialSerialNumber 0..1 string Vaccine vial serial number
    URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
    ... statusReason 0..1 CodeableConcept Reason not done
    Binding: Reason Vaccine Not Administered . (preferred)
    ... vaccineCode 1..1 CodeableConcept Vaccine product administered
    Binding: VaccineAdministeredValueSet (example)
    Additional BindingsPurpose
    Australian Medicines Terminology Vaccine . Preferred
    Australian Immunisation Register Vaccine . Preferred
    ... site 0..1 CodeableConcept Body site vaccine was administered
    Binding: Immunisation Anatomical Site . (preferred)
    ... route 0..1 CodeableConcept How vaccine entered body
    Binding: Immunisation Route of Administration . (preferred)
    ... Slices for performer 0..* BackboneElement Who performed event
    Slice: Unordered, Open by pattern:function
    .... performer:All Slices Content/Rules for all slices
    ..... function 0..1 CodeableConcept What type of performance was done
    Binding: hl7VS-providerRole - AU Extended (extensible)
    .... performer:administeredBy 0..1 BackboneElement Immunisation Administered By
    ..... function 1..1 CodeableConcept Administering role
    Required Pattern: At least the following
    ...... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ....... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
    ....... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: AP
    ..... actor 1..1 Reference(Practitioner | PractitionerRole | Organization) Administering performer
    .... performer:approvedBy 0..1 BackboneElement Immunisation Approved By
    ..... function 1..1 CodeableConcept Approver role
    Required Pattern: At least the following
    ...... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ....... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
    ....... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: OP
    ..... actor 1..1 Reference(Practitioner | PractitionerRole | Organization) Approver
    ... reasonCode 0..* CodeableConcept Why immunization occurred
    Binding: Reason Vaccine Administered . (preferred)
    ... protocolApplied
    .... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
    Binding: Vaccination Target Disease . (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Immunization.statusReasonpreferredReasonVaccineNotAdministered .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
    Immunization.vaccineCodeexampleVaccineAdministeredValueSet
    Immunization.sitepreferredImmunisationAnatomicalSite .
    https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1
    Immunization.routepreferredImmunisationRouteOfAdministration .
    https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1
    Immunization.performer.functionextensibleHl7VSProviderRoleAUExtended
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.reasonCodepreferredReasonVaccineAdministered .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
    Immunization.protocolApplied.targetDiseasepreferredVaccinationTargetDisease .
    https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Immunization 0..* Immunization An immunisation statement in an Australian healthcare context
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: 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
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    .... extension:vaccineVialSerialNumber 0..1 string Vaccine vial serial number
    URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... statusReason 0..1 CodeableConcept Reason not done
    Binding: Reason Vaccine Not Administered . (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
    Binding: VaccineAdministeredValueSet (example)
    Additional BindingsPurpose
    Australian Medicines Terminology Vaccine . Preferred
    Australian Immunisation Register Vaccine . Preferred

    ele-1: All FHIR elements must have a @value or children
    ... patient Σ 1..1 Reference(Patient) Who was immunized
    ele-1: All FHIR elements must have a @value or children
    ... occurrence[x] Σ 1..1 Vaccine administration date
    ele-1: All FHIR elements must have a @value or children
    .... occurrenceDateTime dateTime
    .... occurrenceString string
    ... manufacturer 0..1 Reference(Organization) Vaccine manufacturer
    ele-1: All FHIR elements must have a @value or children
    ... site 0..1 CodeableConcept Body site vaccine was administered
    Binding: Immunisation Anatomical Site . (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... route 0..1 CodeableConcept How vaccine entered body
    Binding: Immunisation Route of Administration . (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... Slices for performer Σ 0..* BackboneElement Who performed event
    Slice: Unordered, Open by pattern:function
    ele-1: All FHIR elements must have a @value or children
    .... performer:All Slices Content/Rules for all slices
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ..... function Σ 0..1 CodeableConcept What type of performance was done
    Binding: hl7VS-providerRole - AU Extended (extensible)
    ele-1: All FHIR elements must have a @value or children
    ..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
    ele-1: All FHIR elements must have a @value or children
    .... performer:administeredBy Σ 0..1 BackboneElement Immunisation Administered By
    ele-1: All FHIR elements must have a @value or children
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ..... function Σ 1..1 CodeableConcept Administering role
    Binding: hl7VS-providerRole - AU Extended (extensible)
    ele-1: All FHIR elements must have a @value or children
    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
    ele-1: All FHIR elements must have a @value or children
    .... performer:approvedBy Σ 0..1 BackboneElement Immunisation Approved By
    ele-1: All FHIR elements must have a @value or children
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ..... function Σ 1..1 CodeableConcept Approver role
    Binding: hl7VS-providerRole - AU Extended (extensible)
    ele-1: All FHIR elements must have a @value or children
    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
    ele-1: All FHIR elements must have a @value or children
    ... reasonCode 0..* CodeableConcept Why immunization occurred
    Binding: Reason Vaccine Administered . (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... isSubpotent ?!Σ 0..1 boolean Dose potency
    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Immunization.statusrequiredImmunizationStatusCodes
    http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
    from the FHIR Standard
    Immunization.statusReasonpreferredReasonVaccineNotAdministered .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
    Immunization.vaccineCodeexampleVaccineAdministeredValueSet
    http://hl7.org/fhir/ValueSet/vaccine-code
    from the FHIR Standard
    Immunization.sitepreferredImmunisationAnatomicalSite .
    https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1
    Immunization.routepreferredImmunisationRouteOfAdministration .
    https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1
    Immunization.performer.functionextensibleHl7VSProviderRoleAUExtended
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.performer:administeredBy.functionextensiblePattern: AP
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.performer:approvedBy.functionextensiblePattern: OP
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.reasonCodepreferredReasonVaccineAdministered .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceImmunizationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. 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
    ... 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 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
    imm-1: One of documentType or reference SHALL be present
    .... 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

    PathConformanceValueSet / CodeURI
    Immunization.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    Immunization.statusrequiredImmunizationStatusCodes
    http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
    from the FHIR Standard
    Immunization.statusReasonpreferredReasonVaccineNotAdministered .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
    Immunization.vaccineCodeexampleVaccineAdministeredValueSet
    http://hl7.org/fhir/ValueSet/vaccine-code
    from the FHIR Standard
    Immunization.reportOriginexampleImmunizationOriginCodes
    http://hl7.org/fhir/ValueSet/immunization-origin
    from the FHIR Standard
    Immunization.sitepreferredImmunisationAnatomicalSite .
    https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1
    Immunization.routepreferredImmunisationRouteOfAdministration .
    https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1
    Immunization.performer.functionextensibleHl7VSProviderRoleAUExtended
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.performer:administeredBy.functionextensiblePattern: AP
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.performer:approvedBy.functionextensiblePattern: OP
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.reasonCodepreferredReasonVaccineAdministered .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
    Immunization.subpotentReasonexampleImmunizationSubpotentReason
    http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
    from the FHIR Standard
    Immunization.programEligibilityexampleImmunizationProgramEligibility
    http://hl7.org/fhir/ValueSet/immunization-program-eligibility
    from the FHIR Standard
    Immunization.fundingSourceexampleImmunizationFundingSource
    http://hl7.org/fhir/ValueSet/immunization-funding-source
    from the FHIR Standard
    Immunization.protocolApplied.targetDiseasepreferredVaccinationTargetDisease .
    https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceImmunizationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    imm-1errorImmunization.educationOne 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

    Differential View

    This structure is derived from Immunization

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Immunization 0..* Immunization An immunisation statement in an Australian healthcare context
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:vaccineVialSerialNumber 0..1 string Vaccine vial serial number
    URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
    ... statusReason 0..1 CodeableConcept Reason not done
    Binding: Reason Vaccine Not Administered . (preferred)
    ... vaccineCode 1..1 CodeableConcept Vaccine product administered
    Binding: VaccineAdministeredValueSet (example)
    Additional BindingsPurpose
    Australian Medicines Terminology Vaccine . Preferred
    Australian Immunisation Register Vaccine . Preferred
    ... site 0..1 CodeableConcept Body site vaccine was administered
    Binding: Immunisation Anatomical Site . (preferred)
    ... route 0..1 CodeableConcept How vaccine entered body
    Binding: Immunisation Route of Administration . (preferred)
    ... Slices for performer 0..* BackboneElement Who performed event
    Slice: Unordered, Open by pattern:function
    .... performer:All Slices Content/Rules for all slices
    ..... function 0..1 CodeableConcept What type of performance was done
    Binding: hl7VS-providerRole - AU Extended (extensible)
    .... performer:administeredBy 0..1 BackboneElement Immunisation Administered By
    ..... function 1..1 CodeableConcept Administering role
    Required Pattern: At least the following
    ...... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ....... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
    ....... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: AP
    ..... actor 1..1 Reference(Practitioner | PractitionerRole | Organization) Administering performer
    .... performer:approvedBy 0..1 BackboneElement Immunisation Approved By
    ..... function 1..1 CodeableConcept Approver role
    Required Pattern: At least the following
    ...... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ....... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
    ....... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: OP
    ..... actor 1..1 Reference(Practitioner | PractitionerRole | Organization) Approver
    ... reasonCode 0..* CodeableConcept Why immunization occurred
    Binding: Reason Vaccine Administered . (preferred)
    ... protocolApplied
    .... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
    Binding: Vaccination Target Disease . (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

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

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Immunization 0..* Immunization An immunisation statement in an Australian healthcare context
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: 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
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    .... extension:vaccineVialSerialNumber 0..1 string Vaccine vial serial number
    URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... statusReason 0..1 CodeableConcept Reason not done
    Binding: Reason Vaccine Not Administered . (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
    Binding: VaccineAdministeredValueSet (example)
    Additional BindingsPurpose
    Australian Medicines Terminology Vaccine . Preferred
    Australian Immunisation Register Vaccine . Preferred

    ele-1: All FHIR elements must have a @value or children
    ... patient Σ 1..1 Reference(Patient) Who was immunized
    ele-1: All FHIR elements must have a @value or children
    ... occurrence[x] Σ 1..1 Vaccine administration date
    ele-1: All FHIR elements must have a @value or children
    .... occurrenceDateTime dateTime
    .... occurrenceString string
    ... manufacturer 0..1 Reference(Organization) Vaccine manufacturer
    ele-1: All FHIR elements must have a @value or children
    ... site 0..1 CodeableConcept Body site vaccine was administered
    Binding: Immunisation Anatomical Site . (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... route 0..1 CodeableConcept How vaccine entered body
    Binding: Immunisation Route of Administration . (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... Slices for performer Σ 0..* BackboneElement Who performed event
    Slice: Unordered, Open by pattern:function
    ele-1: All FHIR elements must have a @value or children
    .... performer:All Slices Content/Rules for all slices
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ..... function Σ 0..1 CodeableConcept What type of performance was done
    Binding: hl7VS-providerRole - AU Extended (extensible)
    ele-1: All FHIR elements must have a @value or children
    ..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
    ele-1: All FHIR elements must have a @value or children
    .... performer:administeredBy Σ 0..1 BackboneElement Immunisation Administered By
    ele-1: All FHIR elements must have a @value or children
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ..... function Σ 1..1 CodeableConcept Administering role
    Binding: hl7VS-providerRole - AU Extended (extensible)
    ele-1: All FHIR elements must have a @value or children
    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
    ele-1: All FHIR elements must have a @value or children
    .... performer:approvedBy Σ 0..1 BackboneElement Immunisation Approved By
    ele-1: All FHIR elements must have a @value or children
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ..... function Σ 1..1 CodeableConcept Approver role
    Binding: hl7VS-providerRole - AU Extended (extensible)
    ele-1: All FHIR elements must have a @value or children
    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
    ele-1: All FHIR elements must have a @value or children
    ... reasonCode 0..* CodeableConcept Why immunization occurred
    Binding: Reason Vaccine Administered . (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... isSubpotent ?!Σ 0..1 boolean Dose potency
    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Immunization.statusrequiredImmunizationStatusCodes
    http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
    from the FHIR Standard
    Immunization.statusReasonpreferredReasonVaccineNotAdministered .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
    Immunization.vaccineCodeexampleVaccineAdministeredValueSet
    http://hl7.org/fhir/ValueSet/vaccine-code
    from the FHIR Standard
    Immunization.sitepreferredImmunisationAnatomicalSite .
    https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1
    Immunization.routepreferredImmunisationRouteOfAdministration .
    https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1
    Immunization.performer.functionextensibleHl7VSProviderRoleAUExtended
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.performer:administeredBy.functionextensiblePattern: AP
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.performer:approvedBy.functionextensiblePattern: OP
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.reasonCodepreferredReasonVaccineAdministered .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceImmunizationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. 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
    ... 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 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
    imm-1: One of documentType or reference SHALL be present
    .... 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

    PathConformanceValueSet / CodeURI
    Immunization.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    Immunization.statusrequiredImmunizationStatusCodes
    http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
    from the FHIR Standard
    Immunization.statusReasonpreferredReasonVaccineNotAdministered .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
    Immunization.vaccineCodeexampleVaccineAdministeredValueSet
    http://hl7.org/fhir/ValueSet/vaccine-code
    from the FHIR Standard
    Immunization.reportOriginexampleImmunizationOriginCodes
    http://hl7.org/fhir/ValueSet/immunization-origin
    from the FHIR Standard
    Immunization.sitepreferredImmunisationAnatomicalSite .
    https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1
    Immunization.routepreferredImmunisationRouteOfAdministration .
    https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1
    Immunization.performer.functionextensibleHl7VSProviderRoleAUExtended
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.performer:administeredBy.functionextensiblePattern: AP
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.performer:approvedBy.functionextensiblePattern: OP
    http://terminology.hl7.org.au/ValueSet/v2-0443-extended
    from this IG
    Immunization.reasonCodepreferredReasonVaccineAdministered .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
    Immunization.subpotentReasonexampleImmunizationSubpotentReason
    http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
    from the FHIR Standard
    Immunization.programEligibilityexampleImmunizationProgramEligibility
    http://hl7.org/fhir/ValueSet/immunization-program-eligibility
    from the FHIR Standard
    Immunization.fundingSourceexampleImmunizationFundingSource
    http://hl7.org/fhir/ValueSet/immunization-funding-source
    from the FHIR Standard
    Immunization.protocolApplied.targetDiseasepreferredVaccinationTargetDisease .
    https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceImmunizationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    imm-1errorImmunization.educationOne 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