DSTU2
This
page
is
part
of
the
FHIR
Specification
(v0.0.82:
(v1.0.2:
DSTU
1).
2).
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
StructureDefinition
for
immunizationrecommendation
{
"resourceType": "Profile",
"resourceType": "StructureDefinition",
"id": "ImmunizationRecommendation",
"meta": {
"lastUpdated": "2015-10-24T07:41:03.495+11:00"
},
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A patient's point-of-time immunization status and recommendation with optional supporting justification.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation\"><b>ImmunizationRecommendation</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 particular recommendation record.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.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=\"The patient who is the subject of the profile.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.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 this profile is for</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Vaccine administration recommendations.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation\"><b>recommendation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> Vaccine administration recommendations --></span>\r\n <<a title=\"The date the immunization recommendation was created.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.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\">Date recommendation created</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Vaccine that pertains to the recommendation.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.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 recommendation applies to</a><span style=\"color: Gray\"> --></span></vaccineType>\r\n <<a title=\"This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.doseNumber\"><b>doseNumber</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 dose number</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Vaccine administration status.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.forecastStatus\"><b>forecastStatus</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-immunization-recommendation-status.html\">Vaccine administration status</a></span><span style=\"color: Gray\"> --></span></forecastStatus>\r\n <<a title=\"Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion\"><b>dateCriterion</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Dates governing proposed immunization --></span>\r\n <<a title=\"Date classification of recommendation - e.g. earliest date to give, latest date to give, etc.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion.code\"><b>code</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-immunization-recommendation-date-criterion.html\">Type of date</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Date recommendation.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion.value\"><b>value</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\">Recommended date</span><span style=\"color: Gray\"> --></span>\r\n </dateCriterion>\r\n <<a title=\"Contains information about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol\"><b>protocol</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Protocol used by recommendation --></span>\r\n <<a title=\"Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.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>0..1</b></span> <span style=\"color: navy\">Number of dose within sequence</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=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.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\">Protocol details</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the authority who published the protocol? E.g. ACIP.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.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=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.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 vaccination series</span><span style=\"color: Gray\"> --></span>\r\n </protocol>\r\n <<a title=\"Immunization event history that supports the status and recommendation.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.supportingImmunization\"><b>supportingImmunization</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"immunization.html#Immunization\">Immunization</a>)</span> <span style=\"color: navy\">\r\n Past immunizations supporting recommendation</span><span style=\"color: Gray\"> --></span></supportingImmunization>\r\n <<a title=\"Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.supportingPatientInformation\"><b>supportingPatientInformation</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>|<a href=\"adversereaction.html#AdverseReaction\">AdverseReaction</a>|\r\n <a href=\"allergyintolerance.html#AllergyIntolerance\">AllergyIntolerance</a>)</span> <span style=\"color: navy\">Patient observations supporting recommendation</span><span style=\"color: Gray\"> --></span></supportingPatientInformation>\r\n </recommendation>\r\n</ImmunizationRecommendation>\r\n</pre></div>"
"div": "<div>!-- Snipped for Brevity --></div>"
},
"name": "immunizationrecommendation",
"publisher": "FHIR Project",
"description": "Basic Profile. A patient's point-of-time immunization status and recommendation with optional supporting justification.",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation",
"name": "ImmunizationRecommendation",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage The ImmunizationRecommendation resource is intended to cover communication of a specified patient's immunization recommendation and status across all healthcare disciplines in all care settings and all regions. \r\n\r\nAdditionally, the ImmunizationRecommendation resource is expected to cover key concepts related to the querying of a patient's immunization recommendation and status. 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 v3 POIZ domain and Immunization Domain Analysis Model.",
"publisher": "Health Level Seven International (Public Health and Emergency Response)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/pher/index.cfm"
}
]
}
],
"date": "2015-10-24T07:41:03+11:00",
"description": "Base StructureDefinition for ImmunizationRecommendation Resource",
"fhirVersion": "1.0.2",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
}
],
"structure": [
{
"type": "ImmunizationRecommendation",
"publish": true,
"element": [
{
"path": "ImmunizationRecommendation",
"definition": {
"short": "Immunization profile",
"formal": "A patient's point-of-time immunization status and recommendation with optional supporting justification.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration[moodCode=RMD]"
},
{
"identity": "v2",
"map": "VXU_V04"
}
]
"kind": "resource",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"snapshot": {
"element": [
{
"path": "ImmunizationRecommendation",
"short": "Guidance or advice relating to an immunization",
"definition": "A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.",
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
},
{
"path": "ImmunizationRecommendation.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
],
"mapping": [
{
"identity": "v2",
"map": "VXU_V04"
},
{
"identity": "rim",
"map": "SubstanceAdministration[moodCode=RMD]"
},
{
"identity": "w5",
"map": "clinical.medication"
}
},
{
"path": "ImmunizationRecommendation.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": "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.",
"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": "ImmunizationRecommendation.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
],
"isSummary": true
},
{
"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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
},
{
"path": "ImmunizationRecommendation.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
],
"isSummary": true
},
{
"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.",
"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"
}
},
{
"path": "ImmunizationRecommendation.identifier",
"definition": {
"short": "Business identifier",
"formal": "A unique identifier assigned to this particular recommendation record.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
],
"isModifier": true,
"isSummary": true
},
{
"path": "ImmunizationRecommendation.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 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",
"type": [
{
"code": "code"
}
},
{
"path": "ImmunizationRecommendation.subject",
"definition": {
"short": "Who this profile is for",
"formal": "The patient who is the subject of the profile.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".partipication[typeCode=SUBJ].role"
},
{
"identity": "v2",
"map": "PID-3-patient ID list"
}
]
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"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.",
"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"
}
},
{
"path": "ImmunizationRecommendation.recommendation",
"definition": {
"short": "Vaccine administration recommendations",
"formal": "Vaccine administration recommendations.",
"min": 1,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]"
}
]
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
},
{
"path": "ImmunizationRecommendation.recommendation.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": "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.",
"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"
}
},
{
"path": "ImmunizationRecommendation.recommendation.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
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
},
{
"path": "ImmunizationRecommendation.recommendation.date",
"definition": {
"short": "Date recommendation created",
"formal": "The date the immunization recommendation was created.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".partipication[typeCode=AUTH].time"
},
{
"identity": "v2",
"map": "OBX-15-date/time of the observation"
}
]
]
},
{
"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.",
"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"
}
},
{
"path": "ImmunizationRecommendation.recommendation.vaccineType",
"definition": {
"short": "Vaccine recommendation applies to",
"formal": "Vaccine that pertains to the recommendation.",
"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": ".partipication[typeCode=CSM].role[classCode=ADMM].code"
},
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier e { 30956-7 | 38890-0 }"
}
]
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
},
{
"path": "ImmunizationRecommendation.recommendation.doseNumber",
"definition": {
"short": "Recommended dose number",
"formal": "This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).",
"comments": "May need other dose concepts such as administered vs. valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber"
},
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 30973-2"
}
]
]
},
{
"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.",
"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"
}
},
{
"path": "ImmunizationRecommendation.recommendation.forecastStatus",
"definition": {
"short": "Vaccine administration status",
"formal": "Vaccine administration status.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ImmunizationRecommendationStatus",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/immunization-recommendation-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code=\"Immunization Forecast Status\"].value"
},
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 59783-1"
}
]
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion",
"definition": {
"short": "Dates governing proposed immunization",
"formal": "Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]"
},
{
"identity": "v2",
"map": "OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue"
}
]
},
{
"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": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "ImmunizationRecommendation.patient",
"short": "Who this profile is for",
"definition": "The patient for whom the recommendations are for.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".partipication[typeCode=SUBJ].role"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation",
"short": "Vaccine administration recommendations",
"definition": "Vaccine administration recommendations.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"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": "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.",
"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"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.date",
"short": "Date recommendation created",
"definition": "The date the immunization recommendation was created.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBX-15"
},
{
"identity": "rim",
"map": ".partipication[typeCode=AUTH].time"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.vaccineCode",
"short": "Vaccine recommendation applies to",
"definition": "Vaccine that pertains to the recommendation.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "The type of vaccine administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccine-code"
}
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.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
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 e { 30956-7 | 38890-0 }"
},
{
"identity": "rim",
"map": ".partipication[typeCode=CSM].role[classCode=ADMM].code"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.doseNumber",
"short": "Recommended dose number",
"definition": "This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).",
"comments": "May need other dose concepts such as administered vs. valid.",
"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"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.forecastStatus",
"short": "Vaccine administration status",
"definition": "Vaccine administration status.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "The patient's status with respect to a vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-status"
}
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.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
"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"
}
]
},
{
"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": "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]"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"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": "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.",
"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"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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": {
"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"
}
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.code",
"definition": {
"short": "Type of date",
"formal": "Date classification of recommendation - e.g. earliest date to give, latest date to give, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ImmunizationRecommendationDateCriterion",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/immunization-recommendation-date-criterion"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "OBX-3-observation identifier"
}
"mapping": [
{
"identity": "v2",
"map": "OBX-3"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"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"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol",
"short": "Protocol used by recommendation",
"definition": "Contains information about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=INST].source[classCode=SBADM, moodCode=DEF]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.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": "ImmunizationRecommendation.recommendation.protocol.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": "ImmunizationRecommendation.recommendation.protocol.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"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.doseSequence",
"short": "Dose number within sequence",
"definition": "Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 30973-2"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.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"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.authority",
"short": "Who is responsible for protocol",
"definition": "Indicates the authority who published the protocol. For example, ACIP.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.value",
"definition": {
"short": "Recommended date",
"formal": "Date recommendation.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".value"
},
{
"identity": "v2",
"map": "OBX-5-observation value"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 59779-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.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"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.supportingImmunization",
"short": "Past immunizations supporting recommendation",
"definition": "Immunization event history that supports the status and recommendation.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Immunization"
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol",
"definition": {
"short": "Protocol used by recommendation",
"formal": "Contains information about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=INST].source[classCode=SBADM, moodCode=DEF]"
}
],
"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\"]"
}
]
},
{
"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",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Observation"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.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
],
"mapping": [
{
"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]"
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.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
]
}
]
},
"differential": {
"element": [
{
"path": "ImmunizationRecommendation",
"short": "Guidance or advice relating to an immunization",
"definition": "A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.",
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.doseSequence",
"definition": {
"short": "Number of dose within sequence",
"formal": "Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber"
},
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 30973-2"
}
],
"mapping": [
{
"identity": "v2",
"map": "VXU_V04"
},
{
"identity": "rim",
"map": "SubstanceAdministration[moodCode=RMD]"
},
{
"identity": "w5",
"map": "clinical.medication"
}
]
},
{
"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": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "ImmunizationRecommendation.patient",
"short": "Who this profile is for",
"definition": "The patient for whom the recommendations are for.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".partipication[typeCode=SUBJ].role"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation",
"short": "Vaccine administration recommendations",
"definition": "Vaccine administration recommendations.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.date",
"short": "Date recommendation created",
"definition": "The date the immunization recommendation was created.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBX-15"
},
{
"identity": "rim",
"map": ".partipication[typeCode=AUTH].time"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.vaccineCode",
"short": "Vaccine recommendation applies to",
"definition": "Vaccine that pertains to the recommendation.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "The type of vaccine administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccine-code"
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.description",
"definition": {
"short": "Protocol details",
"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": ".text"
},
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 30956-7"
}
]
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 e { 30956-7 | 38890-0 }"
},
{
"identity": "rim",
"map": ".partipication[typeCode=CSM].role[classCode=ADMM].code"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.doseNumber",
"short": "Recommended dose number",
"definition": "This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).",
"comments": "May need other dose concepts such as administered vs. valid.",
"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"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.forecastStatus",
"short": "Vaccine administration status",
"definition": "Vaccine administration status.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "The patient's status with respect to a vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-status"
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.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": ".participation[typeCode=AUT]"
},
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 59779-9"
}
]
"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"
}
]
},
{
"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": "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]"
}
]
},
{
"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": {
"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"
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.series",
"definition": {
"short": "Name of vaccination 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": ".title"
},
{
"identity": "v2",
"map": "RXA-5-administered code"
}
"mapping": [
{
"identity": "v2",
"map": "OBX-3"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"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"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol",
"short": "Protocol used by recommendation",
"definition": "Contains information about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=INST].source[classCode=SBADM, moodCode=DEF]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.doseSequence",
"short": "Dose number within sequence",
"definition": "Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 30973-2"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.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"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.authority",
"short": "Who is responsible for protocol",
"definition": "Indicates the authority who published the protocol. For example, ACIP.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.supportingImmunization",
"definition": {
"short": "Past immunizations supporting recommendation",
"formal": "Immunization event history that supports the status and recommendation.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Immunization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code=\"immunization\"]"
},
{
"identity": "v2",
"map": "? No clear way to associate in V2.x or IG"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 : OBX-3 = 59779-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.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"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.supportingImmunization",
"short": "Past immunizations supporting recommendation",
"definition": "Immunization event history that supports the status and recommendation.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Immunization"
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
"definition": {
"short": "Patient observations supporting recommendation",
"formal": "Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Observation"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/AdverseReaction"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/AllergyIntolerance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"
},
{
"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"
}
],
"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\"]"
}
]
},
{
"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",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Observation"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
]
}
}
],
"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": "Date recommendation created",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:date"
},
{
"name": "dose-number",
"type": "number",
"documentation": "Recommended dose number",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:doseNumber"
},
{
"name": "dose-sequence",
"type": "token",
"documentation": "Number of dose within sequence",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:protocol/f:doseSequence"
},
{
"name": "identifier",
"type": "token",
"documentation": "Business identifier",
"xpath": "f:ImmunizationRecommendation/f:identifier"
},
{
"name": "information",
"type": "reference",
"documentation": "Patient observations supporting recommendation",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:supportingPatientInformation"
},
{
"name": "status",
"type": "token",
"documentation": "Vaccine administration status",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:forecastStatus"
},
{
"name": "subject",
"type": "reference",
"documentation": "Who this profile is for",
"xpath": "f:ImmunizationRecommendation/f:subject"
},
{
"name": "support",
"type": "reference",
"documentation": "Past immunizations supporting recommendation",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:supportingImmunization"
},
{
"name": "vaccine-type",
"type": "token",
"documentation": "Vaccine recommendation applies to",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:vaccineType"
}
]
}
]
],
"mapping": [
{
"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
DSTU
(v0.0.82.2943)
DSTU2
(v1.0.2-7202)
generated
on
Tue,
Sep
30,
2014
18:09+1000.
Sat,
Oct
24,
2015
07:43+1100.
Links:
What's
a
DSTU?
Search
|
Version
History
|
Table
of
Contents
|
Compare
to
DSTU1
|
|
Propose
a
change