SQL on FHIR - Local Development build (v2.1.0-pre) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• XML
• JSON

: SQL on FHIR Example - XML Representation

Active as of 2025-07-31

Raw xml | Download

<Library xmlns="http://hl7.org/fhir">
  <id value="SqlOnFhirExample"/>
  <meta>
    <profile value="https://sql-on-fhir.org/ig/StructureDefinition/SQLQuery"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Library SqlOnFhirExample</b></p><a name="SqlOnFhirExample"> </a><a name="hcSqlOnFhirExample"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-SQLQuery.html">SQL Query Library</a></p></div><h2>Participants</h2><table class="grid"><tr><td>Author</td><td>Clinical Informatics Team</td></tr></table><h2>Related Artifacts</h2><table class="grid"><tr><td>Depends On</td><td><code>https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition/PatientDemographics</code></td></tr><tr><td>Depends On</td><td><code>https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition/PatientAddresses</code></td></tr></table><h2>Parameters</h2><table class="grid"><tr><td>city</td><td>in</td><td/><td/><td>string</td></tr></table><h2>Contents</h2><p>sql_on_fhir_example.sql: (<code>application/sql</code>)</p><pre><code>/*
@title: Trivial SQL on FHIR Example
@description: Demonstrating converting SQL to FHIR Library with basic annotations 
@version: 4.2.0
@status: active
@author: Clinical Informatics Team
@publisher: Regional Medical Center
*/

-- @relatedDependency: https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition/PatientDemographics
-- @relatedDependency: https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition/PatientAddresses
-- @param: city string
WITH RankedAddresses AS (
    SELECT 
        pd.*,
        pa.*,
        ROW_NUMBER() OVER (PARTITION BY pd.patient_id ORDER BY pa.address_id) AS address_rank
    FROM 
        patient_demographics pd
    JOIN 
        patient_addresses pa ON pd.patient_id = pa.patient_id
    WHERE 
        pd.age &gt; 18
        AND pa.city = :city
)
</code></pre></div>
  </text>
  <url value="https://sql-on-fhir.org/ig/Library/SqlOnFhirExample"/>
  <version value="2.1.0-pre"/>
  <name value="SqlOnFhirExample"/>
  <title value="SQL on FHIR Example"/>
  <status value="active"/>
  <type>
    <coding>
      <system
              value="https://sql-on-fhir.org/ig/CodeSystem/LibraryTypesCodes"/>
      <code value="sql-query"/>
    </coding>
  </type>
  <date value="2025-07-31T21:26:38+00:00"/>
  <publisher value="SQL on FHIR Working Group"/>
  <contact>
    <name value="SQL on FHIR Working Group"/>
    <telecom>
      <system value="url"/>
      <value value="https://sql-on-fhir.org"/>
    </telecom>
  </contact>
  <description
               value="Demonstrating a SQL Query Library with basic annotations that can
assist in generating properties and metadata.

```sql
/*
@title: SQL on FHIR Example
@description: Demonstrating converting SQL to FHIR Library with basic annotations 
@version: 4.2.0
@status: active
@author: Clinical Informatics Team
@publisher: Regional Medical Center
*/

-- @relatedDependency: https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition/PatientDemographics
-- @relatedDependency: https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition/PatientAddresses
-- @param: city string
WITH RankedAddresses AS (
    SELECT 
        pd.*,
        pa.*,
        ROW_NUMBER() OVER (PARTITION BY pd.patient_id ORDER BY pa.address_id) AS address_rank
    FROM 
        patient_demographics pd
    JOIN 
        patient_addresses pa ON pd.patient_id = pa.patient_id
    WHERE 
        pd.age &gt; 18
        AND pa.city = :city
)
```"/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <author>
    <name value="Clinical Informatics Team"/>
  </author>
  <relatedArtifact>
    <type value="depends-on"/>
    <resource
              value="https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition/PatientDemographics"/>
  </relatedArtifact>
  <relatedArtifact>
    <type value="depends-on"/>
    <resource
              value="https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition/PatientAddresses"/>
  </relatedArtifact>
  <parameter>
    <name value="city"/>
    <use value="in"/>
    <type value="string"/>
  </parameter>
  <content>
    <contentType value="application/sql"/>
    <data
          value="LyoKQHRpdGxlOiBUcml2aWFsIFNRTCBvbiBGSElSIEV4YW1wbGUKQGRlc2NyaXB0aW9uOiBEZW1vbnN0cmF0aW5nIGNvbnZlcnRpbmcgU1FMIHRvIEZISVIgTGlicmFyeSB3aXRoIGJhc2ljIGFubm90YXRpb25zIApAdmVyc2lvbjogNC4yLjAKQHN0YXR1czogYWN0aXZlCkBhdXRob3I6IENsaW5pY2FsIEluZm9ybWF0aWNzIFRlYW0KQHB1Ymxpc2hlcjogUmVnaW9uYWwgTWVkaWNhbCBDZW50ZXIKKi8KCi0tIEByZWxhdGVkRGVwZW5kZW5jeTogaHR0cHM6Ly9zcWwtb24tZmhpci5vcmcvaWcvU3RydWN0dXJlRGVmaW5pdGlvbi9WaWV3RGVmaW5pdGlvbi9QYXRpZW50RGVtb2dyYXBoaWNzCi0tIEByZWxhdGVkRGVwZW5kZW5jeTogaHR0cHM6Ly9zcWwtb24tZmhpci5vcmcvaWcvU3RydWN0dXJlRGVmaW5pdGlvbi9WaWV3RGVmaW5pdGlvbi9QYXRpZW50QWRkcmVzc2VzCi0tIEBwYXJhbTogY2l0eSBzdHJpbmcKV0lUSCBSYW5rZWRBZGRyZXNzZXMgQVMgKAogICAgU0VMRUNUIAogICAgICAgIHBkLiosCiAgICAgICAgcGEuKiwKICAgICAgICBST1dfTlVNQkVSKCkgT1ZFUiAoUEFSVElUSU9OIEJZIHBkLnBhdGllbnRfaWQgT1JERVIgQlkgcGEuYWRkcmVzc19pZCkgQVMgYWRkcmVzc19yYW5rCiAgICBGUk9NIAogICAgICAgIHBhdGllbnRfZGVtb2dyYXBoaWNzIHBkCiAgICBKT0lOIAogICAgICAgIHBhdGllbnRfYWRkcmVzc2VzIHBhIE9OIHBkLnBhdGllbnRfaWQgPSBwYS5wYXRpZW50X2lkCiAgICBXSEVSRSAKICAgICAgICBwZC5hZ2UgPiAxOAogICAgICAgIEFORCBwYS5jaXR5ID0gOmNpdHkKKQo="/>
    <title value="sql_on_fhir_example.sql"/>
    <creation value="2025-07-22T08:20:49.312999Z"/>
  </content>
</Library>