Qi-Core Implementation Guide (Release 2.1 Draft)

D.4.1 StructureDefinition: qicore-immunizationrec

Examples:

Example of immunizationrecommendation using a vaccine code

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationrec

This profile builds on ImmunizationRecommendation.

This profile was published on Mon Aug 21 00:00:00 UTC 2017 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation I0..*Guidance or advice relating to an immunization
... 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
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... patient SΣ1..1Reference(QICore-Patient)Who this profile is for
... recommendation ΣI1..*BackboneElementVaccine administration recommendations
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... date SΣ1..1dateTimeDate recommendation created
.... vaccineCode SΣ0..1CodeableConceptVaccine recommendation applies to
Binding: Vaccine Administered Value Set (CVX) (preferred)
.... targetDisease Σ0..1CodeableConceptDisease to be immunized against
Binding: Immunization Recommendation Target Disease Codes (example)
.... doseNumber SΣ0..1positiveIntRecommended dose number
.... forecastStatus Σ1..1CodeableConceptVaccine administration status
Binding: Immunization Recommendation Status Codes (example)
.... dateCriterion I0..*BackboneElementDates governing proposed immunization
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... code 1..1CodeableConceptType of date
Binding: Immunization Recommendation Date Criterion Codes (example)
..... value 1..1dateTimeRecommended date
.... protocol I0..1BackboneElementProtocol used by recommendation
..... 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 sequence
..... description 0..1stringProtocol details
..... authority 0..1Reference(QICore-Organization)Who is responsible for protocol
..... series 0..1stringName of vaccination series
.... supportingImmunization 0..*Reference(QICore-Immunization)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICore-Observation), Reference(QICore-AllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation I0..*Guidance or advice relating to an immunization
... 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
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... patient SΣ1..1Reference(QICore-Patient)Who this profile is for
... recommendation ΣI1..*BackboneElementVaccine administration recommendations
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... date SΣ1..1dateTimeDate recommendation created
.... vaccineCode SΣ0..1CodeableConceptVaccine recommendation applies to
Binding: Vaccine Administered Value Set (CVX) (preferred)
.... targetDisease Σ0..1CodeableConceptDisease to be immunized against
Binding: Immunization Recommendation Target Disease Codes (example)
.... doseNumber SΣ0..1positiveIntRecommended dose number
.... forecastStatus Σ1..1CodeableConceptVaccine administration status
Binding: Immunization Recommendation Status Codes (example)
.... dateCriterion I0..*BackboneElementDates governing proposed immunization
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... code 1..1CodeableConceptType of date
Binding: Immunization Recommendation Date Criterion Codes (example)
..... value 1..1dateTimeRecommended date
.... protocol I0..1BackboneElementProtocol used by recommendation
..... 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 sequence
..... description 0..1stringProtocol details
..... authority 0..1Reference(QICore-Organization)Who is responsible for protocol
..... series 0..1stringName of vaccination series
.... supportingImmunization 0..*Reference(QICore-Immunization)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICore-Observation), Reference(QICore-AllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
ImmunizationRecommendation.languageCommon LanguagesextensibleCommon Languages
ImmunizationRecommendation.recommendation.vaccineCodeVaccine Administered Value Set (CVX)preferredVaccine Administered Value Set (CVX)
ImmunizationRecommendation.recommendation.targetDiseaseImmunization Recommendation Target Disease CodesexampleImmunization Recommendation Target Disease Codes
ImmunizationRecommendation.recommendation.forecastStatusImmunization Recommendation Status CodesexampleImmunization Recommendation Status Codes
ImmunizationRecommendation.recommendation.dateCriterion.codeImmunization Recommendation Date Criterion CodesexampleImmunization Recommendation Date Criterion Codes

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ImmunizationRecommendationIf 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-3ImmunizationRecommendationIf 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()
ele-1ImmunizationRecommendation.recommendationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
imr-1ImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()
ele-1ImmunizationRecommendation.recommendation.dateCriterionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.protocolAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())