Standard Health Record FHIR Implementation Guide

SHR ImmunizationNotGiven Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-immunization-ImmunizationNotGiven

An immunization that was not given to the subject.

This profile builds on US Core Immunization Profile.

This profile was published on Tue Feb 27 00:00:00 EST 2018 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

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

Summary

Fixed Value: 1 element
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.immunization.ImmunizationNotGiven maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization:
  Vaccine.Type maps to vaccineCode
  constrain explanation to 0..1
  NotPerformedContext.Reason maps to explanation.reasonNotGiven
  constrain site to 0..0
  constrain route to 0..0
  constrain doseQuantity to 0..0
  <TBD "DoseSequenceNumber"> maps to vaccinationProtocol.doseSequence
  fix status to #completed 

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization SHR ImmunizationNotGiven Profile
... status Fixed Value: completed
... vaccineCode Binding: Vaccine Administered Value Set (required)
... site 0..0
... route 0..0
... doseQuantity 0..0
... explanation
.... reasonNotGiven Binding: Immunization Reasons for Not Immunizing Codes (required)
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-entity-BodySite-extension 0..1Reference(SHR BodySite Profile)SHR BodySite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite-extension
... shr-medication-RouteIntoBody-extension 0..1CodeableConceptSHR RouteIntoBody Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-RouteIntoBody-extension
Binding: SNOMED CT Route Codes (required)
... shr-medication-DoseAmount-extension 0..1Reference(SHR SimpleQuantity Profile), SHR Range ProfileSHR DoseAmount Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-DoseAmount-extension
... shr-action-Outcome-extension 0..*(Complex)SHR Outcome Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Outcome-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*SHR ImmunizationNotGiven Profile
... 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
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-entity-BodySite-extension 0..1Reference(SHR BodySite Profile)SHR BodySite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite-extension
... shr-medication-RouteIntoBody-extension 0..1CodeableConceptSHR RouteIntoBody Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-RouteIntoBody-extension
Binding: SNOMED CT Route Codes (required)
... shr-medication-DoseAmount-extension 0..1Reference(SHR SimpleQuantity Profile), SHR Range ProfileSHR DoseAmount Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-DoseAmount-extension
... shr-action-Outcome-extension 0..*(Complex)SHR Outcome Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Outcome-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error
Binding: Immunization Status Codes (required)
Fixed Value: completed
... notGiven ?!SΣ1..1booleanFlag for whether immunization was given
... vaccineCode SI1..1CodeableConceptVaccine Product Type (bind to CVX)
Binding: Vaccine Administered Value Set (required)
us-core-1: SHOULD have a translation to the NDC value set
... patient S1..1Reference(US Core Patient Profile)Who was immunized
... encounter 0..1Reference(Encounter)Encounter administered as part of
... date S1..1dateTimeVaccination administration date
... primarySource S1..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example)
... location 0..1Reference(Location)Where vaccination occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... practitioner ΣI0..*BackboneElementWho performed event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ0..1CodeableConceptWhat type of performance was done
Binding: Immunization Role Codes (extensible)
.... actor Σ1..1Reference(Practitioner)Individual who was performing
... note Σ0..*AnnotationVaccination notes
... explanation I0..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 0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven 0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (required)
... reaction I0..*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(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol I0..*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(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

Summary

Fixed Value: 1 element
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.immunization.ImmunizationNotGiven maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization:
  Vaccine.Type maps to vaccineCode
  constrain explanation to 0..1
  NotPerformedContext.Reason maps to explanation.reasonNotGiven
  constrain site to 0..0
  constrain route to 0..0
  constrain doseQuantity to 0..0
  <TBD "DoseSequenceNumber"> maps to vaccinationProtocol.doseSequence
  fix status to #completed 

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization SHR ImmunizationNotGiven Profile
... status Fixed Value: completed
... vaccineCode Binding: Vaccine Administered Value Set (required)
... site 0..0
... route 0..0
... doseQuantity 0..0
... explanation
.... reasonNotGiven Binding: Immunization Reasons for Not Immunizing Codes (required)
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-entity-BodySite-extension 0..1Reference(SHR BodySite Profile)SHR BodySite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite-extension
... shr-medication-RouteIntoBody-extension 0..1CodeableConceptSHR RouteIntoBody Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-RouteIntoBody-extension
Binding: SNOMED CT Route Codes (required)
... shr-medication-DoseAmount-extension 0..1Reference(SHR SimpleQuantity Profile), SHR Range ProfileSHR DoseAmount Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-DoseAmount-extension
... shr-action-Outcome-extension 0..*(Complex)SHR Outcome Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Outcome-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*SHR ImmunizationNotGiven Profile
... 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
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-entity-BodySite-extension 0..1Reference(SHR BodySite Profile)SHR BodySite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite-extension
... shr-medication-RouteIntoBody-extension 0..1CodeableConceptSHR RouteIntoBody Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-RouteIntoBody-extension
Binding: SNOMED CT Route Codes (required)
... shr-medication-DoseAmount-extension 0..1Reference(SHR SimpleQuantity Profile), SHR Range ProfileSHR DoseAmount Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-DoseAmount-extension
... shr-action-Outcome-extension 0..*(Complex)SHR Outcome Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Outcome-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error
Binding: Immunization Status Codes (required)
Fixed Value: completed
... notGiven ?!SΣ1..1booleanFlag for whether immunization was given
... vaccineCode SI1..1CodeableConceptVaccine Product Type (bind to CVX)
Binding: Vaccine Administered Value Set (required)
us-core-1: SHOULD have a translation to the NDC value set
... patient S1..1Reference(US Core Patient Profile)Who was immunized
... encounter 0..1Reference(Encounter)Encounter administered as part of
... date S1..1dateTimeVaccination administration date
... primarySource S1..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example)
... location 0..1Reference(Location)Where vaccination occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... practitioner ΣI0..*BackboneElementWho performed event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ0..1CodeableConceptWhat type of performance was done
Binding: Immunization Role Codes (extensible)
.... actor Σ1..1Reference(Practitioner)Individual who was performing
... note Σ0..*AnnotationVaccination notes
... explanation I0..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 0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven 0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (required)
... reaction I0..*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(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol I0..*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(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

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

 

Terminology Bindings

PathNameConformanceValueSet
Immunization.languageCommon LanguagesextensibleCommon Languages
Immunization.statusImmunization Status CodesrequiredImmunization Status Codes
Immunization.vaccineCodeVaccine Administered Value SetrequiredVaccine Administered Value Set
Immunization.reportOriginImmunization Origin CodesexampleImmunization Origin Codes
Immunization.practitioner.roleImmunization Role CodesextensibleImmunization Role Codes
Immunization.explanation.reasonImmunization Reason CodesexampleImmunization Reason Codes
Immunization.explanation.reasonNotGivenImmunization Reasons for Not Immunizing CodesrequiredImmunization 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

 

Constraints

IdPathDetailsRequirements
dom-2ImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ImmunizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3ImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
imm-2ImmunizationIf immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
: (notGiven = true) or explanation.reasonNotGiven.empty()
imm-1ImmunizationIf immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
: (notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
us-core-1Immunization.vaccineCodeSHOULD have a translation to the NDC value set
: coding.where(system='http://hl7.org/fhir/sid/ndc').empty()
ele-1Immunization.practitionerAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Immunization.explanationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Immunization.reactionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Immunization.vaccinationProtocolAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())