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: DAFImmunization

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/immunization-daf-dafimmunization

Defines constraints and extensions on the Immunization resource for use in querying and retrieving patient's immunization information.

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by U.S. Office of the National Coordinator (ONC).

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 SHALL come from This identifies the CVX code system (Extensible)

Required/Prohibited Elements

  • The element Immunization.date is required
  • The element Immunization.vaccineType is required
  • The element Immunization.patient is required
  • The element Immunization.reported is required
  • The element Immunization.vaccinationProtocol.doseSequence is required
  • The element Immunization.vaccinationProtocol.doseTarget is required
  • The element Immunization.vaccinationProtocol.doseStatus is required
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 S0..*IdentifierBusiness identifier
... date S1..1dateTimeVaccination administration date
... vaccineType S1..1CodeableConceptVaccine Product Type (bind to CVX)
Binding: VaccineTypesCVX (extensible)
... patient S1..1patient-daf-dafpatientWho was immunized?
... wasNotGiven ?! I1..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 S1..1booleanIs this a self-reported record?
... performer S0..1PractitionerWho administered vaccine?
... requester S0..1PractitionerWho ordered vaccination?
... encounter 0..1EncounterEncounter administered as part of
... manufacturer S0..1OrganizationVaccine Manufacturer
... location 0..1LocationWhere did vaccination occur?
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
Binding: ImmunizationSite (example)
... route S0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRoute (example)
... doseQuantity S0..1QuantityAmount of vaccine administered
... explanation S0..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 0..*CodeableConceptWhy immunization did not occur
Binding: NoImmunizationReason (example)
... reaction S0..*Details of a reaction that follows immunization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... date S0..1dateTimeWhen did reaction start?
.... detail S0..1ObservationAdditional information on reaction
.... reported S0..1booleanWas reaction self-reported?
... vaccinationProtocol S0..*What protocol was followed
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... doseSequence S1..1integerWhat dose number within series?
.... description S0..1stringDetails of vaccine protocol
.... authority S0..1org-daf-daforganizationWho is responsible for protocol
.... series S0..1stringName of vaccine series
.... seriesDoses S0..1integerRecommended number of doses for immunity
.... doseTarget S1..1CodeableConceptDisease immunized against
Binding: VaccinationProtocolDoseTarget (example)
.... doseStatus S1..1CodeableConceptDoes dose count towards immunity?
Binding: VaccinationProtocolDoseStatus (example)
.... doseStatusReason S0..1CodeableConceptWhy does does count/not count?
Binding: VaccinationProtocolDoseStatusReason (example)

todo

This structure is derived from Immunization.

Summary

Terminology Bindings

  • Immunization.vaccineType SHALL come from This identifies the CVX code system (Extensible)

Required/Prohibited Elements

  • The element Immunization.date is required
  • The element Immunization.vaccineType is required
  • The element Immunization.patient is required
  • The element Immunization.reported is required
  • The element Immunization.vaccinationProtocol.doseSequence is required
  • The element Immunization.vaccinationProtocol.doseTarget is required
  • The element Immunization.vaccinationProtocol.doseStatus is required

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 S0..*IdentifierBusiness identifier
... date S1..1dateTimeVaccination administration date
... vaccineType S1..1CodeableConceptVaccine Product Type (bind to CVX)
Binding: VaccineTypesCVX (extensible)
... patient S1..1patient-daf-dafpatientWho was immunized?
... wasNotGiven ?! I1..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 S1..1booleanIs this a self-reported record?
... performer S0..1PractitionerWho administered vaccine?
... requester S0..1PractitionerWho ordered vaccination?
... encounter 0..1EncounterEncounter administered as part of
... manufacturer S0..1OrganizationVaccine Manufacturer
... location 0..1LocationWhere did vaccination occur?
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
Binding: ImmunizationSite (example)
... route S0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRoute (example)
... doseQuantity S0..1QuantityAmount of vaccine administered
... explanation S0..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 0..*CodeableConceptWhy immunization did not occur
Binding: NoImmunizationReason (example)
... reaction S0..*Details of a reaction that follows immunization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... date S0..1dateTimeWhen did reaction start?
.... detail S0..1ObservationAdditional information on reaction
.... reported S0..1booleanWas reaction self-reported?
... vaccinationProtocol S0..*What protocol was followed
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... doseSequence S1..1integerWhat dose number within series?
.... description S0..1stringDetails of vaccine protocol
.... authority S0..1org-daf-daforganizationWho is responsible for protocol
.... series S0..1stringName of vaccine series
.... seriesDoses S0..1integerRecommended number of doses for immunity
.... doseTarget S1..1CodeableConceptDisease immunized against
Binding: VaccinationProtocolDoseTarget (example)
.... doseStatus S1..1CodeableConceptDoes dose count towards immunity?
Binding: VaccinationProtocolDoseStatus (example)
.... doseStatusReason S0..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.vaccineTypeVaccineTypesCVXextensibleVaccine 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)))
.