Immunization Decision Support Forecast (ImmDS) Implementation Guide
0.1.0 - CI Build

Immunization Decision Support Forecast (ImmDS) Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

StructureDefinition: ImmDSImmunization

Immunization event for the patient.

The official URL for this profile is: 

http://hl7.org/fhir/us/ImmunizationFHIRDS/StructureDefinition/immds-immunization

Formal Views of Profile Content

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

This structure is derived from USCoreImmunizationProfile

Summary

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*USCoreImmunizationProfileImmunization event information
... 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 ?!SΣI1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason SI0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example)
... vaccineCode SΣI1..1CodeableConceptVaccine Product Type (bind to CVX)
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
us-core-1: SHOULD have a translation to the NDC value set
... patient SΣI1..1Reference(ImmDS Patient)Who was immunized
... 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 SΣI1..1booleanIndicates context the data was recorded in
... 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 manufacturer
... lotNumber I0..1stringVaccine lot number
... expirationDate I0..1dateVaccine expiration date
... site I0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
... route I0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example)
... doseQuantity I0..1SimpleQuantityAmount of vaccine administered
... performer ΣI0..*BackboneElementWho performed event
.... 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: ImmunizationFunctionCodes (extensible)
.... actor ΣI1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
... note ΣI0..*AnnotationAdditional immunization notes
... reasonCode I0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example)
... 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..*BackboneElementProtocol followed by the provider
.... 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 preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example)
.... 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 structure is derived from USCoreImmunizationProfile

Summary

Structures

This structure refers to these other structures:

Differential View

This structure is derived from USCoreImmunizationProfile

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*USCoreImmunizationProfileImmunization event information
... 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 ?!SΣI1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason SI0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example)
... vaccineCode SΣI1..1CodeableConceptVaccine Product Type (bind to CVX)
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
us-core-1: SHOULD have a translation to the NDC value set
... patient SΣI1..1Reference(ImmDS Patient)Who was immunized
... 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 SΣI1..1booleanIndicates context the data was recorded in
... 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 manufacturer
... lotNumber I0..1stringVaccine lot number
... expirationDate I0..1dateVaccine expiration date
... site I0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
... route I0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example)
... doseQuantity I0..1SimpleQuantityAmount of vaccine administered
... performer ΣI0..*BackboneElementWho performed event
.... 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: ImmunizationFunctionCodes (extensible)
.... actor ΣI1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
... note ΣI0..*AnnotationAdditional immunization notes
... reasonCode I0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example)
... 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..*BackboneElementProtocol followed by the provider
.... 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 preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example)
.... 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

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonexampleImmunizationStatusReasonCodes
Immunization.vaccineCodeextensibleUSCoreVaccineAdministeredValueSetCvx
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
Immunization.routeexampleImmunizationRouteCodes
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes

Constraints

Constraints

IdPathDetailsRequirements
us-core-1Immunization.vaccineCodeSHOULD have a translation to the NDC value set
: coding.where(system='http://hl7.org/fhir/sid/ndc').empty()
imm-1Immunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()