FHIR to OMOP FHIR IG
1.0.0-ballot - INFORMATIVE 1 - Ballot International flag

This page is part of the Vulcan FHIR to OMOP FHIR Implementation Guide (v1.0.0-ballot: INFORMATIVE 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

: Mapping MedicationStatement resource to DrugExposure OMOP Domain - XML Representation

Page standards status: Informative Maturity Level: 1

Raw xml | Download


<StructureMap xmlns="http://hl7.org/fhir">
  <id value="MedicationMap"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureMap MedicationMap</b></p><a name="MedicationMap"> </a><a name="hcMedicationMap"> </a><pre class="fml">
<span style="color: #cc00cc">/// <b>url</b> = </span><span style="color: blue">'http://hl7.org/fhir/uv/omop/StructureMap/MedicationMap'</span>
<span style="color: #cc00cc">/// <b>name</b> = </span><span style="color: blue">'MedicationMap'</span>
<span style="color: #cc00cc">/// <b>title</b> = </span><span style="color: blue">'Mapping MedicationStatement resource to DrugExposure OMOP Domain'</span>
<span style="color: #cc00cc">/// <b>status</b> = </span><span style="color: blue">'draft'</span>

<b>uses</b><span style="color: navy"> &quot;</span><a href="http://hl7.org/fhir/R5/medicationstatement.html" title="MedicationStatement">http://hl7.org/fhir/StructureDefinition/MedicationStatement</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.medication<span style="color: navy"> : </span>CodeableReference<b> as </b><span style="color: maroon">s</span><span style="color: navy"><b> -&gt; </b></span><span style="color: maroon">tgt</span><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><span style="color: maroon">tgt</span><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><span style="color: maroon">tgt</span><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>
  <span style="color: navy">}</span><span style="color: navy">;</span> <span style="color: navy">// </span><span style="color: green">src.id as id -&gt; tgt.drug_exposure_id = cast(id, &quot;integer&quot;);</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><span style="color: maroon">tgt</span><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><span style="color: maroon">tgt</span><b> then</b><span style="color: navy"> {
</span>    s.end<b> as </b><span style="color: maroon">fpe</span><span style="color: navy"><b> -&gt; </b></span> tgt.drug_exposure_end_datetime = <span style="color: maroon">fpe</span><span style="color: navy">, </span> tgt.drug_exposure_end_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><span style="color: maroon">tgt</span><b> then</b><span style="color: navy"> {
</span>    s.end<b> as </b><span style="color: maroon">fpe</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">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.category<span style="color: navy"> : </span>CodeableConcept<b> as </b><span style="color: maroon">s</span><span style="color: navy"><b> -&gt; </b></span><span style="color: maroon">tgt</span><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><span style="color: maroon">tgt</span><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><span style="color: maroon">tgt</span><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><span style="color: maroon">tgt</span><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><span style="color: maroon">tgt</span><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></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="1">
      <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="informative">
      <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/MedicationMap"/>
  <version value="1.0.0-ballot"/>
  <name value="MedicationMap"/>
  <title
         value="Mapping MedicationStatement resource to DrugExposure OMOP Domain"/>
  <status value="draft"/>
  <date value="2025-07-29T21:03:04+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"/>
    <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="medicationCodeableReference"/>
      <source>
        <context value="src"/>
        <type value="CodeableReference"/>
        <element value="medication"/>
        <variable value="s"/>
      </source>
      <target>
        <transform value="copy"/>
        <parameter>
          <valueId value="tgt"/>
        </parameter>
      </target>
      <rule>
        <name value="concept"/>
        <source>
          <context value="s"/>
          <element value="concept"/>
          <variable value="scs"/>
        </source>
        <target>
          <transform value="copy"/>
          <parameter>
            <valueId value="tgt"/>
          </parameter>
        </target>
        <rule>
          <name value="coding"/>
          <source>
            <context value="scs"/>
            <element value="coding"/>
            <variable value="sc"/>
          </source>
          <target>
            <transform value="copy"/>
            <parameter>
              <valueId value="tgt"/>
            </parameter>
          </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>
      <documentation
                     value="src.id as id -&gt; tgt.drug_exposure_id = cast(id, &quot;integer&quot;);"/>
    </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>
        <transform value="copy"/>
        <parameter>
          <valueId value="tgt"/>
        </parameter>
      </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>
        <transform value="copy"/>
        <parameter>
          <valueId value="tgt"/>
        </parameter>
      </target>
      <rule>
        <name value="end"/>
        <source>
          <context value="s"/>
          <element value="end"/>
          <variable value="fpe"/>
        </source>
        <target>
          <context value="tgt"/>
          <element value="drug_exposure_end_datetime"/>
          <transform value="copy"/>
          <parameter>
            <valueId value="fpe"/>
          </parameter>
        </target>
        <target>
          <context value="tgt"/>
          <element value="drug_exposure_end_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>
        <transform value="copy"/>
        <parameter>
          <valueId value="tgt"/>
        </parameter>
      </target>
      <rule>
        <name value="end"/>
        <source>
          <context value="s"/>
          <element value="end"/>
          <variable value="fpe"/>
        </source>
        <target>
          <context value="tgt"/>
          <element value="verbatim_end_date"/>
          <transform value="cast"/>
          <parameter>
            <valueId value="fps"/>
          </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>
        <transform value="copy"/>
        <parameter>
          <valueId value="tgt"/>
        </parameter>
      </target>
      <rule>
        <name value="coding"/>
        <source>
          <context value="s"/>
          <element value="coding"/>
          <variable value="sc"/>
        </source>
        <target>
          <transform value="copy"/>
          <parameter>
            <valueId value="tgt"/>
          </parameter>
        </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>
        <transform value="copy"/>
        <parameter>
          <valueId value="tgt"/>
        </parameter>
      </target>
      <rule>
        <name value="concept"/>
        <source>
          <context value="s"/>
          <element value="concept"/>
          <variable value="scs"/>
        </source>
        <target>
          <transform value="copy"/>
          <parameter>
            <valueId value="tgt"/>
          </parameter>
        </target>
        <rule>
          <name value="coding"/>
          <source>
            <context value="scs"/>
            <element value="coding"/>
            <variable value="sc"/>
          </source>
          <target>
            <transform value="copy"/>
            <parameter>
              <valueId value="tgt"/>
            </parameter>
          </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>
  </group>
</StructureMap>