MediRecords FHIR Implementation Guide
20220926 - ci-build


Resource Profile: MediRecords Immunisation

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-immunisation
Version:20220926
Name:MRImmunisation
Title:MediRecords Immunisation
Status:Active as of 2022-09-28 10:08:29+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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... meta 0..1MRMetaMetadata about a resource
.... lastUpdated S0..1instantWhen the resource version last changed
.... security S0..*CodingSecurity Labels applied to this resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccineSerialNumber S0..1stringVaccine Serial Number Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-vaccine-serial-number-extn
... statusReason S0..1CodeableConceptReason not done
... vaccineCode
.... coding:amtVaccineCode S0..1CodingAMT Vaccine
.... coding:airVaccineCode S0..1CodingAIR Vaccine
... patient S1..1Reference(MediRecords Core Patient)Who was immunized
... encounter S0..1Reference(MediRecords Core Encounter)Encounter immunization was part of
... occurrenceDateTime S1..1dateTimeVaccine administration date
... lotNumber S0..1stringBatch Number
... site S0..1CodeableConceptBody site vaccine was administered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
... performer:administeredBy 0..1BackboneElementImmunisation Administered By
.... actor S1..1Reference(MediRecords Core Practitioner)Administering performer
... performer:approvedBy 0..1BackboneElementImmunisation Approved By
.... actor S1..1Reference(MediRecords Core Practitioner)Approver
... note 0..1AnnotationAdditional immunization notes
.... text S1..1markdownThe annotation - text content (as markdown)
... protocolApplied
.... doseNumberPositiveInt S0..1positiveIntDose number within series

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta 0..1MRMetaMetadata about a resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security SΣC0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccineSerialNumber S0..1stringVaccine Serial Number Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-vaccine-serial-number-extn
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S0..1CodeableConceptReason not done
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred)
... vaccineCode Σ1..1CodeableConceptVaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode SΣ0..1CodingAMT Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:airVaccineCode SΣ0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(MediRecords Core Patient)Who was immunized
... encounter S0..1Reference(MediRecords Core Encounter)Encounter immunization was part of
... Slices for occurrence[x] Σ1..1dateTimeVaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ1..1dateTimeVaccine administration date
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates 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..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber S0..1stringBatch Number
... expirationDate 0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... route 0..1CodeableConceptHow vaccine entered body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... Slices for performer Σ0..*BackboneElementWho performed event
Slice: Unordered, Open by pattern:function
.... performer:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ0..1CodeableConceptWhat type of performance was done
Binding: hl7VS-providerRole - AU Extended (extensible)
..... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
.... performer:administeredBy Σ0..1BackboneElementImmunisation Administered By
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ1..1CodeableConceptAdministering role
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


Required Pattern: At least the following
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AP
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... actor SΣ1..1Reference(MediRecords Core Practitioner)Administering performer
.... performer:approvedBy Σ0..1BackboneElementImmunisation Approved By
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ1..1CodeableConceptApprover role
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


Required Pattern: At least the following
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: OP
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... actor SΣ1..1Reference(MediRecords Core Practitioner)Approver
... note Σ0..1AnnotationAdditional immunization notes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series 0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)
.... Slices for doseNumber[x] 1..1Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
..... doseNumber[x]:doseNumberPositiveInt S0..1positiveIntDose number within series
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... meta 0..1MRMetaMetadata about a resource
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... security ΣC0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... vaccineSerialNumber 0..1stringVaccine Serial Number Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-vaccine-serial-number-extn
... status ?!Σ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... vaccineCode Σ1..1CodeableConceptVaccine product administered
.... coding:amtVaccineCode Σ0..1CodingAMT Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred)
.... coding:airVaccineCode Σ0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
... patient Σ1..1Reference(MediRecords Core Patient)Who was immunized
... encounter 0..1Reference(MediRecords Core Encounter)Encounter immunization was part of
... occurrence[x]:occurrenceDateTime Σ1..1dateTimeVaccine administration date
... lotNumber 0..1stringBatch Number
... site 0..1CodeableConceptBody site vaccine was administered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
... performer:administeredBy Σ0..1BackboneElementImmunisation Administered By
.... actor Σ1..1Reference(MediRecords Core Practitioner)Administering performer
... performer:approvedBy Σ0..1BackboneElementImmunisation Approved By
.... actor Σ1..1Reference(MediRecords Core Practitioner)Approver
... note Σ0..1AnnotationAdditional immunization notes
.... text Σ1..1markdownThe annotation - text content (as markdown)
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... doseNumber[x]:doseNumberPositiveInt 0..1positiveIntDose number within series

doco Documentation for this format

Differential View

This structure is derived from AUBaseImmunisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... meta 0..1MRMetaMetadata about a resource
.... lastUpdated S0..1instantWhen the resource version last changed
.... security S0..*CodingSecurity Labels applied to this resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccineSerialNumber S0..1stringVaccine Serial Number Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-vaccine-serial-number-extn
... statusReason S0..1CodeableConceptReason not done
... vaccineCode
.... coding:amtVaccineCode S0..1CodingAMT Vaccine
.... coding:airVaccineCode S0..1CodingAIR Vaccine
... patient S1..1Reference(MediRecords Core Patient)Who was immunized
... encounter S0..1Reference(MediRecords Core Encounter)Encounter immunization was part of
... occurrenceDateTime S1..1dateTimeVaccine administration date
... lotNumber S0..1stringBatch Number
... site S0..1CodeableConceptBody site vaccine was administered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
... performer:administeredBy 0..1BackboneElementImmunisation Administered By
.... actor S1..1Reference(MediRecords Core Practitioner)Administering performer
... performer:approvedBy 0..1BackboneElementImmunisation Approved By
.... actor S1..1Reference(MediRecords Core Practitioner)Approver
... note 0..1AnnotationAdditional immunization notes
.... text S1..1markdownThe annotation - text content (as markdown)
... protocolApplied
.... doseNumberPositiveInt S0..1positiveIntDose number within series

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta 0..1MRMetaMetadata about a resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security SΣC0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccineSerialNumber S0..1stringVaccine Serial Number Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-vaccine-serial-number-extn
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S0..1CodeableConceptReason not done
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred)
... vaccineCode Σ1..1CodeableConceptVaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode SΣ0..1CodingAMT Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:airVaccineCode SΣ0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(MediRecords Core Patient)Who was immunized
... encounter S0..1Reference(MediRecords Core Encounter)Encounter immunization was part of
... Slices for occurrence[x] Σ1..1dateTimeVaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ1..1dateTimeVaccine administration date
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates 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..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber S0..1stringBatch Number
... expirationDate 0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... route 0..1CodeableConceptHow vaccine entered body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... Slices for performer Σ0..*BackboneElementWho performed event
Slice: Unordered, Open by pattern:function
.... performer:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ0..1CodeableConceptWhat type of performance was done
Binding: hl7VS-providerRole - AU Extended (extensible)
..... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
.... performer:administeredBy Σ0..1BackboneElementImmunisation Administered By
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ1..1CodeableConceptAdministering role
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


Required Pattern: At least the following
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AP
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... actor SΣ1..1Reference(MediRecords Core Practitioner)Administering performer
.... performer:approvedBy Σ0..1BackboneElementImmunisation Approved By
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ1..1CodeableConceptApprover role
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


Required Pattern: At least the following
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: OP
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... actor SΣ1..1Reference(MediRecords Core Practitioner)Approver
... note Σ0..1AnnotationAdditional immunization notes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series 0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)
.... Slices for doseNumber[x] 1..1Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
..... doseNumber[x]:doseNumberPositiveInt S0..1positiveIntDose number within series
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Immunization.meta.securityextensibleAll Security Labels
Immunization.meta.tagexampleCommonTags
Immunization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
Immunization.vaccineCode.coding:amtVaccineCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1
Immunization.vaccineCode.coding:airVaccineCoderequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.siterequiredhttps://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1
Immunization.routepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1
Immunization.performer.functionextensibleHl7VSProviderRoleAUExtended
Immunization.performer:administeredBy.functionextensiblePattern: AP
Immunization.performer:approvedBy.functionextensiblePattern: OP
Immunization.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseasepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1