AU Base Implementation Guide
5.1.0-preview - Preview Australia flag

This page is part of the Australian Base IG (v5.1.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: Vaccine Vial Serial Number

Official URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number Version: 5.1.0-preview
Standards status: Trial-use Maturity Level: 1 Computable Name: VaccineSerialNumber

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

This extension applies to the Immunization resource and is used to represent the serial number of the vial of vaccine. Vial serial number is part of the Australian Immunisation Register Rule 2015 data elements to report for COVID-19 vaccines.

This extension may be used on the following element(s):

  • Element ID Immunization

Usage Notes

Usage:

Changes since version 5.0.0:

  • New Content
  • Formal Views of Extension Content

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

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Vaccine vial serial number
    ... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number"
    ... value[x] 1..1 string Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Vaccine vial serial number
    ... id 0..1 string Unique id for inter-element referencing
    ... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type string: This extension applies to the Immunization resource and is used to represent the serial number of the vial of vaccine. Vial serial number is part of the Australian Immunisation Register Rule 2015 data elements to report for COVID-19 vaccines.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Vaccine vial serial number
    ... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number"
    ... value[x] 1..1 string Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Vaccine vial serial number
    ... id 0..1 string Unique id for inter-element referencing
    ... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    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()