This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: QICore-Immunization

The official URL for this profile is: 

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

Profile of Immunization for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile was published on Fri, Feb 27, 2015 00:00+1100 as a draft by Health Level Seven, Inc. - CQI WG.

Formal Views of Profile Content

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

This structure is derived from Immunization.

Summary

Terminology Bindings

  • Immunization.vaccineType SHOULD come from This identifies the CVX code system
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 1..1ImmunizationImmunization event information
... 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: Language (required)
... 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
... date S1..1dateTimeVaccination administration date
... vaccineType S1..1CodeableConceptVaccine product administered
Binding: QICoreVaccineTypeCVX (preferred)
... patient S1..1patient-qicore-qicore-patientWho was immunized?
... wasNotGiven ?! SI1..1booleanWas immunization given?
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
... reported 1..1booleanIs this a self-reported record?
... performer 0..1practitioner-qicore-qicore-practitionerWho administered vaccine?
... requester 0..1practitioner-qicore-qicore-practitionerWho ordered vaccination?
... encounter S0..1encounter-qicore-qicore-encounterEncounter administered as part of
... manufacturer 0..1organization-qicore-qicore-organizationVaccine manufacturer
... location 0..1location-qicore-qicore-locationWhere did vaccination occur?
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: ImmunizationSite (example)
... route S0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRoute (example)
... doseQuantity S0..1QuantityAmount of vaccine administered
... explanation 0..1Administration / non-administration reasons
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... reason S0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReason (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: NoImmunizationReason (example)
... reaction 0..*Details of a reaction that follows immunization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen did reaction start?
.... detail 0..1observation-qicore-qicore-observationAdditional information on reaction
.... reported 0..1booleanWas reaction self-reported?
... vaccinationProtocol 0..*What protocol was followed
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... doseSequence 1..1integerWhat dose number within series?
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1organization-qicore-qicore-organizationWho is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1integerRecommended number of doses for immunity
.... doseTarget 1..1CodeableConceptDisease immunized against
Binding: VaccinationProtocolDoseTarget (example)
.... doseStatus 1..1CodeableConceptDoes dose count towards immunity?
Binding: VaccinationProtocolDoseStatus (example)
.... doseStatusReason 0..1CodeableConceptWhy does does count/not count?
Binding: VaccinationProtocolDoseStatusReason (example)

todo

This structure is derived from Immunization.

Summary

Terminology Bindings

  • Immunization.vaccineType SHOULD come from This identifies the CVX code system

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 1..1ImmunizationImmunization event information
... 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: Language (required)
... 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
... date S1..1dateTimeVaccination administration date
... vaccineType S1..1CodeableConceptVaccine product administered
Binding: QICoreVaccineTypeCVX (preferred)
... patient S1..1patient-qicore-qicore-patientWho was immunized?
... wasNotGiven ?! SI1..1booleanWas immunization given?
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
... reported 1..1booleanIs this a self-reported record?
... performer 0..1practitioner-qicore-qicore-practitionerWho administered vaccine?
... requester 0..1practitioner-qicore-qicore-practitionerWho ordered vaccination?
... encounter S0..1encounter-qicore-qicore-encounterEncounter administered as part of
... manufacturer 0..1organization-qicore-qicore-organizationVaccine manufacturer
... location 0..1location-qicore-qicore-locationWhere did vaccination occur?
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: ImmunizationSite (example)
... route S0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRoute (example)
... doseQuantity S0..1QuantityAmount of vaccine administered
... explanation 0..1Administration / non-administration reasons
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... reason S0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReason (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: NoImmunizationReason (example)
... reaction 0..*Details of a reaction that follows immunization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen did reaction start?
.... detail 0..1observation-qicore-qicore-observationAdditional information on reaction
.... reported 0..1booleanWas reaction self-reported?
... vaccinationProtocol 0..*What protocol was followed
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... doseSequence 1..1integerWhat dose number within series?
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1organization-qicore-qicore-organizationWho is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1integerRecommended number of doses for immunity
.... doseTarget 1..1CodeableConceptDisease immunized against
Binding: VaccinationProtocolDoseTarget (example)
.... doseStatus 1..1CodeableConceptDoes dose count towards immunity?
Binding: VaccinationProtocolDoseStatus (example)
.... doseStatusReason 0..1CodeableConceptWhy does does count/not count?
Binding: VaccinationProtocolDoseStatusReason (example)

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

Terminology Bindings

PathNameConformanceValueSet
Immunization.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Immunization.vaccineTypeQICoreVaccineTypeCVXpreferredVaccine Administered Value Set
Immunization.siteImmunizationSiteexampleCodes for Immunization Site of Administration
Immunization.routeImmunizationRouteexampleImmunization Route Codes
Immunization.explanation.reasonImmunizationReasonexampleImmunization Reason Codes
Immunization.explanation.reasonNotGivenNoImmunizationReasonexampleImmunization Reasons for Not Immunizing Codes
Immunization.vaccinationProtocol.doseTargetVaccinationProtocolDoseTargetexampleVaccination Protocol Dose TargetCodes
Immunization.vaccinationProtocol.doseStatusVaccinationProtocolDoseStatusexampleVaccination Protocol Dose Status codes
Immunization.vaccinationProtocol.doseStatusReasonVaccinationProtocolDoseStatusReasonexampleVaccination Protocol Dose Status Reason codes

Constraints

IdPathNameDetails
imm-2Immunization.wasNotGivenGiven administrationIf immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
XPath: not(f:wasNotGiven/@value='false' and exists(f:explanation/f:reasonNotGiven))
imm-1Immunization.wasNotGivenNot given administrationIf immunization was not administred (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/reason)))
.