. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Profile for immunization
<Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="immunization-definitions.html#Immunization" title="Immunization event information."><b>Immunization</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- from <a href="resources.html">Resource</a>: <a href="extensibility.html">extension</a>, <a href="extensibility.html#modifierExtension">modifierExtension</a>, language, <a href="narrative.html#Narrative">text</a>, and <a href="references.html#contained">contained</a> --> <<a class="dict" href="immunization-definitions.html#Immunization.identifier" title="A unique identifier assigned to this adverse reaction record."><b>identifier</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.html#Identifier">Identifier</a></span> <span style="color: navy">Business identifier</span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="immunization-definitions.html#Immunization.date" title="Date vaccine administered or was to be administered."><b>date</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#dateTime">dateTime</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Vaccination administration date</span><span style="color: Gray"> --></span> <<a class="dict" href="immunization-definitions.html#Immunization.vaccineType" title="Vaccine that was administered or was to be administered."><b>vaccineType</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <a href="v3/vs/VaccineType/index.html" style="color: navy">Vaccine product administered</a><span style="color: Gray"> --></span></vaccineType> <<a class="dict" href="immunization-definitions.html#Immunization.subject" title="The patient to whom the vaccine was to be administered."><b>subject</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="patient.html#Patient">Patient</a>)</span> <span style="color: navy">Who was immunized?</span><span style="color: Gray"> --></span></subject> <<a class="dict" href="immunization-definitions.html#Immunization.refusedIndicator" title="Indicates if the vaccination was refused."><b>refusedIndicator</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Was immunization refused?</span><span style="color: Gray"> --></span> <<a class="dict" href="immunization-definitions.html#Immunization.reported" title="True if this administration was reported rather than directly administered."><b>reported</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Is this a self-reported record?</span><span style="color: Gray"> --></span> <<a class="dict" href="immunization-definitions.html#Immunization.performer" title="Clinician who administered the vaccine."><b>performer</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="practitioner.html#Practitioner">Practitioner</a>)</span> <span style="color: navy">Who administered vaccine?</span><span style="color: Gray"> --></span></performer> <<a class="dict" href="immunization-definitions.html#Immunization.requester" title="Clinician who ordered the vaccination."><b>requester</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="practitioner.html#Practitioner">Practitioner</a>)</span> <span style="color: navy">Who ordered vaccination?</span><span style="color: Gray"> --></span></requester> <<a class="dict" href="immunization-definitions.html#Immunization.manufacturer" title="Name of vaccine manufacturer."><b>manufacturer</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="organization.html#Organization">Organization</a>)</span> <span style="color: navy">Vaccine manufacturer</span><span style="color: Gray"> --></span></manufacturer> <<a class="dict" href="immunization-definitions.html#Immunization.location" title="The service delivery location where the vaccine administration occurred."><b>location</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="location.html#Location">Location</a>)</span> <span style="color: navy">Where did vaccination occur?</span><span style="color: Gray"> --></span></location> <<a class="dict" href="immunization-definitions.html#Immunization.lotNumber" title="Lot number of the vaccine product."><b>lotNumber</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Vaccine lot number</span><span style="color: Gray"> --></span> <<a class="dict" href="immunization-definitions.html#Immunization.expirationDate" title="Date vaccine batch expires."><b>expirationDate</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#date">date</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Vaccine expiration date</span><span style="color: Gray"> --></span> <<a class="dict" href="immunization-definitions.html#Immunization.site" title="Body site where vaccine was administered."><b>site</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-immunization-site.html" style="color: navy">Body site vaccine was administered</a></span><span style="color: Gray"> --></span></site> <<a class="dict" href="immunization-definitions.html#Immunization.route" title="The path by which the vaccine product is taken into the body."><b>route</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-immunization-route.html" style="color: navy">How vaccine entered body</a></span><span style="color: Gray"> --></span></route> <<a class="dict" href="immunization-definitions.html#Immunization.doseQuantity" title="The quantity of vaccine product that was administered."><b>doseQuantity</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Quantity">Quantity</a></span> <span style="color: navy">Amount of vaccine administered</span><span style="color: Gray"> --></span></doseQuantity> <<a class="dict" href="immunization-definitions.html#Immunization.explanation" title="Reasons why a vaccine was administered or refused."><b>explanation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Administration / refusal reasons --></span> <<a class="dict" href="immunization-definitions.html#Immunization.explanation.reason" title="Reasons why a vaccine was administered."><b>reason</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-immunization-reason.html" style="color: navy">Why immunization occurred</a></span><span style="color: Gray"> --></span></reason> <<a class="dict" href="immunization-definitions.html#Immunization.explanation.refusalReason" title="Refusal or exemption reasons."><b>refusalReason</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-no-immunization-reason.html" style="color: navy">Why immunization did not occur</a></span><span style="color: Gray"> --></span></refusalReason> </explanation> <<a class="dict" href="immunization-definitions.html#Immunization.reaction" title="Categorical data indicating that an adverse event is associated in time to an immunization."><b>reaction</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Details of a reaction that follows immunization --></span> <<a class="dict" href="immunization-definitions.html#Immunization.reaction.date" title="Date of reaction to the immunization."><b>date</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#dateTime">dateTime</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">When did reaction start?</span><span style="color: Gray"> --></span> <<a class="dict" href="immunization-definitions.html#Immunization.reaction.detail" title="Details of the reaction."><b>detail</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="adversereaction.html#AdverseReaction">AdverseReaction</a>|<a href="observation.html#Observation">Observation</a>)</span> <span style="color: navy">Additional information on reaction</span><span style="color: Gray"> --></span></detail> <<a class="dict" href="immunization-definitions.html#Immunization.reaction.reported" title="Self-reported indicator."><b>reported</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Was reaction self-reported?</span><span style="color: Gray"> --></span> </reaction> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol" title="Contains information about the protocol(s) under which the vaccine was administered."><b>vaccinationProtocol</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> What protocol was followed --></span> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.doseSequence" title="Nominal position in a series."><b>doseSequence</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">What dose number within series?</span><span style="color: Gray"> --></span> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.description" title="Contains the description about the protocol under which the vaccine was administered."><b>description</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Details of vaccine protocol</span><span style="color: Gray"> --></span> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.authority" title="Indicates the authority who published the protocol? E.g. ACIP."><b>authority</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="organization.html#Organization">Organization</a>)</span> <span style="color: navy">Who is responsible for protocol</span><span style="color: Gray"> --></span></authority> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.series" title="One possible path to achieve presumed immunity against a disease - within the context of an authority."><b>series</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Name of vaccine series</span><span style="color: Gray"> --></span> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.seriesDoses" title="The recommended number of doses to achieve immunity."><b>seriesDoses</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Recommended number of doses for immunity</span><span style="color: Gray"> --></span> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.doseTarget" title="The targeted disease."><b>doseTarget</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-vaccination-protocol-dose-target.html" style="color: navy">Disease immunized against</a></span><span style="color: Gray"> --></span></doseTarget> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.doseStatus" title="Indicates if the immunization event should "count" against the protocol."><b>doseStatus</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-vaccination-protocol-dose-status.html" style="color: navy">Does dose count towards immunity?</a></span><span style="color: Gray"> --></span></doseStatus> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.doseStatusReason" title="Provides an explanation as to why a immunization event should or should not count against the protocol."><b>doseStatusReason</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-vaccination-protocol-dose-status-reason.html" style="color: navy">Why does does count/not count?</a></span><span style="color: Gray"> --></span></doseStatusReason> </vaccinationProtocol> </Immunization> </pre></div> </text> <name value="immunization"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Immunization event information."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage The immunization resource is intended to cover the administration of vaccines to patients across all healthcare disciplines in all care settings and all regions. This includes immunization of both humans and animals but does not include the administration of non-vaccine agents, even those that may have or claim immunological effects. Additionally, the immunization resource is expected to cover key concepts related to the creation, revision and querying of a patient's immunization history. This resource - through consultation with the PHER work group - is believed to meet key use cases and information requirements as defined in the existing HL7 v2.x immunization implementation guide, HL7 v3 POIZ domain and Immunization Domain Analysis Model."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <mapping> <identity value="cda"/> <uri value="http://hl7.org/v3/cda"/> <name value="CDA (R2)"/> </mapping> <structure> <type value="Immunization"/> <publish value="true"/> <element> <path value="Immunization"/> <definition> <short value="Immunization event information"/> <formal value="Immunization event information."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="SubstanceAdministration"/> </mapping> <mapping> <identity value="v2"/> <map value="VXU_V04"/> </mapping> </definition> </element> <element> <path value="Immunization.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.contained"/> <definition> <short value="Contained, inline Resources"/> <formal 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."/> <comments 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."/> <synonym value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.identifier"/> <definition> <short value="Business identifier"/> <formal value="A unique identifier assigned to this adverse reaction record."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"/> </mapping> </definition> </element> <element> <path value="Immunization.date"/> <definition> <short value="Vaccination administration date"/> <formal value="Date vaccine administered or was to be administered."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveT ime/value"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-3-date/time start of administration"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccineType"/> <definition> <short value="Vaccine product administered"/> <formal value="Vaccine that was administered or was to be administered."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="VaccineType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/VaccineType"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable /manfacturedProduct/manufacturedMaterial/realmCode/code"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-5-administered code"/> </mapping> </definition> </element> <element> <path value="Immunization.subject"/> <definition> <short value="Who was immunized?"/> <formal value="The patient to whom the vaccine was to be administered."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".partipication[ttypeCode=].role"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-patient ID list"/> </mapping> </definition> </element> <element> <path value="Immunization.refusedIndicator"/> <definition> <short value="Was immunization refused?"/> <formal value="Indicates if the vaccination was refused."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="[actionNegationInd=true].reasonCode"/> </mapping> </definition> </element> <element> <path value="Immunization.reported"/> <definition> <short value="Is this a self-reported record?"/> <formal value="True if this administration was reported rather than directly administered."/> <comments value="May need source of reported info (e.g. parent), but leave out for now."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-9"/> </mapping> </definition> </element> <element> <path value="Immunization.performer"/> <definition> <short value="Who administered vaccine?"/> <formal value="Clinician who administered the vaccine."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PRF].COCT_MT090102UV"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/performer/ assignedEntity/assignedPerson/name"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-10-administering provider"/> </mapping> </definition> </element> <element> <path value="Immunization.requester"/> <definition> <short value="Who ordered vaccination?"/> <formal value="Clinician who ordered the vaccination."/> <comments value="Other participants - delegate to Provenance resource."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship.target[classCode=SBADM].participation[typeCode=AUT].COCT_MT090102UV"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-12-ordering provider"/> </mapping> </definition> </element> <element> <path value="Immunization.manufacturer"/> <definition> <short value="Vaccine manufacturer"/> <formal value="Name of vaccine manufacturer."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <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> <mapping> <identity value="v2"/> <map value="RXA-17-substance manufacturer name"/> </mapping> </definition> </element> <element> <path value="Immunization.location"/> <definition> <short value="Where did vaccination occur?"/> <formal value="The service delivery location where the vaccine administration occurred."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=LOC].COCT_MT240000UV"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-27-administered-at (or RXA-11-administered-at location, deprecated as of v2.7)"/> </mapping> </definition> </element> <element> <path value="Immunization.lotNumber"/> <definition> <short value="Vaccine lot number"/> <formal value="Lot number of the vaccine product."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <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> <mapping> <identity value="v2"/> <map value="RXA-15-substance lot number"/> </mapping> </definition> </element> <element> <path value="Immunization.expirationDate"/> <definition> <short value="Vaccine expiration date"/> <formal value="Date vaccine batch expires."/> <min value="0"/> <max value="1"/> <type> <code value="date"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-16-substance expiration date"/> </mapping> </definition> </element> <element> <path value="Immunization.site"/> <definition> <short value="Body site vaccine was administered"/> <formal value="Body site where vaccine was administered."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ImmunizationSite"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/immunization-site"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="observation.targetSiteCode"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSi teCode/code"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-2-administration site"/> </mapping> </definition> </element> <element> <path value="Immunization.route"/> <definition> <short value="How vaccine entered body"/> <formal value="The path by which the vaccine product is taken into the body."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ImmunizationRoute"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/immunization-route"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".routeCode"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/ code"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-1-route"/> </mapping> </definition> </element> <element> <path value="Immunization.doseQuantity"/> <definition> <short value="Amount of vaccine administered"/> <formal value="The quantity of vaccine product that was administered."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".doseQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-6-administered amount / RXA-7.1-administered units.code"/> </mapping> </definition> </element> <element> <path value="Immunization.explanation"/> <definition> <short value="Administration / refusal reasons"/> <formal value="Reasons why a vaccine was administered or refused."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="Immunization.explanation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.explanation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.explanation.reason"/> <definition> <short value="Why immunization occurred"/> <formal value="Reasons why a vaccine was administered."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ImmunizationReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/immunization-reason"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="[actionNegationInd=false].reasonCode"/> </mapping> </definition> </element> <element> <path value="Immunization.explanation.refusalReason"/> <definition> <short value="Why immunization did not occur"/> <formal value="Refusal or exemption reasons."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="NoImmunizationReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/no-immunization-reason"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="[actionNegationInd=true].reasonCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-18"/> </mapping> </definition> </element> <element> <path value="Immunization.reaction"/> <definition> <short value="Details of a reaction that follows immunization"/> <formal value="Categorical data indicating that an adverse event is associated in time to an immunization."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=obs].code"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-3"/> </mapping> </definition> </element> <element> <path value="Immunization.reaction.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.reaction.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.reaction.date"/> <definition> <short value="When did reaction start?"/> <formal value="Date of reaction to the immunization."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the V2.x VXU message - most likely would appear in OBX segments if at all )"/> </mapping> </definition> </element> <element> <path value="Immunization.reaction.detail"/> <definition> <short value="Additional information on reaction"/> <formal value="Details of the reaction."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/AdverseReaction"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Observation"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5"/> </mapping> </definition> </element> <element> <path value="Immunization.reaction.reported"/> <definition> <short value="Was reaction self-reported?"/> <formal value="Self-reported indicator."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"/> </mapping> <mapping> <identity value="v2"/> <map value="(no such concept seems to exist for allergy/adverse reaction in V2.x)"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol"/> <definition> <short value="What protocol was followed"/> <formal value="Contains information about the protocol(s) under which the vaccine was administered."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=INST].target[classCode=SBADM]"/> </mapping> <mapping> <identity value="v2"/> <map value="(V2.x doesn't seem to provide for this)"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.doseSequence"/> <definition> <short value="What dose number within series?"/> <formal value="Nominal position in a series."/> <min value="1"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].seque nceNumber"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.description"/> <definition> <short value="Details of vaccine protocol"/> <formal value="Contains the description about the protocol under which the vaccine was administered."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sourc e[classCode=SBADM].text"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.authority"/> <definition> <short value="Who is responsible for protocol"/> <formal value="Indicates the authority who published the protocol? E.g. ACIP."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sourc e[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.series"/> <definition> <short value="Name of vaccine series"/> <formal value="One possible path to achieve presumed immunity against a disease - within the context of an authority."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=INST].target[classCode=SBADM]"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.seriesDoses"/> <definition> <short value="Recommended number of doses for immunity"/> <formal value="The recommended number of doses to achieve immunity."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sourc e[classCode=SBADM].text"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.doseTarget"/> <definition> <short value="Disease immunized against"/> <formal value="The targeted disease."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="VaccinationProtocolDoseTarget"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/vaccination-protocol-dose-target"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="outboundRelationship.target[classCode=OBS].code"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.doseStatus"/> <definition> <short value="Does dose count towards immunity?"/> <formal value="Indicates if the immunization event should "count" against the protocol."/> <comments value="May need to differentiate between status declarations by a provider vs. a CDS engine."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="VaccinationProtocolDoseStatus"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/vaccination-protocol-dose-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[class Code=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SB J].observation[classCode=OBS].value"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.doseStatusReason"/> <definition> <short value="Why does does count/not count?"/> <formal value="Provides an explanation as to why a immunization event should or should not count against the protocol."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="VaccinationProtocolDoseStatusReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/vaccination-protocol-dose-status-reason"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[class Code=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SB J].observation[classCode=OBS].reasonCode"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="Vaccination Administration / Refusal Date"/> <xpath value="f:Immunization/f:date"/> </searchParam> <searchParam> <name value="dose-sequence"/> <type value="number"/> <documentation value="What dose number within series?"/> <xpath value="f:Immunization/f:vaccinationProtocol/f:doseSequence"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Business identifier"/> <xpath value="f:Immunization/f:identifier"/> </searchParam> <searchParam> <name value="location"/> <type value="reference"/> <documentation value="The service delivery location or facility in which the vaccine was / was to be administered"/> <xpath value="f:Immunization/f:location"/> </searchParam> <searchParam> <name value="lot-number"/> <type value="string"/> <documentation value="Vaccine Lot Number"/> <xpath value="f:Immunization/f:lotNumber"/> </searchParam> <searchParam> <name value="manufacturer"/> <type value="reference"/> <documentation value="Vaccine Manufacturer"/> <xpath value="f:Immunization/f:manufacturer"/> </searchParam> <searchParam> <name value="performer"/> <type value="reference"/> <documentation value="The practitioner who administered the vaccination"/> <xpath value="f:Immunization/f:performer"/> </searchParam> <searchParam> <name value="reaction"/> <type value="reference"/> <documentation value="Additional information on reaction"/> <xpath value="f:Immunization/f:reaction/f:detail"/> </searchParam> <searchParam> <name value="reaction-date"/> <type value="date"/> <documentation value="When did reaction start?"/> <xpath value="f:Immunization/f:reaction/f:date"/> </searchParam> <searchParam> <name value="reason"/> <type value="token"/> <documentation value="Why immunization occurred"/> <xpath value="f:Immunization/f:explanation/f:reason"/> </searchParam> <searchParam> <name value="refusal-reason"/> <type value="token"/> <documentation value="Explanation of refusal / exemption"/> <xpath value="f:Immunization/f:explanation/f:refusalReason"/> </searchParam> <searchParam> <name value="refused"/> <type value="token"/> <documentation value="Was immunization refused?"/> <xpath value="f:Immunization/f:refusedIndicator"/> </searchParam> <searchParam> <name value="requester"/> <type value="reference"/> <documentation value="The practitioner who ordered the vaccination"/> <xpath value="f:Immunization/f:requester"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The subject of the vaccination event / refusal"/> <xpath value="f:Immunization/f:subject"/> </searchParam> <searchParam> <name value="vaccine-type"/> <type value="token"/> <documentation value="Vaccine Product Type Administered"/> <xpath value="f:Immunization/f:vaccineType"/> </searchParam> </structure> </Profile>
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change