This 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
StructureDefinition for Profile of Immunization for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
{
"resourceType": "StructureDefinition",
"id": "immunization-qicore-qicore-immunization",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/immunization-qicore-qicore-immunization",
"name": "QICore-Immunization",
"publisher": "Health Level Seven, Inc. - CQI WG",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/special/committees/CQI"
}
]
}
],
"description": "Profile of Immunization for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.",
"status": "draft",
"date": "2015-02-27",
"mapping": [
{
"identity": "qdm",
"uri": "http://www.healthit.gov/quality-data-model",
"name": "Quality Data Model"
}
],
"type": "constraint",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/Immunization",
"snapshot": {
"element": [
{
"path": "Immunization",
"name": "QICore-Immunization",
"short": "Immunization event information",
"definition": "Immunization event information.",
"min": 1,
"max": "1",
"type": [
{
"code": "Immunization"
}
],
"mapping": [
{
"identity": "v2",
"map": "VXU_V04"
},
{
"identity": "rim",
"map": "SubstanceAdministration"
},
{
"identity": "qdm",
"map": "Medication, administered"
}
]
},
{
"path": "Immunization.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Immunization.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Immunization.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Immunization.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Immunization.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Immunization.contained",
"short": "Contained, inline Resources",
"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.",
"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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Immunization.extension",
"short": "Additional Content defined by implementations",
"definition": "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 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.",
"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 level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Immunization.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. In order 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.",
"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 level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Immunization.identifier",
"short": "Business identifier",
"definition": "A unique identifier assigned to this immunization record.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Immunization.date",
"short": "Vaccination administration date",
"definition": "Date vaccine administered or was to be administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"
},
{
"identity": "v2",
"map": "RXA-3-date/time start of administration"
},
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "qdm",
"map": "start datetime"
}
]
},
{
"path": "Immunization.vaccineType",
"short": "Vaccine product administered",
"definition": "Vaccine that was administered or was to be administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"name": "QICoreVaccineTypeCVX",
"strength": "preferred",
"description": "This identifies the CVX code system",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/daf-cvx"
}
},
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"
},
{
"identity": "v2",
"map": "RXA-5-administered code"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "qdm",
"map": "primary code"
}
]
},
{
"path": "Immunization.patient",
"short": "Who was immunized?",
"definition": "The patient who either received or did not receive the immunization.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/patient-qicore-qicore-patient"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".partipication[ttypeCode=].role"
}
]
},
{
"path": "Immunization.wasNotGiven",
"short": "Was immunization given?",
"definition": "Indicates if the vaccination was or was not given.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"constraint": [
{
"key": "imm-2",
"name": "Given administration",
"severity": "error",
"human": "If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.",
"xpath": "not(f:wasNotGiven/@value='false' and exists(f:explanation/f:reasonNotGiven))"
},
{
"key": "imm-1",
"name": "Not given administration",
"severity": "error",
"human": "If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present",
"xpath": "not(f:wasNotGiven/@value='true' and (count(f:reaction) > 0 or exists(f:explanation/reason)))"
}
],
"mustSupport": true,
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "[actionNegationInd=true].reasonCode"
},
{
"identity": "qdm",
"map": "negation rationale"
}
]
},
{
"path": "Immunization.reported",
"short": "Is this a self-reported record?",
"definition": "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"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
}
]
},
{
"path": "Immunization.performer",
"short": "Who administered vaccine?",
"definition": "Clinician who administered the vaccine.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/practitioner-qicore-qicore-practitioner"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/performer/assignedEntity/assignedPerson/name"
},
{
"identity": "v2",
"map": "RXA-10-administering provider"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].COCT_MT090102UV"
}
]
},
{
"path": "Immunization.requester",
"short": "Who ordered vaccination?",
"definition": "Clinician who ordered the vaccination.",
"comments": "Other participants - delegate to Provenance resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/practitioner-qicore-qicore-practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-12-ordering provider"
},
{
"identity": "rim",
"map": "outboundRelationship.target[classCode=SBADM].participation[typeCode=AUT].COCT_MT090102UV"
}
]
},
{
"path": "Immunization.encounter",
"short": "Encounter administered as part of",
"definition": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/encounter-qicore-qicore-encounter"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": "component->EncounterEvent"
}
]
},
{
"path": "Immunization.manufacturer",
"short": "Vaccine manufacturer",
"definition": "Name of vaccine manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/organization-qicore-qicore-organization"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name"
},
{
"identity": "v2",
"map": "RXA-17-substance manufacturer name"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]"
}
]
},
{
"path": "Immunization.location",
"short": "Where did vaccination occur?",
"definition": "The service delivery location where the vaccine administration occurred.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/location-qicore-qicore-location"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-27-administered-at (or RXA-11-administered-at location, deprecated as of v2.7)"
},
{
"identity": "rim",
"map": ".participation[typeCode=LOC].COCT_MT240000UV"
}
]
},
{
"path": "Immunization.lotNumber",
"short": "Vaccine lot number",
"definition": "Lot number of the vaccine product.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText"
},
{
"identity": "v2",
"map": "RXA-15-substance lot number"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id"
}
]
},
{
"path": "Immunization.expirationDate",
"short": "Vaccine expiration date",
"definition": "Date vaccine batch expires.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-16-substance expiration date"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"
}
]
},
{
"path": "Immunization.site",
"short": "Body site vaccine was administered",
"definition": "Body site where vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ImmunizationSite",
"strength": "example",
"description": "The site at which the vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-site"
}
},
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code"
},
{
"identity": "v2",
"map": "RXR-2-administration site"
},
{
"identity": "rim",
"map": "observation.targetSiteCode"
}
]
},
{
"path": "Immunization.route",
"short": "How vaccine entered body",
"definition": "The path by which the vaccine product is taken into the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"name": "ImmunizationRoute",
"strength": "example",
"description": "The route by which the vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-route"
}
},
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code"
},
{
"identity": "v2",
"map": "RXR-1-route"
},
{
"identity": "rim",
"map": ".routeCode"
},
{
"identity": "qdm",
"map": "route"
}
]
},
{
"path": "Immunization.doseQuantity",
"short": "Amount of vaccine administered",
"definition": "The quantity of vaccine product that was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "v2",
"map": "RXA-6-administered amount / RXA-7.1-administered units.code"
},
{
"identity": "rim",
"map": ".doseQuantity"
},
{
"identity": "qdm",
"map": "dose"
}
]
},
{
"path": "Immunization.explanation",
"short": "Administration / non-administration reasons",
"definition": "Reasons why a vaccine was or was not administered.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.explanation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.explanation.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"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 level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.explanation.modifierExtension",
"short": "Extensions that cannot be ignored",
"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 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 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.",
"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 level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Immunization.explanation.reason",
"short": "Why immunization occurred",
"definition": "Reasons why a vaccine was administered.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"name": "ImmunizationReason",
"strength": "example",
"description": "The reason why a vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": "[actionNegationInd=false].reasonCode"
},
{
"identity": "qdm",
"map": "reason"
}
]
},
{
"path": "Immunization.explanation.reasonNotGiven",
"short": "Why immunization did not occur",
"definition": "Reason why a vaccine was not administered.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"name": "NoImmunizationReason",
"strength": "example",
"description": "The reason why a vaccine was not administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/no-immunization-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXA-18"
},
{
"identity": "rim",
"map": "[actionNegationInd=true].reasonCode"
},
{
"identity": "qdm",
"map": "negation rationale"
}
]
},
{
"path": "Immunization.reaction",
"short": "Details of a reaction that follows immunization",
"definition": "Categorical data indicating that an adverse event is associated in time to an immunization.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "OBX-3"
},
{
"identity": "rim",
"map": "Observation[classCode=obs].code"
}
]
},
{
"path": "Immunization.reaction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.reaction.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"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 level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.reaction.modifierExtension",
"short": "Extensions that cannot be ignored",
"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 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 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.",
"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 level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Immunization.reaction.date",
"short": "When did reaction start?",
"definition": "Date of reaction to the immunization.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"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)"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Immunization.reaction.detail",
"short": "Additional information on reaction",
"definition": "Details of the reaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/observation-qicore-qicore-observation"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5"
},
{
"identity": "rim",
"map": ".value"
}
]
},
{
"path": "Immunization.reaction.reported",
"short": "Was reaction self-reported?",
"definition": "Self-reported indicator.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "v2",
"map": "(no such concept seems to exist for allergy/adverse reaction in V2.x)"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
}
]
},
{
"path": "Immunization.vaccinationProtocol",
"short": "What protocol was followed",
"definition": "Contains information about the protocol(s) under which the vaccine was administered.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "(V2.x doesn't seem to provide for this)"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
},
{
"identity": "qdm",
"map": "frequency"
}
]
},
{
"path": "Immunization.vaccinationProtocol.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.vaccinationProtocol.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"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 level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.vaccinationProtocol.modifierExtension",
"short": "Extensions that cannot be ignored",
"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 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 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.",
"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 level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Immunization.vaccinationProtocol.doseSequence",
"short": "What dose number within series?",
"definition": "Nominal position in a series.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber"
}
]
},
{
"path": "Immunization.vaccinationProtocol.description",
"short": "Details of vaccine protocol",
"definition": "Contains the description about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
},
{
"path": "Immunization.vaccinationProtocol.authority",
"short": "Who is responsible for protocol",
"definition": "Indicates the authority who published the protocol? E.g. ACIP.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/organization-qicore-qicore-organization"
}
],
"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",
"short": "Name of vaccine series",
"definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
}
]
},
{
"path": "Immunization.vaccinationProtocol.seriesDoses",
"short": "Recommended number of doses for immunity",
"definition": "The recommended number of doses to achieve immunity.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
},
{
"path": "Immunization.vaccinationProtocol.doseTarget",
"short": "Disease immunized against",
"definition": "The targeted disease.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "VaccinationProtocolDoseTarget",
"strength": "example",
"description": "The disease target of the vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-target"
}
},
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship.target[classCode=OBS].code"
}
]
},
{
"path": "Immunization.vaccinationProtocol.doseStatus",
"short": "Does dose count towards immunity?",
"definition": "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"
}
],
"binding": {
"name": "VaccinationProtocolDoseStatus",
"strength": "example",
"description": "The status of the vaccination protocol (i.e. should this count)",
"valueSetReference": {
"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",
"short": "Why does does count/not count?",
"definition": "Provides an explanation as to why a immunization event should or should not count against the protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "VaccinationProtocolDoseStatusReason",
"strength": "example",
"description": "The reason for the determining if a vaccination should count or why vaccination should not count.",
"valueSetReference": {
"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"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Immunization",
"name": "QICore-Immunization",
"min": 1,
"max": "1",
"type": [
{
"code": "Immunization"
}
],
"mapping": [
{
"identity": "qdm",
"map": "Medication, administered"
}
]
},
{
"path": "Immunization.date",
"mustSupport": true,
"mapping": [
{
"identity": "qdm",
"map": "start datetime"
}
]
},
{
"path": "Immunization.vaccineType",
"mustSupport": true,
"binding": {
"name": "QICoreVaccineTypeCVX",
"strength": "preferred",
"description": "This identifies the CVX code system",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/daf-cvx"
}
},
"mapping": [
{
"identity": "qdm",
"map": "primary code"
}
]
},
{
"path": "Immunization.patient",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/patient-qicore-qicore-patient"
}
],
"mustSupport": true
},
{
"path": "Immunization.wasNotGiven",
"mustSupport": true,
"mapping": [
{
"identity": "qdm",
"map": "negation rationale"
}
]
},
{
"path": "Immunization.performer",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/practitioner-qicore-qicore-practitioner"
}
]
},
{
"path": "Immunization.requester",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/practitioner-qicore-qicore-practitioner"
}
]
},
{
"path": "Immunization.encounter",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/encounter-qicore-qicore-encounter"
}
],
"mustSupport": true
},
{
"path": "Immunization.manufacturer",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/organization-qicore-qicore-organization"
}
]
},
{
"path": "Immunization.location",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/location-qicore-qicore-location"
}
]
},
{
"path": "Immunization.route",
"mustSupport": true,
"mapping": [
{
"identity": "qdm",
"map": "route"
}
]
},
{
"path": "Immunization.doseQuantity",
"mustSupport": true,
"mapping": [
{
"identity": "qdm",
"map": "dose"
}
]
},
{
"path": "Immunization.explanation"
},
{
"path": "Immunization.explanation.reason",
"mustSupport": true,
"mapping": [
{
"identity": "qdm",
"map": "reason"
}
]
},
{
"path": "Immunization.explanation.reasonNotGiven",
"mustSupport": true,
"mapping": [
{
"identity": "qdm",
"map": "negation rationale"
}
]
},
{
"path": "Immunization.reaction"
},
{
"path": "Immunization.reaction.detail",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/observation-qicore-qicore-observation"
}
]
},
{
"path": "Immunization.vaccinationProtocol",
"mapping": [
{
"identity": "qdm",
"map": "frequency"
}
]
},
{
"path": "Immunization.vaccinationProtocol.authority",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/organization-qicore-qicore-organization"
}
]
}
]
}
}
© HL7.org 2011+. FHIR DSTU (v0.4.0-4902) generated on Fri, Mar 27, 2015 00:20+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change