Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example Library/example (XML)

Clinical Decision Support Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

Raw XML (canonical form + also see XML Format Specification)

Jump past Narrative

Chlamydia Screening Common Library (id = "example")

<?xml version="1.0" encoding="UTF-8"?>

<Library xmlns="http://hl7.org/fhir">
  <id value="example"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Id: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-left: 25px; padding-right: 25px;">Library/example</td> 
            </tr> 
         </table> 
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Identifier: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-left: 25px; padding-right: 25px;">
                  <b> value: </b> 
                  <span> ChalmydiaScreening_Common</span> 
               </td> 
            </tr> 
         </table> 
         <p/>  
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Version: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-left: 25px; padding-right: 25px;">2.0.0</td> 
            </tr> 
         </table> 
         <p/>  
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Title: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-left: 25px; padding-right: 25px;">Chlamydia Screening Common Library</td> 
            </tr> 
         </table> 
         <p/>  
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Type: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-right: 25px;">
                  <span> 
                     <span> 
                        <span style="padding-left: 25px;">
                           <b> code: </b> 
                           <span> logic-library</span> 
                        </span> 
                     </span> 
                  </span> 
               </td> 
            </tr> 
         </table> 
         <p/>  
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Status: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-left: 25px; padding-right: 25px;">draft</td> 
            </tr> 
         </table> 
         <p/>  
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Description: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-left: 25px; padding-right: 25px;">Common Logic for adherence to Chlamydia Screening guidelines</td> 
            </tr> 
         </table> 
         <p/>  
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Topic: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-right: 25px;">
                  <span style="padding-left: 25px;">
                     <b> text: </b> 
                     <span> Chlamydia Screening</span> 
                  </span> 
               </td> 
            </tr> 
         </table> 
         <p/>  
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Related: </b> 
               </td> 
            </tr> 
            <tr style="vertical-align: top;">
               <td style="padding-left: 25px; padding-right: 25px;">
                  <p style="margin-bottom: 5px;">
                     <b> type: </b> 
                     <span> depends-on</span> 
                  </p> 
                  <p style="margin-bottom: 5px;">
                     <b> Resource: </b> 
                     <br/>  
                     <span> 
                        <span style="padding-left: 25px;">
                           <b> reference: </b> 
                           <span> Library/library-quick-model-definition</span> 
                        </span> 
                     </span> 
                  </p> 
               </td> 
            </tr> 
         </table> 
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Data Requirements: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-left: 25px; padding-right: 25px;">
                  <div> 
                     <p style="margin-bottom: 5px;">
                        <b> type: </b> 
                        <span> Condition</span> 
                     </p> 
                     <p style="margin-bottom: 5px;">
                        <b> code filter:</b> 
                        <br/>  
                        <span style="padding-left: 25px;">
                           <b> path: </b> 
                           <span> code</span> 
                        </span> 
                        <br/>  
                        <span style="padding-left: 25px;">
                           <b> valueset: </b> 
                           <span> Other Female Reproductive Conditions</span> 
                        </span> 
                     </p> 
                  </div> 
               </td> 
            </tr> 
         </table> 
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Content: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-left: 25px; padding-right: 25px;">
                  <p style="margin-bottom: 5px;">
                     <b> type: </b> 
                     <span> text/cql</span> 
                  </p> 
                  <p style="margin-bottom: 5px;">
                     <b> url: </b> 
                     <span> library-example-content.cql</span> 
                  </p> 
               </td> 
            </tr> 
         </table> 
      </div> 
  </text> 

  <identifier> 
    <use value="official"/> 
    <value value="ChalmydiaScreening_Common"/> 
  </identifier> 
  <version value="2.0.0"/> 
  <title value="Chlamydia Screening Common Library"/> 
  <status value="draft"/> 
  <type> 
    <coding> 
      <code value="logic-library"/> 
    </coding> 
  </type> 
  <date value="2015-07-22"/> 
  <description value="Common Logic for adherence to Chlamydia Screening guidelines"/> 
  <topic> 
    <text value="Chlamydia Screening"/> 
  </topic> 

  <relatedArtifact> 
    <type value="depends-on"/> 
    <resource value="http://hl7.org/fhir/Library/library-quick-model-definition"/> 
  </relatedArtifact> 

  <!--  valueSet>
    <name value="Female Administrative Sex"/>
    <identifier value="2.16.840.1.113883.3.560.100.2"/>
  </valueSet  -->
  <!--   ... other value sets as defined in the library   -->

  <dataRequirement> 
    <type value="Condition"/> 
    <codeFilter> 
      <path value="code"/> 
      <valueSet value="urn:oid:2.16.840.1.113883.3.464.1003.111.12.1006"/>  <!--   Other Female Reproductive Conditions   -->
    </codeFilter> 
  </dataRequirement> 
  <!--   ... other data requirements as defined in the library   -->

  <content> 
    <contentType value="text/cql"/> 
    <data value="bGlicmFyeSBDaGxhbXlkaWFTY3JlZW5pbmdfQ29tbW9uIHZlcnNpb24gJzInCgp1c2luZyBRVUlDSwoKdmFsdWVzZXQgIkZlbWFs
    ZSBBZG1pbmlzdHJhdGl2ZSBTZXgiOiAnMi4xNi44NDAuMS4xMTM4ODMuMy41NjAuMTAwLjInCnZhbHVlc2V0ICJPdGhlciBGZW1hb
    GUgUmVwcm9kdWN0aXZlIENvbmRpdGlvbnMiOiAnMi4xNi44NDAuMS4xMTM4ODMuMy40NjQuMTAwMy4xMTEuMTIuMTAwNicKdmFsdW
    VzZXQgIkdlbml0YWwgSGVycGVzIjogJzIuMTYuODQwLjEuMTEzODgzLjMuNDY0LjEwMDMuMTEwLjEyLjEwNDknCnZhbHVlc2V0ICJ
    HZW5vY29jY2FsIEluZmVjdGlvbnMgYW5kIFZlbmVyZWFsIERpc2Vhc2VzIjogJzIuMTYuODQwLjEuMTEzODgzLjMuNDY0LjEwMDMu
    MTEyLjEyLjEwMDEnCnZhbHVlc2V0ICJJbmZsYW1tYXRvcnkgRGlzZWFzZXMgb2YgRmVtYWxlIFJlcHJvZHVjdGl2ZSBPcmdhbnMiO
    iAnMi4xNi44NDAuMS4xMTM4ODMuMy40NjQuMTAwMy4xMTIuMTIuMTAwNCcKdmFsdWVzZXQgIkNobGFteWRpYSI6ICcyLjE2Ljg0MC
    4xLjExMzg4My4zLjQ2NC4xMDAzLjExMi4xMi4xMDAzJwp2YWx1ZXNldCAiSElWIjogJzIuMTYuODQwLjEuMTEzODgzLjMuNDY0LjE
    wMDMuMTIwLjEyLjEwMDMnCnZhbHVlc2V0ICJTeXBoaWxpcyI6ICcyLjE2Ljg0MC4xLjExMzg4My4zLjQ2NC4xMDAzLjExMi4xMi4x
    MDAyJwp2YWx1ZXNldCAiQ29tcGxpY2F0aW9ucyBvZiBQcmVnbmFuY3ksIENoaWxkYmlydGggYW5kIHRoZSBQdWVycGVyaXVtIjogJ
    zIuMTYuODQwLjEuMTEzODgzLjMuNDY0LjEwMDMuMTExLjEyLjEwMTInCnZhbHVlc2V0ICJQcmVnbmFuY3kgVGVzdCI6ICcyLjE2Lj
    g0MC4xLjExMzg4My4zLjQ2NC4xMDAzLjExMS4xMi4xMDExJwp2YWx1ZXNldCAiUGFwIFRlc3QiOiAnMi4xNi44NDAuMS4xMTM4ODM
    uMy40NjQuMTAwMy4xMDguMTIuMTAxNycKdmFsdWVzZXQgIkxhYiBUZXN0cyBEdXJpbmcgUHJlZ25hbmN5IjogJzIuMTYuODQwLjEu
    MTEzODgzLjMuNDY0LjEwMDMuMTExLjEyLjEwMDcnCnZhbHVlc2V0ICJMYWIgVGVzdHMgZm9yIFNleHVhbGx5IFRyYW5zbWl0dGVkI
    EluZmVjdGlvbnMiOiAnMi4xNi44NDAuMS4xMTM4ODMuMy40NjQuMTAwMy4xMTAuMTIuMTA1MScKdmFsdWVzZXQgIkNobGFteWRpYS
    BTY3JlZW5pbmciOiAnMi4xNi44NDAuMS4xMTM4ODMuMy40NjQuMTAwMy4xMTAuMTIuMTA1MicKCmNvbnRleHQgUGF0aWVudAoKZGV
    maW5lICJDb25kaXRpb25zIEluZGljYXRpbmcgU2V4dWFsIEFjdGl2aXR5IjoKCVsiQ29uZGl0aW9uIjogIk90aGVyIEZlbWFsZSBS
    ZXByb2R1Y3RpdmUgQ29uZGl0aW9ucyJdCgl1bmlvbiBbIkNvbmRpdGlvbiI6ICJHZW5pdGFsIEhlcnBlcyJdCiAgICB1bmlvbiBbI
    kNvbmRpdGlvbiI6ICJHZW5vY29jY2FsIEluZmVjdGlvbnMgYW5kIFZlbmVyZWFsIERpc2Vhc2VzIl0KICAgIHVuaW9uIFsiQ29uZG
    l0aW9uIjogIkluZmxhbW1hdG9yeSBEaXNlYXNlcyBvZiBGZW1hbGUgUmVwcm9kdWN0aXZlIE9yZ2FucyJdCiAgICB1bmlvbiBbIkN
    vbmRpdGlvbiI6ICJDaGxhbXlkaWEiXQogICAgdW5pb24gWyJDb25kaXRpb24iOiAiSElWIl0KICAgIHVuaW9uIFsiQ29uZGl0aW9u
    IjogIlN5cGhpbGlzIl0KICAgIHVuaW9uIFsiQ29uZGl0aW9uIjogIkNvbXBsaWNhdGlvbnMgb2YgUHJlZ25hbmN5LCBDaGlsZGJpc
    nRoIGFuZCB0aGUgUHVlcnBlcml1bSJdCgpkZWZpbmUgIkxhYm9yYXRvcnkgVGVzdHMgSW5kaWNhdGluZyBTZXh1YWwgQWN0aXZpdH
    kiOgogICAgWyJEaWFnbm9zdGljT3JkZXIiOiAiUHJlZ25hbmN5IFRlc3QiXQogICAgdW5pb24gWyJEaWFnbm9zdGljT3JkZXIiOiA
    iUGFwIFRlc3QiXQogICAgdW5pb24gWyJEaWFnbm9zdGljT3JkZXIiOiAiTGFiIFRlc3RzIER1cmluZyBQcmVnbmFuY3kiXQoJdW5p
    b24gWyJEaWFnbm9zdGljT3JkZXIiOiAiTGFiIFRlc3RzIGZvciBTZXh1YWxseSBUcmFuc21pdHRlZCBJbmZlY3Rpb25zIl0KCmRlZ
    mluZSAiVGVzdHMgUGVyZm9ybWVkIEZvciBDaGxhbXlkaWEiOgoJWyJEaWFnbm9zdGljUmVwb3J0IjogIkNobGFteWRpYSBTY3JlZW
    5pbmciXQoKZGVmaW5lICJSZXN1bHRzIFByZXNlbnQgRm9yIENobGFteWRpYSBTY3JlZW5pbmciOgogICAgWyJEaWFnbm9zdGljUmV
    wb3J0IjogIkNobGFteWRpYSBTY3JlZW5pbmciXSBSIHdoZXJlIFIuInJlc3VsdCIgaXMgbm90IG51bGwK"/> 
  </content> 

</Library>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.