Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.5.0: R1 Draft) based on FHIR (HL7® FHIR® Standard) R3. The current version which supersedes this version is 6.0.0. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-immunisation

AU Base Immunisation [FMM Level 0]

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-immunisation

Australian realm Immunisation profile

This profile builds on Immunization.

This profile was published on Fri Feb 16 17:10:30 AEDT 2018 as a draft by Health Level Seven Australia (Medications).

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

AU Base Immunisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AU Base Immunisation
... vaccineCode 1..1CodeableConceptVaccine Administered
.... coding CodingSlice: Unordered, Open by value:system
.... coding 0..1CodingAustralian Vaccine Code
Binding: Australian Vaccine (required)
... patient 1..1Reference(AU Base PatientImmunised patient
... manufacturer 0..1Reference(AU Base OrganisationVaccine manufacturing organisation
... practitioner BackboneElementImmunisation performer(s)
Slice: Unordered, Open by value:role.coding
... practitioner 0..1BackboneElementImmunisation Administered By
.... role 1..1CodeableConceptAdministering Role
..... coding 1..*CodingFixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"AP","display":"Administering Provider"}
..... text 1..1stringFixed Value: Administering Provider
.... actor 1..1Reference(AU Base PractitionerAdminstrating provider
... practitioner 0..1BackboneElementImmunisation Approved By
.... role 1..1CodeableConceptApprover Role
..... coding 1..*CodingFixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"OP","display":"Ordering Provider"}
..... text 1..1stringFixed Value: Ordering Provider
.... actor 1..1Reference(AU Base PractitionerApproving provider
... explanation 0..1BackboneElementReasons for (Non)Immunisation
.... reasonNotGiven CodeableConceptSlice: Unordered, Open by value:coding.system
.... reasonNotGiven 0..*CodeableConceptSNOMED-CT coded reason
Binding: Reason Vaccine Not Given (required)
..... coding 1..1Coding

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*AU Base Immunisation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... 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..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecompleted | entered-in-error
Binding: Immunization Status Codes (required)
... notGiven ?!Σ1..1booleanFlag for whether immunization was given
... vaccineCode 1..1CodeableConceptVaccine Administered
Binding: Vaccine Administered Value Set (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding Σ0..1CodingAustralian Vaccine Code
Binding: Australian Vaccine (required)
.... text Σ0..1stringPlain text representation of the concept
... patient 1..1Reference(AU Base PatientImmunised patient
... encounter 0..1Reference(EncounterEncounter administered as part of
... date 0..1dateTimeVaccination administration date
... primarySource 1..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example)
... location 0..1Reference(LocationWhere vaccination occurred
... manufacturer 0..1Reference(AU Base OrganisationVaccine manufacturing organisation
... 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 ΣIBackboneElementImmunisation performer(s)
Slice: Unordered, Open by value:role.coding
.... 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(PractitionerIndividual who was performing
... practitioner ΣI0..1BackboneElementImmunisation Administered By
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ1..1CodeableConceptAdministering Role
Binding: Immunization Role Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..*CodingCode defined by a terminology system

Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"AP","display":"Administering Provider"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Administering Provider
.... actor Σ1..1Reference(AU Base PractitionerAdminstrating provider
... practitioner ΣI0..1BackboneElementImmunisation Approved By
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ1..1CodeableConceptApprover Role
Binding: Immunization Role Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..*CodingCode defined by a terminology system

Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"OP","display":"Ordering Provider"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Ordering Provider
.... actor Σ1..1Reference(AU Base PractitionerApproving provider
... note Σ0..*AnnotationVaccination notes
... explanation I0..1BackboneElementReasons for (Non)Immunisation
.... 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 CodeableConceptWhy immunization did not occur
Slice: Unordered, Open by value:coding.system
Binding: Immunization Reasons for Not Immunizing Codes (example)
.... reasonNotGiven 0..*CodeableConceptSNOMED-CT coded reason
Binding: Reason Vaccine Not Given (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
... 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(ObservationAdditional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol I0..*BackboneElementWhat 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(OrganizationWho is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease 1..*CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
.... doseStatus 1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
.... doseStatusReason 0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

AU Base Immunisation

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AU Base Immunisation
... vaccineCode 1..1CodeableConceptVaccine Administered
.... coding CodingSlice: Unordered, Open by value:system
.... coding 0..1CodingAustralian Vaccine Code
Binding: Australian Vaccine (required)
... patient 1..1Reference(AU Base PatientImmunised patient
... manufacturer 0..1Reference(AU Base OrganisationVaccine manufacturing organisation
... practitioner BackboneElementImmunisation performer(s)
Slice: Unordered, Open by value:role.coding
... practitioner 0..1BackboneElementImmunisation Administered By
.... role 1..1CodeableConceptAdministering Role
..... coding 1..*CodingFixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"AP","display":"Administering Provider"}
..... text 1..1stringFixed Value: Administering Provider
.... actor 1..1Reference(AU Base PractitionerAdminstrating provider
... practitioner 0..1BackboneElementImmunisation Approved By
.... role 1..1CodeableConceptApprover Role
..... coding 1..*CodingFixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"OP","display":"Ordering Provider"}
..... text 1..1stringFixed Value: Ordering Provider
.... actor 1..1Reference(AU Base PractitionerApproving provider
... explanation 0..1BackboneElementReasons for (Non)Immunisation
.... reasonNotGiven CodeableConceptSlice: Unordered, Open by value:coding.system
.... reasonNotGiven 0..*CodeableConceptSNOMED-CT coded reason
Binding: Reason Vaccine Not Given (required)
..... coding 1..1Coding

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*AU Base Immunisation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... 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..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecompleted | entered-in-error
Binding: Immunization Status Codes (required)
... notGiven ?!Σ1..1booleanFlag for whether immunization was given
... vaccineCode 1..1CodeableConceptVaccine Administered
Binding: Vaccine Administered Value Set (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding Σ0..1CodingAustralian Vaccine Code
Binding: Australian Vaccine (required)
.... text Σ0..1stringPlain text representation of the concept
... patient 1..1Reference(AU Base PatientImmunised patient
... encounter 0..1Reference(EncounterEncounter administered as part of
... date 0..1dateTimeVaccination administration date
... primarySource 1..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example)
... location 0..1Reference(LocationWhere vaccination occurred
... manufacturer 0..1Reference(AU Base OrganisationVaccine manufacturing organisation
... 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 ΣIBackboneElementImmunisation performer(s)
Slice: Unordered, Open by value:role.coding
.... 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(PractitionerIndividual who was performing
... practitioner ΣI0..1BackboneElementImmunisation Administered By
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ1..1CodeableConceptAdministering Role
Binding: Immunization Role Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..*CodingCode defined by a terminology system

Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"AP","display":"Administering Provider"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Administering Provider
.... actor Σ1..1Reference(AU Base PractitionerAdminstrating provider
... practitioner ΣI0..1BackboneElementImmunisation Approved By
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ1..1CodeableConceptApprover Role
Binding: Immunization Role Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..*CodingCode defined by a terminology system

Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"OP","display":"Ordering Provider"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Ordering Provider
.... actor Σ1..1Reference(AU Base PractitionerApproving provider
... note Σ0..*AnnotationVaccination notes
... explanation I0..1BackboneElementReasons for (Non)Immunisation
.... 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 CodeableConceptWhy immunization did not occur
Slice: Unordered, Open by value:coding.system
Binding: Immunization Reasons for Not Immunizing Codes (example)
.... reasonNotGiven 0..*CodeableConceptSNOMED-CT coded reason
Binding: Reason Vaccine Not Given (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
... 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(ObservationAdditional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol I0..*BackboneElementWhat 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(OrganizationWho is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease 1..*CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
.... doseStatus 1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
.... 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-au-immunisation

none defined