FHIR IG analytics| Package | hl7.fhir.uv.omop |
| Resource Type | StructureMap |
| Id | StructureMap-ImmunizationMap.json |
| FHIR Version | R5 |
| Source | https://build.fhir.org/ig/HL7/fhir-omop-ig/StructureMap-ImmunizationMap.html |
| URL | http://hl7.org/fhir/uv/omop/StructureMap/ImmunizationMap |
| Version | 1.0.0 |
| Status | draft |
| Date | 2026-04-02T22:51:15+00:00 |
| Name | ImmunizationMap |
| Title | Mapping Immunization resource to Drug Exposure OMOP Domain |
| Realm | uv |
| Authority | hl7 |
| Description | This mapping maps FHIR Immunization instances to OMOP Drug Exposure Table objects. |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureMap ImmunizationMap
Language: en
/// url = 'http://hl7.org/fhir/uv/omop/StructureMap/ImmunizationMap' /// name = 'ImmunizationMap' /// title = 'Mapping Immunization resource to Drug Exposure OMOP Domain' /// status = 'draft' uses "http://hl7.org/fhir/StructureDefinition/Immunization" alias Immunization as source uses "http://hl7.org/fhir/uv/omop/StructureDefinition/DrugExposure" alias DrugExposureTable as target group DrugExposure(source src : Immunization, target tgt : DrugExposureTable) { src.id -> tgt.drug_exposure_id = '1'; // OMOP Drug Exposure ID would be a map from FHIR ID to an external key src.patient -> tgt.person_id = '1'; // OMOP Person ID would be a map from the FHIR Immunization Patient reference to an external key src.encounter -> tgt.visit_occurrence_id = '1'; // OMOP Visit Occurrence ID would be a map from the FHIR Immunization Encounter reference to an external key src.vaccineCode as s -> tgt then { s.coding first as sc -> tgt then { sc.code as c -> tgt.drug_concept_id = translate(c, 'http://hl7.org/fhir/uv/omop/ConceptMap/ImmunizationVaccine', 'code'), tgt.drug_source_value = c; }; }; src.doseQuantity as s -> tgt then { s.value as s -> tgt.quantity = s; }; src.route as s -> tgt then { s.coding as sc -> tgt then { sc.code as c -> tgt.route_concept_id = translate(c, 'http://hl7.org/fhir/uv/omop/ConceptMap/ImmunizationRoute', 'code'), tgt.route_source_value = c; }; }; src where (src.informationSource.empty()) -> tgt.drug_type_concept_id = '32818' "emptysource"; src.informationSource as s -> tgt then { s.concept as concept -> tgt then { concept.coding as sc -> tgt then { sc.code as c -> tgt.drug_type_concept_id = translate(c, 'http://hl7.org/fhir/uv/omop/ConceptMap/ImmunizationSource', 'code'); }; }; }; src.occurrence : dateTime as odt -> tgt.drug_exposure_start_date = (src.occurrence.toString().substring(0, 10)), tgt.drug_exposure_start_datetime = odt, tgt.drug_exposure_end_date = (src.occurrence.toString().substring(0, 10)), tgt.drug_exposure_end_datetime = odt; src.lotNumber as s -> tgt.lot_number; }
{
"resourceType": "StructureMap",
"id": "ImmunizationMap",
"language": "en",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"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"
}
]
}
]
}
]
}