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 MedicationStatement resource to DrugExposure OMOP Domain V4

Page standards status: Trial-use Maturity Level: 2

Raw xml | Download


<StructureMap xmlns="http://hl7.org/fhir">
  <id value="MedicationMapV4"/>
  <language value="en"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureMap MedicationMapV4</b></p><a name="MedicationMapV4"> </a><a name="hcMedicationMapV4"> </a><pre class="fml">
<span style="color: #cc00cc">/// <b>url</b> = </span><span style="color: blue">'http://hl7.org/fhir/uv/omop/StructureMap/MedicationMapV4'</span>
<span style="color: #cc00cc">/// <b>version</b> = </span><span style="color: blue">'2.0.0-ballot'</span>
<span style="color: #cc00cc">/// <b>name</b> = </span><span style="color: blue">'MedicationMapV4'</span>
<span style="color: #cc00cc">/// <b>title</b> = </span><span style="color: blue">'Mapping MedicationStatement resource to DrugExposure OMOP Domain V4'</span>
<span style="color: #cc00cc">/// <b>status</b> = </span><span style="color: blue">'active'</span>
<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>

<b>uses</b><span style="color: navy"> &quot;</span><a href="http://hl7.org/fhir/R4/medicationstatement.html" title="MedicationStatement">http://hl7.org/fhir/StructureDefinition/MedicationStatement|4.0.1</a><span style="color: navy">&quot; </span><b>alias </b>MedState <b>as </b><b>source</b>
<b>uses</b><span style="color: navy"> &quot;</span><a href="StructureDefinition-DrugExposure.html" title="Drug Exposure OMOP Table">http://hl7.org/fhir/uv/omop/StructureDefinition/DrugExposure</a><span style="color: navy">&quot; </span><b>alias </b>DrugExpTable <b>as </b><b>target</b>

<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"> {
</span>  src<b> where </b><span style="color: navy">(</span>src.effective.empty().not() and src.identifier.empty().not()<span style="color: navy">)</span><b> then</b><span style="color: navy"> {
</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"> {
</span>      s.identifier<b> as </b><span style="color: maroon">i</span><span style="color: navy"><b> -&gt; </b></span>tgt<b> then</b><span style="color: navy"> {
</span>        i.value<b> as </b><span style="color: maroon">id</span><span style="color: navy"><b> -&gt; </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>
      <span style="color: navy">}</span> <i>&quot;medIdFromIdentifier&quot;</i><span style="color: navy">;</span>
    <span style="color: navy">}</span> <i>&quot;medicationId&quot;</i><span style="color: navy">;</span>
    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"> {
</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>
    <span style="color: navy">}</span><span style="color: navy">;</span>
    src.medication<span style="color: navy"> : </span>CodeableConcept<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"> {
</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"> {
</span>        sc.code<b> as </b><span style="color: maroon">a</span><span style="color: navy"><b> -&gt; </b></span>tgt.drug_concept_id = <span style="color: maroon">a</span><span style="color: navy">;</span>
      <span style="color: navy">}</span><span style="color: navy">;</span>
    <span style="color: navy">}</span><span style="color: navy">;</span>
    src.medication<span style="color: navy"> : </span>Reference<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"> {
</span>      s.reference<b> as </b><span style="color: maroon">sr</span><span style="color: navy"><b> -&gt; </b></span>tgt.drug_concept_id = <span style="color: maroon">sr</span><span style="color: navy">;</span>
    <span style="color: navy">}</span><span style="color: navy">;</span>
    src.effective<span style="color: navy"> : </span>dateTime<b> as </b><span style="color: maroon">edt</span><span style="color: navy"><b> -&gt; </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>
    src.effective<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"> {
</span>      s.start<b> as </b><span style="color: maroon">fps</span><span style="color: navy"><b> -&gt; </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>
    <span style="color: navy">}</span><span style="color: navy">;</span>
    src.effective<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"> {
</span>      s.end<b> as </b><span style="color: maroon">end</span><span style="color: navy"><b> -&gt; </b></span> tgt.drug_exposure_end_datetime = <span style="color: maroon">end</span><span style="color: navy">, </span> tgt.drug_exposure_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>
    <span style="color: navy">}</span><span style="color: navy">;</span>
    src.effective<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"> {
</span>      s.end<b> as </b><span style="color: maroon">end</span><span style="color: navy"><b> -&gt; </b></span>tgt.verbatim_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>
    <span style="color: navy">}</span><span style="color: navy">;</span>
    src.category<span style="color: navy"> : </span>CodeableConcept<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"> {
</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"> {
</span>        sc.code<b> as </b><span style="color: maroon">a</span><span style="color: navy"><b> -&gt; </b></span>tgt.drug_type_concept_id = <span style="color: maroon">a</span><span style="color: navy">;</span>
      <span style="color: navy">}</span><span style="color: navy">;</span>
    <span style="color: navy">}</span><span style="color: navy">;</span>
    src.reason<span style="color: navy"> : </span>CodeableReference<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"> {
</span>      s.concept<b> as </b><span style="color: maroon">scs</span><span style="color: navy"><b> -&gt; </b></span>tgt<b> then</b><span style="color: navy"> {
</span>        scs.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"> {
</span>          sc.code<b> as </b><span style="color: maroon">a</span><span style="color: navy"><b> -&gt; </b></span>tgt.stop_reason = <span style="color: maroon">a</span><span style="color: navy">;</span>
        <span style="color: navy">}</span><span style="color: navy">;</span>
      <span style="color: navy">}</span><span style="color: navy">;</span>
    <span style="color: navy">}</span><span style="color: navy">;</span>
  <span style="color: navy">}</span> <i>&quot;medMapping&quot;</i><span style="color: navy">;</span>
<span style="color: navy">}

</span></pre></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="brr"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="2">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"/>
      </extension>
    </valueInteger>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"/>
      </extension>
    </valueCode>
  </extension>
  <url value="http://hl7.org/fhir/uv/omop/StructureMap/MedicationMapV4"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.40.80.43.24"/>
  </identifier>
  <version value="2.0.0-ballot"/>
  <name value="MedicationMapV4"/>
  <title
         value="Mapping MedicationStatement resource to DrugExposure OMOP Domain V4"/>
  <status value="active"/>
  <date value="2026-11-06T00:33:48+00:00"/>
  <publisher value="HL7 International / Biomedical Research and Regulation"/>
  <contact>
    <name value="HL7 International / Biomedical Research and Regulation"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/rcrim"/>
    </telecom>
  </contact>
  <description
               value="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 value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <structure>
    <url
         value="http://hl7.org/fhir/StructureDefinition/MedicationStatement|4.0.1"/>
    <mode value="source"/>
    <alias value="MedState"/>
  </structure>
  <structure>
    <url
         value="http://hl7.org/fhir/uv/omop/StructureDefinition/DrugExposure"/>
    <mode value="target"/>
    <alias value="DrugExpTable"/>
  </structure>
  <group>
    <name value="MedExposure"/>
    <input>
      <name value="src"/>
      <type value="MedState"/>
      <mode value="source"/>
    </input>
    <input>
      <name value="tgt"/>
      <type value="DrugExpTable"/>
      <mode value="target"/>
    </input>
    <rule>
      <name value="medMapping"/>
      <source>
        <context value="src"/>
        <condition
                   value="src.effective.empty().not() and src.identifier.empty().not()"/>
      </source>
      <rule>
        <name value="medicationId"/>
        <source>
          <context value="src"/>
          <variable value="s"/>
        </source>
        <target>
          <context value="tgt"/>
        </target>
        <rule>
          <name value="medIdFromIdentifier"/>
          <source>
            <context value="s"/>
            <element value="identifier"/>
            <variable value="i"/>
          </source>
          <target>
            <context value="tgt"/>
          </target>
          <rule>
            <name value="value"/>
            <source>
              <context value="i"/>
              <element value="value"/>
              <variable value="id"/>
            </source>
            <target>
              <context value="tgt"/>
              <element value="drug_exposure_id"/>
              <transform value="cast"/>
              <parameter>
                <valueId value="id"/>
              </parameter>
              <parameter>
                <valueString value="integer"/>
              </parameter>
            </target>
          </rule>
        </rule>
      </rule>
      <rule>
        <name value="subject"/>
        <source>
          <context value="src"/>
          <element value="subject"/>
          <variable value="subject"/>
        </source>
        <target>
          <context value="tgt"/>
        </target>
        <rule>
          <name value="reference"/>
          <source>
            <context value="subject"/>
            <element value="reference"/>
            <variable value="s"/>
          </source>
          <target>
            <context value="tgt"/>
            <element value="person_id"/>
            <transform value="evaluate"/>
            <parameter>
              <valueString value="%s.substring(%s.indexOf('/') + 1)"/>
            </parameter>
          </target>
        </rule>
      </rule>
      <rule>
        <name value="medicationCodeableConcept"/>
        <source>
          <context value="src"/>
          <type value="CodeableConcept"/>
          <element value="medication"/>
          <variable value="s"/>
        </source>
        <target>
          <context value="tgt"/>
        </target>
        <rule>
          <name value="coding"/>
          <source>
            <context value="s"/>
            <element value="coding"/>
            <variable value="sc"/>
          </source>
          <target>
            <context value="tgt"/>
          </target>
          <rule>
            <name value="code"/>
            <source>
              <context value="sc"/>
              <element value="code"/>
              <variable value="a"/>
            </source>
            <target>
              <context value="tgt"/>
              <element value="drug_concept_id"/>
              <transform value="copy"/>
              <parameter>
                <valueId value="a"/>
              </parameter>
            </target>
          </rule>
        </rule>
      </rule>
      <rule>
        <name value="medicationReference"/>
        <source>
          <context value="src"/>
          <type value="Reference"/>
          <element value="medication"/>
          <variable value="s"/>
        </source>
        <target>
          <context value="tgt"/>
        </target>
        <rule>
          <name value="reference"/>
          <source>
            <context value="s"/>
            <element value="reference"/>
            <variable value="sr"/>
          </source>
          <target>
            <context value="tgt"/>
            <element value="drug_concept_id"/>
            <transform value="copy"/>
            <parameter>
              <valueId value="sr"/>
            </parameter>
          </target>
        </rule>
      </rule>
      <rule>
        <name value="effectiveDateTime"/>
        <source>
          <context value="src"/>
          <type value="dateTime"/>
          <element value="effective"/>
          <variable value="edt"/>
        </source>
        <target>
          <context value="tgt"/>
          <element value="drug_exposure_start_datetime"/>
          <transform value="copy"/>
          <parameter>
            <valueId value="edt"/>
          </parameter>
        </target>
        <target>
          <context value="tgt"/>
          <element value="drug_exposure_start_date"/>
          <transform value="cast"/>
          <parameter>
            <valueId value="edt"/>
          </parameter>
          <parameter>
            <valueString value="date"/>
          </parameter>
        </target>
      </rule>
      <rule>
        <name value="effectivePeriod"/>
        <source>
          <context value="src"/>
          <type value="Period"/>
          <element value="effective"/>
          <variable value="s"/>
        </source>
        <target>
          <context value="tgt"/>
        </target>
        <rule>
          <name value="start"/>
          <source>
            <context value="s"/>
            <element value="start"/>
            <variable value="fps"/>
          </source>
          <target>
            <context value="tgt"/>
            <element value="drug_exposure_start_datetime"/>
            <transform value="copy"/>
            <parameter>
              <valueId value="fps"/>
            </parameter>
          </target>
          <target>
            <context value="tgt"/>
            <element value="drug_exposure_start_date"/>
            <transform value="cast"/>
            <parameter>
              <valueId value="fps"/>
            </parameter>
            <parameter>
              <valueString value="date"/>
            </parameter>
          </target>
        </rule>
      </rule>
      <rule>
        <name value="effectivePeriod"/>
        <source>
          <context value="src"/>
          <type value="Period"/>
          <element value="effective"/>
          <variable value="s"/>
        </source>
        <target>
          <context value="tgt"/>
        </target>
        <rule>
          <name value="end"/>
          <source>
            <context value="s"/>
            <element value="end"/>
            <variable value="end"/>
          </source>
          <target>
            <context value="tgt"/>
            <element value="drug_exposure_end_datetime"/>
            <transform value="copy"/>
            <parameter>
              <valueId value="end"/>
            </parameter>
          </target>
          <target>
            <context value="tgt"/>
            <element value="drug_exposure_end_date"/>
            <transform value="cast"/>
            <parameter>
              <valueId value="end"/>
            </parameter>
            <parameter>
              <valueString value="date"/>
            </parameter>
          </target>
        </rule>
      </rule>
      <rule>
        <name value="effectivePeriod"/>
        <source>
          <context value="src"/>
          <type value="Period"/>
          <element value="effective"/>
          <variable value="s"/>
        </source>
        <target>
          <context value="tgt"/>
        </target>
        <rule>
          <name value="end"/>
          <source>
            <context value="s"/>
            <element value="end"/>
            <variable value="end"/>
          </source>
          <target>
            <context value="tgt"/>
            <element value="verbatim_end_date"/>
            <transform value="cast"/>
            <parameter>
              <valueId value="end"/>
            </parameter>
            <parameter>
              <valueString value="date"/>
            </parameter>
          </target>
        </rule>
      </rule>
      <rule>
        <name value="categoryCodeableConcept"/>
        <source>
          <context value="src"/>
          <type value="CodeableConcept"/>
          <element value="category"/>
          <variable value="s"/>
        </source>
        <target>
          <context value="tgt"/>
        </target>
        <rule>
          <name value="coding"/>
          <source>
            <context value="s"/>
            <element value="coding"/>
            <variable value="sc"/>
          </source>
          <target>
            <context value="tgt"/>
          </target>
          <rule>
            <name value="code"/>
            <source>
              <context value="sc"/>
              <element value="code"/>
              <variable value="a"/>
            </source>
            <target>
              <context value="tgt"/>
              <element value="drug_type_concept_id"/>
              <transform value="copy"/>
              <parameter>
                <valueId value="a"/>
              </parameter>
            </target>
          </rule>
        </rule>
      </rule>
      <rule>
        <name value="reasonCodeableReference"/>
        <source>
          <context value="src"/>
          <type value="CodeableReference"/>
          <element value="reason"/>
          <variable value="s"/>
        </source>
        <target>
          <context value="tgt"/>
        </target>
        <rule>
          <name value="concept"/>
          <source>
            <context value="s"/>
            <element value="concept"/>
            <variable value="scs"/>
          </source>
          <target>
            <context value="tgt"/>
          </target>
          <rule>
            <name value="coding"/>
            <source>
              <context value="scs"/>
              <element value="coding"/>
              <variable value="sc"/>
            </source>
            <target>
              <context value="tgt"/>
            </target>
            <rule>
              <name value="code"/>
              <source>
                <context value="sc"/>
                <element value="code"/>
                <variable value="a"/>
              </source>
              <target>
                <context value="tgt"/>
                <element value="stop_reason"/>
                <transform value="copy"/>
                <parameter>
                  <valueId value="a"/>
                </parameter>
              </target>
            </rule>
          </rule>
        </rule>
      </rule>
    </rule>
  </group>
</StructureMap>