STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-immunization

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/qicore/StructureDefinition/qicore-immunization

This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*Immunization event information
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administered (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!S1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... date S0..1dateTimeVaccination administration date
... vaccineCode S1..1CodeableConceptVaccine product administered
Binding: 7.org/fhir/daf/ValueSet/daf-cvx (preferred)
... patient S1..1Reference(Profile qicore-patient)Who was immunized
... wasNotGiven ?!S1..1booleanFlag for whether immunization was given
... reported 1..1booleanIndicates a self-reported record
... performer 0..1Reference(Profile qicore-practitioner)Who administered vaccine
... requester 0..1Reference(Profile qicore-practitioner)Who ordered vaccination
... encounter S0..1Reference(Profile qicore-encounter)An interaction during which services are provided to the patient
... manufacturer 0..1Reference(Profile qicore-organization)Vaccine manufacturer
... location 0..1Reference(Profile qicore-location)Where vaccination occurred
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: 7.org/fhir/daf/ValueSet/daf-bodysite (preferred)
... route S0..1CodeableConceptHow vaccine entered body
Binding: Immunization Route Codes (example)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... note ∑0..*AnnotationVaccination notes
... explanation 0..1BackboneElementAdministration/non-administration reasons
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... reason S0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Profile qicore-observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol 0..*BackboneElementWhat protocol was followed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... doseSequence 0..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(Profile qicore-organization)Who is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease 1..*CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
.... doseStatus 1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
.... doseStatusReason 0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*Immunization event information
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administered (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!S1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... date S0..1dateTimeVaccination administration date
... vaccineCode S1..1CodeableConceptVaccine product administered
Binding: 7.org/fhir/daf/ValueSet/daf-cvx (preferred)
... patient S1..1Reference(Profile qicore-patient)Who was immunized
... wasNotGiven ?!S1..1booleanFlag for whether immunization was given
... reported 1..1booleanIndicates a self-reported record
... performer 0..1Reference(Profile qicore-practitioner)Who administered vaccine
... requester 0..1Reference(Profile qicore-practitioner)Who ordered vaccination
... encounter S0..1Reference(Profile qicore-encounter)An interaction during which services are provided to the patient
... manufacturer 0..1Reference(Profile qicore-organization)Vaccine manufacturer
... location 0..1Reference(Profile qicore-location)Where vaccination occurred
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: 7.org/fhir/daf/ValueSet/daf-bodysite (preferred)
... route S0..1CodeableConceptHow vaccine entered body
Binding: Immunization Route Codes (example)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... note ∑0..*AnnotationVaccination notes
... explanation 0..1BackboneElementAdministration/non-administration reasons
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... reason S0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Profile qicore-observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol 0..*BackboneElementWhat protocol was followed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... doseSequence 0..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(Profile qicore-organization)Who is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease 1..*CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
.... doseStatus 1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
.... doseStatusReason 0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Immunization.languageCommon LanguagesextensibleCommon Languages
Immunization.statusMedicationAdministrationStatusrequiredMedicationAdministrationStatus
Immunization.vaccineCode?extpreferredhttp://hl7.org/fhir/daf/ValueSet/daf-cvx
Immunization.site?extpreferredhttp://hl7.org/fhir/daf/ValueSet/daf-bodysite
Immunization.routeImmunization Route CodesexampleImmunization Route Codes
Immunization.explanation.reasonImmunization Reason CodesexampleImmunization Reason Codes
Immunization.explanation.reasonNotGivenImmunization Reasons for Not Immunizing CodesexampleImmunization Reasons for Not Immunizing Codes
Immunization.vaccinationProtocol.targetDiseaseVaccination Protocol Dose Target CodesexampleVaccination Protocol Dose Target Codes
Immunization.vaccinationProtocol.doseStatusVaccination Protocol Dose Status codesexampleVaccination Protocol Dose Status codes
Immunization.vaccinationProtocol.doseStatusReasonVaccination Protocol Dose Status Reason codesexampleVaccination Protocol Dose Status Reason codes

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1ImmunizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4ImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3ImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
imm-2ImmunizationIf immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
XPath: not(f:wasNotGiven/@value=false() and exists(f:explanation/f:reasonNotGiven))
imm-1ImmunizationIf immunization was not administered (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
XPath: not(f:wasNotGiven/@value=true() and (count(f:reaction) > 0 or exists(f:explanation/f:reason)))
.