FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureMap/ImmunizationMap

Packagehl7.fhir.uv.omop
Resource TypeStructureMap
IdImmunizationMap
FHIR VersionR5
Sourcehttp://hl7.org/fhir/uv/omop/https://build.fhir.org/ig/HL7/fhir-omop-ig/StructureMap-ImmunizationMap.html
URLhttp://hl7.org/fhir/uv/omop/StructureMap/ImmunizationMap
Version1.0.0-ballot
Statusdraft
Date2025-07-29T17:40:15+00:00
NameImmunizationMap
TitleMapping Immunization resource to Drug Exposure OMOP Domain
Realmuv
Authorityhl7
DescriptionThis mapping maps FHIR Immunization instances to OMOP Drug Exposure Table objects.

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: StructureMap ImmunizationMap

/// 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.vaccineCode as s -> tgt then {
    s.coding as sc -> tgt then {
      sc.code ->  tgt.drug_concept_id,  tgt.drug_source_value,  tgt.drug_source_concept_id;
    };
  }; // src.id as id -> tgt.drug_exposure_id = cast(id, "integer");
  src.doseQuantity as s -> tgt then {
    s.value as s -> tgt.quantity = cast(s, 'decimal');
    s.code as s -> tgt.dose_unit_source_value = cast(s, 'string');
  }; // src.patient as s -> tgt then {
  src.route as s -> tgt then {
    s.text as s -> tgt.route_source_value = cast(s, 'string');
    s.coding as sc -> tgt then {
      sc.code ->  tgt.route_concept_id,  tgt.route_source_value;
    };
  };
  src.occurrence : dateTime as odt ->  tgt.drug_exposure_start_date = cast(odt, 'date'),  tgt.drug_exposure_start_datetime = odt,  tgt.drug_exposure_end_date = cast(odt, 'date'),  tgt.drug_exposure_end_datetime = odt;
  src.lotNumber as s -> tgt.lot_number = cast(s, 'string'); // src.encounter as s -> tgt then {
}


Source

{
  "resourceType": "StructureMap",
  "id": "ImmunizationMap",
  "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-ballot",
  "name": "ImmunizationMap",
  "title": "Mapping Immunization resource to Drug Exposure OMOP Domain",
  "status": "draft",
  "date": "2025-07-29T17:40: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": "vaccineCode",
          "source": [
            {
              "context": "src",
              "element": "vaccineCode",
              "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"
                    }
                  ],
                  "target": [
                    {
                      "context": "tgt",
                      "element": "drug_concept_id"
                    },
                    {
                      "context": "tgt",
                      "element": "drug_source_value"
                    },
                    {
                      "context": "tgt",
                      "element": "drug_source_concept_id"
                    }
                  ]
                }
              ]
            }
          ],
          "documentation": "src.id as id -> tgt.drug_exposure_id = cast(id, \"integer\");"
        },
        {
          "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": "cast",
                  "parameter": [
                    {
                      "valueId": "s"
                    },
                    {
                      "valueString": "decimal"
                    }
                  ]
                }
              ]
            },
            {
              "name": "code",
              "source": [
                {
                  "context": "s",
                  "element": "code",
                  "variable": "s"
                }
              ],
              "target": [
                {
                  "context": "tgt",
                  "element": "dose_unit_source_value",
                  "transform": "cast",
                  "parameter": [
                    {
                      "valueId": "s"
                    },
                    {
                      "valueString": "string"
                    }
                  ]
                }
              ]
            }
          ],
          "documentation": "src.patient as s -> tgt then {"
        },
        {
          "name": "route",
          "source": [
            {
              "context": "src",
              "element": "route",
              "variable": "s"
            }
          ],
          "target": [
            {
              "transform": "copy",
              "parameter": [
                {
                  "valueId": "tgt"
                }
              ]
            }
          ],
          "rule": [
            {
              "name": "text",
              "source": [
                {
                  "context": "s",
                  "element": "text",
                  "variable": "s"
                }
              ],
              "target": [
                {
                  "context": "tgt",
                  "element": "route_source_value",
                  "transform": "cast",
                  "parameter": [
                    {
                      "valueId": "s"
                    },
                    {
                      "valueString": "string"
                    }
                  ]
                }
              ]
            },
            {
              "name": "coding",
              "source": [
                {
                  "context": "s",
                  "element": "coding",
                  "variable": "sc"
                }
              ],
              "target": [
                {
                  "transform": "copy",
                  "parameter": [
                    {
                      "valueId": "tgt"
                    }
                  ]
                }
              ],
              "rule": [
                {
                  "name": "code",
                  "source": [
                    {
                      "context": "sc",
                      "element": "code"
                    }
                  ],
                  "target": [
                    {
                      "context": "tgt",
                      "element": "route_concept_id"
                    },
                    {
                      "context": "tgt",
                      "element": "route_source_value"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "name": "occurrenceDateTime",
          "source": [
            {
              "context": "src",
              "type": "dateTime",
              "element": "occurrence",
              "variable": "odt"
            }
          ],
          "target": [
            {
              "context": "tgt",
              "element": "drug_exposure_start_date",
              "transform": "cast",
              "parameter": [
                {
                  "valueId": "odt"
                },
                {
                  "valueString": "date"
                }
              ]
            },
            {
              "context": "tgt",
              "element": "drug_exposure_start_datetime",
              "transform": "copy",
              "parameter": [
                {
                  "valueId": "odt"
                }
              ]
            },
            {
              "context": "tgt",
              "element": "drug_exposure_end_date",
              "transform": "cast",
              "parameter": [
                {
                  "valueId": "odt"
                },
                {
                  "valueString": "date"
                }
              ]
            },
            {
              "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",
              "transform": "cast",
              "parameter": [
                {
                  "valueId": "s"
                },
                {
                  "valueString": "string"
                }
              ]
            }
          ],
          "documentation": "src.encounter as s -> tgt then {"
        }
      ]
    }
  ]
}