CDSi CDS-Immunization Forecast Implementation Guide - STU 1 Ballot (v0.1.0)
This page is part of the Immunization Decision Support Forecast FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
Definitions for the cdsi-immunizationrecommendation Profile.
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="cdsi-immunizationrecommendation"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> ImmunizationRecommendation<a name="ImmunizationRecommendation"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div> </text> <url value="http://hl7.org/fhir/uv/cdsi/StructureDefinition/cdsi-immunizationrecommendation"/> <version value="0.01"/> <name value="CDS on FHIR ImmunizationRecommendation Profile"/> <status value="draft"/> <date value="2017-04-27T00:00:00+10:00"/> <publisher value="PHER"/> <contact> <telecom> <system value="url"/> <value value="http://www.nist.gov"/> </telecom> </contact> <description value="Defines constraints and extensions on the ImmunizationRecommendation resource for the minimal set of data to be used in an immunization forecast."/> <fhirVersion value="3.0.1"/> <mapping> <identity value="quick"/> <uri value="http://unknown.org/QUICK"/> <name value="QUICK"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2 Mapping"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/w5"/> <name value="W5 Mapping"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="ImmunizationRecommendation"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"/> <derivation value="constraint"/> <snapshot> <element id="ImmunizationRecommendation"> <path value="ImmunizationRecommendation"/> <short value="Guidance or advice relating to an immunization"/> <definition value="A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification."/> <min value="0"/> <max value="*"/> <base> <path value="ImmunizationRecommendation"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <xpath value="not(parent::f:contained and f:contained)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-1"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/> <expression value="contained.text.empty()"/> <xpath value="not(parent::f:contained and f:text)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-3"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource"/> <expression value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()"/> <xpath value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"/> <source value="DomainResource"/> </constraint> <mustSupport value="false"/> <mapping> <identity value="rim"/> <map value="Entity. Role, or Act"/> </mapping> <mapping> <identity value="v2"/> <map value="VXU_V04"/> </mapping> <mapping> <identity value="rim"/> <map value="SubstanceAdministration[moodCode=RMD]"/> </mapping> <mapping> <identity value="w5"/> <map value="clinical.medication"/> </mapping> <mapping> <identity value="quick"/> <map value="ImmunizationRecommendationPerformanceOccurrence"/> </mapping> </element> <element id="ImmunizationRecommendation.id"> <path value="ImmunizationRecommendation.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <isSummary value="true"/> </element> <element id="ImmunizationRecommendation.meta"> <path value="ImmunizationRecommendation.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Meta"/> </type> <isSummary value="true"/> </element> <element id="ImmunizationRecommendation.implicitRules"> <path value="ImmunizationRecommendation.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isSummary value="true"/> </element> <element id="ImmunizationRecommendation.language"> <path value="ImmunizationRecommendation.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages"/> </valueReference> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="A human language."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages"/> </valueSetReference> </binding> </element> <element id="ImmunizationRecommendation.text"> <path value="ImmunizationRecommendation.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="ImmunizationRecommendation.contained"> <path value="ImmunizationRecommendation.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ImmunizationRecommendation.extension"> <path value="ImmunizationRecommendation.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ImmunizationRecommendation.modifierExtension"> <path value="ImmunizationRecommendation.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ImmunizationRecommendation.identifier"> <path value="ImmunizationRecommendation.identifier"/> <short value="Business identifier"/> <definition value="A unique identifier assigned to this particular recommendation record."/> <min value="0"/> <max value="*"/> <base> <path value="ImmunizationRecommendation.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element id="ImmunizationRecommendation.patient"> <path value="ImmunizationRecommendation.patient"/> <short value="Who this profile is for"/> <definition value="The patient the recommendations are for."/> <min value="1"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.patient"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="PID-3"/> </mapping> <mapping> <identity value="rim"/> <map value=".partipication[typeCode=SUBJ].role"/> </mapping> <mapping> <identity value="w5"/> <map value="who.focus"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation"> <path value="ImmunizationRecommendation.recommendation"/> <short value="Vaccine administration recommendations"/> <definition value="Vaccine administration recommendations."/> <min value="1"/> <max value="*"/> <base> <path value="ImmunizationRecommendation.recommendation"/> <min value="1"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="imr-1"/> <severity value="error"/> <human value="One of vaccineCode or targetDisease SHALL be present"/> <expression value="vaccineCode.exists() or targetDisease.exists()"/> <xpath value="exists(f:vaccineCode) or exists(f:targetDisease)"/> </constraint> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.id"> <path value="ImmunizationRecommendation.recommendation.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.extension"> <path value="ImmunizationRecommendation.recommendation.extension"/> <slicing id="1"> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <ordered value="false"/> <rules value="open"/> </slicing> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element id="ImmunizationRecommendation.recommendation.extension:my_simple_extension"> <path value="ImmunizationRecommendation.recommendation.extension"/> <sliceName value="My_Simple_Extension"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/uv/cdsi/StructureDefinition/template-forecastStatusReason"/> </type> <condition value="ele-1"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/> <source value="Extension"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> </element> <element id="ImmunizationRecommendation.recommendation.modifierExtension"> <path value="ImmunizationRecommendation.recommendation.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.date"> <path value="ImmunizationRecommendation.recommendation.date"/> <short value="Date recommendation created"/> <definition value="The date the immunization recommendation was created."/> <min value="1"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.recommendation.date"/> <min value="1"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="OBX-15"/> </mapping> <mapping> <identity value="rim"/> <map value=".partipication[typeCode=AUTH].time"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.vaccineCode"> <path value="ImmunizationRecommendation.recommendation.vaccineCode"/> <short value="Vaccine recommendation applies to"/> <definition value="Vaccine that pertains to the recommendation."/> <min value="0"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.recommendation.vaccineCode"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="VaccineCode"/> </extension> <strength value="example"/> <description value="The type of vaccine administered"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/vaccine-code"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 e { 30956-7 | 38890-0 }"/> </mapping> <mapping> <identity value="rim"/> <map value=".partipication[typeCode=CSM].role[classCode=ADMM].code"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.targetDisease"> <path value="ImmunizationRecommendation.recommendation.targetDisease"/> <short value="Disease to be immunized against"/> <definition value="The targeted disease for the recommendation."/> <min value="0"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.recommendation.targetDisease"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="TargetDisease"/> </extension> <strength value="example"/> <description value="The disease that the recommended vaccination targets"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 e { 30956-7 | 38890-0 }"/> </mapping> <mapping> <identity value="rim"/> <map value=".partipication[typeCode=CSM].role[classCode=ADMM].code"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.doseNumber"> <path value="ImmunizationRecommendation.recommendation.doseNumber"/> <short value="Recommended dose number"/> <definition value="The next recommended dose number (e.g. dose 2 is the next recommended dose)."/> <comment value="May need other dose concepts such as administered vs. valid."/> <min value="0"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.recommendation.doseNumber"/> <min value="0"/> <max value="1"/> </base> <type> <code value="positiveInt"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = 30973-2"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.forecastStatus"> <path value="ImmunizationRecommendation.recommendation.forecastStatus"/> <short value="Vaccine administration status"/> <definition value="Vaccine administration status."/> <min value="1"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.recommendation.forecastStatus"/> <min value="1"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="false"/> <isSummary value="true"/> <binding> <strength value="extensible"/> <description value="a bunch of example codes"/> <valueSetReference> <reference value="ValueSet/forecastStatus-codes"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = 59783-1"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code="Immunization Forecast Status"].value"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.dateCriterion"> <path value="ImmunizationRecommendation.recommendation.dateCriterion"/> <short value="Dates governing proposed immunization"/> <definition value="Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc."/> <min value="0"/> <max value="*"/> <base> <path value="ImmunizationRecommendation.recommendation.dateCriterion"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="imm-cds-1"/> <severity value="error"/> <human value="if recommendation.forecastStatus is one of (due, due later, not complete, overdue, consider, wavered, recommended but not required) then two dateCriterion elements are required: one with dateCriterion.code=earliest, and one with dateCriterion.code=recommended"/> <expression value="recommendation.where(($this.forecastStatus.coding.where(code = 'due') or $this.forecastStatus.coding.where(code = 'duelater')).not() or ($this.dateCriterion.code.coding.where(code = 'due') and $this.dateCriterion.code.coding.where(code = 'overdue'))).count() = recommendation.count()"/> <xpath value="f:recommendation.dateCriterion/f:value/string-length(@value)>5"/> </constraint> <mustSupport value="false"/> <mapping> <identity value="v2"/> <map value="OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]"/> </mapping> <mapping> <identity value="quick"/> <map value="dateCriterion"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.dateCriterion.id"> <path value="ImmunizationRecommendation.recommendation.dateCriterion.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.dateCriterion.extension"> <path value="ImmunizationRecommendation.recommendation.dateCriterion.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension"> <path value="ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.dateCriterion.code"> <path value="ImmunizationRecommendation.recommendation.dateCriterion.code"/> <short value="Type of date"/> <definition value="Date classification of recommendation. For example, earliest date to give, latest date to give, etc."/> <min value="1"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.recommendation.dateCriterion.code"/> <min value="1"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="false"/> <binding> <strength value="extensible"/> <description value="a bunch of example codes"/> <valueSetReference> <reference value="ValueSet/immRecDateCriterion-codes"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="OBX-3"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="quick"/> <map value="code"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.dateCriterion.value"> <path value="ImmunizationRecommendation.recommendation.dateCriterion.value"/> <short value="Recommended date"/> <definition value="The date whose meaning is specified by dateCriterion.code."/> <min value="1"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.recommendation.dateCriterion.value"/> <min value="1"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <mustSupport value="false"/> <mapping> <identity value="v2"/> <map value="OBX-5"/> </mapping> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> <mapping> <identity value="quick"/> <map value="value"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.protocol"> <path value="ImmunizationRecommendation.recommendation.protocol"/> <short value="Protocol used by recommendation"/> <definition value="Contains information about the protocol under which the vaccine was administered."/> <min value="0"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.recommendation.protocol"/> <min value="0"/> <max value="1"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=INST].source[classCode=SBADM, moodCode=DEF]"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.protocol.id"> <path value="ImmunizationRecommendation.recommendation.protocol.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.protocol.extension"> <path value="ImmunizationRecommendation.recommendation.protocol.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.protocol.modifierExtension"> <path value="ImmunizationRecommendation.recommendation.protocol.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.protocol.doseSequence"> <path value="ImmunizationRecommendation.recommendation.protocol.doseSequence"/> <short value="Dose number within sequence"/> <definition value="Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol."/> <min value="0"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.recommendation.protocol.doseSequence"/> <min value="0"/> <max value="1"/> </base> <type> <code value="positiveInt"/> </type> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = 30973-2"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.protocol.description"> <path value="ImmunizationRecommendation.recommendation.protocol.description"/> <short value="Protocol details"/> <definition value="Contains the description about the protocol under which the vaccine was administered."/> <min value="0"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.recommendation.protocol.description"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = 30956-7"/> </mapping> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.protocol.authority"> <path value="ImmunizationRecommendation.recommendation.protocol.authority"/> <short value="Who is responsible for protocol"/> <definition value="Indicates the authority who published the protocol. For example, ACIP."/> <min value="0"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.recommendation.protocol.authority"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = 59779-9"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT]"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.protocol.series"> <path value="ImmunizationRecommendation.recommendation.protocol.series"/> <short value="Name of vaccination series"/> <definition value="One possible path to achieve presumed immunity against a disease - within the context of an authority."/> <min value="0"/> <max value="1"/> <base> <path value="ImmunizationRecommendation.recommendation.protocol.series"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="v2"/> <map value="RXA-5-administered code"/> </mapping> <mapping> <identity value="rim"/> <map value=".title"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.supportingImmunization"> <path value="ImmunizationRecommendation.recommendation.supportingImmunization"/> <short value="Past immunizations supporting recommendation"/> <definition value="Immunization event history that supports the status and recommendation."/> <min value="0"/> <max value="*"/> <base> <path value="ImmunizationRecommendation.recommendation.supportingImmunization"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Immunization"/> </type> <mapping> <identity value="v2"/> <map value="? No clear way to associate in HL7 v2 or IG"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code="immunization"]"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.supportingPatientInformation"> <path value="ImmunizationRecommendation.recommendation.supportingPatientInformation"/> <short value="Patient observations supporting recommendation"/> <definition value="Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information."/> <min value="0"/> <max value="*"/> <base> <path value="ImmunizationRecommendation.recommendation.supportingPatientInformation"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"/> </type> <mapping> <identity value="v2"/> <map value="OBX If OBX is associated with ( RXA : RXA-5-administered code = '998^No vaccine administered^CVX'), could contain the reason the vaccine was not administered"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"/> </mapping> </element> </snapshot> <differential> <element id="ImmunizationRecommendation"> <path value="ImmunizationRecommendation"/> <mustSupport value="false"/> <isModifier value="false"/> <mapping> <identity value="quick"/> <map value="ImmunizationRecommendationPerformanceOccurrence"/> </mapping> <mapping> <identity value="quick"/> <map value="ImmunizationRecommendationPerformanceOccurrence"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.extension:my_simple_extension"> <path value="ImmunizationRecommendation.recommendation.extension"/> <sliceName value="My_Simple_Extension"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/uv/cdsi/StructureDefinition/template-forecastStatusReason"/> </type> <mustSupport value="false"/> <isModifier value="false"/> </element> <element id="ImmunizationRecommendation.recommendation.forecastStatus"> <path value="ImmunizationRecommendation.recommendation.forecastStatus"/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <binding> <strength value="extensible"/> <description value="a bunch of example codes"/> <valueSetReference> <reference value="ValueSet/forecastStatus-codes"/> </valueSetReference> </binding> </element> <element id="ImmunizationRecommendation.recommendation.dateCriterion"> <path value="ImmunizationRecommendation.recommendation.dateCriterion"/> <min value="0"/> <max value="*"/> <type> <code value="BackboneElement"/> </type> <constraint> <key value="imm-cds-1"/> <severity value="error"/> <human value="if recommendation.forecastStatus is one of (due, due later, not complete, overdue, consider, wavered, recommended but not required) then two dateCriterion elements are required: one with dateCriterion.code=earliest, and one with dateCriterion.code=recommended"/> <expression value="recommendation.where(($this.forecastStatus.coding.where(code = 'due') or $this.forecastStatus.coding.where(code = 'duelater')).not() or ($this.dateCriterion.code.coding.where(code = 'due') and $this.dateCriterion.code.coding.where(code = 'overdue'))).count() = recommendation.count()"/> <xpath value="f:recommendation.dateCriterion/f:value/string-length(@value)>5"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <mapping> <identity value="quick"/> <map value="dateCriterion"/> </mapping> <mapping> <identity value="quick"/> <map value="dateCriterion"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.dateCriterion.code"> <path value="ImmunizationRecommendation.recommendation.dateCriterion.code"/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <binding> <strength value="extensible"/> <description value="a bunch of example codes"/> <valueSetReference> <reference value="ValueSet/immRecDateCriterion-codes"/> </valueSetReference> </binding> <mapping> <identity value="quick"/> <map value="code"/> </mapping> <mapping> <identity value="quick"/> <map value="code"/> </mapping> </element> <element id="ImmunizationRecommendation.recommendation.dateCriterion.value"> <path value="ImmunizationRecommendation.recommendation.dateCriterion.value"/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <mapping> <identity value="quick"/> <map value="value"/> </mapping> <mapping> <identity value="quick"/> <map value="value"/> </mapping> </element> </differential> </StructureDefinition>
© HL7.org 2011+. ImmDS v0.1.0 (using FHIR R3 (STU; v3.0.1) generated on Wed, Apr 19, 2017 07:49+1000.
