FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.v2mappings.r4b
Resource TypeConceptMap
IdConceptMap-segment-msh-source-to-provenance.json
FHIR VersionR4B

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: ConceptMap segment-msh-source-to-provenance

Mapping from (not specified) to (not specified)


Group 1 Mapping from unspecified code system to unspecified code system

Source Concept DetailsRelationshipTarget Concept DetailsComment
Codes from NarrativeConditionComputableANTLRCodes from
MSHwhen you hold on to/persist the v2 message in a data storeis equivalent toentity[1].what(DocumentReference.content.attachment.url)entity[1].what(DocumentReference.content.attachment.url)If there is an interest in holding to the original message by the recipient
MSHwhen you do not hold on to/persist the v2 message in a data storeis equivalent toentity[1].what(DocumentReference.content.attachment.data)entity[1].what(DocumentReference.content.attachment.data)If there is an interest in holding to the original message by the recipient
MSHwhen you do not hold on to/persist the v2 message in a data storeis equivalent toentity[1].what(DocumentReference.status)entity[1].what(DocumentReference.status)If there is an interest in holding to the original message by the recipient
MSHis equivalent toentity[1].roleentity[1].role
MSH-3Sending ApplicationIF MSH-3 AND MSH-24 VALUEDis equivalent toentity[2].what(Device.identifier)entity[2].what(Device.identifier)
MSH-3Sending ApplicationIF MSH-3 AND MSH-24 VALUEDis equivalent toentity[2].roleentity[2].role
MSH-4Sending FacilityIF MSH-22 NOT VALUEDis equivalent toagent[1].who(Organization)agent[1].who(Organization)
MSH-4Sending FacilityIF MSH-22 NOT VALUEDis equivalent toagent[1].type.coding.codeagent[1].type.coding.code
MSH-4Sending FacilityIF MSH-22 NOT VALUEDis equivalent toagent[1].type.coding.systemagent[1].type.coding.system
MSH-7Date/Time of Messageis equivalent torecordedrecordedWe 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.
MSH-7Date/Time of Messageis equivalent tooccurredoccurred
MSH-9Message Typeis equivalent toactivity.coding.displayactivity.coding.display
MSH-22Sending Responsible Organizationis equivalent toagent[2].who(Organization)agent[2].who(Organization)
MSH-22Sending Responsible Organizationis equivalent toagent[2].type.coding.codeagent[2].type.coding.code
MSH-22Sending Responsible Organizationis equivalent toagent[2].type.coding.systemagent[2].type.coding.system

Source1

{
  "resourceType": "ConceptMap",
  "id": "segment-msh-source-to-provenance",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "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"
            }
          ]
        }
      ]
    }
  ]
}