MediRecords FHIR Implementation Guide
1.4.2 - release


Resource Profile: MR Immunisation

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-immunisation
Version:1.4.2
Name:MRImmunisation
Title:MR Immunisation
Status:Active as of 2025-04-04 01:10:23+0000
Definition:

MediRecords Immunisation profile to record vaccination that had been administered to the patient in context

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://fhir.medirecords.com/StructureDefinition/mr-immunisation

Formal Views of Profile Content

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

This structure is derived from AUBaseImmunisation

Summary

Mandatory: 1 element
Must-Support: 16 elements

Structures

This structure refers to these other structures:

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.occurrence[x]
  • The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]

This structure is derived from AUBaseImmunisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* AUBaseImmunisation An immunisation statement in an Australian healthcare context
... meta 0..1 MRMeta Metadata about a resource
.... lastUpdated S 0..1 instant When the resource version last changed
.... security S 0..* Coding Security Labels applied to this resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... vaccineSerialNumber S 0..1 string Vaccine Serial Number Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-vaccine-serial-number-extn
... status S 1..1 code completed | entered-in-error | not-done
... vaccineCode
.... Slices for coding Content/Rules for all slices
..... coding:amtVaccineCode S 0..1 Coding AMT Vaccine
..... coding:airVaccineCode S 0..1 Coding AIR Vaccine
... patient S 1..1 Reference(MR Patient) Who was immunized
... encounter S 0..1 Reference(MR Encounter) Encounter immunization was part of
... Slices for occurrence[x] 1..1 dateTime Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 1..1 dateTime Vaccine administration date
... lotNumber S 0..1 string Batch Number
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunisation Anatomical Site . (extensible)
... Slices for performer Content/Rules for all slices
.... performer:administeredBy 0..1 BackboneElement Immunisation Administered By
..... actor S 1..1 Reference(MR Practitioner) Administering performer
.... performer:approvedBy 0..1 BackboneElement Immunisation Approved By
..... actor S 1..1 Reference(MR Practitioner) Approver
... note 0..1 Annotation Additional immunization notes
.... text S 1..1 markdown The annotation - text content (as markdown)
... protocolApplied
.... Slices for doseNumber[x] 1..1 positiveInt, string Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumber[x]:doseNumberPositiveInt S 0..1 positiveInt Dose number within series

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* AUBaseImmunisation An immunisation statement in an Australian healthcare context
... id Σ 0..1 id Logical id of this artifact
... meta 0..1 MRMeta Metadata about a resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security SΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-mr-meta-security-01: Medirecords supports only U, R security code
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
.... vaccineSerialNumber S 0..1 string Vaccine Serial Number Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-vaccine-serial-number-extn
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S 0..1 CodeableConcept Reason not done
Binding: Reason Vaccine Not Administered . (preferred)
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode SΣ 0..1 Coding AMT Vaccine
Binding: Australian Medicines Terminology Vaccine . (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:airVaccineCode SΣ 0..1 Coding AIR Vaccine
Binding: Australian Immunisation Register Vaccine . (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... 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
... patient SΣ 1..1 Reference(MR Patient) Who was immunized
... encounter S 0..1 Reference(MR Encounter) Encounter immunization was part of
... Slices for occurrence[x] Σ 1..1 dateTime Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ 1..1 dateTime Vaccine administration date
... 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 S 0..1 string Batch Number
... expirationDate 0..1 date Vaccine expiration date
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunisation Anatomical Site . (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... route 0..1 CodeableConcept How vaccine entered body
Binding: Immunisation Route of Administration . (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... 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: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


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 SΣ 1..1 Reference(MR Practitioner) 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: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


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 SΣ 1..1 Reference(MR Practitioner) Approver
... note Σ 0..1 Annotation Additional immunization notes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
... 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)
.... Slices for doseNumber[x] 1..1 Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
..... doseNumber[x]:doseNumberPositiveInt S 0..1 positiveInt Dose number within series
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* AUBaseImmunisation An immunisation statement in an Australian healthcare context
... meta 0..1 MRMeta Metadata about a resource
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... security ΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-mr-meta-security-01: Medirecords supports only U, R security code
... Slices for extension Content/Rules for all slices
.... vaccineSerialNumber 0..1 string Vaccine Serial Number Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-vaccine-serial-number-extn
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
.... Slices for coding Content/Rules for all slices
..... coding:amtVaccineCode Σ 0..1 Coding AMT Vaccine
Binding: Australian Medicines Terminology Vaccine . (preferred)
..... coding:airVaccineCode Σ 0..1 Coding AIR Vaccine
Binding: Australian Immunisation Register Vaccine . (required)
... patient Σ 1..1 Reference(MR Patient) Who was immunized
... encounter 0..1 Reference(MR Encounter) Encounter immunization was part of
... Slices for occurrence[x] Content/Rules for all slices
.... occurrence[x]:occurrenceDateTime Σ 1..1 dateTime Vaccine administration date
... lotNumber 0..1 string Batch Number
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunisation Anatomical Site . (extensible)
... Slices for performer Content/Rules for all slices
.... performer:administeredBy Σ 0..1 BackboneElement Immunisation Administered By
..... actor Σ 1..1 Reference(MR Practitioner) Administering performer
.... performer:approvedBy Σ 0..1 BackboneElement Immunisation Approved By
..... actor Σ 1..1 Reference(MR Practitioner) Approver
... note Σ 0..1 Annotation Additional immunization notes
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... Slices for doseNumber[x] Content/Rules for all slices
..... doseNumber[x]:doseNumberPositiveInt 0..1 positiveInt Dose number within series

doco Documentation for this format

This structure is derived from AUBaseImmunisation

Summary

Mandatory: 1 element
Must-Support: 16 elements

Structures

This structure refers to these other structures:

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.occurrence[x]
  • The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]

Differential View

This structure is derived from AUBaseImmunisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* AUBaseImmunisation An immunisation statement in an Australian healthcare context
... meta 0..1 MRMeta Metadata about a resource
.... lastUpdated S 0..1 instant When the resource version last changed
.... security S 0..* Coding Security Labels applied to this resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... vaccineSerialNumber S 0..1 string Vaccine Serial Number Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-vaccine-serial-number-extn
... status S 1..1 code completed | entered-in-error | not-done
... vaccineCode
.... Slices for coding Content/Rules for all slices
..... coding:amtVaccineCode S 0..1 Coding AMT Vaccine
..... coding:airVaccineCode S 0..1 Coding AIR Vaccine
... patient S 1..1 Reference(MR Patient) Who was immunized
... encounter S 0..1 Reference(MR Encounter) Encounter immunization was part of
... Slices for occurrence[x] 1..1 dateTime Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 1..1 dateTime Vaccine administration date
... lotNumber S 0..1 string Batch Number
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunisation Anatomical Site . (extensible)
... Slices for performer Content/Rules for all slices
.... performer:administeredBy 0..1 BackboneElement Immunisation Administered By
..... actor S 1..1 Reference(MR Practitioner) Administering performer
.... performer:approvedBy 0..1 BackboneElement Immunisation Approved By
..... actor S 1..1 Reference(MR Practitioner) Approver
... note 0..1 Annotation Additional immunization notes
.... text S 1..1 markdown The annotation - text content (as markdown)
... protocolApplied
.... Slices for doseNumber[x] 1..1 positiveInt, string Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumber[x]:doseNumberPositiveInt S 0..1 positiveInt Dose number within series

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* AUBaseImmunisation An immunisation statement in an Australian healthcare context
... id Σ 0..1 id Logical id of this artifact
... meta 0..1 MRMeta Metadata about a resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security SΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-mr-meta-security-01: Medirecords supports only U, R security code
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
.... vaccineSerialNumber S 0..1 string Vaccine Serial Number Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-vaccine-serial-number-extn
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S 0..1 CodeableConcept Reason not done
Binding: Reason Vaccine Not Administered . (preferred)
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode SΣ 0..1 Coding AMT Vaccine
Binding: Australian Medicines Terminology Vaccine . (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:airVaccineCode SΣ 0..1 Coding AIR Vaccine
Binding: Australian Immunisation Register Vaccine . (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... 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
... patient SΣ 1..1 Reference(MR Patient) Who was immunized
... encounter S 0..1 Reference(MR Encounter) Encounter immunization was part of
... Slices for occurrence[x] Σ 1..1 dateTime Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ 1..1 dateTime Vaccine administration date
... 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 S 0..1 string Batch Number
... expirationDate 0..1 date Vaccine expiration date
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunisation Anatomical Site . (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... route 0..1 CodeableConcept How vaccine entered body
Binding: Immunisation Route of Administration . (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... 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: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


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 SΣ 1..1 Reference(MR Practitioner) 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: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


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 SΣ 1..1 Reference(MR Practitioner) Approver
... note Σ 0..1 Annotation Additional immunization notes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
... 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)
.... Slices for doseNumber[x] 1..1 Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
..... doseNumber[x]:doseNumberPositiveInt S 0..1 positiveInt Dose number within series
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Immunization.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
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-1
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
Immunization.vaccineCode.coding:amtVaccineCodepreferredAustralianMedicinesTerminologyVaccine .
https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1
Immunization.vaccineCode.coding:airVaccineCoderequiredAustralianImmunisationRegisterVaccine . (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats)
https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard
Immunization.siteextensibleImmunisationAnatomicalSite .
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
Immunization.performer:administeredBy.functionextensiblePattern: AP
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.performer:approvedBy.functionextensiblePattern: OP
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
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()
inv-mr-meta-security-01errorImmunization.meta.securityMedirecords supports only U, R security code
: code.exists() implies (code = 'U' or code = 'R')