{"abstract":false,"baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/pher/index.cfm"}]}],"date":"2018-08-19T21:48:56+10:00","derivation":"specialization","description":"Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.","differential":{"element":[{"definition":"Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.","id":"Immunization","mapping":[{"identity":"workflow","map":"Event"},{"identity":"v2","map":"VXU_V04"},{"identity":"rim","map":"SubstanceAdministration"}],"max":"*","min":0,"path":"Immunization","short":"Immunization event information"},{"definition":"A unique identifier assigned to this immunization record.","id":"Immunization.identifier","mapping":[{"identity":"workflow","map":"Event.identifier"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"rim","map":".id"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"}],"max":"*","min":0,"path":"Immunization.identifier","short":"Business identifier","type":[{"code":"Identifier"}]},{"binding":{"description":"A set of codes indicating the current status of an Immunization.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationStatus"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/immunization-status"},"comment":"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.","definition":"Indicates the current status of the immunization event.","id":"Immunization.status","isModifier":true,"isModifierReason":"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":true,"mapping":[{"identity":"workflow","map":"Event.status"},{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"statusCode"}],"max":"1","min":1,"path":"Immunization.status","short":"completed | entered-in-error | not-done","type":[{"code":"code"}]},{"binding":{"description":"The reason why a vaccine was not administered.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationStatusReason"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-status-reason"},"comment":"This is generally only used for the status of \"not-done\". The reason for performing the immunization event is captured in reasonCode, not here.","definition":"Indicates the reason the immunization event was not performed.","id":"Immunization.statusReason","mapping":[{"identity":"workflow","map":"Event.statusReason"},{"identity":"rim","map":".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"}],"max":"1","min":0,"path":"Immunization.statusReason","short":"Reason not done","type":[{"code":"CodeableConcept"}]},{"binding":{"description":"The code for vaccine product administered.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VaccineCode"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/vaccine-code"},"definition":"Vaccine that was administered or was to be administered.","id":"Immunization.vaccineCode","isSummary":true,"mapping":[{"identity":"workflow","map":"Event.code"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"v2","map":"RXA-5"},{"identity":"rim","map":".code"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"}],"max":"1","min":1,"path":"Immunization.vaccineCode","short":"Vaccine product administered","type":[{"code":"CodeableConcept"}]},{"definition":"The patient who either received or did not receive the immunization.","id":"Immunization.patient","isSummary":true,"mapping":[{"identity":"workflow","map":"Event.subject"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":".partipication[ttypeCode=].role"},{"identity":"w5","map":"FiveWs.subject"}],"max":"1","min":1,"path":"Immunization.patient","short":"Who was immunized","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient"]}]},{"definition":"The visit or admission or other contact between patient and health care provider the immunization was performed as part of.","id":"Immunization.encounter","mapping":[{"identity":"workflow","map":"Event.context"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"PV1-19"},{"identity":"rim","map":"component->EncounterEvent"}],"max":"1","min":0,"path":"Immunization.encounter","short":"Encounter immunization was part of","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}]},{"comment":"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.","definition":"Date vaccine administered or was to be administered.","id":"Immunization.occurrence[x]","isSummary":true,"mapping":[{"identity":"workflow","map":"Event.occurrence[x]"},{"identity":"w5","map":"FiveWs.done[x]"},{"identity":"v2","map":"RXA-3"},{"identity":"rim","map":".effectiveTime"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"}],"max":"1","min":1,"path":"Immunization.occurrence[x]","short":"Vaccine administration date","type":[{"code":"dateTime"},{"code":"string"}]},{"definition":"The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.","id":"Immunization.recorded","isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.recorded"},{"identity":"rim","map":".participation[typeCode=AUT].time"}],"max":"1","min":0,"path":"Immunization.recorded","short":"When the immunization was first captured in the subject's record","type":[{"code":"dateTime"}]},{"comment":"Reflects the “reliability” of the content.","definition":"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.","id":"Immunization.primarySource","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.source"},{"identity":"v2","map":"RXA-9"},{"identity":"rim","map":"immunization.uncertaintycode (if primary source=false, uncertainty=U)"}],"max":"1","min":0,"path":"Immunization.primarySource","short":"Indicates context the data was recorded in","type":[{"code":"boolean"}]},{"binding":{"description":"The source of the data for a record which is not from a primary source.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationReportOrigin"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-origin"},"comment":"Should not be populated if primarySource = True, not required even if primarySource = False.","definition":"The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.","id":"Immunization.reportOrigin","mapping":[{"identity":"w5","map":"FiveWs.source"},{"identity":"v2","map":"RXA-9"},{"identity":"rim","map":".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)"}],"max":"1","min":0,"path":"Immunization.reportOrigin","short":"Indicates the source of a secondarily reported record","type":[{"code":"CodeableConcept"}]},{"definition":"The service delivery location where the vaccine administration occurred.","id":"Immunization.location","mapping":[{"identity":"workflow","map":"Event.location"},{"identity":"w5","map":"FiveWs.where[x]"},{"identity":"v2","map":"RXA-27 (or RXA-11, deprecated as of v2.7)"},{"identity":"rim","map":".participation[typeCode=LOC].COCT_MT240000UV"}],"max":"1","min":0,"path":"Immunization.location","short":"Where immunization occurred","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Location"]}]},{"definition":"Name of vaccine manufacturer.","id":"Immunization.manufacturer","mapping":[{"identity":"v2","map":"RXA-17"},{"identity":"rim","map":".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name"}],"max":"1","min":0,"path":"Immunization.manufacturer","short":"Vaccine manufacturer","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"definition":"Lot number of the vaccine product.","id":"Immunization.lotNumber","mapping":[{"identity":"v2","map":"RXA-15"},{"identity":"rim","map":".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText"}],"max":"1","min":0,"path":"Immunization.lotNumber","short":"Vaccine lot number","type":[{"code":"string"}]},{"definition":"Date vaccine batch expires.","id":"Immunization.expirationDate","mapping":[{"identity":"v2","map":"RXA-16"},{"identity":"rim","map":".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"}],"max":"1","min":0,"path":"Immunization.expirationDate","short":"Vaccine expiration date","type":[{"code":"date"}]},{"binding":{"description":"The site at which the vaccine was administered.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationSite"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-site"},"definition":"Body site where vaccine was administered.","id":"Immunization.site","mapping":[{"identity":"v2","map":"RXR-2"},{"identity":"rim","map":"observation.targetSiteCode"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code"}],"max":"1","min":0,"path":"Immunization.site","short":"Body site vaccine was administered","type":[{"code":"CodeableConcept"}]},{"binding":{"description":"The route by which the vaccine was administered.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationRoute"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-route"},"definition":"The path by which the vaccine product is taken into the body.","id":"Immunization.route","mapping":[{"identity":"v2","map":"RXR-1"},{"identity":"rim","map":".routeCode"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code"}],"max":"1","min":0,"path":"Immunization.route","short":"How vaccine entered body","type":[{"code":"CodeableConcept"}]},{"definition":"The quantity of vaccine product that was administered.","id":"Immunization.doseQuantity","mapping":[{"identity":"v2","map":"RXA-6 / RXA-7"},{"identity":"rim","map":".doseQuantity"}],"max":"1","min":0,"path":"Immunization.doseQuantity","short":"Amount of vaccine administered","type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}]},{"definition":"Indicates who performed the immunization event.","id":"Immunization.performer","isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer"},{"identity":"v2","map":"ORC-12 / RXA-10"},{"identity":"rim","map":".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"}],"max":"*","min":0,"path":"Immunization.performer","short":"Who performed event","type":[{"code":"BackboneElement"}]},{"binding":{"description":"The role a practitioner or organization plays in the immunization event.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationFunction"}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/immunization-function"},"definition":"Describes the type of performance (e.g. ordering provider, administering provider, etc.).","id":"Immunization.performer.function","isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer.function"},{"identity":"rim","map":".participation.functionCode"}],"max":"1","min":0,"path":"Immunization.performer.function","short":"What type of performance was done","type":[{"code":"CodeableConcept"}]},{"comment":"When the individual practitioner who performed the action is known, it is best to send.","definition":"The practitioner or organization who performed the action.","id":"Immunization.performer.actor","isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer.actor"},{"identity":"w5","map":"FiveWs.actor"},{"identity":"rim","map":".player"}],"max":"1","min":1,"path":"Immunization.performer.actor","short":"Individual or organization who was performing","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"definition":"Extra information about the immunization that is not conveyed by the other attributes.","id":"Immunization.note","isSummary":true,"mapping":[{"identity":"workflow","map":"Event.note"},{"identity":"v2","map":"OBX-5 : OBX-3 = 48767-8"},{"identity":"rim","map":"note"}],"max":"*","min":0,"path":"Immunization.note","short":"Additional immunization notes","type":[{"code":"Annotation"}]},{"binding":{"description":"The reason why a vaccine was administered.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationReason"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-reason"},"definition":"Reasons why the vaccine was administered.","id":"Immunization.reasonCode","mapping":[{"identity":"workflow","map":"Event.reasonCode"},{"identity":"rim","map":"[actionNegationInd=false].reasonCode"}],"max":"*","min":0,"path":"Immunization.reasonCode","short":"Why immunization occurred","type":[{"code":"CodeableConcept"}]},{"definition":"Condition, Observation or DiagnosticReport that supports why the immunization was administered.","id":"Immunization.reasonReference","mapping":[{"identity":"workflow","map":"Event.reasonReference"},{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.reasonReference","short":"Why immunization occurred","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Condition","http://hl7.org/fhir/StructureDefinition/Observation","http://hl7.org/fhir/StructureDefinition/DiagnosticReport"]}]},{"definition":"Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.","id":"Immunization.isSubpotent","isModifier":true,"isModifierReason":"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":true,"mapping":[{"identity":"v2","map":"RXA-20 = PA (partial administration)"},{"identity":"rim","map":"N/A"}],"max":"1","meaningWhenMissing":"By default, a dose should be considered to be potent.","min":0,"path":"Immunization.isSubpotent","short":"Dose potency","type":[{"code":"boolean"}]},{"binding":{"description":"The reason why a dose is considered to be subpotent.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"SubpotentReason"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-subpotent-reason"},"definition":"Reason why a dose is considered to be subpotent.","id":"Immunization.subpotentReason","mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.subpotentReason","short":"Reason for being subpotent","type":[{"code":"CodeableConcept"}]},{"constraint":[{"expression":"documentType.exists() or reference.exists()","human":"One of documentType or reference SHALL be present","key":"imm-1","severity":"error","xpath":"exists(f:documentType) or exists(f:reference)"}],"definition":"Educational material presented to the patient (or guardian) at the time of vaccine administration.","id":"Immunization.education","mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.education","short":"Educational material presented to patient","type":[{"code":"BackboneElement"}]},{"definition":"Identifier of the material presented to the patient.","id":"Immunization.education.documentType","mapping":[{"identity":"v2","map":"OBX-5 : OBX-3 = 69764-9"},{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.education.documentType","short":"Educational material document identifier","type":[{"code":"string"}]},{"definition":"Reference pointer to the educational material given to the patient if the information was on line.","id":"Immunization.education.reference","mapping":[{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.education.reference","short":"Educational material reference pointer","type":[{"code":"uri"}]},{"definition":"Date the educational material was published.","id":"Immunization.education.publicationDate","mapping":[{"identity":"v2","map":"OBX-5 : OBX-3 = 29768-9"},{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.education.publicationDate","short":"Educational material publication date","type":[{"code":"dateTime"}]},{"definition":"Date the educational material was given to the patient.","id":"Immunization.education.presentationDate","mapping":[{"identity":"v2","map":"OBX-5 : OBX-3 = 29769-7"},{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.education.presentationDate","short":"Educational material presentation date","type":[{"code":"dateTime"}]},{"binding":{"description":"The patient's eligibility for a vaccation program.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ProgramEligibility"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-program-eligibility"},"definition":"Indicates a patient's eligibility for a funding program.","id":"Immunization.programEligibility","mapping":[{"identity":"v2","map":"OBX-5 : OBX-3 = 64994-7"},{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.programEligibility","short":"Patient eligibility for a vaccination program","type":[{"code":"CodeableConcept"}]},{"binding":{"description":"The source of funding used to purchase the vaccine administered.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"FundingSource"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-funding-source"},"definition":"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).","id":"Immunization.fundingSource","mapping":[{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.fundingSource","short":"Funding source for the vaccine","type":[{"code":"CodeableConcept"}]},{"definition":"The protocol (set of recommendations) being followed by the provider who administered the dose.","id":"Immunization.protocolApplied","mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.protocolApplied","short":"Protocol followed by the provider","type":[{"code":"BackboneElement"}]},{"definition":"One possible path to achieve presumed immunity against a disease - within the context of an authority.","id":"Immunization.protocolApplied.series","mapping":[{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.protocolApplied.series","short":"Name of vaccine series","type":[{"code":"string"}]},{"definition":"Indicates the authority who published the protocol (e.g. ACIP) that is being followed.","id":"Immunization.protocolApplied.authority","mapping":[{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.protocolApplied.authority","short":"Who is responsible for publishing the recommendations","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"binding":{"description":"The vaccine preventable disease the dose is being administered for.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"TargetDisease"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-target-disease"},"definition":"The vaccine preventable disease the dose is being administered against.","id":"Immunization.protocolApplied.targetDisease","mapping":[{"identity":"rim","map":"N/A"}],"max":"1","min":1,"path":"Immunization.protocolApplied.targetDisease","short":"Vaccine preventatable disease being targetted","type":[{"code":"CodeableConcept"}]},{"comment":"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).","definition":"Nominal position in a series.","id":"Immunization.protocolApplied.doseNumber[x]","mapping":[{"identity":"rim","map":"N/A"}],"max":"1","min":1,"path":"Immunization.protocolApplied.doseNumber[x]","short":"Dose number within series","type":[{"code":"positiveInt"},{"code":"string"}]}]},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Clinical.Medications"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueString":"Trial Use"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":3},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"pher"}],"fhirVersion":"3.5a.0","id":"Immunization","kind":"resource","mapping":[{"identity":"workflow","name":"Workflow Pattern","uri":"http://hl7.org/fhir/workflow"},{"identity":"v2","name":"HL7 v2 Mapping","uri":"http://hl7.org/v2"},{"identity":"rim","name":"RIM Mapping","uri":"http://hl7.org/v3"},{"identity":"w5","name":"FiveWs Pattern","uri":"http://hl7.org/fhir/fivews"},{"identity":"cda","name":"CDA (R2)","uri":"http://hl7.org/v3/cda"}],"meta":{"lastUpdated":"2018-08-19T21:48:56.559+10:00"},"name":"Immunization","publisher":"Health Level Seven International (Public Health and Emergency Response)","resourceType":"StructureDefinition","snapshot":{"element":[{"base":{"max":"*","min":0,"path":"Immunization"},"constraint":[{"expression":"contained.contained.empty()","human":"If the resource is contained in another resource, it SHALL NOT contain nested Resources","key":"dom-2","severity":"error","source":"DomainResource","xpath":"not(parent::f:contained and f:contained)"},{"expression":"contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated","key":"dom-4","severity":"error","source":"DomainResource","xpath":"not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"},{"expression":"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()","human":"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","key":"dom-3","severity":"error","source":"DomainResource","xpath":"not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))"},{"expression":"text.div.exists()","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a guman 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."}],"human":"A resource should have narrative for robust management","key":"dom-6","severity":"warning","source":"DomainResource","xpath":"exists(f:text/h:div)"},{"expression":"contained.meta.security.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a security label","key":"dom-5","severity":"error","source":"DomainResource","xpath":"not(exists(f:contained/*/f:meta/f:security))"}],"definition":"Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.","id":"Immunization","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity. Role, or Act"},{"identity":"workflow","map":"Event"},{"identity":"v2","map":"VXU_V04"},{"identity":"rim","map":"SubstanceAdministration"}],"max":"*","min":0,"path":"Immunization","short":"Immunization event information"},{"base":{"max":"1","min":0,"path":"Resource.id"},"comment":"The only time that a resource does not have an id is when it is being submitted to the server using a create operation.","definition":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","id":"Immunization.id","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"Immunization.id","short":"Logical id of this artifact","type":[{"code":"id"}]},{"base":{"max":"1","min":0,"path":"Resource.meta"},"definition":"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.","id":"Immunization.meta","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"Immunization.meta","short":"Metadata about the resource","type":[{"code":"Meta"}]},{"base":{"max":"1","min":0,"path":"Resource.implicitRules"},"comment":"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.","definition":"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.","id":"Immunization.implicitRules","isModifier":true,"isModifierReason":"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":true,"max":"1","min":0,"path":"Immunization.implicitRules","short":"A set of rules under which this content was created","type":[{"code":"uri"}]},{"base":{"max":"1","min":0,"path":"Resource.language"},"binding":{"description":"A human language.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueCanonical":"http://hl7.org/fhir/ValueSet/all-languages"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/languages"},"comment":"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).","definition":"The base language in which the resource is written.","id":"Immunization.language","isModifier":false,"isSummary":false,"max":"1","min":0,"path":"Immunization.language","short":"Language of the resource content","type":[{"code":"code"}]},{"alias":["narrative","html","xhtml","display"],"base":{"max":"1","min":0,"path":"DomainResource.text"},"comment":"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.","definition":"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.","id":"Immunization.text","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}],"max":"1","min":0,"path":"Immunization.text","short":"Text summary of the resource, for human interpretation","type":[{"code":"Narrative"}]},{"alias":["inline resources","anonymous resources","contained resources"],"base":{"max":"*","min":0,"path":"DomainResource.contained"},"comment":"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.","definition":"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.","id":"Immunization.contained","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.contained","short":"Contained, inline Resources","type":[{"code":"Resource"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.extension"},"comment":"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.","definition":"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.","id":"Immunization.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.extension","short":"Additional Content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.modifierExtension"},"comment":"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.","definition":"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. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Immunization.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.modifierExtension","short":"Extensions that cannot be ignored","type":[{"code":"Extension"}]},{"base":{"max":"*","min":0,"path":"Immunization.identifier"},"definition":"A unique identifier assigned to this immunization record.","id":"Immunization.identifier","isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Event.identifier"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"rim","map":".id"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"}],"max":"*","min":0,"path":"Immunization.identifier","short":"Business identifier","type":[{"code":"Identifier"}]},{"base":{"max":"1","min":1,"path":"Immunization.status"},"binding":{"description":"A set of codes indicating the current status of an Immunization.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationStatus"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/immunization-status"},"comment":"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.","definition":"Indicates the current status of the immunization event.","id":"Immunization.status","isModifier":true,"isModifierReason":"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":true,"mapping":[{"identity":"workflow","map":"Event.status"},{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"statusCode"}],"max":"1","min":1,"path":"Immunization.status","short":"completed | entered-in-error | not-done","type":[{"code":"code"}]},{"base":{"max":"1","min":0,"path":"Immunization.statusReason"},"binding":{"description":"The reason why a vaccine was not administered.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationStatusReason"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-status-reason"},"comment":"This is generally only used for the status of \"not-done\". The reason for performing the immunization event is captured in reasonCode, not here.","definition":"Indicates the reason the immunization event was not performed.","id":"Immunization.statusReason","isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Event.statusReason"},{"identity":"rim","map":".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"}],"max":"1","min":0,"path":"Immunization.statusReason","short":"Reason not done","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":1,"path":"Immunization.vaccineCode"},"binding":{"description":"The code for vaccine product administered.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VaccineCode"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/vaccine-code"},"definition":"Vaccine that was administered or was to be administered.","id":"Immunization.vaccineCode","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.code"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"v2","map":"RXA-5"},{"identity":"rim","map":".code"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"}],"max":"1","min":1,"path":"Immunization.vaccineCode","short":"Vaccine product administered","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":1,"path":"Immunization.patient"},"definition":"The patient who either received or did not receive the immunization.","id":"Immunization.patient","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.subject"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":".partipication[ttypeCode=].role"},{"identity":"w5","map":"FiveWs.subject"}],"max":"1","min":1,"path":"Immunization.patient","short":"Who was immunized","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient"]}]},{"base":{"max":"1","min":0,"path":"Immunization.encounter"},"definition":"The visit or admission or other contact between patient and health care provider the immunization was performed as part of.","id":"Immunization.encounter","isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Event.context"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"PV1-19"},{"identity":"rim","map":"component->EncounterEvent"}],"max":"1","min":0,"path":"Immunization.encounter","short":"Encounter immunization was part of","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}]},{"base":{"max":"1","min":1,"path":"Immunization.occurrence[x]"},"comment":"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.","definition":"Date vaccine administered or was to be administered.","id":"Immunization.occurrence[x]","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.occurrence[x]"},{"identity":"w5","map":"FiveWs.done[x]"},{"identity":"v2","map":"RXA-3"},{"identity":"rim","map":".effectiveTime"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"}],"max":"1","min":1,"path":"Immunization.occurrence[x]","short":"Vaccine administration date","type":[{"code":"dateTime"},{"code":"string"}]},{"base":{"max":"1","min":0,"path":"Immunization.recorded"},"definition":"The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.","id":"Immunization.recorded","isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.recorded"},{"identity":"rim","map":".participation[typeCode=AUT].time"}],"max":"1","min":0,"path":"Immunization.recorded","short":"When the immunization was first captured in the subject's record","type":[{"code":"dateTime"}]},{"base":{"max":"1","min":0,"path":"Immunization.primarySource"},"comment":"Reflects the “reliability” of the content.","definition":"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.","id":"Immunization.primarySource","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.source"},{"identity":"v2","map":"RXA-9"},{"identity":"rim","map":"immunization.uncertaintycode (if primary source=false, uncertainty=U)"}],"max":"1","min":0,"path":"Immunization.primarySource","short":"Indicates context the data was recorded in","type":[{"code":"boolean"}]},{"base":{"max":"1","min":0,"path":"Immunization.reportOrigin"},"binding":{"description":"The source of the data for a record which is not from a primary source.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationReportOrigin"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-origin"},"comment":"Should not be populated if primarySource = True, not required even if primarySource = False.","definition":"The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.","id":"Immunization.reportOrigin","isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.source"},{"identity":"v2","map":"RXA-9"},{"identity":"rim","map":".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)"}],"max":"1","min":0,"path":"Immunization.reportOrigin","short":"Indicates the source of a secondarily reported record","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Immunization.location"},"definition":"The service delivery location where the vaccine administration occurred.","id":"Immunization.location","isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Event.location"},{"identity":"w5","map":"FiveWs.where[x]"},{"identity":"v2","map":"RXA-27 (or RXA-11, deprecated as of v2.7)"},{"identity":"rim","map":".participation[typeCode=LOC].COCT_MT240000UV"}],"max":"1","min":0,"path":"Immunization.location","short":"Where immunization occurred","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Location"]}]},{"base":{"max":"1","min":0,"path":"Immunization.manufacturer"},"definition":"Name of vaccine manufacturer.","id":"Immunization.manufacturer","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"RXA-17"},{"identity":"rim","map":".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name"}],"max":"1","min":0,"path":"Immunization.manufacturer","short":"Vaccine manufacturer","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"base":{"max":"1","min":0,"path":"Immunization.lotNumber"},"definition":"Lot number of the vaccine product.","id":"Immunization.lotNumber","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"RXA-15"},{"identity":"rim","map":".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText"}],"max":"1","min":0,"path":"Immunization.lotNumber","short":"Vaccine lot number","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"Immunization.expirationDate"},"definition":"Date vaccine batch expires.","id":"Immunization.expirationDate","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"RXA-16"},{"identity":"rim","map":".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"}],"max":"1","min":0,"path":"Immunization.expirationDate","short":"Vaccine expiration date","type":[{"code":"date"}]},{"base":{"max":"1","min":0,"path":"Immunization.site"},"binding":{"description":"The site at which the vaccine was administered.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationSite"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-site"},"definition":"Body site where vaccine was administered.","id":"Immunization.site","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"RXR-2"},{"identity":"rim","map":"observation.targetSiteCode"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code"}],"max":"1","min":0,"path":"Immunization.site","short":"Body site vaccine was administered","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Immunization.route"},"binding":{"description":"The route by which the vaccine was administered.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationRoute"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-route"},"definition":"The path by which the vaccine product is taken into the body.","id":"Immunization.route","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"RXR-1"},{"identity":"rim","map":".routeCode"},{"identity":"cda","map":"ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code"}],"max":"1","min":0,"path":"Immunization.route","short":"How vaccine entered body","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Immunization.doseQuantity"},"definition":"The quantity of vaccine product that was administered.","id":"Immunization.doseQuantity","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"RXA-6 / RXA-7"},{"identity":"rim","map":".doseQuantity"}],"max":"1","min":0,"path":"Immunization.doseQuantity","short":"Amount of vaccine administered","type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}]},{"base":{"max":"*","min":0,"path":"Immunization.performer"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"Element","xpath":"@value|f:*|h:div"}],"definition":"Indicates who performed the immunization event.","id":"Immunization.performer","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer"},{"identity":"v2","map":"ORC-12 / RXA-10"},{"identity":"rim","map":".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"}],"max":"*","min":0,"path":"Immunization.performer","short":"Who performed event","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"Immunization.performer.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"Immunization.performer.id","representation":["xmlAttr"],"short":"xml:id (or equivalent in JSON)","type":[{"code":"string"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.extension"},"comment":"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.","definition":"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.","id":"Immunization.performer.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"Immunization.performer.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"comment":"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.","definition":"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. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Immunization.performer.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.performer.modifierExtension","short":"Extensions that cannot be ignored if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"1","min":0,"path":"Immunization.performer.function"},"binding":{"description":"The role a practitioner or organization plays in the immunization event.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationFunction"}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/immunization-function"},"definition":"Describes the type of performance (e.g. ordering provider, administering provider, etc.).","id":"Immunization.performer.function","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer.function"},{"identity":"rim","map":".participation.functionCode"}],"max":"1","min":0,"path":"Immunization.performer.function","short":"What type of performance was done","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":1,"path":"Immunization.performer.actor"},"comment":"When the individual practitioner who performed the action is known, it is best to send.","definition":"The practitioner or organization who performed the action.","id":"Immunization.performer.actor","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer.actor"},{"identity":"w5","map":"FiveWs.actor"},{"identity":"rim","map":".player"}],"max":"1","min":1,"path":"Immunization.performer.actor","short":"Individual or organization who was performing","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"base":{"max":"*","min":0,"path":"Immunization.note"},"definition":"Extra information about the immunization that is not conveyed by the other attributes.","id":"Immunization.note","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.note"},{"identity":"v2","map":"OBX-5 : OBX-3 = 48767-8"},{"identity":"rim","map":"note"}],"max":"*","min":0,"path":"Immunization.note","short":"Additional immunization notes","type":[{"code":"Annotation"}]},{"base":{"max":"*","min":0,"path":"Immunization.reasonCode"},"binding":{"description":"The reason why a vaccine was administered.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ImmunizationReason"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-reason"},"definition":"Reasons why the vaccine was administered.","id":"Immunization.reasonCode","isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Event.reasonCode"},{"identity":"rim","map":"[actionNegationInd=false].reasonCode"}],"max":"*","min":0,"path":"Immunization.reasonCode","short":"Why immunization occurred","type":[{"code":"CodeableConcept"}]},{"base":{"max":"*","min":0,"path":"Immunization.reasonReference"},"definition":"Condition, Observation or DiagnosticReport that supports why the immunization was administered.","id":"Immunization.reasonReference","isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Event.reasonReference"},{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.reasonReference","short":"Why immunization occurred","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Condition","http://hl7.org/fhir/StructureDefinition/Observation","http://hl7.org/fhir/StructureDefinition/DiagnosticReport"]}]},{"base":{"max":"1","min":0,"path":"Immunization.isSubpotent"},"definition":"Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.","id":"Immunization.isSubpotent","isModifier":true,"isModifierReason":"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":true,"mapping":[{"identity":"v2","map":"RXA-20 = PA (partial administration)"},{"identity":"rim","map":"N/A"}],"max":"1","meaningWhenMissing":"By default, a dose should be considered to be potent.","min":0,"path":"Immunization.isSubpotent","short":"Dose potency","type":[{"code":"boolean"}]},{"base":{"max":"*","min":0,"path":"Immunization.subpotentReason"},"binding":{"description":"The reason why a dose is considered to be subpotent.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"SubpotentReason"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-subpotent-reason"},"definition":"Reason why a dose is considered to be subpotent.","id":"Immunization.subpotentReason","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.subpotentReason","short":"Reason for being subpotent","type":[{"code":"CodeableConcept"}]},{"base":{"max":"*","min":0,"path":"Immunization.education"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"Element","xpath":"@value|f:*|h:div"},{"expression":"documentType.exists() or reference.exists()","human":"One of documentType or reference SHALL be present","key":"imm-1","severity":"error","xpath":"exists(f:documentType) or exists(f:reference)"}],"definition":"Educational material presented to the patient (or guardian) at the time of vaccine administration.","id":"Immunization.education","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.education","short":"Educational material presented to patient","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"Immunization.education.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"Immunization.education.id","representation":["xmlAttr"],"short":"xml:id (or equivalent in JSON)","type":[{"code":"string"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.extension"},"comment":"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.","definition":"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.","id":"Immunization.education.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"Immunization.education.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"comment":"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.","definition":"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. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Immunization.education.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.education.modifierExtension","short":"Extensions that cannot be ignored if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"1","min":0,"path":"Immunization.education.documentType"},"definition":"Identifier of the material presented to the patient.","id":"Immunization.education.documentType","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-5 : OBX-3 = 69764-9"},{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.education.documentType","short":"Educational material document identifier","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"Immunization.education.reference"},"definition":"Reference pointer to the educational material given to the patient if the information was on line.","id":"Immunization.education.reference","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.education.reference","short":"Educational material reference pointer","type":[{"code":"uri"}]},{"base":{"max":"1","min":0,"path":"Immunization.education.publicationDate"},"definition":"Date the educational material was published.","id":"Immunization.education.publicationDate","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-5 : OBX-3 = 29768-9"},{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.education.publicationDate","short":"Educational material publication date","type":[{"code":"dateTime"}]},{"base":{"max":"1","min":0,"path":"Immunization.education.presentationDate"},"definition":"Date the educational material was given to the patient.","id":"Immunization.education.presentationDate","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-5 : OBX-3 = 29769-7"},{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.education.presentationDate","short":"Educational material presentation date","type":[{"code":"dateTime"}]},{"base":{"max":"*","min":0,"path":"Immunization.programEligibility"},"binding":{"description":"The patient's eligibility for a vaccation program.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ProgramEligibility"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-program-eligibility"},"definition":"Indicates a patient's eligibility for a funding program.","id":"Immunization.programEligibility","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-5 : OBX-3 = 64994-7"},{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.programEligibility","short":"Patient eligibility for a vaccination program","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Immunization.fundingSource"},"binding":{"description":"The source of funding used to purchase the vaccine administered.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"FundingSource"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-funding-source"},"definition":"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).","id":"Immunization.fundingSource","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.fundingSource","short":"Funding source for the vaccine","type":[{"code":"CodeableConcept"}]},{"base":{"max":"*","min":0,"path":"Immunization.protocolApplied"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"Element","xpath":"@value|f:*|h:div"}],"definition":"The protocol (set of recommendations) being followed by the provider who administered the dose.","id":"Immunization.protocolApplied","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.protocolApplied","short":"Protocol followed by the provider","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"Immunization.protocolApplied.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"Immunization.protocolApplied.id","representation":["xmlAttr"],"short":"xml:id (or equivalent in JSON)","type":[{"code":"string"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.extension"},"comment":"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.","definition":"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.","id":"Immunization.protocolApplied.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"Immunization.protocolApplied.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"comment":"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.","definition":"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. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Immunization.protocolApplied.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Immunization.protocolApplied.modifierExtension","short":"Extensions that cannot be ignored if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"1","min":0,"path":"Immunization.protocolApplied.series"},"definition":"One possible path to achieve presumed immunity against a disease - within the context of an authority.","id":"Immunization.protocolApplied.series","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.protocolApplied.series","short":"Name of vaccine series","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"Immunization.protocolApplied.authority"},"definition":"Indicates the authority who published the protocol (e.g. ACIP) that is being followed.","id":"Immunization.protocolApplied.authority","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"1","min":0,"path":"Immunization.protocolApplied.authority","short":"Who is responsible for publishing the recommendations","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"base":{"max":"1","min":1,"path":"Immunization.protocolApplied.targetDisease"},"binding":{"description":"The vaccine preventable disease the dose is being administered for.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"TargetDisease"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/immunization-target-disease"},"definition":"The vaccine preventable disease the dose is being administered against.","id":"Immunization.protocolApplied.targetDisease","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"1","min":1,"path":"Immunization.protocolApplied.targetDisease","short":"Vaccine preventatable disease being targetted","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":1,"path":"Immunization.protocolApplied.doseNumber[x]"},"comment":"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).","definition":"Nominal position in a series.","id":"Immunization.protocolApplied.doseNumber[x]","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"1","min":1,"path":"Immunization.protocolApplied.doseNumber[x]","short":"Dose number within series","type":[{"code":"positiveInt"},{"code":"string"}]}]},"status":"draft","text":{"div":"
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Immunization TUDomainResourceImmunization event information
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
\".\"\".\"\".\" identifier 0..*IdentifierBusiness identifier
\".\"\".\"\".\" status ?!Σ1..1codecompleted | entered-in-error | not-done
Immunization Status Codes (Required)
\".\"\".\"\".\" statusReason 0..1CodeableConceptReason not done
Immunization Status Reason Codes (Example)
\".\"\".\"\".\" vaccineCode Σ1..1CodeableConceptVaccine product administered
Vaccine Administered Value Set (Example)
\".\"\".\"\".\" patient Σ1..1Reference(Patient)Who was immunized
\".\"\".\"\".\" encounter 0..1Reference(Encounter)Encounter immunization was part of
\".\"\".\"\".\" occurrence[x] Σ1..1Vaccine administration date
\".\"\".\"\".\"\".\" occurrenceDateTimedateTime
\".\"\".\"\".\"\".\" occurrenceStringstring
\".\"\".\"\".\" recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
\".\"\".\"\".\" primarySource Σ0..1booleanIndicates context the data was recorded in
\".\"\".\"\".\" reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Immunization Origin Codes (Example)
\".\"\".\"\".\" location 0..1Reference(Location)Where immunization occurred
\".\"\".\"\".\" manufacturer 0..1Reference(Organization)Vaccine manufacturer
\".\"\".\"\".\" lotNumber 0..1stringVaccine lot number
\".\"\".\"\".\" expirationDate 0..1dateVaccine expiration date
\".\"\".\"\".\" site 0..1CodeableConceptBody site vaccine was administered
Codes for Immunization Site of Administration (Example)
\".\"\".\"\".\" route 0..1CodeableConceptHow vaccine entered body
Immunization Route Codes (Example)
\".\"\".\"\".\" doseQuantity 0..1SimpleQuantityAmount of vaccine administered
\".\"\".\"\".\" performer Σ0..*BackboneElementWho performed event
\".\"\".\"\".\"\".\" function Σ0..1CodeableConceptWhat type of performance was done
Immunization Function Codes (Extensible)
\".\"\".\"\".\"\".\" actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
\".\"\".\"\".\" note Σ0..*AnnotationAdditional immunization notes
\".\"\".\"\".\" reasonCode 0..*CodeableConceptWhy immunization occurred
Immunization Reason Codes (Example)
\".\"\".\"\".\" reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
\".\"\".\"\".\" isSubpotent ?!Σ0..1booleanDose potency
\".\"\".\"\".\" subpotentReason 0..*CodeableConceptReason for being subpotent
Immunization Subpotent Reason (Example)
\".\"\".\"\".\" education I0..*BackboneElementEducational material presented to patient
+ Rule: One of documentType or reference SHALL be present
\".\"\".\"\".\"\".\" documentType 0..1stringEducational material document identifier
\".\"\".\"\".\"\".\" reference 0..1uriEducational material reference pointer
\".\"\".\"\".\"\".\" publicationDate 0..1dateTimeEducational material publication date
\".\"\".\"\".\"\".\" presentationDate 0..1dateTimeEducational material presentation date
\".\"\".\"\".\" programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Immunization Program Eligibility (Example)
\".\"\".\"\".\" fundingSource 0..1CodeableConceptFunding source for the vaccine
Immunization Funding Source (Example)
\".\"\".\"\".\" protocolApplied 0..*BackboneElementProtocol followed by the provider
\".\"\".\"\".\"\".\" series 0..1stringName of vaccine series
\".\"\".\"\".\"\".\" authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
\".\"\".\"\".\"\".\" targetDisease 1..1CodeableConceptVaccine preventatable disease being targetted
Immunization Target Disease Codes (Example)
\".\"\".\"\".\"\".\" doseNumber[x] 1..1Dose number within series
\".\"\".\"\".\"\".\"\".\" doseNumberPositiveIntpositiveInt
\".\"\".\"\".\"\".\"\".\" doseNumberStringstring

\"doco\" Documentation for this format
","status":"generated"},"type":"Immunization","url":"http://hl7.org/fhir/StructureDefinition/Immunization"}