This page is part of the Immunization Decision Support Forecast FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
XML Format: StructureDefinition-immds-immunizationevaluation
Raw xml
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="immds-immunizationevaluation"/> <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/R4/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/R4/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/R4/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/R4/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/R4/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/R4/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/R4/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_bck1.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"/> <a href="StructureDefinition-immds-immunizationevaluation-definitions.html#ImmunizationEvaluation" title="Defines constraints and extensions on the immunizationevaluation resource for the minimal set of data to perform the Immunization Decision Support Forecast operation.">ImmunizationEvaluation</a><a name="ImmunizationEvaluation"> </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">0..*</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">ImmDS Immunization evaluation information<br/></td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="StructureDefinition-immds-immunizationevaluation-definitions.html#ImmunizationEvaluation.date" title="The date the evaluation of the vaccine administration event was performed.">date</a><a name="ImmunizationEvaluation.date"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Date evaluation was performed</td></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_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_datatype.gif" alt="." style="background-color: white; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="StructureDefinition-immds-immunizationevaluation-definitions.html#ImmunizationEvaluation.targetDisease" title="The vaccine preventable disease the dose is being evaluated against.">targetDisease</a><a name="ImmunizationEvaluation.targetDisease"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: black; null" title="This element is included in summaries">Σ</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td 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/R4/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Evaluation target disease<br/><span style="font-weight:bold">Binding: </span><a href="https://build.fhir.org/ig/HL7/US-Core-R4//ValueSet-us-core-vaccines-cvx.html">US Core Vaccine Administered Value Set (CVX)</a> (<a href="http://hl7.org/fhir/R4/terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.">extensible</a>)</td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_datatype.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="StructureDefinition-immds-immunizationevaluation-definitions.html#ImmunizationEvaluation.doseStatus" title="Indicates if the dose is valid or not valid with respect to the published recommendations.">doseStatus</a><a name="ImmunizationEvaluation.doseStatus"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: black; null" title="This element is included in summaries">Σ</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Status of the dose relative to published recommendations<br/><span style="font-weight:bold">Binding: </span><a href="http://hl7.org/fhir/R4/valueset-immunization-evaluation-dose-status.html">ImmunizationEvaluationDoseStatusCodes</a> (<a href="http://hl7.org/fhir/R4/terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.">extensible</a>)</td></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_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_datatype.gif" alt="." style="background-color: white; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="StructureDefinition-immds-immunizationevaluation-definitions.html#ImmunizationEvaluation.doseStatusReason" title="While an extensible value set is provided for this element, there is not a broadly agreed upon value set to use. Implementations will likely make extensive use of the text element within the CodeableConcept data type to convey information.">doseStatusReason</a><a name="ImmunizationEvaluation.doseStatusReason"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..*</td><td 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/R4/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Reason for the dose status<br/><span style="font-weight:bold">Binding: </span><a href="http://hl7.org/fhir/R4/valueset-immunization-evaluation-dose-status-reason.html">ImmunizationEvaluationDoseStatusReasonCodes</a> (<a href="http://hl7.org/fhir/R4/terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.">extensible</a>)<br/></td></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/R4/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/R4/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/immds/StructureDefinition/immds-immunizationevaluation"/> <version value="0.2.0"/> <name value="ImmDSImmunizationEvaluationProfile"/> <title value="Immunization Decision Support ImmunizationEvaluation Profile"/> <status value="active"/> <experimental value="false"/> <date value="2019-06-27T20:00:00-04:00"/> <publisher value="HL7 International - Public Health Work Group"/> <contact> <telecom> <system value="url"/> <value value="https://confluence.hl7.org/display/PHWG/Public+Health+Work+Group"/> </telecom> </contact> <description value="Defines constraints and extensions on the immunizationevaluation resource for the minimal set of data to perform the Immunization Decision Support Forecast operation."/> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="US"/> <display value="United States of America"/> </coding> </jurisdiction> <fhirVersion value="4.0.0"/> <mapping> <identity value="workflow"/> <uri value="http://hl7.org/fhir/workflow"/> <name value="Workflow Pattern"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2 Mapping"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/fivews"/> <name value="FiveWs Pattern Mapping"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="ImmunizationEvaluation"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation"/> <derivation value="constraint"/> <snapshot> <element id="ImmunizationEvaluation"> <path value="ImmunizationEvaluation"/> <short value="ImmDS Immunization evaluation information"/> <definition value="Defines constraints and extensions on the immunizationevaluation resource for the minimal set of data to perform the Immunization Decision Support Forecast operation."/> <min value="0"/> <max value="*"/> <base> <path value="ImmunizationEvaluation"/> <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-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 or SHALL refer to the containing resource"/> <expression value="contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"/> <xpath value="not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))"/> <source value="DomainResource"/> </constraint> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"> <valueBoolean value="true"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation"> <valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."/> </extension> <key value="dom-6"/> <severity value="warning"/> <human value="A resource should have narrative for robust management"/> <expression value="text.div.exists()"/> <xpath value="exists(f:text/h:div)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-5"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a security label"/> <expression value="contained.meta.security.empty()"/> <xpath value="not(exists(f:contained/*/f:meta/f:security))"/> <source value="DomainResource"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Entity. Role, or Act"/> </mapping> <mapping> <identity value="workflow"/> <map value="Event"/> </mapping> <mapping> <identity value="v2"/> <map value="RSP_K11"/> </mapping> </element> <element id="ImmunizationEvaluation.id"> <path value="ImmunizationEvaluation.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> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="ImmunizationEvaluation.meta"> <path value="ImmunizationEvaluation.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 might 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> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="ImmunizationEvaluation.implicitRules"> <path value="ImmunizationEvaluation.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc."/> <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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc."/> <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"/> <isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation"/> <isSummary value="true"/> </element> <element id="ImmunizationEvaluation.language"> <path value="ImmunizationEvaluation.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> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages"/> </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="preferred"/> <description value="A human language."/> <valueSet value="http://hl7.org/fhir/ValueSet/languages"/> </binding> </element> <element id="ImmunizationEvaluation.text"> <path value="ImmunizationEvaluation.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 can 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 information 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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="ImmunizationEvaluation.contained"> <path value="ImmunizationEvaluation.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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels."/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ImmunizationEvaluation.extension"> <path value="ImmunizationEvaluation.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. 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 can 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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ImmunizationEvaluation.modifierExtension"> <path value="ImmunizationEvaluation.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."/> <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."/> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)."/> <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"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ImmunizationEvaluation.identifier"> <path value="ImmunizationEvaluation.identifier"/> <short value="Business identifier"/> <definition value="A unique identifier assigned to this immunization evaluation record."/> <min value="0"/> <max value="*"/> <base> <path value="ImmunizationEvaluation.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.identifier"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.identifier"/> </mapping> </element> <element id="ImmunizationEvaluation.status"> <path value="ImmunizationEvaluation.status"/> <short value="completed | entered-in-error"/> <definition value="Indicates the current status of the evaluation of the vaccination administration event."/> <min value="1"/> <max value="1"/> <base> <path value="ImmunizationEvaluation.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isModifier value="true"/> <isModifierReason value="This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)."/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationEvaluationStatus"/> </extension> <strength value="required"/> <description value="The status of the evaluation being done."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-evaluation-status|4.0.0"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.status"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.status"/> </mapping> </element> <element id="ImmunizationEvaluation.patient"> <path value="ImmunizationEvaluation.patient"/> <short value="Who this evaluation is for"/> <definition value="The individual for whom the evaluation is being done."/> <min value="1"/> <max value="1"/> <base> <path value="ImmunizationEvaluation.patient"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.subject"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.subject[x]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.subject"/> </mapping> </element> <element id="ImmunizationEvaluation.date"> <path value="ImmunizationEvaluation.date"/> <short value="Date evaluation was performed"/> <definition value="The date the evaluation of the vaccine administration event was performed."/> <min value="1"/> <max value="1"/> <base> <path value="ImmunizationEvaluation.date"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.occurrenceDateTime"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.init"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-3"/> </mapping> </element> <element id="ImmunizationEvaluation.authority"> <path value="ImmunizationEvaluation.authority"/> <short value="Who is responsible for publishing the recommendations"/> <definition value="Indicates the authority who published the protocol (e.g. ACIP)."/> <min value="0"/> <max value="1"/> <base> <path value="ImmunizationEvaluation.authority"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = ( 59779-9 )"/> </mapping> </element> <element id="ImmunizationEvaluation.targetDisease"> <path value="ImmunizationEvaluation.targetDisease"/> <short value="Evaluation target disease"/> <definition value="The vaccine preventable disease the dose is being evaluated against."/> <min value="1"/> <max value="1"/> <base> <path value="ImmunizationEvaluation.targetDisease"/> <min value="1"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="true"/> <binding> <strength value="extensible"/> <description value="The US Core CVX (vaccine administered) code system."/> <valueSet value="http://hl7.org/fhir/us/core/ValueSet/us-core-vaccines-cvx"/> </binding> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )"/> </mapping> </element> <element id="ImmunizationEvaluation.immunizationEvent"> <path value="ImmunizationEvaluation.immunizationEvent"/> <short value="Immunization being evaluated"/> <definition value="The vaccine administration event being evaluated."/> <min value="1"/> <max value="1"/> <base> <path value="ImmunizationEvaluation.immunizationEvent"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Immunization"/> </type> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="ImmunizationEvaluation.doseStatus"> <path value="ImmunizationEvaluation.doseStatus"/> <short value="Status of the dose relative to published recommendations"/> <definition value="Indicates if the dose is valid or not valid with respect to the published recommendations."/> <min value="1"/> <max value="1"/> <base> <path value="ImmunizationEvaluation.doseStatus"/> <min value="1"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="true"/> <binding> <strength value="extensible"/> <description value="The status of the administered dose relative to the published recommendations for the target disease."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status"/> </binding> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = ( 59781-5 )"/> </mapping> </element> <element id="ImmunizationEvaluation.doseStatusReason"> <path value="ImmunizationEvaluation.doseStatusReason"/> <short value="Reason for the dose status"/> <definition value="While an extensible value set is provided for this element, there is not a broadly agreed upon value set to use. Implementations will likely make extensive use of the text element within the CodeableConcept data type to convey information."/> <min value="0"/> <max value="*"/> <base> <path value="ImmunizationEvaluation.doseStatusReason"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <strength value="extensible"/> <description value="The reason the dose status was assigned."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status-reason"/> </binding> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = ( 30982-3 )"/> </mapping> </element> <element id="ImmunizationEvaluation.description"> <path value="ImmunizationEvaluation.description"/> <short value="Evaluation notes"/> <definition value="Additional information about the evaluation."/> <min value="0"/> <max value="1"/> <base> <path value="ImmunizationEvaluation.description"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.note"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = ( 48767-8 )"/> </mapping> </element> <element id="ImmunizationEvaluation.series"> <path value="ImmunizationEvaluation.series"/> <short value="Name of vaccine 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="ImmunizationEvaluation.series"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="ImmunizationEvaluation.doseNumber[x]"> <path value="ImmunizationEvaluation.doseNumber[x]"/> <short value="Dose number within series"/> <definition value="Nominal position in a series."/> <comment value="The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose)."/> <min value="0"/> <max value="1"/> <base> <path value="ImmunizationEvaluation.doseNumber[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="positiveInt"/> </type> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = ( 30973-2 )"/> </mapping> </element> <element id="ImmunizationEvaluation.seriesDoses[x]"> <path value="ImmunizationEvaluation.seriesDoses[x]"/> <short value="Recommended number of doses for immunity"/> <definition value="The recommended number of doses to achieve immunity."/> <comment value="The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose)."/> <min value="0"/> <max value="1"/> <base> <path value="ImmunizationEvaluation.seriesDoses[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="positiveInt"/> </type> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = ( 59782-3 )"/> </mapping> </element> </snapshot> <differential> <element id="ImmunizationEvaluation"> <path value="ImmunizationEvaluation"/> <short value="ImmDS Immunization evaluation information"/> <definition value="Defines constraints and extensions on the immunizationevaluation resource for the minimal set of data to perform the Immunization Decision Support Forecast operation."/> <min value="0"/> <max value="*"/> <mapping> <identity value="workflow"/> <map value="Event"/> </mapping> <mapping> <identity value="v2"/> <map value="RSP_K11"/> </mapping> </element> <element id="ImmunizationEvaluation.date"> <path value="ImmunizationEvaluation.date"/> <short value="Date evaluation was performed"/> <definition value="The date the evaluation of the vaccine administration event was performed."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> </element> <element id="ImmunizationEvaluation.targetDisease"> <path value="ImmunizationEvaluation.targetDisease"/> <short value="Evaluation target disease"/> <definition value="The vaccine preventable disease the dose is being evaluated against."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <strength value="extensible"/> <description value="The US Core CVX (vaccine administered) code system."/> <valueSet value="http://hl7.org/fhir/us/core/ValueSet/us-core-vaccines-cvx"/> </binding> </element> <element id="ImmunizationEvaluation.doseStatus"> <path value="ImmunizationEvaluation.doseStatus"/> <short value="Status of the dose relative to published recommendations"/> <definition value="Indicates if the dose is valid or not valid with respect to the published recommendations."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <strength value="extensible"/> <description value="The status of the administered dose relative to the published recommendations for the target disease."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status"/> </binding> </element> <element id="ImmunizationEvaluation.doseStatusReason"> <path value="ImmunizationEvaluation.doseStatusReason"/> <short value="Reason for the dose status"/> <definition value="While an extensible value set is provided for this element, there is not a broadly agreed upon value set to use. Implementations will likely make extensive use of the text element within the CodeableConcept data type to convey information."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <binding> <strength value="extensible"/> <description value="The reason the dose status was assigned."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status-reason"/> </binding> </element> </differential> </StructureDefinition>
