Primary Care Implementation Guide

AU Primary Care Implementation Guide - Local Development build (vnull). See the Directory of published versions

1.0 StructureDefinition-au-primarycareimmunisation

AU Primary Care Immunisation Profile [FMM Level 0]

This profile defines an immunisation structure that includes core localisation concepts for use in an Australian primary care practice-to-practice record transfer context.

Examples thanks to Brett Esler - Oridashi .. not yet checked for conformance to this IG

​Oridashi Sample Immunization 1

​Oridashi Sample Immunization 2

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

This profile defines an immunisation structure that includes core localisation concepts for use in an Australian primary care practice-to-practice record transfer context.

This profile builds on AUBaseImmunisation.

This profile was published on Wed Nov 06 14:07:15 AEST 2019 as a draft by null.

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

This profile contains the following variations from [AU Base Immunisation] (http://hl7.org.au/fhir/StructureDefinition/au-immunization.html):

  1. vaccineCode.coding:amtVaccineCode mustSupport
    • ValueSet binding https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-2 added
  2. date mustSupport
  3. note mustSupport
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*An immunisation statement in an Australian primary care practice-to-practice record transfer context.
... vaccineCode
.... coding:amtVaccineCode S0..1CodingBinding: (unbound) (extensible)
... occurrence[x] S1..1dateTime, string
... note
.... text S1..1markdown

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*An immunisation statement in an Australian primary care practice-to-practice record transfer context.
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierBusiness identifier
... status ?!ΣI1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason I0..1CodeableConceptReason not done
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred)
... vaccineCode ΣI1..1CodeableConceptVaccine product for administration
Binding: VaccineAdministeredValueSet (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode SΣI0..1CodingAMT Vaccine
Binding: (unbound) (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... coding:airVaccineCode ΣI0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... patient ΣI1..1Reference(Patient)Patient immunised
... encounter I0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] SΣI1..1Vaccine administration date
.... occurrenceDateTimedateTime
.... occurrenceStringstring
... recorded I0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource ΣI0..1booleanOptional information source
... reportOrigin I0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example)
... location I0..1Reference(Location)Where immunization occurred
... manufacturer I0..1Reference(Organization)Vaccine product manufacturer
... lotNumber I0..1stringVaccine lot number
... expirationDate I0..1dateVaccine expiration date
... site I0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..1CodingCode defined by a terminology system
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
.... text ΣI0..1stringPlain text representation of the concept
... route I0..1CodeableConceptRoute of vaccination
Binding: ImmunizationRouteCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedRoute ΣI0..1CodingImmunisation Route of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required)
.... text ΣI0..1stringPlain text representation of the concept
... doseQuantity I0..1SimpleQuantityAmount of vaccine administered
... performer ΣI0..*(Slice Definition)Who performed event
Slice: Unordered, Open by value:function
.... performer:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function ΣI0..1CodeableConceptWhat type of performance was done
Binding: v2 Provider Role - AU Extended (extensible)
..... actor ΣI1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
.... performer:administeredBy ΣI0..1BackboneElementImmunisation Administered By
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function ΣI1..1CodeableConceptAdministering role
Binding: ImmunizationFunctionCodes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI1..*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://hl7.org/fhir/v2/0443
....... version0..0stringVersion 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..0booleanIf this coding was chosen directly by the user
...... text ΣI1..1stringPlain text representation of the concept
Fixed Value: Administering Provider
..... actor ΣI1..1Reference(Practitioner | PractitionerRole | Organization)Administering performer
.... performer:approvedBy ΣI0..1BackboneElementImmunisation Approved By
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function ΣI1..1CodeableConceptApprover role
Binding: ImmunizationFunctionCodes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI1..*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://hl7.org/fhir/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 ΣI1..1stringPlain text representation of the concept
Fixed Value: Ordering Provider
..... actor ΣI1..1Reference(Practitioner | PractitionerRole | Organization)Approving practitioner
... note ΣI0..*AnnotationAdditional immunization notes
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] ΣI0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time ΣI0..1dateTimeWhen the annotation was made
.... text SΣI1..1markdownThe annotation - text content (as markdown)
... reasonCode I0..*CodeableConceptWhy immunization occurred
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!ΣI0..1booleanDose potency
... subpotentReason I0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example)
... 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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType I0..1stringEducational material document identifier
.... reference I0..1uriEducational material reference pointer
.... publicationDate I0..1dateTimeEducational material publication date
.... presentationDate I0..1dateTimeEducational material presentation date
... programEligibility I0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example)
... fundingSource I0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example)
... reaction I0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date I0..1dateTimeWhen reaction started
.... detail I0..1Reference(Observation)Additional information on reaction
.... reported I0..1booleanIndicates self-reported reaction
... protocolApplied I0..*BackboneElementVaccination protocol
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series I0..1stringName of vaccine series
.... authority I0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease I0..*CodeableConceptVaccine disease target
Binding: ImmunizationTargetDiseaseCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedTargetDisease ΣI0..1CodingVaccination Target Disease (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required)
...... coding:targetDiseaseNoInformation ΣI0..1CodingNo Information for Target Disease

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://hl7.org/fhir/v3/NullFlavor
....... version0..0stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NI
....... display1..1stringRepresentation defined by the system
Fixed Value: NoInformation
....... userSelected0..0booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
.... doseNumber[x] I1..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] I0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

This profile contains the following variations from [AU Base Immunisation] (http://hl7.org.au/fhir/StructureDefinition/au-immunization.html):

  1. vaccineCode.coding:amtVaccineCode mustSupport
    • ValueSet binding https://healthterminologies.gov.au/fhir/ValueSet/australian-vaccine-2 added
  2. date mustSupport
  3. note mustSupport

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*An immunisation statement in an Australian primary care practice-to-practice record transfer context.
... vaccineCode
.... coding:amtVaccineCode S0..1CodingBinding: (unbound) (extensible)
... occurrence[x] S1..1dateTime, string
... note
.... text S1..1markdown

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*An immunisation statement in an Australian primary care practice-to-practice record transfer context.
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierBusiness identifier
... status ?!ΣI1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason I0..1CodeableConceptReason not done
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred)
... vaccineCode ΣI1..1CodeableConceptVaccine product for administration
Binding: VaccineAdministeredValueSet (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode SΣI0..1CodingAMT Vaccine
Binding: (unbound) (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... coding:airVaccineCode ΣI0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... patient ΣI1..1Reference(Patient)Patient immunised
... encounter I0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] SΣI1..1Vaccine administration date
.... occurrenceDateTimedateTime
.... occurrenceStringstring
... recorded I0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource ΣI0..1booleanOptional information source
... reportOrigin I0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example)
... location I0..1Reference(Location)Where immunization occurred
... manufacturer I0..1Reference(Organization)Vaccine product manufacturer
... lotNumber I0..1stringVaccine lot number
... expirationDate I0..1dateVaccine expiration date
... site I0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..1CodingCode defined by a terminology system
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
.... text ΣI0..1stringPlain text representation of the concept
... route I0..1CodeableConceptRoute of vaccination
Binding: ImmunizationRouteCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedRoute ΣI0..1CodingImmunisation Route of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required)
.... text ΣI0..1stringPlain text representation of the concept
... doseQuantity I0..1SimpleQuantityAmount of vaccine administered
... performer ΣI0..*(Slice Definition)Who performed event
Slice: Unordered, Open by value:function
.... performer:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function ΣI0..1CodeableConceptWhat type of performance was done
Binding: v2 Provider Role - AU Extended (extensible)
..... actor ΣI1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
.... performer:administeredBy ΣI0..1BackboneElementImmunisation Administered By
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function ΣI1..1CodeableConceptAdministering role
Binding: ImmunizationFunctionCodes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI1..*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://hl7.org/fhir/v2/0443
....... version0..0stringVersion 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..0booleanIf this coding was chosen directly by the user
...... text ΣI1..1stringPlain text representation of the concept
Fixed Value: Administering Provider
..... actor ΣI1..1Reference(Practitioner | PractitionerRole | Organization)Administering performer
.... performer:approvedBy ΣI0..1BackboneElementImmunisation Approved By
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function ΣI1..1CodeableConceptApprover role
Binding: ImmunizationFunctionCodes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI1..*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://hl7.org/fhir/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 ΣI1..1stringPlain text representation of the concept
Fixed Value: Ordering Provider
..... actor ΣI1..1Reference(Practitioner | PractitionerRole | Organization)Approving practitioner
... note ΣI0..*AnnotationAdditional immunization notes
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] ΣI0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time ΣI0..1dateTimeWhen the annotation was made
.... text SΣI1..1markdownThe annotation - text content (as markdown)
... reasonCode I0..*CodeableConceptWhy immunization occurred
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!ΣI0..1booleanDose potency
... subpotentReason I0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example)
... 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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType I0..1stringEducational material document identifier
.... reference I0..1uriEducational material reference pointer
.... publicationDate I0..1dateTimeEducational material publication date
.... presentationDate I0..1dateTimeEducational material presentation date
... programEligibility I0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example)
... fundingSource I0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example)
... reaction I0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date I0..1dateTimeWhen reaction started
.... detail I0..1Reference(Observation)Additional information on reaction
.... reported I0..1booleanIndicates self-reported reaction
... protocolApplied I0..*BackboneElementVaccination protocol
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series I0..1stringName of vaccine series
.... authority I0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease I0..*CodeableConceptVaccine disease target
Binding: ImmunizationTargetDiseaseCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedTargetDisease ΣI0..1CodingVaccination Target Disease (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required)
...... coding:targetDiseaseNoInformation ΣI0..1CodingNo Information for Target Disease

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://hl7.org/fhir/v3/NullFlavor
....... version0..0stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NI
....... display1..1stringRepresentation defined by the system
Fixed Value: NoInformation
....... userSelected0..0booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
.... doseNumber[x] I1..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] I0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

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

 

1.0.2 Quick Start

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

Summary of Search Criteria for StructureDefinition-au-primarycareimmunisation

none defined