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

The set of immunization recommendations for the patient.

The official URL for this profile is: 

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

Formal Views of Profile Content

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

This structure is derived from ImmunizationRecommendation

Summary

Structures

This structure refers to these other structures:

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... patient 1..1Reference(ImmDS Patient)Who this profile is for
... recommendation
.... vaccineCode 0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
.... targetDisease 0..1CodeableConceptDisease to be immunized against
Binding: Vaccine Target Disease (extensible)
.... contraindicatedVaccineCode 0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
.... forecastStatus 1..1CodeableConceptVaccine recommendation status
Binding: Forecast Status (preferred)
.... forecastReason 0..*CodeableConceptVaccine administration status reason
Binding: Forecast Reason (example)
.... dateCriterion
..... code 1..1CodeableConceptType of date
Binding: ImmunizationRecommendationDateCriterionCodes (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation I0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... 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
... 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
... patient ΣI1..1Reference(ImmDS Patient)Who this profile is for
... date ΣI1..1dateTimeDate recommendation(s) created
... authority I0..1Reference(Organization)Who is responsible for protocol
... recommendation ΣI1..*BackboneElementVaccine administration recommendations
imr-1: One of vaccineCode or targetDisease 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
.... vaccineCode ΣI0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
.... targetDisease ΣI0..1CodeableConceptDisease to be immunized against
Binding: Vaccine Target Disease (extensible)
.... contraindicatedVaccineCode ΣI0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
.... forecastStatus ?!ΣI1..1CodeableConceptVaccine recommendation status
Binding: Forecast Status (preferred)
.... forecastReason ΣI0..*CodeableConceptVaccine administration status reason
Binding: Forecast Reason (example)
.... dateCriterion I0..*BackboneElementDates governing proposed 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
..... code I1..1CodeableConceptType of date
Binding: ImmunizationRecommendationDateCriterionCodes (extensible)
..... value I1..1dateTimeRecommended date
.... description I0..1stringProtocol details
.... series I0..1stringName of vaccination series
.... doseNumber[x] ΣI0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] I0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization I0..*Reference(Immunization | ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation I0..*Reference(Resource)Patient observations supporting recommendation

doco Documentation for this format

This structure is derived from ImmunizationRecommendation

Summary

Structures

This structure refers to these other structures:

Differential View

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... patient 1..1Reference(ImmDS Patient)Who this profile is for
... recommendation
.... vaccineCode 0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
.... targetDisease 0..1CodeableConceptDisease to be immunized against
Binding: Vaccine Target Disease (extensible)
.... contraindicatedVaccineCode 0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
.... forecastStatus 1..1CodeableConceptVaccine recommendation status
Binding: Forecast Status (preferred)
.... forecastReason 0..*CodeableConceptVaccine administration status reason
Binding: Forecast Reason (example)
.... dateCriterion
..... code 1..1CodeableConceptType of date
Binding: ImmunizationRecommendationDateCriterionCodes (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation I0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... 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
... 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
... patient ΣI1..1Reference(ImmDS Patient)Who this profile is for
... date ΣI1..1dateTimeDate recommendation(s) created
... authority I0..1Reference(Organization)Who is responsible for protocol
... recommendation ΣI1..*BackboneElementVaccine administration recommendations
imr-1: One of vaccineCode or targetDisease 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
.... vaccineCode ΣI0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
.... targetDisease ΣI0..1CodeableConceptDisease to be immunized against
Binding: Vaccine Target Disease (extensible)
.... contraindicatedVaccineCode ΣI0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
.... forecastStatus ?!ΣI1..1CodeableConceptVaccine recommendation status
Binding: Forecast Status (preferred)
.... forecastReason ΣI0..*CodeableConceptVaccine administration status reason
Binding: Forecast Reason (example)
.... dateCriterion I0..*BackboneElementDates governing proposed 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
..... code I1..1CodeableConceptType of date
Binding: ImmunizationRecommendationDateCriterionCodes (extensible)
..... value I1..1dateTimeRecommended date
.... description I0..1stringProtocol details
.... series I0..1stringName of vaccination series
.... doseNumber[x] ΣI0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] I0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization I0..*Reference(Immunization | ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation I0..*Reference(Resource)Patient observations supporting recommendation

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
ImmunizationRecommendation.languagepreferredCommonLanguages
Max Binding: AllLanguages
ImmunizationRecommendation.recommendation.vaccineCodeextensibleUSCoreVaccineAdministeredValueSetCvx
ImmunizationRecommendation.recommendation.targetDiseaseextensibleTargetDisease
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeextensibleUSCoreVaccineAdministeredValueSetCvx
ImmunizationRecommendation.recommendation.forecastStatuspreferredForecastStatus
ImmunizationRecommendation.recommendation.forecastReasonexampleForecastReason
ImmunizationRecommendation.recommendation.dateCriterion.codeextensibleImmunizationRecommendationDateCriterionCodes

Constraints

Constraints

IdPathDetailsRequirements
imr-1ImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()