Medicare Records FHIR Implementation Guide version 1.0.0

1.0 StructureDefinition-immunization-air

This profile defines a representation of vaccination information from the Australian Immunisation Register.

Usage Scenarios

The following are the usage scenarios expected:

  • DHS Medicare sends records of administered vaccines to the My Health Record system
Each Immunization SHALL have
  1. a profile assertion to this profile
  2. an identifier for this immunisation record
  3. a status of vaccination event
  4. a flag to indicate whether the vaccine was administered
  5. a vaccine
  6. a patient
  7. a flag to indicate this data is based on information from the person who administered the vaccine
Must Support

In the context of this profile Must Support SHALL be interpreted as follows.

  • The system SHALL be able to store and retrieve the following elements:
    • status
    • notGiven
    • vaccineCode
    • date
    • primarySource
    • explanation
    • explanation.reasonNotGiven
    • vaccinationProtocol
    • vaccinationProtocol.targetDisease
    • vaccinationProtocol.doseStatus
    • extension-immunization-cancellationperiod
  • The system SHALL be able to take the following elements into account when performing processing:
    • identifier
    • patient
Profile-specific implementation guidance
  • The patient resource should be identified in the patient element with a logical reference, i.e. an Australian IHI
  • If a resource is referenced rather than identified in the applicable element, the referenced resource should be contained
  • In order to provide identification of a target disease to be protected against, the resource requires a dose status; this data is not available so doseStatus has been set to NAVU Not Available
  • Though not expected to be provided, a cancelled, rejected, or not administered vaccination can be represented using notGiven=true and status=completed
Examples
  1. Administered immunisation - short
  2. Administered immunisation
  3. Immunisation not given
  4. Administered immunisation with text list of targetDisease

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air

This profile defines representation of vaccination information from the Australian Immunisation Register.

This profile builds on Immunization.

This profile was published on Tue Aug 28 00:00:00 AEST 2018 as a active by Australian Digital Health Agency.

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

This structure is derived from the STU3 FHIR® resource Immunization.

This profile introduces the following variations from the above core resource:

  1. Conditional invariants
    • inv-dh-imm-01: If immunization was administered (notGiven is false) then date SHALL be present and cancellation period SHALL be absent.
  2. One meta.profile is ‘http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air’
  3. Exactly one identifier
  4. status is ‘completed’
  5. vaccineCode required binding to Australian Vaccine value set
  6. patient as AU Base Patient
  7. primarySource is ‘true’
  8. manufacturer as AU Base Organisation
  9. practitioner.actor as AU Base Practitioner
  10. explanation.reasonNotGiven extensible binding to Reason Vaccine Not Administered value set
  11. At most one vaccinationProtocol
  12. vaccinationProtocol.authority as AU Base Organisation
  13. vaccinationProtocol.doseStatus is Not available (Details : {http://hl7.org/fhir/v3/NullFlavor code ‘NAVU’})
  14. At most one Extension Immunization Cancellation Period
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*inv-dh-imm-01: If immunization was administered (notGiven=false) then date SHALL be present and cancellation period SHALL be absent.
inv-dh-imm-02: One meta.profile SHALL have value 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air'
... meta 1..1Meta
.... profile 1..*uri
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... extension-immunization-cancellationperiod S0..1PeriodImmunisation cancellation period
URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/extension-immunization-cancellationperiod
... identifier S1..1Identifier
... status S1..1codeFixed Value: completed
... notGiven S1..1boolean
... vaccineCode S1..1CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-1 (required)
... patient S1..1Reference(AU Base Patient)
... date S0..1dateTime
... primarySource S1..1booleanFixed Value: true
... manufacturer 0..1Reference(AU Base Organisation)
... practitioner 0..*BackboneElement
.... actor 1..1Reference(AU Base Practitioner)
... explanation S0..1BackboneElement
.... reasonNotGiven S0..*CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (extensible)
... vaccinationProtocol S0..1BackboneElement
.... authority 0..1Reference(AU Base Organisation)
.... targetDisease S1..*CodeableConcept
.... doseStatus S1..1CodeableConceptFixed Value: {"coding":[{"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NAVU"}]} (Not available)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*Immunization event information
inv-dh-imm-01: If immunization was administered (notGiven=false) then date SHALL be present and cancellation period SHALL be absent.
inv-dh-imm-02: One meta.profile SHALL have value 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air'
... id Σ0..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ1..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: Common Tags (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension-immunization-cancellationperiod SI0..1PeriodImmunisation cancellation period
URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/extension-immunization-cancellationperiod
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..1IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error
Binding: Immunization Status Codes (required)
Fixed Value: completed
... notGiven ?!SΣ1..1booleanFlag for whether immunization was given
... vaccineCode S1..1CodeableConceptVaccine product administered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-1 (required)
... patient S1..1Reference(AU Base Patient)Who was immunized
... encounter 0..1Reference(Encounter)Encounter administered as part of
... date S0..1dateTimeVaccination administration date
... primarySource S1..1booleanIndicates context the data was recorded in
Fixed Value: true
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example)
... location 0..1Reference(Location)Where vaccination occurred
... manufacturer 0..1Reference(AU Base Organisation)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: Codes for Immunization Site of Administration (example)
... route 0..1CodeableConceptHow vaccine entered body
Binding: Immunization Route Codes (example)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... practitioner ΣI0..*BackboneElementWho performed event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ0..1CodeableConceptWhat type of performance was done
Binding: Immunization Role Codes (extensible)
.... actor Σ1..1Reference(AU Base Practitioner)Individual who was performing
... note Σ0..*AnnotationVaccination notes
... explanation SI0..1BackboneElementAdministration/non-administration reasons
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... reason 0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (extensible)
... reaction I0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol SI0..1BackboneElementWhat protocol was followed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... doseSequence 0..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(AU Base Organisation)Who is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease S1..*CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
.... doseStatus S1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NAVU"}]} (Not available)
.... doseStatusReason 0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

This structure is derived from the STU3 FHIR® resource Immunization.

This profile introduces the following variations from the above core resource:

  1. Conditional invariants
    • inv-dh-imm-01: If immunization was administered (notGiven is false) then date SHALL be present and cancellation period SHALL be absent.
  2. One meta.profile is ‘http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air’
  3. Exactly one identifier
  4. status is ‘completed’
  5. vaccineCode required binding to Australian Vaccine value set
  6. patient as AU Base Patient
  7. primarySource is ‘true’
  8. manufacturer as AU Base Organisation
  9. practitioner.actor as AU Base Practitioner
  10. explanation.reasonNotGiven extensible binding to Reason Vaccine Not Administered value set
  11. At most one vaccinationProtocol
  12. vaccinationProtocol.authority as AU Base Organisation
  13. vaccinationProtocol.doseStatus is Not available (Details : {http://hl7.org/fhir/v3/NullFlavor code ‘NAVU’})
  14. At most one Extension Immunization Cancellation Period

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*inv-dh-imm-01: If immunization was administered (notGiven=false) then date SHALL be present and cancellation period SHALL be absent.
inv-dh-imm-02: One meta.profile SHALL have value 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air'
... meta 1..1Meta
.... profile 1..*uri
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... extension-immunization-cancellationperiod S0..1PeriodImmunisation cancellation period
URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/extension-immunization-cancellationperiod
... identifier S1..1Identifier
... status S1..1codeFixed Value: completed
... notGiven S1..1boolean
... vaccineCode S1..1CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-1 (required)
... patient S1..1Reference(AU Base Patient)
... date S0..1dateTime
... primarySource S1..1booleanFixed Value: true
... manufacturer 0..1Reference(AU Base Organisation)
... practitioner 0..*BackboneElement
.... actor 1..1Reference(AU Base Practitioner)
... explanation S0..1BackboneElement
.... reasonNotGiven S0..*CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (extensible)
... vaccinationProtocol S0..1BackboneElement
.... authority 0..1Reference(AU Base Organisation)
.... targetDisease S1..*CodeableConcept
.... doseStatus S1..1CodeableConceptFixed Value: {"coding":[{"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NAVU"}]} (Not available)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*Immunization event information
inv-dh-imm-01: If immunization was administered (notGiven=false) then date SHALL be present and cancellation period SHALL be absent.
inv-dh-imm-02: One meta.profile SHALL have value 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/immunization-air'
... id Σ0..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ1..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: Common Tags (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension-immunization-cancellationperiod SI0..1PeriodImmunisation cancellation period
URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/extension-immunization-cancellationperiod
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..1IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error
Binding: Immunization Status Codes (required)
Fixed Value: completed
... notGiven ?!SΣ1..1booleanFlag for whether immunization was given
... vaccineCode S1..1CodeableConceptVaccine product administered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-1 (required)
... patient S1..1Reference(AU Base Patient)Who was immunized
... encounter 0..1Reference(Encounter)Encounter administered as part of
... date S0..1dateTimeVaccination administration date
... primarySource S1..1booleanIndicates context the data was recorded in
Fixed Value: true
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example)
... location 0..1Reference(Location)Where vaccination occurred
... manufacturer 0..1Reference(AU Base Organisation)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: Codes for Immunization Site of Administration (example)
... route 0..1CodeableConceptHow vaccine entered body
Binding: Immunization Route Codes (example)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... practitioner ΣI0..*BackboneElementWho performed event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ0..1CodeableConceptWhat type of performance was done
Binding: Immunization Role Codes (extensible)
.... actor Σ1..1Reference(AU Base Practitioner)Individual who was performing
... note Σ0..*AnnotationVaccination notes
... explanation SI0..1BackboneElementAdministration/non-administration reasons
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... reason 0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (extensible)
... reaction I0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol SI0..1BackboneElementWhat protocol was followed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... doseSequence 0..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(AU Base Organisation)Who is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease S1..*CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
.... doseStatus S1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NAVU"}]} (Not available)
.... doseStatusReason 0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-immunization-air

none defined