FHIR to OMOP FHIR IG
1.0.0-ballot - INFORMATIVE 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 1.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 Encounter resource to VisitOccurrence OMOP Domain - XML Representation

Page standards status: Informative Maturity Level: 1

Raw xml | Download


<StructureMap xmlns="http://hl7.org/fhir">
  <id value="EncounterVisitMap"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureMap EncounterVisitMap</b></p><a name="EncounterVisitMap"> </a><a name="hcEncounterVisitMap"> </a><pre class="fml">
<span style="color: #cc00cc">/// <b>url</b> = </span><span style="color: blue">'http://hl7.org/fhir/uv/omop/StructureMap/EncounterVisitMap'</span>
<span style="color: #cc00cc">/// <b>name</b> = </span><span style="color: blue">'EncounterVisitMap'</span>
<span style="color: #cc00cc">/// <b>title</b> = </span><span style="color: blue">'Mapping Encounter resource to VisitOccurrence 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/encounter.html" title="Encounter">http://hl7.org/fhir/StructureDefinition/Encounter</a><span style="color: navy">&quot; </span><b>alias </b>Encounter <b>as </b><b>source</b>
<b>uses</b><span style="color: navy"> &quot;</span><a href="StructureDefinition-VisitOccurrence.html" title="Visit Occurrence OMOP Table">http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence</a><span style="color: navy">&quot; </span><b>alias </b>VisitTable <b>as </b><b>target</b>

<b>group </b>VisitOccurrence<span style="color: navy">(</span><b>source</b> <span style="color: maroon">src</span><span style="color: navy"> : </span>Encounter, <b>target</b> <span style="color: maroon">tgt</span><span style="color: navy"> : </span>VisitTable<span style="color: navy">)</span><span style="color: navy"> {
</span>  src.class<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.visit_concept_id = <span style="color: maroon">a</span><span style="color: navy">, </span> tgt.visit_source_value = <span style="color: maroon">a</span><span style="color: navy">, </span> tgt.visit_source_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: green">src.id as id -&gt; tgt.visit_occurrence_id = cast(id, &quot;integer&quot;);</span>
  src.actualPeriod<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">std</span><span style="color: navy"><b> -&gt; </b></span> tgt.visit_start_date = <b>cast</b><span style="color: navy">(</span><span style="color: maroon">std</span><span style="color: navy">, </span><span style="color: blue">'date'</span><span style="color: navy">)</span><span style="color: navy">, </span> tgt.visit_start_datetime = <span style="color: maroon">std</span><span style="color: navy">;</span>
    s.end<b> as </b><span style="color: maroon">ed</span><span style="color: navy"><b> -&gt; </b></span> tgt.visit_end_date = <b>cast</b><span style="color: navy">(</span><span style="color: maroon">ed</span><span style="color: navy">, </span><span style="color: blue">'date'</span><span style="color: navy">)</span><span style="color: navy">, </span> tgt.visit_end_datetime = <span style="color: maroon">ed</span><span style="color: navy">;</span>
  <span style="color: navy">}</span><span style="color: navy">;</span>
  src.admission<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.admitSource<b> as </b><span style="color: maroon">sa</span><span style="color: navy"><b> -&gt; </b></span><span style="color: maroon">tgt</span><b> then</b><span style="color: navy"> {
</span>      sa.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">code</span><span style="color: navy"><b> -&gt; </b></span> tgt.admitted_from_concept_id = <span style="color: maroon">code</span><span style="color: navy">, </span> tgt.admitted_from_source_value = <span style="color: maroon">code</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>
    s.dischargeDisposition<b> as </b><span style="color: maroon">sd</span><span style="color: navy"><b> -&gt; </b></span><span style="color: maroon">tgt</span><b> then</b><span style="color: navy"> {
</span>      sd.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">code</span><span style="color: navy"><b> -&gt; </b></span> tgt.discharged_to_concept_id = <span style="color: maroon">code</span><span style="color: navy">, </span> tgt.discharged_to_source_value = <span style="color: maroon">code</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/EncounterVisitMap"/>
  <version value="1.0.0-ballot"/>
  <name value="EncounterVisitMap"/>
  <title value="Mapping Encounter resource to VisitOccurrence OMOP Domain"/>
  <status value="draft"/>
  <date value="2025-07-29T17:40:15+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 Encounter instances to OMOP Visit Occurence Table objects."/>
  <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/Encounter"/>
    <mode value="source"/>
    <alias value="Encounter"/>
  </structure>
  <structure>
    <url
         value="http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence"/>
    <mode value="target"/>
    <alias value="VisitTable"/>
  </structure>
  <group>
    <name value="VisitOccurrence"/>
    <input>
      <name value="src"/>
      <type value="Encounter"/>
      <mode value="source"/>
    </input>
    <input>
      <name value="tgt"/>
      <type value="VisitTable"/>
      <mode value="target"/>
    </input>
    <rule>
      <name value="class"/>
      <source>
        <context value="src"/>
        <element value="class"/>
        <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="visit_concept_id"/>
            <transform value="copy"/>
            <parameter>
              <valueId value="a"/>
            </parameter>
          </target>
          <target>
            <context value="tgt"/>
            <element value="visit_source_value"/>
            <transform value="copy"/>
            <parameter>
              <valueId value="a"/>
            </parameter>
          </target>
          <target>
            <context value="tgt"/>
            <element value="visit_source_concept_id"/>
            <transform value="copy"/>
            <parameter>
              <valueId value="a"/>
            </parameter>
          </target>
        </rule>
      </rule>
      <documentation
                     value="src.id as id -&gt; tgt.visit_occurrence_id = cast(id, &quot;integer&quot;);"/>
    </rule>
    <rule>
      <name value="actualPeriod"/>
      <source>
        <context value="src"/>
        <element value="actualPeriod"/>
        <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="std"/>
        </source>
        <target>
          <context value="tgt"/>
          <element value="visit_start_date"/>
          <transform value="cast"/>
          <parameter>
            <valueId value="std"/>
          </parameter>
          <parameter>
            <valueString value="date"/>
          </parameter>
        </target>
        <target>
          <context value="tgt"/>
          <element value="visit_start_datetime"/>
          <transform value="copy"/>
          <parameter>
            <valueId value="std"/>
          </parameter>
        </target>
      </rule>
      <rule>
        <name value="end"/>
        <source>
          <context value="s"/>
          <element value="end"/>
          <variable value="ed"/>
        </source>
        <target>
          <context value="tgt"/>
          <element value="visit_end_date"/>
          <transform value="cast"/>
          <parameter>
            <valueId value="ed"/>
          </parameter>
          <parameter>
            <valueString value="date"/>
          </parameter>
        </target>
        <target>
          <context value="tgt"/>
          <element value="visit_end_datetime"/>
          <transform value="copy"/>
          <parameter>
            <valueId value="ed"/>
          </parameter>
        </target>
      </rule>
    </rule>
    <rule>
      <name value="admission"/>
      <source>
        <context value="src"/>
        <element value="admission"/>
        <variable value="s"/>
      </source>
      <target>
        <transform value="copy"/>
        <parameter>
          <valueId value="tgt"/>
        </parameter>
      </target>
      <rule>
        <name value="admitSource"/>
        <source>
          <context value="s"/>
          <element value="admitSource"/>
          <variable value="sa"/>
        </source>
        <target>
          <transform value="copy"/>
          <parameter>
            <valueId value="tgt"/>
          </parameter>
        </target>
        <rule>
          <name value="coding"/>
          <source>
            <context value="sa"/>
            <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="code"/>
            </source>
            <target>
              <context value="tgt"/>
              <element value="admitted_from_concept_id"/>
              <transform value="copy"/>
              <parameter>
                <valueId value="code"/>
              </parameter>
            </target>
            <target>
              <context value="tgt"/>
              <element value="admitted_from_source_value"/>
              <transform value="copy"/>
              <parameter>
                <valueId value="code"/>
              </parameter>
            </target>
          </rule>
        </rule>
      </rule>
      <rule>
        <name value="dischargeDisposition"/>
        <source>
          <context value="s"/>
          <element value="dischargeDisposition"/>
          <variable value="sd"/>
        </source>
        <target>
          <transform value="copy"/>
          <parameter>
            <valueId value="tgt"/>
          </parameter>
        </target>
        <rule>
          <name value="coding"/>
          <source>
            <context value="sd"/>
            <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="code"/>
            </source>
            <target>
              <context value="tgt"/>
              <element value="discharged_to_concept_id"/>
              <transform value="copy"/>
              <parameter>
                <valueId value="code"/>
              </parameter>
            </target>
            <target>
              <context value="tgt"/>
              <element value="discharged_to_source_value"/>
              <transform value="copy"/>
              <parameter>
                <valueId value="code"/>
              </parameter>
            </target>
          </rule>
        </rule>
      </rule>
    </rule>
  </group>
</StructureMap>