This page is part of the International Patient Summary Implementation Guide (v0.3.0: STU 1 (FHIR R4) Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
XML Format: StructureDefinition-Immunization-uv-ips
Download Raw xml
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Immunization-uv-ips"/> <meta> <lastUpdated value="2018-03-07T12:47:01.502-05:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">This profile represents the constraints applied to the Immunization resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an immunization is represented in the patient summary as an instance of an Immunization resource constrained by this profile. It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party.</div> </text> <url value="http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips"/> <version value="0.3.0"/> <name value="ImmunizationUvIps"/> <title value="Immunization (IPS)"/> <status value="draft"/> <date value="2018-03-06T00:00:00-05:00"/> <description value="This profile represents the constraints applied to the Immunization resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an immunization is represented in the patient summary as an instance of an Immunization resource constrained by this profile. It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <purpose value="This profile constrains the representation of a record of a vaccination of the patient, in the context of the international patient summary as specified by the IPS project of HL7 International."/> <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="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/fivews"/> <name value="FiveWs Pattern Mapping"/> </mapping> <mapping> <identity value="cda"/> <uri value="http://hl7.org/v3/cda"/> <name value="CDA (R2)"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="Immunization"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Immunization"/> <derivation value="constraint"/> <snapshot> <element id="Immunization"> <path value="Immunization"/> <short value="Immunization event information"/> <definition value="Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed"/> <min value="0"/> <max value="*"/> <base> <path value="Immunization"/> <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> <mustSupport value="true"/> <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="VXU_V04"/> </mapping> <mapping> <identity value="rim"/> <map value="SubstanceAdministration"/> </mapping> </element> <element id="Immunization.id"> <path value="Immunization.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> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Immunization.meta"> <path value="Immunization.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> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Immunization.meta.id"> <path value="Immunization.meta.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.meta.extension"> <path value="Immunization.meta.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <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. 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="Element.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="Immunization.meta.versionId"> <path value="Immunization.meta.versionId"/> <short value="Version specific identifier"/> <definition value="The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted."/> <comment value="The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes."/> <min value="0"/> <max value="1"/> <base> <path value="Meta.versionId"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Immunization.meta.lastUpdated"> <path value="Immunization.meta.lastUpdated"/> <short value="When the resource version last changed"/> <definition value="When the resource last changed - e.g. when the version changed."/> <comment value="This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction."/> <min value="0"/> <max value="1"/> <base> <path value="Meta.lastUpdated"/> <min value="0"/> <max value="1"/> </base> <type> <code value="instant"/> </type> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Immunization.meta.source"> <path value="Immunization.meta.source"/> <short value="Identifies where the resource comes from"/> <definition value="A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc."/> <comment value="In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL."/> <min value="0"/> <max value="1"/> <base> <path value="Meta.source"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Immunization.meta.profile"> <path value="Immunization.meta.profile"/> <short value="Profiles this resource claims to conform to"/> <definition value="A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url)."/> <comment value="It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set."/> <min value="0"/> <max value="*"/> <base> <path value="Meta.profile"/> <min value="0"/> <max value="*"/> </base> <type> <code value="canonical"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/StructureDefinition"/> </type> <fixedCanonical value="http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Immunization.meta.security"> <path value="Immunization.meta.security"/> <short value="Security Labels applied to this resource"/> <definition value="Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure."/> <comment value="The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored."/> <min value="0"/> <max value="*"/> <base> <path value="Meta.security"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Coding"/> </type> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SecurityLabels"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="Security Labels from the Healthcare Privacy and Security Classification System."/> <valueSet value="http://hl7.org/fhir/ValueSet/security-labels"/> </binding> </element> <element id="Immunization.meta.tag"> <path value="Immunization.meta.tag"/> <short value="Tags applied to this resource"/> <definition value="Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource."/> <comment value="The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored."/> <min value="0"/> <max value="*"/> <base> <path value="Meta.tag"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Coding"/> </type> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Tags"/> </extension> <strength value="example"/> <description value="Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"."/> <valueSet value="http://hl7.org/fhir/ValueSet/common-tags"/> </binding> </element> <element id="Immunization.implicitRules"> <path value="Immunization.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="Immunization.language"> <path value="Immunization.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="Immunization.text"> <path value="Immunization.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="Immunization.contained"> <path value="Immunization.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="Immunization.extension"> <path value="Immunization.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="Immunization.modifierExtension"> <path value="Immunization.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="Immunization.identifier"> <path value="Immunization.identifier"/> <short value="Business identifier"/> <definition value="A unique identifier assigned to this immunization record."/> <min value="0"/> <max value="*"/> <base> <path value="Immunization.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> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"/> </mapping> </element> <element id="Immunization.status"> <path value="Immunization.status"/> <short value="completed | entered-in-error | not-done"/> <definition value="Indicates the current status of the immunization event."/> <comment value="Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid."/> <min value="1"/> <max value="1"/> <base> <path value="Immunization.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mustSupport value="true"/> <isModifier value="true"/> <isModifierReason value="This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done 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="ImmunizationStatus"/> </extension> <strength value="required"/> <description value="A set of codes indicating the current status of an Immunization."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-status|4.0.0"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.status"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.status"/> </mapping> <mapping> <identity value="rim"/> <map value="statusCode"/> </mapping> </element> <element id="Immunization.statusReason"> <path value="Immunization.statusReason"/> <short value="Reason not done"/> <definition value="Indicates the reason the immunization event was not performed."/> <comment value="This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.statusReason"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationStatusReason"/> </extension> <strength value="example"/> <description value="The reason why a vaccine was not administered."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-status-reason"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.statusReason"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"/> </mapping> </element> <element id="Immunization.vaccineCode"> <path value="Immunization.vaccineCode"/> <slicing> <discriminator> <type value="value"/> <path value="coding.system"/> </discriminator> <description value="Discriminated by code system"/> <rules value="open"/> </slicing> <short value="Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO AC codes; or any other kind of code that that identifies, classifies or cluster the administered product."/> <definition value="Vaccine that was administered or was to be administered. Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunized is provided; or the known absent / unknown. Other coded information can be provided as well as: 1. The IDMP Pharmaceutical Product Identifier (PhPID), Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium; or any other equivalent coded concept; 2. The IDMP Pharmaceutical Product Identifier (PhPID), Level 2 [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg; or any other equivalent coded concept; 3. The IDMP Pharmaceutical Product Identifier (PhPID), Level 3 [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet; or any other equivalent coded concept; 4. The IDMP Pharmaceutical Product Identifier (PhPID), Level 4 [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet; or any other equivalent coded concept 5. The IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier. IDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorization numbers allocated by a regulator. MPID implies one (set of) PhPID. The MPID shall use a common segment pattern related to a Medicinal Product, which, when each segment is valued shall define a specific MPID concept. 6. The IDMP Packaged Medicinal Product Identifier (PCID) or any equivalent Packaged Medicinal Product Identifier. Uniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package. 7. Any other kind of code that that identifies, classifies or cluster the administered product (e.g. the medicinal product or the product class) The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available."/> <comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination."/> <min value="1"/> <max value="1"/> <base> <path value="Immunization.vaccineCode"/> <min value="1"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"/> </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() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <binding> <strength value="preferred"/> <description value="The type of vaccine for particular disease or diseases against which the patient has been immunised."/> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips"/> </binding> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> <mapping> <identity value="v2"/> <map value="CE/CNE/CWE"/> </mapping> <mapping> <identity value="rim"/> <map value="CD"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD"/> </mapping> </element> <element id="Immunization.vaccineCode.id"> <path value="Immunization.vaccineCode.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.vaccineCode.extension"> <path value="Immunization.vaccineCode.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <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. 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="Element.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="Immunization.vaccineCode.coding"> <path value="Immunization.vaccineCode.coding"/> <slicing> <discriminator> <type value="value"/> <path value="system"/> </discriminator> <description value="Discriminated by code system"/> <rules value="open"/> </slicing> <short value="A reference to a code defined by a terminology system"/> <definition value="A representation of the vaccine in a code system. The representation can be granular or may also be a class or category."/> <comment value="Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information."/> <requirements value="Allows for alternative encodings within a code system, and translations to other code systems."/> <min value="1"/> <max value="*"/> <base> <path value="CodeableConcept.coding"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Coding"/> <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips"/> </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() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> <mapping> <identity value="v2"/> <map value="CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"/> </mapping> <mapping> <identity value="rim"/> <map value="CV"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding rdfs:subClassOf dt:CDCoding"/> </mapping> </element> <element id="Immunization.vaccineCode.coding:atcClass"> <path value="Immunization.vaccineCode.coding"/> <sliceName value="atcClass"/> <short value="WHO ATC classification"/> <definition value="WHO ATC classification"/> <comment value="Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information."/> <requirements value="Allows for alternative encodings within a code system, and translations to other code systems."/> <min value="0"/> <max value="1"/> <base> <path value="CodeableConcept.coding"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Coding"/> <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips"/> </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() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="WHO ATC"/> </extension> <strength value="required"/> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips"/> </binding> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> <mapping> <identity value="v2"/> <map value="CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"/> </mapping> <mapping> <identity value="rim"/> <map value="CV"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding rdfs:subClassOf dt:CDCoding"/> </mapping> </element> <element id="Immunization.vaccineCode.coding:atcClass.id"> <path value="Immunization.vaccineCode.coding.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.vaccineCode.coding:atcClass.extension"> <path value="Immunization.vaccineCode.coding.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <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. 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="Element.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="Immunization.vaccineCode.coding:atcClass.system"> <path value="Immunization.vaccineCode.coding.system"/> <short value="Identity of the terminology system"/> <definition value="The identification of the code system that defines the meaning of the symbol in the code."/> <comment value="The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously."/> <requirements value="Need to be unambiguous about the source of the definition of the symbol."/> <min value="1"/> <max value="1"/> <base> <path value="Coding.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="http://www.whocc.no/atc"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.3"/> </mapping> <mapping> <identity value="rim"/> <map value="./codeSystem"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"/> </mapping> </element> <element id="Immunization.vaccineCode.coding:atcClass.version"> <path value="Immunization.vaccineCode.coding.version"/> <short value="Version of the system - if relevant"/> <definition value="The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged."/> <comment value="Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.version"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.7"/> </mapping> <mapping> <identity value="rim"/> <map value="./codeSystemVersion"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"/> </mapping> </element> <element id="Immunization.vaccineCode.coding:atcClass.code"> <path value="Immunization.vaccineCode.coding.code"/> <short value="Symbol in syntax defined by the system"/> <definition value="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)."/> <requirements value="Need to refer to a particular code in the system."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.code"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.1"/> </mapping> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"/> </mapping> </element> <element id="Immunization.vaccineCode.coding:atcClass.display"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true"/> </extension> <path value="Immunization.vaccineCode.coding.display"/> <short value="Representation defined by the system"/> <definition value="A representation of the meaning of the code in the system, following the rules of the system."/> <requirements value="Need to be able to carry a human-readable meaning of the code for readers that do not know the system."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.display"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.2 - but note this is not well followed"/> </mapping> <mapping> <identity value="rim"/> <map value="CV.displayName"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"/> </mapping> </element> <element id="Immunization.vaccineCode.coding:atcClass.display.id"> <path value="Immunization.vaccineCode.coding.display.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)"/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Immunization.vaccineCode.coding:atcClass.display.extension"> <path value="Immunization.vaccineCode.coding.display.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <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> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Immunization.vaccineCode.coding:atcClass.display.extension:translation"> <path value="Immunization.vaccineCode.coding.display.extension"/> <sliceName value="translation"/> <short value="Language Translation (Localization)"/> <definition value="Language translation from base language of resource to another language."/> <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/StructureDefinition/translation"/> </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() or (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="true"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="ST.translation"/> </mapping> </element> <element id="Immunization.vaccineCode.coding:atcClass.display.value"> <path value="Immunization.vaccineCode.coding.display.value"/> <representation value="xmlAttr"/> <short value="Primitive value for string"/> <definition value="The actual value"/> <min value="0"/> <max value="1"/> <base> <path value="string.value"/> <min value="0"/> <max value="1"/> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/regex"> <valueString value="[ \r\n\t\S]+"/> </extension> <code> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type"> <valueString value="string"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type"> <valueString value="xsd:string"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type"> <valueString value="xsd:string"/> </extension> </code> </type> <maxLength value="1048576"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Immunization.vaccineCode.coding:atcClass.userSelected"> <path value="Immunization.vaccineCode.coding.userSelected"/> <short value="If this coding was chosen directly by the user"/> <definition value="Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays)."/> <comment value="Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely."/> <requirements value="This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.userSelected"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Sometimes implied by being first"/> </mapping> <mapping> <identity value="rim"/> <map value="CD.codingRationale"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]"/> </mapping> </element> <element id="Immunization.vaccineCode.text"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true"/> </extension> <path value="Immunization.vaccineCode.text"/> <short value="Plain text representation of the concept"/> <definition value="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user."/> <comment value="Very often the text is the same as a displayName of one of the codings."/> <requirements value="The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source."/> <min value="0"/> <max value="1"/> <base> <path value="CodeableConcept.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.9. But note many systems use C*E.2 for this"/> </mapping> <mapping> <identity value="rim"/> <map value="./originalText[mediaType/code="text/plain"]/data"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"/> </mapping> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization"> <path value="Immunization.vaccineCode"/> <sliceName value="absentOrUnknownImmunization"/> <short value="Absent Unknown Immunization"/> <definition value="A reference to a code indicating that there there are no known immunizations or that this information is unknown."/> <comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.vaccineCode"/> <min value="1"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"/> </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() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Absent Unknown Immunization"/> </extension> <strength value="required"/> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips"/> </binding> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> <mapping> <identity value="v2"/> <map value="CE/CNE/CWE"/> </mapping> <mapping> <identity value="rim"/> <map value="CD"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD"/> </mapping> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.id"> <path value="Immunization.vaccineCode.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.extension"> <path value="Immunization.vaccineCode.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <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. 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="Element.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="Immunization.vaccineCode:absentOrUnknownImmunization.coding"> <path value="Immunization.vaccineCode.coding"/> <short value="A reference to a code defined by a terminology system"/> <definition value="A reference to a code defined by a terminology system."/> <comment value="Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information."/> <requirements value="Allows for alternative encodings within a code system, and translations to other code systems."/> <min value="1"/> <max value="1"/> <base> <path value="CodeableConcept.coding"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Coding"/> <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips"/> </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() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> <mapping> <identity value="v2"/> <map value="CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"/> </mapping> <mapping> <identity value="rim"/> <map value="CV"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding rdfs:subClassOf dt:CDCoding"/> </mapping> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.coding.id"> <path value="Immunization.vaccineCode.coding.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.coding.extension"> <path value="Immunization.vaccineCode.coding.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <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. 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="Element.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="Immunization.vaccineCode:absentOrUnknownImmunization.coding.system"> <path value="Immunization.vaccineCode.coding.system"/> <short value="Identity of the terminology system"/> <definition value="The identification of the code system that defines the meaning of the symbol in the code."/> <comment value="The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously."/> <requirements value="Need to be unambiguous about the source of the definition of the symbol."/> <min value="1"/> <max value="1"/> <base> <path value="Coding.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="http://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown-uv-ips"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.3"/> </mapping> <mapping> <identity value="rim"/> <map value="./codeSystem"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"/> </mapping> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.coding.version"> <path value="Immunization.vaccineCode.coding.version"/> <short value="Version of the system - if relevant"/> <definition value="The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged."/> <comment value="Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.version"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.7"/> </mapping> <mapping> <identity value="rim"/> <map value="./codeSystemVersion"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"/> </mapping> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.coding.code"> <path value="Immunization.vaccineCode.coding.code"/> <short value="Symbol in syntax defined by the system"/> <definition value="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)."/> <requirements value="Need to refer to a particular code in the system."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.code"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.1"/> </mapping> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"/> </mapping> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.coding.display"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true"/> </extension> <path value="Immunization.vaccineCode.coding.display"/> <short value="Representation defined by the system"/> <definition value="A representation of the meaning of the code in the system, following the rules of the system."/> <requirements value="Need to be able to carry a human-readable meaning of the code for readers that do not know the system."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.display"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.2 - but note this is not well followed"/> </mapping> <mapping> <identity value="rim"/> <map value="CV.displayName"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"/> </mapping> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.coding.display.id"> <path value="Immunization.vaccineCode.coding.display.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)"/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.coding.display.extension"> <path value="Immunization.vaccineCode.coding.display.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <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> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.coding.display.extension:translation"> <path value="Immunization.vaccineCode.coding.display.extension"/> <sliceName value="translation"/> <short value="Language Translation (Localization)"/> <definition value="Language translation from base language of resource to another language."/> <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/StructureDefinition/translation"/> </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() or (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="true"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="ST.translation"/> </mapping> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.coding.display.value"> <path value="Immunization.vaccineCode.coding.display.value"/> <representation value="xmlAttr"/> <short value="Primitive value for string"/> <definition value="The actual value"/> <min value="0"/> <max value="1"/> <base> <path value="string.value"/> <min value="0"/> <max value="1"/> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/regex"> <valueString value="[ \r\n\t\S]+"/> </extension> <code> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type"> <valueString value="string"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type"> <valueString value="xsd:string"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type"> <valueString value="xsd:string"/> </extension> </code> </type> <maxLength value="1048576"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.coding.userSelected"> <path value="Immunization.vaccineCode.coding.userSelected"/> <short value="If this coding was chosen directly by the user"/> <definition value="Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays)."/> <comment value="Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely."/> <requirements value="This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.userSelected"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Sometimes implied by being first"/> </mapping> <mapping> <identity value="rim"/> <map value="CD.codingRationale"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]"/> </mapping> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.text"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true"/> </extension> <path value="Immunization.vaccineCode.text"/> <short value="Plain text representation of the concept"/> <definition value="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user."/> <comment value="The text should be at the displayName level and not on this level."/> <requirements value="The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source."/> <min value="0"/> <max value="1"/> <base> <path value="CodeableConcept.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.9. But note many systems use C*E.2 for this"/> </mapping> <mapping> <identity value="rim"/> <map value="./originalText[mediaType/code="text/plain"]/data"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"/> </mapping> </element> <element id="Immunization.patient"> <path value="Immunization.patient"/> <short value="Who was immunized"/> <definition value="The patient who either received or did not receive the immunization."/> <min value="1"/> <max value="1"/> <base> <path value="Immunization.patient"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips"/> </type> <mustSupport value="true"/> <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="rim"/> <map value=".partipication[ttypeCode=].role"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.subject"/> </mapping> </element> <element id="Immunization.patient.id"> <path value="Immunization.patient.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.patient.extension"> <path value="Immunization.patient.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <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. 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="Element.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="Immunization.patient.reference"> <path value="Immunization.patient.reference"/> <short value="Literal reference, Relative, internal or absolute URL"/> <definition value="A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources."/> <comment value="Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server."/> <min value="1"/> <max value="1"/> <base> <path value="Reference.reference"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <condition value="ref-1"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.patient.type"> <path value="Immunization.patient.type"/> <short value="Type the reference refers to (e.g. "Patient")"/> <definition value="The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources)."/> <comment value="This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified."/> <min value="0"/> <max value="1"/> <base> <path value="Reference.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="FHIRResourceTypeExt"/> </extension> <strength value="extensible"/> <description value="Aa resource (or, for logical models, the URI of the logical model)."/> <valueSet value="http://hl7.org/fhir/ValueSet/resource-types"/> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.patient.identifier"> <path value="Immunization.patient.identifier"/> <short value="Logical reference, when literal reference is not known"/> <definition value="An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference."/> <comment value="When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any)."/> <min value="0"/> <max value="1"/> <base> <path value="Reference.identifier"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".identifier"/> </mapping> </element> <element id="Immunization.patient.display"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true"/> </extension> <path value="Immunization.patient.display"/> <short value="Text alternative for the resource"/> <definition value="Plain text narrative that identifies the resource in addition to the resource reference."/> <comment value="This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it."/> <min value="0"/> <max value="1"/> <base> <path value="Reference.display"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.encounter"> <path value="Immunization.encounter"/> <short value="Encounter immunization was part of"/> <definition value="The visit or admission or other contact between patient and health care provider the immunization was performed as part of."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.encounter"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.context"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-19"/> </mapping> <mapping> <identity value="rim"/> <map value="component->EncounterEvent"/> </mapping> </element> <element id="Immunization.occurrence[x]"> <path value="Immunization.occurrence[x]"/> <short value="Vaccine administration date"/> <definition value="Date vaccine administered or was to be administered."/> <comment value="When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose."/> <min value="1"/> <max value="1"/> <base> <path value="Immunization.occurrence[x]"/> <min value="1"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <type> <code value="string"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.occurrence[x]"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.done[x]"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-3"/> </mapping> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"/> </mapping> </element> <element id="Immunization.occurrence[x].id"> <path value="Immunization.occurrence[x].id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type"> <valueString value="string"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type"> <valueString value="xsd:string"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type"> <valueString value="xsd:string"/> </extension> </code> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.occurrence[x].extension"> <path value="Immunization.occurrence[x].extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <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. 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="Element.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="Immunization.occurrence[x].extension:data-absent-reason"> <path value="Immunization.occurrence[x].extension"/> <sliceName value="data-absent-reason"/> <short value="occurrence[x] absence reason"/> <definition value="Provides a reason why the occurrence is missing."/> <min value="0"/> <max value="1"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="ANY.nullFlavor"/> </mapping> </element> <element id="Immunization.occurrence[x].extension:data-absent-reason.id"> <path value="Immunization.occurrence[x].extension.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.occurrence[x].extension:data-absent-reason.extension"> <path value="Immunization.occurrence[x].extension.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="0"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Immunization.occurrence[x].extension:data-absent-reason.url"> <path value="Immunization.occurrence[x].extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="http://hl7.org/fhir/StructureDefinition/data-absent-reason"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.occurrence[x].extension:data-absent-reason.valueCode"> <path value="Immunization.occurrence[x].extension.valueCode"/> <short value="Value of extension"/> <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list)."/> <min value="0"/> <max value="1"/> <base> <path value="Extension.value[x]"/> <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-bindingName"> <valueString value="DataAbsentReason"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="required"/> <description value="Used to specify why the normally expected content of the data element is missing."/> <valueSet value="http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.0"/> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.recorded"> <path value="Immunization.recorded"/> <short value="When the immunization was first captured in the subject's record"/> <definition value="The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.recorded"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.recorded"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].time"/> </mapping> </element> <element id="Immunization.primarySource"> <path value="Immunization.primarySource"/> <short value="Indicates context the data was recorded in"/> <definition value="An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded."/> <comment value="Reflects the “reliability” of the content."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.primarySource"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.source"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-9"/> </mapping> <mapping> <identity value="rim"/> <map value="immunization.uncertaintycode (if primary source=false, uncertainty=U)"/> </mapping> </element> <element id="Immunization.reportOrigin"> <path value="Immunization.reportOrigin"/> <short value="Indicates the source of a secondarily reported record"/> <definition value="The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine."/> <comment value="Should not be populated if primarySource = True, not required even if primarySource = False."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.reportOrigin"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationReportOrigin"/> </extension> <strength value="example"/> <description value="The source of the data for a record which is not from a primary source."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-origin"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.source"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-9"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)"/> </mapping> </element> <element id="Immunization.location"> <path value="Immunization.location"/> <short value="Where immunization occurred"/> <definition value="The service delivery location where the vaccine administration occurred."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.location"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Location"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.location"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.where[x]"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-27 (or RXA-11, deprecated as of v2.7)"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=LOC].COCT_MT240000UV"/> </mapping> </element> <element id="Immunization.manufacturer"> <path value="Immunization.manufacturer"/> <short value="Vaccine manufacturer"/> <definition value="Name of vaccine manufacturer."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.manufacturer"/> <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="RXA-17"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name"/> </mapping> </element> <element id="Immunization.lotNumber"> <path value="Immunization.lotNumber"/> <short value="Vaccine lot number"/> <definition value="Lot number of the vaccine product."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.lotNumber"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="RXA-15"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText"/> </mapping> </element> <element id="Immunization.expirationDate"> <path value="Immunization.expirationDate"/> <short value="Vaccine expiration date"/> <definition value="Date vaccine batch expires."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.expirationDate"/> <min value="0"/> <max value="1"/> </base> <type> <code value="date"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="RXA-16"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"/> </mapping> </element> <element id="Immunization.site"> <path value="Immunization.site"/> <short value="Concept - reference to a terminology or just text"/> <definition value="A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text."/> <comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.site"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"/> </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() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <binding> <strength value="preferred"/> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips"/> </binding> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> <mapping> <identity value="v2"/> <map value="CE/CNE/CWE"/> </mapping> <mapping> <identity value="rim"/> <map value="CD"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD"/> </mapping> </element> <element id="Immunization.route"> <path value="Immunization.route"/> <short value="Concept - reference to a terminology or just text"/> <definition value="A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text."/> <comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.route"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"/> </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() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationRoute"/> </extension> <strength value="required"/> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration"/> </binding> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> <mapping> <identity value="v2"/> <map value="CE/CNE/CWE"/> </mapping> <mapping> <identity value="rim"/> <map value="CD"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD"/> </mapping> </element> <element id="Immunization.doseQuantity"> <path value="Immunization.doseQuantity"/> <short value="Amount of vaccine administered"/> <definition value="The quantity of vaccine product that was administered."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.doseQuantity"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Quantity"/> <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="RXA-6 / RXA-7"/> </mapping> <mapping> <identity value="rim"/> <map value=".doseQuantity"/> </mapping> </element> <element id="Immunization.performer"> <path value="Immunization.performer"/> <short value="Who performed event"/> <definition value="Indicates who performed the immunization event."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.performer"/> <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() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.performer"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-12 / RXA-10"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"/> </mapping> </element> <element id="Immunization.performer.id"> <path value="Immunization.performer.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.performer.extension"> <path value="Immunization.performer.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. 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="Element.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="Immunization.performer.modifierExtension"> <path value="Immunization.performer.modifierExtension"/> <short value="Extensions that cannot be ignored even if unrecognized"/> <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 in which it is contained 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 can 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"/> <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"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.performer.function"> <path value="Immunization.performer.function"/> <short value="What type of performance was done"/> <definition value="Describes the type of performance (e.g. ordering provider, administering provider, etc.)."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.performer.function"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationFunction"/> </extension> <strength value="extensible"/> <description value="The role a practitioner or organization plays in the immunization event."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-function"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.performer.function"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation.functionCode"/> </mapping> </element> <element id="Immunization.performer.actor"> <path value="Immunization.performer.actor"/> <short value="Individual or organization who was performing"/> <definition value="The practitioner or organization who performed the action."/> <comment value="When the individual practitioner who performed the action is known, it is best to send."/> <min value="1"/> <max value="1"/> <base> <path value="Immunization.performer.actor"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.performer.actor"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.actor"/> </mapping> <mapping> <identity value="rim"/> <map value=".player"/> </mapping> </element> <element id="Immunization.performer.actor.id"> <path value="Immunization.performer.actor.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.performer.actor.extension"> <path value="Immunization.performer.actor.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <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. 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="Element.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="Immunization.performer.actor.reference"> <path value="Immunization.performer.actor.reference"/> <short value="Literal reference, Relative, internal or absolute URL"/> <definition value="A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources."/> <comment value="Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server."/> <min value="0"/> <max value="1"/> <base> <path value="Reference.reference"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <condition value="ref-1"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.performer.actor.type"> <path value="Immunization.performer.actor.type"/> <short value="Type the reference refers to (e.g. "Patient")"/> <definition value="The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources)."/> <comment value="This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified."/> <min value="0"/> <max value="1"/> <base> <path value="Reference.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="FHIRResourceTypeExt"/> </extension> <strength value="extensible"/> <description value="Aa resource (or, for logical models, the URI of the logical model)."/> <valueSet value="http://hl7.org/fhir/ValueSet/resource-types"/> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.performer.actor.identifier"> <path value="Immunization.performer.actor.identifier"/> <short value="Logical reference, when literal reference is not known"/> <definition value="An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference."/> <comment value="When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any)."/> <min value="0"/> <max value="1"/> <base> <path value="Reference.identifier"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".identifier"/> </mapping> </element> <element id="Immunization.performer.actor.display"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true"/> </extension> <path value="Immunization.performer.actor.display"/> <short value="Text alternative for the resource"/> <definition value="Plain text narrative that identifies the resource in addition to the resource reference."/> <comment value="This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it."/> <min value="0"/> <max value="1"/> <base> <path value="Reference.display"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.note"> <path value="Immunization.note"/> <short value="Additional immunization notes"/> <definition value="Extra information about the immunization that is not conveyed by the other attributes."/> <min value="0"/> <max value="*"/> <base> <path value="Immunization.note"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Annotation"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.note"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = 48767-8"/> </mapping> <mapping> <identity value="rim"/> <map value="note"/> </mapping> </element> <element id="Immunization.reasonCode"> <path value="Immunization.reasonCode"/> <short value="Why immunization occurred"/> <definition value="Reasons why the vaccine was administered."/> <min value="0"/> <max value="*"/> <base> <path value="Immunization.reasonCode"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationReason"/> </extension> <strength value="example"/> <description value="The reason why a vaccine was administered."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-reason"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.reasonCode"/> </mapping> <mapping> <identity value="rim"/> <map value="[actionNegationInd=false].reasonCode"/> </mapping> </element> <element id="Immunization.reasonReference"> <path value="Immunization.reasonReference"/> <short value="Why immunization occurred"/> <definition value="Condition, Observation or DiagnosticReport that supports why the immunization was administered."/> <min value="0"/> <max value="*"/> <base> <path value="Immunization.reasonReference"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Condition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DiagnosticReport"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.reasonReference"/> </mapping> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.isSubpotent"> <path value="Immunization.isSubpotent"/> <short value="Dose potency"/> <definition value="Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent."/> <comment value="Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.isSubpotent"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <meaningWhenMissing value="By default, a dose should be considered to be potent."/> <isModifier value="true"/> <isModifierReason value="This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose."/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="RXA-20 = PA (partial administration)"/> </mapping> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.subpotentReason"> <path value="Immunization.subpotentReason"/> <short value="Reason for being subpotent"/> <definition value="Reason why a dose is considered to be subpotent."/> <min value="0"/> <max value="*"/> <base> <path value="Immunization.subpotentReason"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubpotentReason"/> </extension> <strength value="example"/> <description value="The reason why a dose is considered to be subpotent."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-subpotent-reason"/> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.education"> <path value="Immunization.education"/> <short value="Educational material presented to patient"/> <definition value="Educational material presented to the patient (or guardian) at the time of vaccine administration."/> <min value="0"/> <max value="*"/> <base> <path value="Immunization.education"/> <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() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="imm-1"/> <severity value="error"/> <human value="One of documentType or reference SHALL be present"/> <expression value="documentType.exists() or reference.exists()"/> <xpath value="exists(f:documentType) or exists(f:reference)"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.education.id"> <path value="Immunization.education.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.education.extension"> <path value="Immunization.education.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. 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="Element.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="Immunization.education.modifierExtension"> <path value="Immunization.education.modifierExtension"/> <short value="Extensions that cannot be ignored even if unrecognized"/> <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 in which it is contained 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 can 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"/> <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"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.education.documentType"> <path value="Immunization.education.documentType"/> <short value="Educational material document identifier"/> <definition value="Identifier of the material presented to the patient."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.education.documentType"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = 69764-9"/> </mapping> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.education.reference"> <path value="Immunization.education.reference"/> <short value="Educational material reference pointer"/> <definition value="Reference pointer to the educational material given to the patient if the information was on line."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.education.reference"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.education.publicationDate"> <path value="Immunization.education.publicationDate"/> <short value="Educational material publication date"/> <definition value="Date the educational material was published."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.education.publicationDate"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = 29768-9"/> </mapping> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.education.presentationDate"> <path value="Immunization.education.presentationDate"/> <short value="Educational material presentation date"/> <definition value="Date the educational material was given to the patient."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.education.presentationDate"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = 29769-7"/> </mapping> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.programEligibility"> <path value="Immunization.programEligibility"/> <short value="Patient eligibility for a vaccination program"/> <definition value="Indicates a patient's eligibility for a funding program."/> <min value="0"/> <max value="*"/> <base> <path value="Immunization.programEligibility"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProgramEligibility"/> </extension> <strength value="example"/> <description value="The patient's eligibility for a vaccation program."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-program-eligibility"/> </binding> <mapping> <identity value="v2"/> <map value="OBX-5 : OBX-3 = 64994-7"/> </mapping> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.fundingSource"> <path value="Immunization.fundingSource"/> <short value="Funding source for the vaccine"/> <definition value="Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered)."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.fundingSource"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="FundingSource"/> </extension> <strength value="example"/> <description value="The source of funding used to purchase the vaccine administered."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-funding-source"/> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.reaction"> <path value="Immunization.reaction"/> <short value="Details of a reaction that follows immunization"/> <definition value="Categorical data indicating that an adverse event is associated in time to an immunization."/> <comment value="A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements."/> <min value="0"/> <max value="*"/> <base> <path value="Immunization.reaction"/> <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() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="OBX-3"/> </mapping> <mapping> <identity value="rim"/> <map value="Observation[classCode=obs].code"/> </mapping> </element> <element id="Immunization.reaction.id"> <path value="Immunization.reaction.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.reaction.extension"> <path value="Immunization.reaction.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. 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="Element.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="Immunization.reaction.modifierExtension"> <path value="Immunization.reaction.modifierExtension"/> <short value="Extensions that cannot be ignored even if unrecognized"/> <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 in which it is contained 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 can 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"/> <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"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.reaction.date"> <path value="Immunization.reaction.date"/> <short value="When reaction started"/> <definition value="Date of reaction to the immunization."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.reaction.date"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)"/> </mapping> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> </element> <element id="Immunization.reaction.detail"> <path value="Immunization.reaction.detail"/> <short value="Additional information on reaction"/> <definition value="Details of the reaction."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.reaction.detail"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="OBX-5"/> </mapping> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> </element> <element id="Immunization.reaction.reported"> <path value="Immunization.reaction.reported"/> <short value="Indicates self-reported reaction"/> <definition value="Self-reported indicator."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.reaction.reported"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="(HL7 v2 doesn't seem to provide for this)"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"/> </mapping> </element> <element id="Immunization.protocolApplied"> <path value="Immunization.protocolApplied"/> <short value="Protocol followed by the provider"/> <definition value="The protocol (set of recommendations) being followed by the provider who administered the dose."/> <min value="0"/> <max value="*"/> <base> <path value="Immunization.protocolApplied"/> <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() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.protocolApplied.id"> <path value="Immunization.protocolApplied.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Immunization.protocolApplied.extension"> <path value="Immunization.protocolApplied.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. 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="Element.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="Immunization.protocolApplied.modifierExtension"> <path value="Immunization.protocolApplied.modifierExtension"/> <short value="Extensions that cannot be ignored even if unrecognized"/> <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 in which it is contained 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 can 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"/> <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"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.protocolApplied.series"> <path value="Immunization.protocolApplied.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="Immunization.protocolApplied.series"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.protocolApplied.authority"> <path value="Immunization.protocolApplied.authority"/> <short value="Who is responsible for publishing the recommendations"/> <definition value="Indicates the authority who published the protocol (e.g. ACIP) that is being followed."/> <min value="0"/> <max value="1"/> <base> <path value="Immunization.protocolApplied.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="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.protocolApplied.targetDisease"> <path value="Immunization.protocolApplied.targetDisease"/> <short value="Vaccine preventatable disease being targetted"/> <definition value="The vaccine preventable disease the dose is being administered against."/> <min value="0"/> <max value="*"/> <base> <path value="Immunization.protocolApplied.targetDisease"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="TargetDisease"/> </extension> <strength value="example"/> <description value="The vaccine preventable disease the dose is being administered for."/> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-target-disease"/> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.protocolApplied.doseNumber[x]"> <path value="Immunization.protocolApplied.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="1"/> <max value="1"/> <base> <path value="Immunization.protocolApplied.doseNumber[x]"/> <min value="1"/> <max value="1"/> </base> <type> <code value="positiveInt"/> </type> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Immunization.protocolApplied.seriesDoses[x]"> <path value="Immunization.protocolApplied.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="Immunization.protocolApplied.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="rim"/> <map value="N/A"/> </mapping> </element> </snapshot> <differential> <element id="Immunization"> <path value="Immunization"/> <definition value="Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed"/> <mustSupport value="true"/> </element> <element id="Immunization.id"> <path value="Immunization.id"/> <mustSupport value="true"/> </element> <element id="Immunization.meta"> <path value="Immunization.meta"/> <mustSupport value="true"/> </element> <element id="Immunization.meta.profile"> <path value="Immunization.meta.profile"/> <fixedCanonical value="http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips"/> <mustSupport value="true"/> </element> <element id="Immunization.status"> <path value="Immunization.status"/> <mustSupport value="true"/> </element> <element id="Immunization.vaccineCode"> <path value="Immunization.vaccineCode"/> <slicing> <discriminator> <type value="value"/> <path value="coding.system"/> </discriminator> <description value="Discriminated by code system"/> <rules value="open"/> </slicing> <short value="Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO AC codes; or any other kind of code that that identifies, classifies or cluster the administered product."/> <definition value="Vaccine that was administered or was to be administered. Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunized is provided; or the known absent / unknown. Other coded information can be provided as well as: 1. The IDMP Pharmaceutical Product Identifier (PhPID), Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium; or any other equivalent coded concept; 2. The IDMP Pharmaceutical Product Identifier (PhPID), Level 2 [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg; or any other equivalent coded concept; 3. The IDMP Pharmaceutical Product Identifier (PhPID), Level 3 [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet; or any other equivalent coded concept; 4. The IDMP Pharmaceutical Product Identifier (PhPID), Level 4 [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet; or any other equivalent coded concept 5. The IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier. IDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorization numbers allocated by a regulator. MPID implies one (set of) PhPID. The MPID shall use a common segment pattern related to a Medicinal Product, which, when each segment is valued shall define a specific MPID concept. 6. The IDMP Packaged Medicinal Product Identifier (PCID) or any equivalent Packaged Medicinal Product Identifier. Uniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package. 7. Any other kind of code that that identifies, classifies or cluster the administered product (e.g. the medicinal product or the product class) The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"/> </type> <mustSupport value="true"/> <binding> <strength value="preferred"/> <description value="The type of vaccine for particular disease or diseases against which the patient has been immunised."/> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips"/> </binding> </element> <element id="Immunization.vaccineCode.coding"> <path value="Immunization.vaccineCode.coding"/> <slicing> <discriminator> <type value="value"/> <path value="system"/> </discriminator> <description value="Discriminated by code system"/> <rules value="open"/> </slicing> <definition value="A representation of the vaccine in a code system. The representation can be granular or may also be a class or category."/> <min value="1"/> <mustSupport value="true"/> </element> <element id="Immunization.vaccineCode.coding:atcClass"> <path value="Immunization.vaccineCode.coding"/> <sliceName value="atcClass"/> <short value="WHO ATC classification"/> <definition value="WHO ATC classification"/> <max value="1"/> <mustSupport value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="WHO ATC"/> </extension> <strength value="required"/> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips"/> </binding> </element> <element id="Immunization.vaccineCode.coding:atcClass.system"> <path value="Immunization.vaccineCode.coding.system"/> <min value="1"/> <max value="1"/> <fixedUri value="http://www.whocc.no/atc"/> <mustSupport value="true"/> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization"> <path value="Immunization.vaccineCode"/> <sliceName value="absentOrUnknownImmunization"/> <short value="Absent Unknown Immunization"/> <definition value="A reference to a code indicating that there there are no known immunizations or that this information is unknown."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"/> </type> <mustSupport value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Absent Unknown Immunization"/> </extension> <strength value="required"/> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips"/> </binding> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.coding"> <path value="Immunization.vaccineCode.coding"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.coding.system"> <path value="Immunization.vaccineCode.coding.system"/> <min value="1"/> <max value="1"/> <fixedUri value="http://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown-uv-ips"/> <mustSupport value="true"/> </element> <element id="Immunization.vaccineCode:absentOrUnknownImmunization.text"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true"/> </extension> <path value="Immunization.vaccineCode.text"/> <comment value="The text should be at the displayName level and not on this level."/> <mustSupport value="true"/> </element> <element id="Immunization.patient"> <path value="Immunization.patient"/> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips"/> </type> <mustSupport value="true"/> </element> <element id="Immunization.patient.reference"> <path value="Immunization.patient.reference"/> <min value="1"/> <mustSupport value="true"/> </element> <element id="Immunization.occurrence[x]"> <path value="Immunization.occurrence[x]"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> </element> <element id="Immunization.occurrence[x].extension:data-absent-reason"> <path value="Immunization.occurrence[x].extension"/> <sliceName value="data-absent-reason"/> <short value="occurrence[x] absence reason"/> <definition value="Provides a reason why the occurrence is missing."/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason"/> </type> <mustSupport value="true"/> </element> <element id="Immunization.recorded"> <path value="Immunization.recorded"/> <mustSupport value="true"/> </element> <element id="Immunization.primarySource"> <path value="Immunization.primarySource"/> <mustSupport value="true"/> </element> <element id="Immunization.reportOrigin"> <path value="Immunization.reportOrigin"/> <mustSupport value="true"/> </element> <element id="Immunization.site"> <path value="Immunization.site"/> <type> <code value="CodeableConcept"/> <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"/> </type> <mustSupport value="true"/> <binding> <strength value="preferred"/> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips"/> </binding> </element> <element id="Immunization.route"> <path value="Immunization.route"/> <type> <code value="CodeableConcept"/> <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"/> </type> <mustSupport value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationRoute"/> </extension> <strength value="required"/> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration"/> </binding> </element> <element id="Immunization.performer"> <path value="Immunization.performer"/> <max value="1"/> <mustSupport value="true"/> </element> <element id="Immunization.performer.actor"> <path value="Immunization.performer.actor"/> <mustSupport value="true"/> </element> <element id="Immunization.performer.actor.reference"> <path value="Immunization.performer.actor.reference"/> <mustSupport value="true"/> </element> </differential> </StructureDefinition>
