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" : "MedicationMap",
"language" : "en",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureMap MedicationMap</b></p><a name=\"MedicationMap\"> </a><a name=\"hcMedicationMap\"> </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/MedicationMap'</span>\r\n<span style=\"color: #cc00cc\">/// <b>name</b> = </span><span style=\"color: blue\">'MedicationMap'</span>\r\n<span style=\"color: #cc00cc\">/// <b>title</b> = </span><span style=\"color: blue\">'Mapping MedicationStatement resource to DrugExposure OMOP Domain'</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 MedicationStatement instances to OMOP Drug Exposure Table objects. NOTE: It does not map FHIR MedicationRequest instances although there is a discussion of those instances in the notes.'</span>\r\n\r\n<b>uses</b><span style=\"color: navy\"> "</span><a href=\"http://hl7.org/fhir/R5/medicationstatement.html\" title=\"MedicationStatement\">http://hl7.org/fhir/StructureDefinition/MedicationStatement</a><span style=\"color: navy\">" </span><b>alias </b>MedState <b>as </b><b>source</b>\r\n<b>uses</b><span style=\"color: navy\"> "</span><a href=\"StructureDefinition-DrugExposure.html\" title=\"Drug Exposure OMOP Table\">http://hl7.org/fhir/uv/omop/StructureDefinition/DrugExposure</a><span style=\"color: navy\">" </span><b>alias </b>DrugExpTable <b>as </b><b>target</b>\r\n\r\n<b>group </b>MedExposure<span style=\"color: navy\">(</span><b>source</b> <span style=\"color: maroon\">src</span><span style=\"color: navy\"> : </span>MedState, <b>target</b> <span style=\"color: maroon\">tgt</span><span style=\"color: navy\"> : </span>DrugExpTable<span style=\"color: navy\">)</span><span style=\"color: navy\"> {\r\n</span> src<b> where </b><span style=\"color: navy\">(</span>src.effective.empty().not()<span style=\"color: navy\">)</span><b> then</b><span style=\"color: navy\"> {\r\n</span> 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.id<b> as </b><span style=\"color: maroon\">id</span><span style=\"color: navy\"><b> -> </b></span>tgt.drug_exposure_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>"medID"</i><span style=\"color: navy\">;</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.medication<span style=\"color: navy\"> : </span>CodeableReference<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.concept<b> as </b><span style=\"color: maroon\">scs</span><span style=\"color: navy\"><b> -> </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span> scs.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\">a</span><span style=\"color: navy\"><b> -> </b></span>tgt.drug_concept_id = <span style=\"color: maroon\">a</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 src.effective<span style=\"color: navy\"> : </span>dateTime<b> as </b><span style=\"color: maroon\">edt</span><span style=\"color: navy\"><b> -> </b></span> tgt.drug_exposure_start_datetime = <span style=\"color: maroon\">edt</span><span style=\"color: navy\">, </span> tgt.drug_exposure_start_date = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">edt</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'date'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">;</span>\r\n src.effective<span style=\"color: navy\"> : </span>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\">fps</span><span style=\"color: navy\"><b> -> </b></span> tgt.drug_exposure_start_datetime = <span style=\"color: maroon\">fps</span><span style=\"color: navy\">, </span> tgt.drug_exposure_start_date = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">fps</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'date'</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.effective<span style=\"color: navy\"> : </span>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.end<b> as </b><span style=\"color: maroon\">fpe</span><span style=\"color: navy\"><b> -> </b></span> tgt.drug_exposure_end_datetime = <span style=\"color: maroon\">fpe</span><span style=\"color: navy\">, </span> tgt.drug_exposure_end_date = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">fpe</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'date'</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.effective<span style=\"color: navy\"> : </span>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.end<b> as </b><span style=\"color: maroon\">fpe</span><span style=\"color: navy\"><b> -> </b></span>tgt.verbatim_end_date = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">fpe</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'date'</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.category<span style=\"color: navy\"> : </span>CodeableConcept<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.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\">a</span><span style=\"color: navy\"><b> -> </b></span>tgt.drug_type_concept_id = <span style=\"color: maroon\">a</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 src.reason<span style=\"color: navy\"> : </span>CodeableReference<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.concept<b> as </b><span style=\"color: maroon\">scs</span><span style=\"color: navy\"><b> -> </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span> scs.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\">a</span><span style=\"color: navy\"><b> -> </b></span>tgt.stop_reason = <span style=\"color: maroon\">a</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>"medMapping"</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/MedicationMap",
"identifier" : [
{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.40.77.43.12"
}
],
"version" : "2.0.0-ballot",
"name" : "MedicationMap",
"title" : "Mapping MedicationStatement resource to DrugExposure OMOP Domain",
"status" : "active",
"date" : "2026-08-14T16:09:20+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 MedicationStatement instances to OMOP Drug Exposure Table objects. NOTE: It does not map FHIR MedicationRequest instances although there is a discussion of those instances in the notes.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"structure" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"mode" : "source",
"alias" : "MedState"
},
{
"url" : "http://hl7.org/fhir/uv/omop/StructureDefinition/DrugExposure",
"mode" : "target",
"alias" : "DrugExpTable"
}
],
"group" : [
{
"name" : "MedExposure",
"input" : [
{
"name" : "src",
"type" : "MedState",
"mode" : "source"
},
{
"name" : "tgt",
"type" : "DrugExpTable",
"mode" : "target"
}
],
"rule" : [
{
"name" : "medMapping",
"source" : [
{
"context" : "src",
"condition" : "src.effective.empty().not()"
}
],
"rule" : [
{
"name" : "medID",
"source" : [
{
"context" : "src",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "id",
"source" : [
{
"context" : "s",
"element" : "id",
"variable" : "id"
}
],
"target" : [
{
"context" : "tgt",
"element" : "drug_exposure_id",
"transform" : "cast",
"parameter" : [
{
"valueId" : "id"
},
{
"valueString" : "integer"
}
]
}
]
}
]
},
{
"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)"
}
]
}
]
}
]
},
{
"name" : "medicationCodeableReference",
"source" : [
{
"context" : "src",
"type" : "CodeableReference",
"element" : "medication",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "concept",
"source" : [
{
"context" : "s",
"element" : "concept",
"variable" : "scs"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "coding",
"source" : [
{
"context" : "scs",
"element" : "coding",
"variable" : "sc"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "code",
"source" : [
{
"context" : "sc",
"element" : "code",
"variable" : "a"
}
],
"target" : [
{
"context" : "tgt",
"element" : "drug_concept_id",
"transform" : "copy",
"parameter" : [
{
"valueId" : "a"
}
]
}
]
}
]
}
]
}
]
},
{
"name" : "effectiveDateTime",
"source" : [
{
"context" : "src",
"type" : "dateTime",
"element" : "effective",
"variable" : "edt"
}
],
"target" : [
{
"context" : "tgt",
"element" : "drug_exposure_start_datetime",
"transform" : "copy",
"parameter" : [
{
"valueId" : "edt"
}
]
},
{
"context" : "tgt",
"element" : "drug_exposure_start_date",
"transform" : "cast",
"parameter" : [
{
"valueId" : "edt"
},
{
"valueString" : "date"
}
]
}
]
},
{
"name" : "effectivePeriod",
"source" : [
{
"context" : "src",
"type" : "Period",
"element" : "effective",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "start",
"source" : [
{
"context" : "s",
"element" : "start",
"variable" : "fps"
}
],
"target" : [
{
"context" : "tgt",
"element" : "drug_exposure_start_datetime",
"transform" : "copy",
"parameter" : [
{
"valueId" : "fps"
}
]
},
{
"context" : "tgt",
"element" : "drug_exposure_start_date",
"transform" : "cast",
"parameter" : [
{
"valueId" : "fps"
},
{
"valueString" : "date"
}
]
}
]
}
]
},
{
"name" : "effectivePeriod",
"source" : [
{
"context" : "src",
"type" : "Period",
"element" : "effective",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "end",
"source" : [
{
"context" : "s",
"element" : "end",
"variable" : "fpe"
}
],
"target" : [
{
"context" : "tgt",
"element" : "drug_exposure_end_datetime",
"transform" : "copy",
"parameter" : [
{
"valueId" : "fpe"
}
]
},
{
"context" : "tgt",
"element" : "drug_exposure_end_date",
"transform" : "cast",
"parameter" : [
{
"valueId" : "fpe"
},
{
"valueString" : "date"
}
]
}
]
}
]
},
{
"name" : "effectivePeriod",
"source" : [
{
"context" : "src",
"type" : "Period",
"element" : "effective",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "end",
"source" : [
{
"context" : "s",
"element" : "end",
"variable" : "fpe"
}
],
"target" : [
{
"context" : "tgt",
"element" : "verbatim_end_date",
"transform" : "cast",
"parameter" : [
{
"valueId" : "fpe"
},
{
"valueString" : "date"
}
]
}
]
}
]
},
{
"name" : "categoryCodeableConcept",
"source" : [
{
"context" : "src",
"type" : "CodeableConcept",
"element" : "category",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "coding",
"source" : [
{
"context" : "s",
"element" : "coding",
"variable" : "sc"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "code",
"source" : [
{
"context" : "sc",
"element" : "code",
"variable" : "a"
}
],
"target" : [
{
"context" : "tgt",
"element" : "drug_type_concept_id",
"transform" : "copy",
"parameter" : [
{
"valueId" : "a"
}
]
}
]
}
]
}
]
},
{
"name" : "reasonCodeableReference",
"source" : [
{
"context" : "src",
"type" : "CodeableReference",
"element" : "reason",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "concept",
"source" : [
{
"context" : "s",
"element" : "concept",
"variable" : "scs"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "coding",
"source" : [
{
"context" : "scs",
"element" : "coding",
"variable" : "sc"
}
],
"target" : [
{
"context" : "tgt"
}
],
"rule" : [
{
"name" : "code",
"source" : [
{
"context" : "sc",
"element" : "code",
"variable" : "a"
}
],
"target" : [
{
"context" : "tgt",
"element" : "stop_reason",
"transform" : "copy",
"parameter" : [
{
"valueId" : "a"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
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-08-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change