Primary Care Practice-to-Practice
0.0.3 - CI Build

Primary Care Practice-to-Practice, published by . This is not an authorized publication; it is the continuous build for version 0.0.3). This version is based on the current content of https://github.com/aehrc/primary-care-data-technical/ and changes regularly. See the Directory of published versions

Resource Profile: AU Primary Care Immunisation

Defining URL:https://aehrc.com/fhir/StructureDefinition/AUPrimaryCareImmunisation
Version:0.0.3
Name:AUPrimaryCareImmunisation
Title:AU Primary Care Immunisation
Status:Active as of 2021-06-27T13:53:23+00:00
Definition:

A vaccine that has been administered to an individual.

Usage

Use to record details about a vaccination that had been administered to an individual.

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

https://aehrc.com/fhir/StructureDefinition/AUPrimaryCareImmunisation

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: 5 elements

This structure is derived from AUBaseImmunisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... vaccineCode S1..1CodeableConceptVaccine product for administration
.... coding:amtVaccineCode S0..1CodingAMT Vaccine
Binding: Vaccination Code Valueset (preferred)
... occurrenceDateTime S1..1dateTimeVaccine administration date
... note
.... text S1..1markdownThe annotation - text content (as markdown)
.... doseNumber[x] S1..1positiveInt, stringVaccination sequence number or description

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... id Σ0..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..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 | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

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

.... id 0..1stringUnique id for inter-element referencing
.... Slices for 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: Vaccination Code Valueset (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for 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 Σ0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for 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 Σ1..1Reference(Patient)Patient immunised
... encounter 0..1Reference(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..1booleanOptional information source
... 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 product manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCode defined by a terminology system
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... route 0..1CodeableConceptRoute of vaccination
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for 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:snomedRoute Σ0..1CodingImmunisation Route of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required)
.... 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.coding
.... 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: v2 Provider Role - 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.

...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..*CodingCode defined by a terminology system

Required Pattern: At least the following
....... id0..1stringUnique 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
....... display1..1stringRepresentation defined by the system
Fixed Value: Administering Provider
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
Fixed Value: Administering Provider
..... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)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.

...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..*CodingCode defined by a terminology system

Fixed Value: As shown
....... id0..0stringUnique id for inter-element referencing
....... extension0..0ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... version0..0stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: OP
....... display1..1stringRepresentation defined by the system
Fixed Value: Ordering Provider
....... userSelected0..0booleanIf this coding was chosen directly by the user
...... text Σ1..1stringPlain text representation of the concept
Fixed Value: Ordering Provider
..... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Approving practitioner
... note Σ0..*AnnotationAdditional immunization notes
.... id 0..1stringUnique id for inter-element referencing
.... Slices for 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 I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... 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..*BackboneElementVaccination protocol
.... 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 disease target
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)
.... doseNumber[x] S1..1Vaccination sequence number or description
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... 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
... vaccineCode Σ1..1CodeableConceptVaccine product for administration
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... coding:amtVaccineCode Σ0..1CodingAMT Vaccine
Binding: Vaccination Code Valueset (preferred)
... occurrence[x]:occurrenceDateTime Σ1..1dateTimeVaccine administration date
... note Σ0..*AnnotationAdditional immunization notes
.... text Σ1..1markdownThe annotation - text content (as markdown)
.... doseNumber[x] 1..1Vaccination sequence number or description
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring

doco Documentation for this format

This structure is derived from AUBaseImmunisation

Summary

Mandatory: 1 element
Must-Support: 5 elements

Differential View

This structure is derived from AUBaseImmunisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... vaccineCode S1..1CodeableConceptVaccine product for administration
.... coding:amtVaccineCode S0..1CodingAMT Vaccine
Binding: Vaccination Code Valueset (preferred)
... occurrenceDateTime S1..1dateTimeVaccine administration date
... note
.... text S1..1markdownThe annotation - text content (as markdown)
.... doseNumber[x] S1..1positiveInt, stringVaccination sequence number or description

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... id Σ0..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..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 | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

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

.... id 0..1stringUnique id for inter-element referencing
.... Slices for 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: Vaccination Code Valueset (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for 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 Σ0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for 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 Σ1..1Reference(Patient)Patient immunised
... encounter 0..1Reference(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..1booleanOptional information source
... 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 product manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCode defined by a terminology system
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... route 0..1CodeableConceptRoute of vaccination
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for 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:snomedRoute Σ0..1CodingImmunisation Route of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required)
.... 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.coding
.... 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: v2 Provider Role - 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.

...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..*CodingCode defined by a terminology system

Required Pattern: At least the following
....... id0..1stringUnique 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
....... display1..1stringRepresentation defined by the system
Fixed Value: Administering Provider
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
Fixed Value: Administering Provider
..... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)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.

...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..*CodingCode defined by a terminology system

Fixed Value: As shown
....... id0..0stringUnique id for inter-element referencing
....... extension0..0ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... version0..0stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: OP
....... display1..1stringRepresentation defined by the system
Fixed Value: Ordering Provider
....... userSelected0..0booleanIf this coding was chosen directly by the user
...... text Σ1..1stringPlain text representation of the concept
Fixed Value: Ordering Provider
..... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Approving practitioner
... note Σ0..*AnnotationAdditional immunization notes
.... id 0..1stringUnique id for inter-element referencing
.... Slices for 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 I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... 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..*BackboneElementVaccination protocol
.... 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 disease target
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)
.... doseNumber[x] S1..1Vaccination sequence number or description
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... 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
Immunization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
Immunization.vaccineCode.coding:amtVaccineCodepreferredVaccination_Code_Valueset
Immunization.vaccineCode.coding:airVaccineCoderequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
Immunization.site.codingrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1
Immunization.routeexampleImmunizationRouteCodes
Immunization.route.coding:snomedRouterequiredhttps://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1
Immunization.performer.functionextensibleV2IdentifierTypeAUExtended
Immunization.performer:administeredBy.functionextensibleImmunizationFunctionCodes
Immunization.performer:approvedBy.functionextensibleImmunizationFunctionCodes
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

Constraints

IdPathDetailsRequirements
imm-1Immunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()