. 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
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Immunization event information.\" class=\"dict\" href=\"immunization-definitions.html#Immunization\"><b>Immunization</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- 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> -->\r\n <<a title=\"A unique identifier assigned to this adverse reaction record.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.identifier\"><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>\r\n <<a title=\"Date vaccine administered or was to be administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.date\"><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>\r\n <<a title=\"Vaccine that was administered or was to be administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccineType\"><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 style=\"color: navy\" href=\"v3/vs/VaccineType/index.html\">Vaccine product administered</a><span style=\"color: Gray\"> --></span></vaccineType>\r\n <<a title=\"The patient to whom the vaccine was to be administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.subject\"><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>\r\n <<a title=\"Indicates if the vaccination was refused.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.refusedIndicator\"><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>\r\n <<a title=\"True if this administration was reported rather than directly administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reported\"><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>\r\n <<a title=\"Clinician who administered the vaccine.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.performer\"><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>\r\n <<a title=\"Clinician who ordered the vaccination.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.requester\"><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>\r\n <<a title=\"Name of vaccine manufacturer.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.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>\r\n <<a title=\"The service delivery location where the vaccine administration occurred.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.location\"><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>\r\n <<a title=\"Lot number of the vaccine product.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.lotNumber\"><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>\r\n <<a title=\"Date vaccine batch expires.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.expirationDate\"><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>\r\n <<a title=\"Body site where vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.site\"><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 style=\"color: navy\" href=\"valueset-immunization-site.html\">Body site vaccine was administered</a></span><span style=\"color: Gray\"> --></span></site>\r\n <<a title=\"The path by which the vaccine product is taken into the body.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.route\"><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 style=\"color: navy\" href=\"valueset-immunization-route.html\">How vaccine entered body</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"The quantity of vaccine product that was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.doseQuantity\"><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>\r\n <<a title=\"Reasons why a vaccine was administered or refused.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.explanation\"><b>explanation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Administration / refusal reasons --></span>\r\n <<a title=\"Reasons why a vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.explanation.reason\"><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 style=\"color: navy\" href=\"valueset-immunization-reason.html\">Why immunization occurred</a></span><span style=\"color: Gray\"> --></span></reason>\r\n <<a title=\"Refusal or exemption reasons.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.explanation.refusalReason\"><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 style=\"color: navy\" href=\"valueset-no-immunization-reason.html\">Why immunization did not occur</a></span><span style=\"color: Gray\"> --></span></refusalReason>\r\n </explanation>\r\n <<a title=\"Categorical data indicating that an adverse event is associated in time to an immunization.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reaction\"><b>reaction</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Details of a reaction that follows immunization --></span>\r\n <<a title=\"Date of reaction to the immunization.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reaction.date\"><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>\r\n <<a title=\"Details of the reaction.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reaction.detail\"><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>\r\n <<a title=\"Self-reported indicator.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reaction.reported\"><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>\r\n </reaction>\r\n <<a title=\"Contains information about the protocol(s) under which the vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol\"><b>vaccinationProtocol</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> What protocol was followed --></span>\r\n <<a title=\"Nominal position in a series.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.doseSequence\"><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>\r\n <<a title=\"Contains the description about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.description\"><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>\r\n <<a title=\"Indicates the authority who published the protocol? E.g. ACIP.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.authority\"><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>\r\n <<a title=\"One possible path to achieve presumed immunity against a disease - within the context of an authority.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.series\"><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>\r\n <<a title=\"The recommended number of doses to achieve immunity.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.seriesDoses\"><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>\r\n <<a title=\"The targeted disease.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.doseTarget\"><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 style=\"color: navy\" href=\"valueset-vaccination-protocol-dose-target.html\">Disease immunized against</a></span><span style=\"color: Gray\"> --></span></doseTarget>\r\n <<a title=\"Indicates if the immunization event should "count" against the protocol.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.doseStatus\"><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 style=\"color: navy\" href=\"valueset-vaccination-protocol-dose-status.html\">Does dose count towards immunity?</a></span><span style=\"color: Gray\"> --></span></doseStatus>\r\n <<a title=\"Provides an explanation as to why a immunization event should or should not count against the protocol.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.doseStatusReason\"><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 style=\"color: navy\" href=\"valueset-vaccination-protocol-dose-status-reason.html\">Why does does count/not count?</a></span><span style=\"color: Gray\"> --></span></doseStatusReason>\r\n </vaccinationProtocol>\r\n</Immunization>\r\n</pre></div>"
},
"name": "immunization",
"publisher": "FHIR Project",
"description": "Basic Profile. Immunization event information.",
"status": "draft",
"date": "2014-09-30",
"requirements": "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. \r\n\r\nAdditionally, 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": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "cda",
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)"
}
],
"structure": [
{
"type": "Immunization",
"publish": true,
"element": [
{
"path": "Immunization",
"definition": {
"short": "Immunization event information",
"formal": "Immunization event information.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration"
},
{
"identity": "v2",
"map": "VXU_V04"
}
]
}
},
{
"path": "Immunization.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "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": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Immunization.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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": "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": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Immunization.identifier",
"definition": {
"short": "Business identifier",
"formal": "A unique identifier assigned to this adverse reaction record.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"
}
]
}
},
{
"path": "Immunization.date",
"definition": {
"short": "Vaccination administration date",
"formal": "Date vaccine administered or was to be administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"
},
{
"identity": "v2",
"map": "RXA-3-date/time start of administration"
}
]
}
},
{
"path": "Immunization.vaccineType",
"definition": {
"short": "Vaccine product administered",
"formal": "Vaccine that was administered or was to be administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "VaccineType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/VaccineType"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"
},
{
"identity": "v2",
"map": "RXA-5-administered code"
}
]
}
},
{
"path": "Immunization.subject",
"definition": {
"short": "Who was immunized?",
"formal": "The patient to whom the vaccine was to be administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".partipication[ttypeCode=].role"
},
{
"identity": "v2",
"map": "PID-3-patient ID list"
}
]
}
},
{
"path": "Immunization.refusedIndicator",
"definition": {
"short": "Was immunization refused?",
"formal": "Indicates if the vaccination was refused.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "[actionNegationInd=true].reasonCode"
}
]
}
},
{
"path": "Immunization.reported",
"definition": {
"short": "Is this a self-reported record?",
"formal": "True if this administration was reported rather than directly administered.",
"comments": "May need source of reported info (e.g. parent), but leave out for now.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
},
{
"identity": "v2",
"map": "RXA-9"
}
]
}
},
{
"path": "Immunization.performer",
"definition": {
"short": "Who administered vaccine?",
"formal": "Clinician who administered the vaccine.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRF].COCT_MT090102UV"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/performer/assignedEntity/assignedPerson/name"
},
{
"identity": "v2",
"map": "RXA-10-administering provider"
}
]
}
},
{
"path": "Immunization.requester",
"definition": {
"short": "Who ordered vaccination?",
"formal": "Clinician who ordered the vaccination.",
"comments": "Other participants - delegate to Provenance resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship.target[classCode=SBADM].participation[typeCode=AUT].COCT_MT090102UV"
},
{
"identity": "v2",
"map": "ORC-12-ordering provider"
}
]
}
},
{
"path": "Immunization.manufacturer",
"definition": {
"short": "Vaccine manufacturer",
"formal": "Name of vaccine manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"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"
},
{
"identity": "v2",
"map": "RXA-17-substance manufacturer name"
}
]
}
},
{
"path": "Immunization.location",
"definition": {
"short": "Where did vaccination occur?",
"formal": "The service delivery location where the vaccine administration occurred.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=LOC].COCT_MT240000UV"
},
{
"identity": "v2",
"map": "RXA-27-administered-at (or RXA-11-administered-at location, deprecated as of v2.7)"
}
]
}
},
{
"path": "Immunization.lotNumber",
"definition": {
"short": "Vaccine lot number",
"formal": "Lot number of the vaccine product.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"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"
},
{
"identity": "v2",
"map": "RXA-15-substance lot number"
}
]
}
},
{
"path": "Immunization.expirationDate",
"definition": {
"short": "Vaccine expiration date",
"formal": "Date vaccine batch expires.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"
},
{
"identity": "v2",
"map": "RXA-16-substance expiration date"
}
]
}
},
{
"path": "Immunization.site",
"definition": {
"short": "Body site vaccine was administered",
"formal": "Body site where vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ImmunizationSite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/immunization-site"
}
},
"mapping": [
{
"identity": "rim",
"map": "observation.targetSiteCode"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code"
},
{
"identity": "v2",
"map": "RXR-2-administration site"
}
]
}
},
{
"path": "Immunization.route",
"definition": {
"short": "How vaccine entered body",
"formal": "The path by which the vaccine product is taken into the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ImmunizationRoute",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/immunization-route"
}
},
"mapping": [
{
"identity": "rim",
"map": ".routeCode"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code"
},
{
"identity": "v2",
"map": "RXR-1-route"
}
]
}
},
{
"path": "Immunization.doseQuantity",
"definition": {
"short": "Amount of vaccine administered",
"formal": "The quantity of vaccine product that was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".doseQuantity"
},
{
"identity": "v2",
"map": "RXA-6-administered amount / RXA-7.1-administered units.code"
}
]
}
},
{
"path": "Immunization.explanation",
"definition": {
"short": "Administration / refusal reasons",
"formal": "Reasons why a vaccine was administered or refused.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "Immunization.explanation.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.explanation.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.explanation.reason",
"definition": {
"short": "Why immunization occurred",
"formal": "Reasons why a vaccine was administered.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ImmunizationReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/immunization-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": "[actionNegationInd=false].reasonCode"
}
]
}
},
{
"path": "Immunization.explanation.refusalReason",
"definition": {
"short": "Why immunization did not occur",
"formal": "Refusal or exemption reasons.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "NoImmunizationReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/no-immunization-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": "[actionNegationInd=true].reasonCode"
},
{
"identity": "v2",
"map": "RXA-18"
}
]
}
},
{
"path": "Immunization.reaction",
"definition": {
"short": "Details of a reaction that follows immunization",
"formal": "Categorical data indicating that an adverse event is associated in time to an immunization.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=obs].code"
},
{
"identity": "v2",
"map": "OBX-3"
}
]
}
},
{
"path": "Immunization.reaction.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.reaction.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.reaction.date",
"definition": {
"short": "When did reaction start?",
"formal": "Date of reaction to the immunization.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "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\n)"
}
]
}
},
{
"path": "Immunization.reaction.detail",
"definition": {
"short": "Additional information on reaction",
"formal": "Details of the reaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/AdverseReaction"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Observation"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".value"
},
{
"identity": "v2",
"map": "OBX-5"
}
]
}
},
{
"path": "Immunization.reaction.reported",
"definition": {
"short": "Was reaction self-reported?",
"formal": "Self-reported indicator.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
},
{
"identity": "v2",
"map": "(no such concept seems to exist for allergy/adverse reaction in V2.x)"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol",
"definition": {
"short": "What protocol was followed",
"formal": "Contains information about the protocol(s) under which the vaccine was administered.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
},
{
"identity": "v2",
"map": "(V2.x doesn't seem to provide for this)"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.vaccinationProtocol.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.vaccinationProtocol.doseSequence",
"definition": {
"short": "What dose number within series?",
"formal": "Nominal position in a series.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.description",
"definition": {
"short": "Details of vaccine protocol",
"formal": "Contains the description about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.authority",
"definition": {
"short": "Who is responsible for protocol",
"formal": "Indicates the authority who published the protocol? E.g. ACIP.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.series",
"definition": {
"short": "Name of vaccine series",
"formal": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.seriesDoses",
"definition": {
"short": "Recommended number of doses for immunity",
"formal": "The recommended number of doses to achieve immunity.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.doseTarget",
"definition": {
"short": "Disease immunized against",
"formal": "The targeted disease.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "VaccinationProtocolDoseTarget",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-target"
}
},
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship.target[classCode=OBS].code"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.doseStatus",
"definition": {
"short": "Does dose count towards immunity?",
"formal": "Indicates if the immunization event should \"count\" against the protocol.",
"comments": "May need to differentiate between status declarations by a provider vs. a CDS engine.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "VaccinationProtocolDoseStatus",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].value"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.doseStatusReason",
"definition": {
"short": "Why does does count/not count?",
"formal": "Provides an explanation as to why a immunization event should or should not count against the protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "VaccinationProtocolDoseStatusReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-status-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].reasonCode"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "Vaccination Administration / Refusal Date",
"xpath": "f:Immunization/f:date"
},
{
"name": "dose-sequence",
"type": "number",
"documentation": "What dose number within series?",
"xpath": "f:Immunization/f:vaccinationProtocol/f:doseSequence"
},
{
"name": "identifier",
"type": "token",
"documentation": "Business identifier",
"xpath": "f:Immunization/f:identifier"
},
{
"name": "location",
"type": "reference",
"documentation": "The service delivery location or facility in which the vaccine was / was to be administered",
"xpath": "f:Immunization/f:location"
},
{
"name": "lot-number",
"type": "string",
"documentation": "Vaccine Lot Number",
"xpath": "f:Immunization/f:lotNumber"
},
{
"name": "manufacturer",
"type": "reference",
"documentation": "Vaccine Manufacturer",
"xpath": "f:Immunization/f:manufacturer"
},
{
"name": "performer",
"type": "reference",
"documentation": "The practitioner who administered the vaccination",
"xpath": "f:Immunization/f:performer"
},
{
"name": "reaction",
"type": "reference",
"documentation": "Additional information on reaction",
"xpath": "f:Immunization/f:reaction/f:detail"
},
{
"name": "reaction-date",
"type": "date",
"documentation": "When did reaction start?",
"xpath": "f:Immunization/f:reaction/f:date"
},
{
"name": "reason",
"type": "token",
"documentation": "Why immunization occurred",
"xpath": "f:Immunization/f:explanation/f:reason"
},
{
"name": "refusal-reason",
"type": "token",
"documentation": "Explanation of refusal / exemption",
"xpath": "f:Immunization/f:explanation/f:refusalReason"
},
{
"name": "refused",
"type": "token",
"documentation": "Was immunization refused?",
"xpath": "f:Immunization/f:refusedIndicator"
},
{
"name": "requester",
"type": "reference",
"documentation": "The practitioner who ordered the vaccination",
"xpath": "f:Immunization/f:requester"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject of the vaccination event / refusal",
"xpath": "f:Immunization/f:subject"
},
{
"name": "vaccine-type",
"type": "token",
"documentation": "Vaccine Product Type Administered",
"xpath": "f:Immunization/f:vaccineType"
}
]
}
]
}
© 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