HL7 Version 2 to FHIR
1.0.0 - STU 1
HL7 Version 2 to FHIR
1.0.0 - STU 1
HL7 Version 2 to FHIR, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2-to-fhir/ and changes regularly. See the Directory of published versions
| Page standards status: Informative |
{
"resourceType" : "ConceptMap",
"id" : "segment-msh-source-to-provenance",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ConceptMap segment-msh-source-to-provenance</b></p><a name=\"segment-msh-source-to-provenance\"> </a><a name=\"hcsegment-msh-source-to-provenance\"> </a><p>Mapping from (not specified) to (not specified)</p><br/><p><b>Group 1 </b>Mapping from <code>unspecified code system</code> to <code>unspecified code system</code></p><table class=\"grid\"><tr><td colspan=\"4\"><b>Source Concept Details</b></td><td><b>Relationship</b></td><td colspan=\"2\"><b>Target Concept Details</b></td><td><b>Comment</b></td></tr><tr><td colspan=\"2\"><b>Codes</b> from </td><td><b>NarrativeCondition</b></td><td><b>ComputableANTLR</b></td><td/><td colspan=\"2\"><b>Codes</b> from </td><td/></tr><tr><td style=\"border-right-width: 0px\">MSH</td><td style=\"border-left-width: 0px\"/><td>when you hold on to/persist the v2 message in a data store</td><td/><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">entity[1].what(DocumentReference.content.attachment.url)</td><td style=\"border-left-width: 0px\">entity[1].what(DocumentReference.content.attachment.url)</td><td>If there is an interest in holding to the original message by the recipient</td></tr><tr><td style=\"border-right-width: 0px\">MSH</td><td style=\"border-left-width: 0px\"/><td>when you do not hold on to/persist the v2 message in a data store</td><td/><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">entity[1].what(DocumentReference.content.attachment.data)</td><td style=\"border-left-width: 0px\">entity[1].what(DocumentReference.content.attachment.data)</td><td>If there is an interest in holding to the original message by the recipient</td></tr><tr><td style=\"border-right-width: 0px\">MSH</td><td style=\"border-left-width: 0px\"/><td>when you do not hold on to/persist the v2 message in a data store</td><td/><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">entity[1].what(DocumentReference.status)</td><td style=\"border-left-width: 0px\">entity[1].what(DocumentReference.status)</td><td>If there is an interest in holding to the original message by the recipient</td></tr><tr><td style=\"border-right-width: 0px\">MSH</td><td style=\"border-left-width: 0px\"/><td/><td/><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">entity[1].role</td><td style=\"border-left-width: 0px\">entity[1].role</td><td/></tr><tr><td style=\"border-right-width: 0px\">MSH-3</td><td style=\"border-left-width: 0px\">Sending Application</td><td/><td>IF MSH-3 AND MSH-24 VALUED</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">entity[2].what(Device.identifier)</td><td style=\"border-left-width: 0px\">entity[2].what(Device.identifier)</td><td/></tr><tr><td style=\"border-right-width: 0px\">MSH-3</td><td style=\"border-left-width: 0px\">Sending Application</td><td/><td>IF MSH-3 AND MSH-24 VALUED</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">entity[2].role</td><td style=\"border-left-width: 0px\">entity[2].role</td><td/></tr><tr><td style=\"border-right-width: 0px\">MSH-4</td><td style=\"border-left-width: 0px\">Sending Facility</td><td/><td>IF MSH-22 NOT VALUED</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">agent[1].who(Organization)</td><td style=\"border-left-width: 0px\">agent[1].who(Organization)</td><td/></tr><tr><td style=\"border-right-width: 0px\">MSH-4</td><td style=\"border-left-width: 0px\">Sending Facility</td><td/><td>IF MSH-22 NOT VALUED</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">agent[1].type.coding.code</td><td style=\"border-left-width: 0px\">agent[1].type.coding.code</td><td/></tr><tr><td style=\"border-right-width: 0px\">MSH-4</td><td style=\"border-left-width: 0px\">Sending Facility</td><td/><td>IF MSH-22 NOT VALUED</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">agent[1].type.coding.system</td><td style=\"border-left-width: 0px\">agent[1].type.coding.system</td><td/></tr><tr><td style=\"border-right-width: 0px\">MSH-7</td><td style=\"border-left-width: 0px\">Date/Time of Message</td><td/><td/><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">recorded</td><td style=\"border-left-width: 0px\">recorded</td><td>We note that this could have been mapped to the Provenance.occurred[x] attribute, but since Provenance.recorded is required and these two times are virtually the same, we opted to map to Provenance.recorded.</td></tr><tr><td style=\"border-right-width: 0px\">MSH-7</td><td style=\"border-left-width: 0px\">Date/Time of Message</td><td/><td/><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">occurred</td><td style=\"border-left-width: 0px\">occurred</td><td/></tr><tr><td style=\"border-right-width: 0px\">MSH-9</td><td style=\"border-left-width: 0px\">Message Type</td><td/><td/><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">activity.coding.display</td><td style=\"border-left-width: 0px\">activity.coding.display</td><td/></tr><tr><td style=\"border-right-width: 0px\">MSH-22</td><td style=\"border-left-width: 0px\">Sending Responsible Organization</td><td/><td/><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">agent[2].who(Organization)</td><td style=\"border-left-width: 0px\">agent[2].who(Organization)</td><td/></tr><tr><td style=\"border-right-width: 0px\">MSH-22</td><td style=\"border-left-width: 0px\">Sending Responsible Organization</td><td/><td/><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">agent[2].type.coding.code</td><td style=\"border-left-width: 0px\">agent[2].type.coding.code</td><td/></tr><tr><td style=\"border-right-width: 0px\">MSH-22</td><td style=\"border-left-width: 0px\">Sending Responsible Organization</td><td/><td/><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">agent[2].type.coding.system</td><td style=\"border-left-width: 0px\">agent[2].type.coding.system</td><td/></tr></table></div>"
},
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "derived-from"
},
{
"url" : "label",
"valueString" : "Segment MSH[Source] to Provenance.fsh"
},
{
"url" : "url",
"valueUri" : "https://docs.google.com/spreadsheets/d/1F5aYk6tFCYTQd_qEaEc5G85ZcCm98R5B-sq2JGqUagk/edit#gid=0"
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/RelatedArtifact"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "informative",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/uv/v2mappings/ImplementationGuide/hl7.fhir.uv.v2mappings"
}
]
}
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/ConceptMap/segment-msh-source-to-provenance",
"version" : "1.0.0",
"name" : "SegmentMSHSourceToProvenance",
"title" : "Segment MSH [Source] to Provenance Map",
"status" : "active",
"experimental" : true,
"date" : "2025-08-25",
"publisher" : "HL7 International / Orders and Observations",
"contact" : [
{
"name" : "HL7 Orders and Observations Workgroup",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders"
}
]
}
],
"description" : "This ConceptMap represents a mapping from the HL7 V2 Segment MSH to the FHIR Provenance Resource.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"copyright" : "Copyright (c) 2025, HL7 International, Inc., All Rights Reserved.",
"group" : [
{
"element" : [
{
"code" : "MSH",
"target" : [
{
"code" : "entity[1].what(DocumentReference.content.attachment.url)",
"display" : "entity[1].what(DocumentReference.content.attachment.url)",
"equivalence" : "equivalent",
"comment" : "If there is an interest in holding to the original message by the recipient",
"dependsOn" : [
{
"property" : "Narrative-Condition",
"value" : "when you hold on to/persist the v2 message in a data store"
}
]
}
]
},
{
"code" : "MSH",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "assignment",
"valueString" : "/v2.txt or v2.xml into base 64/"
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "entity[1].what(DocumentReference.content.attachment.data)",
"display" : "entity[1].what(DocumentReference.content.attachment.data)",
"equivalence" : "equivalent",
"comment" : "If there is an interest in holding to the original message by the recipient",
"dependsOn" : [
{
"property" : "Narrative-Condition",
"value" : "when you do not hold on to/persist the v2 message in a data store"
}
]
}
]
},
{
"code" : "MSH",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "assignment",
"valueString" : "\"current\""
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "entity[1].what(DocumentReference.status)",
"display" : "entity[1].what(DocumentReference.status)",
"equivalence" : "equivalent",
"comment" : "If there is an interest in holding to the original message by the recipient",
"dependsOn" : [
{
"property" : "Narrative-Condition",
"value" : "when you do not hold on to/persist the v2 message in a data store"
}
]
}
]
},
{
"code" : "MSH",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "assignment",
"valueString" : "\"source\""
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "entity[1].role",
"display" : "entity[1].role",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "HD"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "MSH-3",
"display" : "Sending Application",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "Reference(Device)"
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "entity[2].what(Device.identifier)",
"display" : "entity[2].what(Device.identifier)",
"equivalence" : "equivalent",
"dependsOn" : [
{
"property" : "Computable-ANTLR",
"value" : "IF MSH-3 AND MSH-24 VALUED"
}
]
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "HD"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "MSH-3",
"display" : "Sending Application",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "code"
},
{
"url" : "assignment",
"valueString" : "\"source\""
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "entity[2].role",
"display" : "entity[2].role",
"equivalence" : "equivalent",
"dependsOn" : [
{
"property" : "Computable-ANTLR",
"value" : "IF MSH-3 AND MSH-24 VALUED"
}
]
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "HD"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "MSH-4",
"display" : "Sending Facility",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "Reference(Organization)"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "agent[1].who(Organization)",
"display" : "agent[1].who(Organization)",
"equivalence" : "equivalent",
"dependsOn" : [
{
"property" : "Computable-ANTLR",
"value" : "IF MSH-22 NOT VALUED"
}
]
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "HD"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "MSH-4",
"display" : "Sending Facility",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "code"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
},
{
"url" : "assignment",
"valueString" : "\"author\""
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "agent[1].type.coding.code",
"display" : "agent[1].type.coding.code",
"equivalence" : "equivalent",
"dependsOn" : [
{
"property" : "Computable-ANTLR",
"value" : "IF MSH-22 NOT VALUED"
}
]
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "HD"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "MSH-4",
"display" : "Sending Facility",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "uri"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
},
{
"url" : "assignment",
"valueString" : "\"http://terminology.hl7.org/CodeSystem/provenance-participant-type\""
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "agent[1].type.coding.system",
"display" : "agent[1].type.coding.system",
"equivalence" : "equivalent",
"dependsOn" : [
{
"property" : "Computable-ANTLR",
"value" : "IF MSH-22 NOT VALUED"
}
]
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "DTM"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "MSH-7",
"display" : "Date/Time of Message",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "recorded",
"display" : "recorded",
"equivalence" : "equivalent",
"comment" : "We note that this could have been mapped to the Provenance.occurred[x] attribute, but since Provenance.recorded is required and these two times are virtually the same, we opted to map to Provenance.recorded."
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "DTM"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "MSH-7",
"display" : "Date/Time of Message",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "occurred",
"display" : "occurred",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "MSG"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "MSH-9",
"display" : "Message Type",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "string"
},
{
"url" : "assignment",
"valueString" : "\"message - \"+MSG.1+\"^\"+MSG.2+\"^\"+MSG.3"
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "activity.coding.display",
"display" : "activity.coding.display",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "XON"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "MSH-22",
"display" : "Sending Responsible Organization",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "Reference(Organization)"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "agent[2].who(Organization)",
"display" : "agent[2].who(Organization)",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "XON"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "MSH-22",
"display" : "Sending Responsible Organization",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "code"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
},
{
"url" : "assignment",
"valueString" : "\"author\""
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "agent[2].type.coding.code",
"display" : "agent[2].type.coding.code",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "XON"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "MSH-22",
"display" : "Sending Responsible Organization",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "uri"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
},
{
"url" : "assignment",
"valueString" : "\"http://terminology.hl7.org/CodeSystem/provenance-participant-type\""
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "agent[2].type.coding.system",
"display" : "agent[2].type.coding.system",
"equivalence" : "equivalent"
}
]
}
]
}
]
}
IG © 2020+ HL7 International / Orders and Observations. Package hl7.fhir.uv.v2mappings#1.0.0 based on FHIR 4.0.1. Generated 2025-08-25
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change