FHIR to OMOP FHIR IG
1.0.0 - INFORMATIVE 1
FHIR to OMOP FHIR IG
1.0.0 - INFORMATIVE 1
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 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/fhir-omop-ig/ and changes regularly. See the Directory of published versions
| Page standards status: Informative | Maturity Level: 1 |
{
"resourceType" : "StructureMap",
"id" : "ImmunizationMap",
"language" : "en",
"text" : {
"status" : "generated",
"div" : "<div xml:lang=\"en\" xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"en\"><p class=\"res-header-id\"><b>Generated Narrative: StructureMap ImmunizationMap</b></p><a name=\"ImmunizationMap\"> </a><a name=\"hcImmunizationMap\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Language: en</p></div><pre class=\"fml\">\r\n<span style=\"color: #cc00cc\">/// <b>url</b> = </span><span style=\"color: blue\">'http://hl7.org/fhir/uv/omop/StructureMap/ImmunizationMap'</span>\r\n<span style=\"color: #cc00cc\">/// <b>name</b> = </span><span style=\"color: blue\">'ImmunizationMap'</span>\r\n<span style=\"color: #cc00cc\">/// <b>title</b> = </span><span style=\"color: blue\">'Mapping Immunization resource to Drug Exposure OMOP Domain'</span>\r\n<span style=\"color: #cc00cc\">/// <b>status</b> = </span><span style=\"color: blue\">'draft'</span>\r\n\r\n<b>uses</b><span style=\"color: navy\"> "</span><a href=\"http://hl7.org/fhir/R5/immunization.html\" title=\"Immunization\">http://hl7.org/fhir/StructureDefinition/Immunization</a><span style=\"color: navy\">" </span><b>alias </b>Immunization <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>DrugExposureTable <b>as </b><b>target</b>\r\n\r\n<b>group </b>DrugExposure<span style=\"color: navy\">(</span><b>source</b> <span style=\"color: maroon\">src</span><span style=\"color: navy\"> : </span>Immunization, <b>target</b> <span style=\"color: maroon\">tgt</span><span style=\"color: navy\"> : </span>DrugExposureTable<span style=\"color: navy\">)</span><span style=\"color: navy\"> {\r\n</span> src.id<span style=\"color: navy\"><b> -> </b></span>tgt.drug_exposure_id = <span style=\"color: blue\">'1'</span><span style=\"color: navy\">;</span> <span style=\"color: navy\">// </span><span style=\"color: green\">OMOP Drug Exposure ID would be a map from FHIR ID to an external key</span>\r\n src.patient<span style=\"color: navy\"><b> -> </b></span>tgt.person_id = <span style=\"color: blue\">'1'</span><span style=\"color: navy\">;</span> <span style=\"color: navy\">// </span><span style=\"color: green\">OMOP Person ID would be a map from the FHIR Immunization Patient reference to an external key</span>\r\n src.encounter<span style=\"color: navy\"><b> -> </b></span>tgt.visit_occurrence_id = <span style=\"color: blue\">'1'</span><span style=\"color: navy\">;</span> <span style=\"color: navy\">// </span><span style=\"color: green\">OMOP Visit Occurrence ID would be a map from the FHIR Immunization Encounter reference to an external key</span>\r\n src.vaccineCode<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -> </b></span><span style=\"color: maroon\">tgt</span><b> then</b><span style=\"color: navy\"> {\r\n</span> s.coding first<b> as </b><span style=\"color: maroon\">sc</span><span style=\"color: navy\"><b> -> </b></span><span style=\"color: maroon\">tgt</span><b> then</b><span style=\"color: navy\"> {\r\n</span> sc.code<b> as </b><span style=\"color: maroon\">c</span><span style=\"color: navy\"><b> -> </b></span> tgt.drug_concept_id = <b>translate</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">c</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'http://hl7.org/fhir/uv/omop/ConceptMap/ImmunizationVaccine'</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'code'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">, </span> tgt.drug_source_value = <span style=\"color: maroon\">c</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.doseQuantity<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -> </b></span><span style=\"color: maroon\">tgt</span><b> then</b><span style=\"color: navy\"> {\r\n</span> s.value<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -> </b></span>tgt.quantity = <span style=\"color: maroon\">s</span><span style=\"color: navy\">;</span>\r\n <span style=\"color: navy\">}</span><span style=\"color: navy\">;</span>\r\n src.route<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -> </b></span><span style=\"color: maroon\">tgt</span><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><span style=\"color: maroon\">tgt</span><b> then</b><span style=\"color: navy\"> {\r\n</span> sc.code<b> as </b><span style=\"color: maroon\">c</span><span style=\"color: navy\"><b> -> </b></span> tgt.route_concept_id = <b>translate</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">c</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'http://hl7.org/fhir/uv/omop/ConceptMap/ImmunizationRoute'</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'code'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">, </span> tgt.route_source_value = <span style=\"color: maroon\">c</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<b> where </b>(src.informationSource.empty())<span style=\"color: navy\"><b> -> </b></span>tgt.drug_type_concept_id = <span style=\"color: blue\">'32818'</span> <i>"emptysource"</i><span style=\"color: navy\">;</span>\r\n src.informationSource<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -> </b></span><span style=\"color: maroon\">tgt</span><b> then</b><span style=\"color: navy\"> {\r\n</span> s.concept<b> as </b><span style=\"color: maroon\">concept</span><span style=\"color: navy\"><b> -> </b></span><span style=\"color: maroon\">tgt</span><b> then</b><span style=\"color: navy\"> {\r\n</span> concept.coding<b> as </b><span style=\"color: maroon\">sc</span><span style=\"color: navy\"><b> -> </b></span><span style=\"color: maroon\">tgt</span><b> then</b><span style=\"color: navy\"> {\r\n</span> sc.code<b> as </b><span style=\"color: maroon\">c</span><span style=\"color: navy\"><b> -> </b></span>tgt.drug_type_concept_id = <b>translate</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">c</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'http://hl7.org/fhir/uv/omop/ConceptMap/ImmunizationSource'</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'code'</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 src.occurrence<span style=\"color: navy\"> : </span>dateTime<b> as </b><span style=\"color: maroon\">odt</span><span style=\"color: navy\"><b> -> </b></span> tgt.drug_exposure_start_date = <span style=\"color: navy\">(</span>src.occurrence.toString().substring(0, 10)<span style=\"color: navy\">)</span><span style=\"color: navy\">, </span> tgt.drug_exposure_start_datetime = <span style=\"color: maroon\">odt</span><span style=\"color: navy\">, </span> tgt.drug_exposure_end_date = <span style=\"color: navy\">(</span>src.occurrence.toString().substring(0, 10)<span style=\"color: navy\">)</span><span style=\"color: navy\">, </span> tgt.drug_exposure_end_datetime = <span style=\"color: maroon\">odt</span><span style=\"color: navy\">;</span>\r\n src.lotNumber<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -> </b></span>tgt.lot_number<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" : 1,
"_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" : "informative",
"_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/ImmunizationMap",
"version" : "1.0.0",
"name" : "ImmunizationMap",
"title" : "Mapping Immunization resource to Drug Exposure OMOP Domain",
"status" : "draft",
"date" : "2026-04-02T22:51:15+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 Immunization instances to OMOP Drug Exposure 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/Immunization",
"mode" : "source",
"alias" : "Immunization"
},
{
"url" : "http://hl7.org/fhir/uv/omop/StructureDefinition/DrugExposure",
"mode" : "target",
"alias" : "DrugExposureTable"
}
],
"group" : [
{
"name" : "DrugExposure",
"input" : [
{
"name" : "src",
"type" : "Immunization",
"mode" : "source"
},
{
"name" : "tgt",
"type" : "DrugExposureTable",
"mode" : "target"
}
],
"rule" : [
{
"name" : "id",
"source" : [
{
"context" : "src",
"element" : "id"
}
],
"target" : [
{
"context" : "tgt",
"element" : "drug_exposure_id",
"transform" : "copy",
"parameter" : [
{
"valueString" : "1"
}
]
}
],
"documentation" : "OMOP Drug Exposure ID would be a map from FHIR ID to an external key"
},
{
"name" : "patient",
"source" : [
{
"context" : "src",
"element" : "patient"
}
],
"target" : [
{
"context" : "tgt",
"element" : "person_id",
"transform" : "copy",
"parameter" : [
{
"valueString" : "1"
}
]
}
],
"documentation" : "OMOP Person ID would be a map from the FHIR Immunization Patient reference to an external key"
},
{
"name" : "encounter",
"source" : [
{
"context" : "src",
"element" : "encounter"
}
],
"target" : [
{
"context" : "tgt",
"element" : "visit_occurrence_id",
"transform" : "copy",
"parameter" : [
{
"valueString" : "1"
}
]
}
],
"documentation" : "OMOP Visit Occurrence ID would be a map from the FHIR Immunization Encounter reference to an external key"
},
{
"name" : "vaccineCode",
"source" : [
{
"context" : "src",
"element" : "vaccineCode",
"variable" : "s"
}
],
"target" : [
{
"transform" : "copy",
"parameter" : [
{
"valueId" : "tgt"
}
]
}
],
"rule" : [
{
"name" : "coding",
"source" : [
{
"context" : "s",
"element" : "coding",
"listMode" : "first",
"variable" : "sc"
}
],
"target" : [
{
"transform" : "copy",
"parameter" : [
{
"valueId" : "tgt"
}
]
}
],
"rule" : [
{
"name" : "code",
"source" : [
{
"context" : "sc",
"element" : "code",
"variable" : "c"
}
],
"target" : [
{
"context" : "tgt",
"element" : "drug_concept_id",
"transform" : "translate",
"parameter" : [
{
"valueId" : "c"
},
{
"valueString" : "http://hl7.org/fhir/uv/omop/ConceptMap/ImmunizationVaccine"
},
{
"valueString" : "code"
}
]
},
{
"context" : "tgt",
"element" : "drug_source_value",
"transform" : "copy",
"parameter" : [
{
"valueId" : "c"
}
]
}
]
}
]
}
]
},
{
"name" : "doseQuantity",
"source" : [
{
"context" : "src",
"element" : "doseQuantity",
"variable" : "s"
}
],
"target" : [
{
"transform" : "copy",
"parameter" : [
{
"valueId" : "tgt"
}
]
}
],
"rule" : [
{
"name" : "value",
"source" : [
{
"context" : "s",
"element" : "value",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt",
"element" : "quantity",
"transform" : "copy",
"parameter" : [
{
"valueId" : "s"
}
]
}
]
}
]
},
{
"name" : "route",
"source" : [
{
"context" : "src",
"element" : "route",
"variable" : "s"
}
],
"target" : [
{
"transform" : "copy",
"parameter" : [
{
"valueId" : "tgt"
}
]
}
],
"rule" : [
{
"name" : "coding",
"source" : [
{
"context" : "s",
"element" : "coding",
"variable" : "sc"
}
],
"target" : [
{
"transform" : "copy",
"parameter" : [
{
"valueId" : "tgt"
}
]
}
],
"rule" : [
{
"name" : "code",
"source" : [
{
"context" : "sc",
"element" : "code",
"variable" : "c"
}
],
"target" : [
{
"context" : "tgt",
"element" : "route_concept_id",
"transform" : "translate",
"parameter" : [
{
"valueId" : "c"
},
{
"valueString" : "http://hl7.org/fhir/uv/omop/ConceptMap/ImmunizationRoute"
},
{
"valueString" : "code"
}
]
},
{
"context" : "tgt",
"element" : "route_source_value",
"transform" : "copy",
"parameter" : [
{
"valueId" : "c"
}
]
}
]
}
]
}
]
},
{
"name" : "emptysource",
"source" : [
{
"context" : "src",
"condition" : "(src.informationSource.empty())"
}
],
"target" : [
{
"context" : "tgt",
"element" : "drug_type_concept_id",
"transform" : "copy",
"parameter" : [
{
"valueString" : "32818"
}
]
}
]
},
{
"name" : "informationSource",
"source" : [
{
"context" : "src",
"element" : "informationSource",
"variable" : "s"
}
],
"target" : [
{
"transform" : "copy",
"parameter" : [
{
"valueId" : "tgt"
}
]
}
],
"rule" : [
{
"name" : "concept",
"source" : [
{
"context" : "s",
"element" : "concept",
"variable" : "concept"
}
],
"target" : [
{
"transform" : "copy",
"parameter" : [
{
"valueId" : "tgt"
}
]
}
],
"rule" : [
{
"name" : "coding",
"source" : [
{
"context" : "concept",
"element" : "coding",
"variable" : "sc"
}
],
"target" : [
{
"transform" : "copy",
"parameter" : [
{
"valueId" : "tgt"
}
]
}
],
"rule" : [
{
"name" : "code",
"source" : [
{
"context" : "sc",
"element" : "code",
"variable" : "c"
}
],
"target" : [
{
"context" : "tgt",
"element" : "drug_type_concept_id",
"transform" : "translate",
"parameter" : [
{
"valueId" : "c"
},
{
"valueString" : "http://hl7.org/fhir/uv/omop/ConceptMap/ImmunizationSource"
},
{
"valueString" : "code"
}
]
}
]
}
]
}
]
}
]
},
{
"name" : "occurrenceDateTime",
"source" : [
{
"context" : "src",
"type" : "dateTime",
"element" : "occurrence",
"variable" : "odt"
}
],
"target" : [
{
"context" : "tgt",
"element" : "drug_exposure_start_date",
"transform" : "evaluate",
"parameter" : [
{
"valueString" : "src.occurrence.toString().substring(0, 10)"
}
]
},
{
"context" : "tgt",
"element" : "drug_exposure_start_datetime",
"transform" : "copy",
"parameter" : [
{
"valueId" : "odt"
}
]
},
{
"context" : "tgt",
"element" : "drug_exposure_end_date",
"transform" : "evaluate",
"parameter" : [
{
"valueString" : "src.occurrence.toString().substring(0, 10)"
}
]
},
{
"context" : "tgt",
"element" : "drug_exposure_end_datetime",
"transform" : "copy",
"parameter" : [
{
"valueId" : "odt"
}
]
}
]
},
{
"name" : "lotNumber",
"source" : [
{
"context" : "src",
"element" : "lotNumber",
"variable" : "s"
}
],
"target" : [
{
"context" : "tgt",
"element" : "lot_number"
}
]
}
]
}
]
}
IG © 2023+ HL7 International / Biomedical Research and Regulation.
Package hl7.fhir.uv.omop#1.0.0 based on FHIR 5.0.0.
Generated
2026-04-02
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change