R4 Draft for Comment
MedicationsThis page is part of the FHIR Specification (v3.2.0: R4 Ballot 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
| Public Health and Emergency Response Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Patient |
StructureDefinition for immunizationrecommendation
{
"resourceType": "StructureDefinition",
"id": "ImmunizationRecommendation",
"meta": {
"lastUpdated": "2017-12-20T15:52:34.818+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pher"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation",
"name": "ImmunizationRecommendation",
"status": "draft",
"date": "2017-12-20T15:52:34+11:00",
"publisher": "Health Level Seven International (Public Health and Emergency Response)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pher/index.cfm"
}
]
}
],
"description": "A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.",
"fhirVersion": "3.2.0",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "ImmunizationRecommendation",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "ImmunizationRecommendation",
"path": "ImmunizationRecommendation",
"short": "Guidance or advice relating to an immunization",
"definition": "A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"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",
"expression": "contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::reference[@value='#'])]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Request"
},
{
"identity": "v2",
"map": "VXU_V04"
},
{
"identity": "rim",
"map": "SubstanceAdministration[moodCode=RMD]"
},
{
"identity": "w5",
"map": "clinical.medication"
}
]
},
{
"id": "ImmunizationRecommendation.id",
"path": "ImmunizationRecommendation.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "ImmunizationRecommendation.meta",
"path": "ImmunizationRecommendation.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 might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "ImmunizationRecommendation.implicitRules",
"path": "ImmunizationRecommendation.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.",
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "ImmunizationRecommendation.language",
"path": "ImmunizationRecommendation.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "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": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "ImmunizationRecommendation.text",
"path": "ImmunizationRecommendation.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.",
"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 in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "ImmunizationRecommendation.contained",
"path": "ImmunizationRecommendation.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.",
"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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImmunizationRecommendation.extension",
"path": "ImmunizationRecommendation.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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImmunizationRecommendation.modifierExtension",
"path": "ImmunizationRecommendation.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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImmunizationRecommendation.identifier",
"path": "ImmunizationRecommendation.identifier",
"short": "Business identifier",
"definition": "A unique identifier assigned to this particular recommendation record.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ImmunizationRecommendation.patient",
"path": "ImmunizationRecommendation.patient",
"short": "Who this profile is for",
"definition": "The patient the recommendation(s) are for.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".partipication[typeCode=SUBJ].role"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "ImmunizationRecommendation.date",
"path": "ImmunizationRecommendation.date",
"short": "Date recommendation(s) created",
"definition": "The date the immunization recommendation(s) were created.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.authoredOn"
},
{
"identity": "v2",
"map": "OBX-15"
},
{
"identity": "rim",
"map": ".partipication[typeCode=AUTH].time"
}
]
},
{
"id": "ImmunizationRecommendation.authority",
"path": "ImmunizationRecommendation.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",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 59779-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT]"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation",
"path": "ImmunizationRecommendation.recommendation",
"short": "Vaccine administration recommendations",
"definition": "Vaccine administration recommendations.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "imr-1",
"severity": "error",
"human": "One of vaccineCode or targetDisease SHALL be present",
"expression": "vaccineCode.exists() or targetDisease.exists()",
"xpath": "exists(f:vaccineCode) or exists(f:targetDisease)"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.id",
"path": "ImmunizationRecommendation.recommendation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.extension",
"path": "ImmunizationRecommendation.recommendation.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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.modifierExtension",
"path": "ImmunizationRecommendation.recommendation.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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.vaccineCode",
"path": "ImmunizationRecommendation.recommendation.vaccineCode",
"short": "Vaccine or vaccine group recommendation applies to",
"definition": "Vaccine(s) or vaccine group that pertain to the recommendation.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccineCode"
}
],
"strength": "example",
"description": "The type of vaccine administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccine-code"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.code"
},
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )"
},
{
"identity": "rim",
"map": ".partipication[typeCode=CSM].role[classCode=ADMM].code"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.targetDisease",
"path": "ImmunizationRecommendation.recommendation.targetDisease",
"short": "Disease to be immunized against",
"definition": "The targeted disease for the recommendation.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "TargetDisease"
}
],
"strength": "example",
"description": "The disease that the recommended vaccination targets",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )"
},
{
"identity": "rim",
"map": ".partipication[typeCode=CSM].role[classCode=ADMM].code"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.contraindicatedVaccineCode",
"path": "ImmunizationRecommendation.recommendation.contraindicatedVaccineCode",
"short": "Vaccine which is contraindicated to fulfill the recommendation",
"definition": "Vaccine(s) which should not be used to fulfill the recommendation.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccineCode"
}
],
"strength": "example",
"description": "The type of vaccine administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccine-code"
}
}
},
{
"id": "ImmunizationRecommendation.recommendation.forecastStatus",
"path": "ImmunizationRecommendation.recommendation.forecastStatus",
"short": "Vaccine recommendation status",
"definition": "Indicates the patient status with respect to the path to immunity for the target disease.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRecommendationStatus"
}
],
"strength": "example",
"description": "The patient's status with respect to a vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 59783-1"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code=\"Immunization Forecast Status\"].value"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.forecastReason",
"path": "ImmunizationRecommendation.recommendation.forecastReason",
"short": "Vaccine administration status reason",
"definition": "The reason for the assigned forecast status.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRecommendationReason"
}
],
"strength": "example",
"description": "The reason for the patient's status with respect to a vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 30982-3"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.dateCriterion",
"path": "ImmunizationRecommendation.recommendation.dateCriterion",
"short": "Dates governing proposed immunization",
"definition": "Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.occurrence[x]"
},
{
"identity": "v2",
"map": "OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.dateCriterion.id",
"path": "ImmunizationRecommendation.recommendation.dateCriterion.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.dateCriterion.extension",
"path": "ImmunizationRecommendation.recommendation.dateCriterion.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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension",
"path": "ImmunizationRecommendation.recommendation.dateCriterion.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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.dateCriterion.code",
"path": "ImmunizationRecommendation.recommendation.dateCriterion.code",
"short": "Type of date",
"definition": "Date classification of recommendation. For example, earliest date to give, latest date to give, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRecommendationDateCriterion"
}
],
"strength": "example",
"description": "Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-3"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.dateCriterion.value",
"path": "ImmunizationRecommendation.recommendation.dateCriterion.value",
"short": "Recommended date",
"definition": "The date whose meaning is specified by dateCriterion.code.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5"
},
{
"identity": "rim",
"map": ".value"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.description",
"path": "ImmunizationRecommendation.recommendation.description",
"short": "Protocol details",
"definition": "Contains the description about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 30956-7"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.series",
"path": "ImmunizationRecommendation.recommendation.series",
"short": "Name of vaccination 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": "v2",
"map": "RXA-5-administered code"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.doseNumber",
"path": "ImmunizationRecommendation.recommendation.doseNumber",
"short": "Recommended dose number within series",
"definition": "Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).",
"min": 0,
"max": "1",
"type": [
{
"code": "positiveInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 30973-2"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.seriesDoses",
"path": "ImmunizationRecommendation.recommendation.seriesDoses",
"short": "Recommended number of doses for immunity",
"definition": "The recommended number of doses to achieve immunity.",
"min": 0,
"max": "1",
"type": [
{
"code": "positiveInt"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 59782-3"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.supportingImmunization",
"path": "ImmunizationRecommendation.recommendation.supportingImmunization",
"short": "Past immunizations supporting recommendation",
"definition": "Immunization event history and/or evaluation that supports the status and recommendation.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Immunization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation"
}
],
"mapping": [
{
"identity": "v2",
"map": "? No clear way to associate in HL7 v2 or IG"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code=\"immunization\"]"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
"path": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
"short": "Patient observations supporting recommendation",
"definition": "Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.supportingInfo"
},
{
"identity": "v2",
"map": "OBX If OBX is associated with ( RXA : RXA-5-administered code = '998^No vaccine administered^CVX'), could contain the reason the vaccine was not administered"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ImmunizationRecommendation",
"path": "ImmunizationRecommendation",
"short": "Guidance or advice relating to an immunization",
"definition": "A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "workflow",
"map": "Request"
},
{
"identity": "v2",
"map": "VXU_V04"
},
{
"identity": "rim",
"map": "SubstanceAdministration[moodCode=RMD]"
},
{
"identity": "w5",
"map": "clinical.medication"
}
]
},
{
"id": "ImmunizationRecommendation.identifier",
"path": "ImmunizationRecommendation.identifier",
"short": "Business identifier",
"definition": "A unique identifier assigned to this particular recommendation record.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ImmunizationRecommendation.patient",
"path": "ImmunizationRecommendation.patient",
"short": "Who this profile is for",
"definition": "The patient the recommendation(s) are for.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".partipication[typeCode=SUBJ].role"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "ImmunizationRecommendation.date",
"path": "ImmunizationRecommendation.date",
"short": "Date recommendation(s) created",
"definition": "The date the immunization recommendation(s) were created.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.authoredOn"
},
{
"identity": "v2",
"map": "OBX-15"
},
{
"identity": "rim",
"map": ".partipication[typeCode=AUTH].time"
}
]
},
{
"id": "ImmunizationRecommendation.authority",
"path": "ImmunizationRecommendation.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",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 59779-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT]"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation",
"path": "ImmunizationRecommendation.recommendation",
"short": "Vaccine administration recommendations",
"definition": "Vaccine administration recommendations.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "imr-1",
"severity": "error",
"human": "One of vaccineCode or targetDisease SHALL be present",
"expression": "vaccineCode.exists() or targetDisease.exists()",
"xpath": "exists(f:vaccineCode) or exists(f:targetDisease)"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.vaccineCode",
"path": "ImmunizationRecommendation.recommendation.vaccineCode",
"short": "Vaccine or vaccine group recommendation applies to",
"definition": "Vaccine(s) or vaccine group that pertain to the recommendation.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccineCode"
}
],
"strength": "example",
"description": "The type of vaccine administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccine-code"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.code"
},
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )"
},
{
"identity": "rim",
"map": ".partipication[typeCode=CSM].role[classCode=ADMM].code"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.targetDisease",
"path": "ImmunizationRecommendation.recommendation.targetDisease",
"short": "Disease to be immunized against",
"definition": "The targeted disease for the recommendation.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "TargetDisease"
}
],
"strength": "example",
"description": "The disease that the recommended vaccination targets",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )"
},
{
"identity": "rim",
"map": ".partipication[typeCode=CSM].role[classCode=ADMM].code"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.contraindicatedVaccineCode",
"path": "ImmunizationRecommendation.recommendation.contraindicatedVaccineCode",
"short": "Vaccine which is contraindicated to fulfill the recommendation",
"definition": "Vaccine(s) which should not be used to fulfill the recommendation.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccineCode"
}
],
"strength": "example",
"description": "The type of vaccine administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccine-code"
}
}
},
{
"id": "ImmunizationRecommendation.recommendation.forecastStatus",
"path": "ImmunizationRecommendation.recommendation.forecastStatus",
"short": "Vaccine recommendation status",
"definition": "Indicates the patient status with respect to the path to immunity for the target disease.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRecommendationStatus"
}
],
"strength": "example",
"description": "The patient's status with respect to a vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 59783-1"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code=\"Immunization Forecast Status\"].value"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.forecastReason",
"path": "ImmunizationRecommendation.recommendation.forecastReason",
"short": "Vaccine administration status reason",
"definition": "The reason for the assigned forecast status.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRecommendationReason"
}
],
"strength": "example",
"description": "The reason for the patient's status with respect to a vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 30982-3"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.dateCriterion",
"path": "ImmunizationRecommendation.recommendation.dateCriterion",
"short": "Dates governing proposed immunization",
"definition": "Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.occurrence[x]"
},
{
"identity": "v2",
"map": "OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.dateCriterion.code",
"path": "ImmunizationRecommendation.recommendation.dateCriterion.code",
"short": "Type of date",
"definition": "Date classification of recommendation. For example, earliest date to give, latest date to give, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRecommendationDateCriterion"
}
],
"strength": "example",
"description": "Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-3"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.dateCriterion.value",
"path": "ImmunizationRecommendation.recommendation.dateCriterion.value",
"short": "Recommended date",
"definition": "The date whose meaning is specified by dateCriterion.code.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5"
},
{
"identity": "rim",
"map": ".value"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.description",
"path": "ImmunizationRecommendation.recommendation.description",
"short": "Protocol details",
"definition": "Contains the description about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 30956-7"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.series",
"path": "ImmunizationRecommendation.recommendation.series",
"short": "Name of vaccination 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": "v2",
"map": "RXA-5-administered code"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.doseNumber",
"path": "ImmunizationRecommendation.recommendation.doseNumber",
"short": "Recommended dose number within series",
"definition": "Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).",
"min": 0,
"max": "1",
"type": [
{
"code": "positiveInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 30973-2"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.seriesDoses",
"path": "ImmunizationRecommendation.recommendation.seriesDoses",
"short": "Recommended number of doses for immunity",
"definition": "The recommended number of doses to achieve immunity.",
"min": 0,
"max": "1",
"type": [
{
"code": "positiveInt"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 59782-3"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.supportingImmunization",
"path": "ImmunizationRecommendation.recommendation.supportingImmunization",
"short": "Past immunizations supporting recommendation",
"definition": "Immunization event history and/or evaluation that supports the status and recommendation.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Immunization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation"
}
],
"mapping": [
{
"identity": "v2",
"map": "? No clear way to associate in HL7 v2 or IG"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code=\"immunization\"]"
}
]
},
{
"id": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
"path": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
"short": "Patient observations supporting recommendation",
"definition": "Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.supportingInfo"
},
{
"identity": "v2",
"map": "OBX If OBX is associated with ( RXA : RXA-5-administered code = '998^No vaccine administered^CVX'), could contain the reason the vaccine was not administered"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Release 4 Draft for Comment (Jan-2018 v3.2.0-12885) generated on Wed, Dec 20, 2017 15:57+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change