FHIR to OMOP FHIR IG
2.0.0-ballot - STU 1 Ballot International flag

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

: Mapping Procedure resource to Procedure Occurrence OMOP Domain

Page standards status: Trial-use Maturity Level: 2

Raw json | Download

{
  "resourceType" : "StructureMap",
  "id" : "ProcedureMap",
  "language" : "en",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureMap ProcedureMap</b></p><a name=\"ProcedureMap\"> </a><a name=\"hcProcedureMap\"> </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/ProcedureMap'</span>\r\n<span style=\"color: #cc00cc\">/// <b>name</b> = </span><span style=\"color: blue\">'ProcedureMap'</span>\r\n<span style=\"color: #cc00cc\">/// <b>title</b> = </span><span style=\"color: blue\">'Mapping Procedure resource to Procedure Occurrence 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 Procedure instances to OMOP Procedure Occurrence Table objects.'</span>\r\n\r\n<b>uses</b><span style=\"color: navy\"> &quot;</span><a href=\"http://hl7.org/fhir/R5/procedure.html\" title=\"Procedure\">http://hl7.org/fhir/StructureDefinition/Procedure</a><span style=\"color: navy\">&quot; </span><b>alias </b>Procedure <b>as </b><b>source</b>\r\n<b>uses</b><span style=\"color: navy\"> &quot;</span><a href=\"StructureDefinition-ProcedureOccurrence.html\" title=\"Procedure Occurrence OMOP Table\">http://hl7.org/fhir/uv/omop/StructureDefinition/ProcedureOccurrence</a><span style=\"color: navy\">&quot; </span><b>alias </b>ProcedureTable <b>as </b><b>target</b>\r\n\r\n<b>group </b>ProcedureOccurrence<span style=\"color: navy\">(</span><b>source</b> <span style=\"color: maroon\">src</span><span style=\"color: navy\"> : </span>Procedure, <b>target</b> <span style=\"color: maroon\">tgt</span><span style=\"color: navy\"> : </span>ProcedureTable<span style=\"color: navy\">)</span><span style=\"color: navy\"> {\r\n</span>  src<b> where </b><span style=\"color: navy\">(</span>src.occurrence.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> -&gt; </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> -&gt; </b></span>tgt.procedure_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>&quot;procedureID&quot;</i><span style=\"color: navy\">;</span>\r\n    src.subject<b> as </b><span style=\"color: maroon\">subject</span><span style=\"color: navy\"><b> -&gt; </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> -&gt; </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.code<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -&gt; </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> -&gt; </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> -&gt; </b></span> tgt.procedure_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/ProcedureType'</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'code'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">, </span> tgt.procedure_source_value = <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.occurrence<span style=\"color: navy\"> : </span>dateTime<b> as </b><span style=\"color: maroon\">edt</span><span style=\"color: navy\"><b> -&gt; </b></span> tgt.procedure_datetime = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">edt</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'dateTime'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">, </span> tgt.procedure_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.occurrence<span style=\"color: navy\"> : </span>Period<b> as </b><span style=\"color: maroon\">s</span><span style=\"color: navy\"><b> -&gt; </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span>      s.start<b> as </b><span style=\"color: maroon\">start</span><span style=\"color: navy\"><b> -&gt; </b></span> tgt.procedure_datetime = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">start</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'dateTime'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">, </span> tgt.procedure_date = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">start</span><span style=\"color: navy\">, </span><span style=\"color: blue\">'date'</span><span style=\"color: navy\">)</span><span style=\"color: navy\">;</span>\r\n      s.end<b> as </b><span style=\"color: maroon\">end</span><span style=\"color: navy\"><b> -&gt; </b></span> tgt.procedure_end_datetime<span style=\"color: navy\">, </span> tgt.procedure_end_date = <b>cast</b><span style=\"color: navy\">(</span><span style=\"color: maroon\">end</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.encounter<b> as </b><span style=\"color: maroon\">encounter</span><span style=\"color: navy\"><b> -&gt; </b></span>tgt<b> then</b><span style=\"color: navy\"> {\r\n</span>      encounter.reference<b> as </b><span style=\"color: maroon\">e</span><span style=\"color: navy\"><b> -&gt; </b></span>tgt.visit_occurrence_id = <span style=\"color: navy\">(</span>%e.substring(%e.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  <span style=\"color: navy\">}</span> <i>&quot;procedureMapping&quot;</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/ProcedureMap",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.4.642.40.77.43.9"
    }
  ],
  "version" : "2.0.0-ballot",
  "name" : "ProcedureMap",
  "title" : "Mapping Procedure resource to Procedure Occurrence 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 Procedure instances to OMOP Procedure Occurrence 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/Procedure",
      "mode" : "source",
      "alias" : "Procedure"
    },
    {
      "url" : "http://hl7.org/fhir/uv/omop/StructureDefinition/ProcedureOccurrence",
      "mode" : "target",
      "alias" : "ProcedureTable"
    }
  ],
  "group" : [
    {
      "name" : "ProcedureOccurrence",
      "input" : [
        {
          "name" : "src",
          "type" : "Procedure",
          "mode" : "source"
        },
        {
          "name" : "tgt",
          "type" : "ProcedureTable",
          "mode" : "target"
        }
      ],
      "rule" : [
        {
          "name" : "procedureMapping",
          "source" : [
            {
              "context" : "src",
              "condition" : "src.occurrence.empty().not()"
            }
          ],
          "rule" : [
            {
              "name" : "procedureID",
              "source" : [
                {
                  "context" : "src",
                  "variable" : "s"
                }
              ],
              "target" : [
                {
                  "context" : "tgt"
                }
              ],
              "rule" : [
                {
                  "name" : "id",
                  "source" : [
                    {
                      "context" : "s",
                      "element" : "id",
                      "variable" : "id"
                    }
                  ],
                  "target" : [
                    {
                      "context" : "tgt",
                      "element" : "procedure_occurrence_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" : "code",
              "source" : [
                {
                  "context" : "src",
                  "element" : "code",
                  "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" : "procedure_concept_id",
                          "transform" : "translate",
                          "parameter" : [
                            {
                              "valueId" : "a"
                            },
                            {
                              "valueString" : "http://hl7.org/fhir/uv/omop/ConceptMap/ProcedureType"
                            },
                            {
                              "valueString" : "code"
                            }
                          ]
                        },
                        {
                          "context" : "tgt",
                          "element" : "procedure_source_value",
                          "transform" : "copy",
                          "parameter" : [
                            {
                              "valueId" : "a"
                            }
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            },
            {
              "name" : "occurrenceDateTime",
              "source" : [
                {
                  "context" : "src",
                  "type" : "dateTime",
                  "element" : "occurrence",
                  "variable" : "edt"
                }
              ],
              "target" : [
                {
                  "context" : "tgt",
                  "element" : "procedure_datetime",
                  "transform" : "cast",
                  "parameter" : [
                    {
                      "valueId" : "edt"
                    },
                    {
                      "valueString" : "dateTime"
                    }
                  ]
                },
                {
                  "context" : "tgt",
                  "element" : "procedure_date",
                  "transform" : "cast",
                  "parameter" : [
                    {
                      "valueId" : "edt"
                    },
                    {
                      "valueString" : "date"
                    }
                  ]
                }
              ]
            },
            {
              "name" : "occurrencePeriod",
              "source" : [
                {
                  "context" : "src",
                  "type" : "Period",
                  "element" : "occurrence",
                  "variable" : "s"
                }
              ],
              "target" : [
                {
                  "context" : "tgt"
                }
              ],
              "rule" : [
                {
                  "name" : "start",
                  "source" : [
                    {
                      "context" : "s",
                      "element" : "start",
                      "variable" : "start"
                    }
                  ],
                  "target" : [
                    {
                      "context" : "tgt",
                      "element" : "procedure_datetime",
                      "transform" : "cast",
                      "parameter" : [
                        {
                          "valueId" : "start"
                        },
                        {
                          "valueString" : "dateTime"
                        }
                      ]
                    },
                    {
                      "context" : "tgt",
                      "element" : "procedure_date",
                      "transform" : "cast",
                      "parameter" : [
                        {
                          "valueId" : "start"
                        },
                        {
                          "valueString" : "date"
                        }
                      ]
                    }
                  ]
                },
                {
                  "name" : "end",
                  "source" : [
                    {
                      "context" : "s",
                      "element" : "end",
                      "variable" : "end"
                    }
                  ],
                  "target" : [
                    {
                      "context" : "tgt",
                      "element" : "procedure_end_datetime"
                    },
                    {
                      "context" : "tgt",
                      "element" : "procedure_end_date",
                      "transform" : "cast",
                      "parameter" : [
                        {
                          "valueId" : "end"
                        },
                        {
                          "valueString" : "date"
                        }
                      ]
                    }
                  ]
                }
              ]
            },
            {
              "name" : "encounter",
              "source" : [
                {
                  "context" : "src",
                  "element" : "encounter",
                  "variable" : "encounter"
                }
              ],
              "target" : [
                {
                  "context" : "tgt"
                }
              ],
              "rule" : [
                {
                  "name" : "reference",
                  "source" : [
                    {
                      "context" : "encounter",
                      "element" : "reference",
                      "variable" : "e"
                    }
                  ],
                  "target" : [
                    {
                      "context" : "tgt",
                      "element" : "visit_occurrence_id",
                      "transform" : "evaluate",
                      "parameter" : [
                        {
                          "valueString" : "%e.substring(%e.indexOf('/') + 1)"
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}