FHIR to OMOP FHIR IG
2.0.0-ballot - STU 1 Ballot
FHIR to OMOP FHIR IG
2.0.0-ballot - STU 1 Ballot
FHIR to OMOP FHIR IG, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-omop-ig/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
{
"resourceType" : "StructureMap",
"id" : "EncounterVisitMapV4",
"language" : "en",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureMap EncounterVisitMapV4</b></p><a name=\"EncounterVisitMapV4\"> </a><a name=\"hcEncounterVisitMapV4\"> </a><pre class=\"fml\">\r\n<span style=\"color: #cc00cc\">/// <b>url</b> = </span><span style=\"color: blue\">'http://hl7.org/fhir/uv/omop/StructureMap/EncounterVisitMapV4'</span>\r\n<span style=\"color: #cc00cc\">/// <b>version</b> = </span><span style=\"color: blue\">'2.0.0-ballot'</span>\r\n<span style=\"color: #cc00cc\">/// <b>name</b> = </span><span style=\"color: blue\">'EncounterVisitMapV4'</span>\r\n<span style=\"color: #cc00cc\">/// <b>title</b> = </span><span style=\"color: blue\">'Mapping Encounter resource to VisitOccurrence OMOP Domain V4'</span>\r\n<span style=\"color: #cc00cc\">/// <b>status</b> = </span><span style=\"color: blue\">'active'</span>\r\n<span style=\"color: #cc00cc\">/// <b>description</b> = </span><span style=\"color: blue\">'This mapping maps FHIR Encounter instances to OMOP Visit Occurence Table objects.'</span>\r\n\r\n<b>uses</b><span style=\"color: navy\"> "</span><a href=\"http://hl7.org/fhir/R4/encounter.html\" title=\"Encounter\">http://hl7.org/fhir/StructureDefinition/Encounter|4.0.1</a><span style=\"color: navy\">" </span><b>alias </b>Encounter <b>as </b><b>source</b>\r\n<b>uses</b><span style=\"color: navy\"> "</span><a href=\"StructureDefinition-VisitOccurrence.html\" title=\"Visit Occurrence OMOP Table\">http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence</a><span style=\"color: navy\">" </span><b>alias </b>VisitTable <b>as </b><b>target</b>\r\n\r\n<b>group </b>VisitOccurrence<span style=\"color: navy\">(</span><b>source</b> <span style=\"color: maroon\">src</span><span style=\"color: navy\"> : </span>Encounter, <b>target</b> <span style=\"color: maroon\">tgt</span><span style=\"color: navy\"> : </span>VisitTable<span style=\"color: navy\">)</span><span style=\"color: navy\"> {\r\n</span> src<b> where </b><span style=\"color: navy\">(</span>src.period.empty().not()<span style=\"color: navy\">)</span><b> then</b><span style=\"color: navy\"> {\r\n</span> <span style=\"color: navy\">// </span><span style=\"color: green\">OMOP Visit Occurrence ID would be a map from FHIR ID to an external key</span>\r\n src<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -> </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span> s.identifier<b> as </b><span style=\"color: maroon\">i</span><span style=\"color: navy\"><b> -> </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span> i.value<b> as </b><span style=\"color: maroon\">id</span><span style=\"color: navy\"><b> -> </b></span>tgt.visit_occurrence_id = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">id</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'integer'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">}</span> <i>"encounterIdFromIdentifier"</i><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">}</span> <i>"encounterId"</i><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">// </span><span style=\"color: green\">OMOP Person ID would be a map from the FHIR Encounter Subject reference to an external key</span>\r\n src.subject<b> as </b><span style=\"color: maroon\">subject</span><span style=\"color: navy\"><b> -> </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span> subject.reference<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -> </b></span>tgt.person_id = <span style=\"color: navy\">(</span>%s.substring(%s.indexOf('/') + 1)<span style=\"color: navy\">)</span><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">}</span><span style=\"color: navy\">;</span>\r\n src.class<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -> </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span> s.code<b> as </b><span style=\"color: maroon\">a</span><span style=\"color: navy\"><b> -> </b></span> tgt.visit_concept_id = <b>translate</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">a</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'http://hl7.org/fhir/uv/omop/ConceptMap/EncounterClass'</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'code'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">, </span> tgt.visit_source_value = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">a</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'string'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">}</span><span style=\"color: navy\">;</span>\r\n src.period<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -> </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span> s.start<b> as </b><span style=\"color: maroon\">std</span><span style=\"color: navy\"><b> -> </b></span> tgt.visit_start_date = <span style=\"color: navy\">(</span>src.period.start.toString().substring(0, 10)<span style=\"color: navy\">)</span><span style=\"color: navy\">, </span> tgt.visit_start_datetime = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">std</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'dateTime'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">;</span>\r\n s.end<b> as </b><span style=\"color: maroon\">ed</span><span style=\"color: navy\"><b> -> </b></span> tgt.visit_end_date = <span style=\"color: navy\">(</span>src.period.end.toString().substring(0, 10)<span style=\"color: navy\">)</span><span style=\"color: navy\">, </span> tgt.visit_end_datetime = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">ed</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'dateTime'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">}</span><span style=\"color: navy\">;</span>\r\n src.hospitalization<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -> </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span> s.admitSource<b> as </b><span style=\"color: maroon\">sa</span><span style=\"color: navy\"><b> -> </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span> sa.coding<b> as </b><span style=\"color: maroon\">sc</span><span style=\"color: navy\"><b> -> </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span> sc.code<b> as </b><span style=\"color: maroon\">code</span><span style=\"color: navy\"><b> -> </b></span> tgt.admitted_from_concept_id = <b>translate</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">code</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'http://hl7.org/fhir/uv/omop/ConceptMap/EncounterAdmitSource'</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'code'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">, </span> tgt.admitted_from_source_value = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">code</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'string'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">}</span><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">}</span><span style=\"color: navy\">;</span>\r\n s.dischargeDisposition<b> as </b><span style=\"color: maroon\">sd</span><span style=\"color: navy\"><b> -> </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span> sd.coding<b> as </b><span style=\"color: maroon\">sc</span><span style=\"color: navy\"><b> -> </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span> sc.code<b> as </b><span style=\"color: maroon\">code</span><span style=\"color: navy\"><b> -> </b></span> tgt.discharged_to_concept_id = <b>translate</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">code</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'http://hl7.org/fhir/uv/omop/ConceptMap/EncounterDischargeDisposition'</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'code'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">, </span> tgt.discharged_to_source_value = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">code</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'string'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">}</span><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">}</span><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">}</span><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">}</span> <i>"visitOccurrenceMap"</i><span style=\"color: navy\">;</span>\r\n<span style=\"color: navy\">}\r\n\r\n</span></pre></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
}
]
}
}
],
"url" : "http://hl7.org/fhir/uv/omop/StructureMap/EncounterVisitMapV4",
"identifier" : [
{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.40.80.43.16"
}
],
"version" : "2.0.0-ballot",
"name" : "EncounterVisitMapV4",
"title" : "Mapping Encounter resource to VisitOccurrence OMOP Domain V4",
"status" : "active",
"date" : "2026-11-06T00:33:48+00:00",
"publisher" : "HL7 International / Biomedical Research and Regulation",
"contact" : [
{
"name" : "HL7 International / Biomedical Research and Regulation",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim"
}
]
}
],
"description" : "This mapping maps FHIR Encounter instances to OMOP Visit Occurence Table objects.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"structure" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/Encounter|4.0.1",
"mode" : "source",
"alias" : "Encounter"
},
{
"url" : "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence",
"mode" : "target",
"alias" : "VisitTable"
}
],
"group" : [
{
"name" : "VisitOccurrence",
"input" : [
{
"name" : "src",
"type" : "Encounter",
"mode" : "source"
},
{
"name" : "tgt",
"type" : "VisitTable",
"mode" : "target"
}
],
"rule" : [
{
"name" : "visitOccurrenceMap",
"source" : [
{
"context" : "src",
"condition" : "src.period.empty().not()"
}
],
"rule" : [
{
"name" : "encounterId",
"source" : [
{
"context" : "src",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "encounterIdFromIdentifier",
"source" : [
{
"context" : "s",
"element" : "identifier",
"variable" : "i"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "value",
"source" : [
{
"context" : "i",
"element" : "value",
"variable" : "id"
}
],
"target" : [
{
"context" : "tgt",
"element" : "visit_occurrence_id",
"transform" : "cast",
"parameter" : [
{
"valueId" : "id"
},
{
"valueString" : "integer"
}
]
}
]
}
]
}
],
"documentation" : "OMOP Visit Occurrence ID would be a map from FHIR ID to an external key"
},
{
"name" : "subject",
"source" : [
{
"context" : "src",
"element" : "subject",
"variable" : "subject"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "reference",
"source" : [
{
"context" : "subject",
"element" : "reference",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt",
"element" : "person_id",
"transform" : "evaluate",
"parameter" : [
{
"valueString" : "%s.substring(%s.indexOf('/') + 1)"
}
]
}
]
}
],
"documentation" : "OMOP Person ID would be a map from the FHIR Encounter Subject reference to an external key"
},
{
"name" : "class",
"source" : [
{
"context" : "src",
"element" : "class",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "code",
"source" : [
{
"context" : "s",
"element" : "code",
"variable" : "a"
}
],
"target" : [
{
"context" : "tgt",
"element" : "visit_concept_id",
"transform" : "translate",
"parameter" : [
{
"valueId" : "a"
},
{
"valueString" : "http://hl7.org/fhir/uv/omop/ConceptMap/EncounterClass"
},
{
"valueString" : "code"
}
]
},
{
"context" : "tgt",
"element" : "visit_source_value",
"transform" : "cast",
"parameter" : [
{
"valueId" : "a"
},
{
"valueString" : "string"
}
]
}
]
}
]
},
{
"name" : "period",
"source" : [
{
"context" : "src",
"element" : "period",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "start",
"source" : [
{
"context" : "s",
"element" : "start",
"variable" : "std"
}
],
"target" : [
{
"context" : "tgt",
"element" : "visit_start_date",
"transform" : "evaluate",
"parameter" : [
{
"valueString" : "src.period.start.toString().substring(0, 10)"
}
]
},
{
"context" : "tgt",
"element" : "visit_start_datetime",
"transform" : "cast",
"parameter" : [
{
"valueId" : "std"
},
{
"valueString" : "dateTime"
}
]
}
]
},
{
"name" : "end",
"source" : [
{
"context" : "s",
"element" : "end",
"variable" : "ed"
}
],
"target" : [
{
"context" : "tgt",
"element" : "visit_end_date",
"transform" : "evaluate",
"parameter" : [
{
"valueString" : "src.period.end.toString().substring(0, 10)"
}
]
},
{
"context" : "tgt",
"element" : "visit_end_datetime",
"transform" : "cast",
"parameter" : [
{
"valueId" : "ed"
},
{
"valueString" : "dateTime"
}
]
}
]
}
]
},
{
"name" : "hospitalization",
"source" : [
{
"context" : "src",
"element" : "hospitalization",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "admitSource",
"source" : [
{
"context" : "s",
"element" : "admitSource",
"variable" : "sa"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "coding",
"source" : [
{
"context" : "sa",
"element" : "coding",
"variable" : "sc"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "code",
"source" : [
{
"context" : "sc",
"element" : "code",
"variable" : "code"
}
],
"target" : [
{
"context" : "tgt",
"element" : "admitted_from_concept_id",
"transform" : "translate",
"parameter" : [
{
"valueId" : "code"
},
{
"valueString" : "http://hl7.org/fhir/uv/omop/ConceptMap/EncounterAdmitSource"
},
{
"valueString" : "code"
}
]
},
{
"context" : "tgt",
"element" : "admitted_from_source_value",
"transform" : "cast",
"parameter" : [
{
"valueId" : "code"
},
{
"valueString" : "string"
}
]
}
]
}
]
}
]
},
{
"name" : "dischargeDisposition",
"source" : [
{
"context" : "s",
"element" : "dischargeDisposition",
"variable" : "sd"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "coding",
"source" : [
{
"context" : "sd",
"element" : "coding",
"variable" : "sc"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "code",
"source" : [
{
"context" : "sc",
"element" : "code",
"variable" : "code"
}
],
"target" : [
{
"context" : "tgt",
"element" : "discharged_to_concept_id",
"transform" : "translate",
"parameter" : [
{
"valueId" : "code"
},
{
"valueString" : "http://hl7.org/fhir/uv/omop/ConceptMap/EncounterDischargeDisposition"
},
{
"valueString" : "code"
}
]
},
{
"context" : "tgt",
"element" : "discharged_to_source_value",
"transform" : "cast",
"parameter" : [
{
"valueId" : "code"
},
{
"valueString" : "string"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
IG © 2023+ HL7 International / Biomedical Research and Regulation.
Package hl7.fhir.uv.omop#2.0.0-ballot based on FHIR 5.0.0.
Generated
2026-11-06
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change