Quality Measure Implementation Guide
1.0.0-ballot - ballot International flag

This page is part of the Quality Measure Implementation Guide (v1.0.0-ballot: STU1 (v1.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

: Terminology Library - JSON Representation

Draft as of 2024-12-16

Raw json | Download

{
  "resourceType" : "Library",
  "id" : "Terminology-FHIR",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n<div>\n    <table class=\"grid dict\">\n        \n        \n        <tr>\n            <th scope=\"row\"><b>Title: </b></th>\n            <td style=\"padding-left: 4px;\">Terminology Library</td>\n        </tr>\n        \n\n        \n        \n        <tr>\n            <th scope=\"row\"><b>Id: </b></th>\n            <td style=\"padding-left: 4px;\">Terminology-FHIR</td>\n        </tr>\n        \n\n        \n        \n        <tr>\n            <th scope=\"row\"><b>Version: </b></th>\n            <td style=\"padding-left: 4px;\">1.0.0</td>\n        </tr>\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Url: </b></th>\n            <td style=\"padding-left: 4px;\"><code>http://hl7.org/fhir/uv/cqm/Library/Terminology-FHIR</code></td>\n        </tr>\n        \n\n        \n\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Status: </b></th>\n            <td style=\"padding-left: 4px;\">draft</td>\n        </tr>\n        \n\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Type: </b></th>\n            <td style=\"padding-left: 4px;\">\n                \n                    \n                        \n                        <p style=\"margin-bottom: 5px;\">\n                            <b>system: </b> <span><a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-library-type.html\">http://terminology.hl7.org/CodeSystem/library-type</a></span>\n                        </p>\n                        \n                        \n                        <p style=\"margin-bottom: 5px;\">\n                            <b>code: </b> <span>logic-library</span>\n                        </p>\n                        \n                        \n                    \n                \n                \n            </td>\n        </tr>\n        \n\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Date: </b></th>\n            <td style=\"padding-left: 4px;\">2024-12-16 21:50:47+0000</td>\n        </tr>\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Publisher: </b></th>\n            <td style=\"padding-left: 4px;\">HL7 International / Clinical Quality Information</td>\n        </tr>\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Description: </b></th>\n            <td style=\"padding-left: 4px;\"><div><p>This library is the primary measure library for the terminology example measure</p>\n</div></td>\n        </tr>\n        \n\n        \n\n        \n\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Jurisdiction: </b></th>\n            <td style=\"padding-left: 4px;\">001</td>\n        </tr>\n        \n\n        \n\n        \n\n        \n\n        \n\n        \n\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Related Artifacts: </b></th>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <p><b>Dependencies</b></p>\n                <ul>\n                  \n                    <li><code>http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1</code></li>\n                  \n                    <li><code>http://fhir.org/guides/common/Library/FHIRHelpers|4.0.1</code></li>\n                  \n                    <li><code>http://snomed.info/sct|http://snomed.info/sct/731000124108/version/201709</code></li>\n                  \n                    <li><code>http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.666.7.307|20160929</code></li>\n                  \n                </ul>\n                \n                \n                \n                \n                \n            </td>\n        </tr>\n        \n\n        \n        <tr>\n          <th scope=\"row\"><b>Parameters: </b></th>\n          <td style=\"padding-left: 4px;\">\n            <table class=\"grid-dict\">\n              <tr><th><b>Name</b></th><th><b>Type</b></th><th><b>Min</b></th><th><b>Max</b></th><th><b>In/Out</b></th></tr>\n              \n                <tr><th>Measurement Period</th><th>Period</th><th>0</th><th>1</th><th>In</th></tr>\n              \n                <tr><th>Inpatient Encounter</th><th>Encounter</th><th>0</th><th>*</th><th>Out</th></tr>\n              \n            </table>\n          </td>\n        </tr>\n        \n\n        \n        <tr>\n          <th scope=\"row\"><b>Data Requirements:</b></th>\n          <td style=\"padding-left: 4px;\">\n            <table class=\"grid-dict\">\n              <tr><th><b>Type</b></th><th><b>Profile</b></th><th><b>MS</b></th><th><b>Code Filter</b></th></tr>\n              \n                <tr>\n                  <th>Encounter</th>\n                  <th>http://hl7.org/fhir/StructureDefinition/Encounter</th>\n                  <th/>\n                  <th>\n                    \n                      <b>code filter: </b>\n                      \n                      <br/>\n                      \n                      \n                      <span style=\"padding-left: 4px;\">\n                          <b>path: </b><span>type</span>\n                      </span>\n                      \n                      <br/>\n                      \n                      \n                      \n                      <span style=\"padding-left: 4px;\">\n                          <b>value set: </b><span>http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.666.7.307|20160929</span>\n                      </span>\n                      \n                      \n                    \n                      <b>code filter: </b>\n                      \n                      <br/>\n                      \n                      \n                      <span style=\"padding-left: 4px;\">\n                          <b>path: </b><span>status</span>\n                      </span>\n                      \n                      <br/>\n                      \n                      \n                      \n                      \n                          \n                          <p style=\"margin-bottom: 5px;\">\n                              <b>system: </b> <span><a href=\"http://hl7.org/fhir/R4/codesystem-encounter-status.html\">http://hl7.org/fhir/encounter-status</a></span>\n                          </p>\n                          \n                          \n                          <p style=\"margin-bottom: 5px;\">\n                              <b>code: </b> <span>finished</span>\n                          </p>\n                          \n                          \n                      \n                    \n                  </th>\n                </tr>\n              \n            </table>\n          </td>\n        </tr>\n        \n\n        \n        \n        <tr>\n          <td colspan=\"2\">\n            <table>\n              <tr><th><a id=\"cql-content\"><b>Content: </b></a> text/cql</th></tr>\n              <tr><td><pre><code class=\"language-cql\">/*\nThis example is purely for illustration purposes to show how all the elements of a\nFHIR-based quality measure are represented. It is intentionally simplified to show\nspecific aspects of a measure, and is not intended as an example of a clinically\nmeaningful measure.\n*/\nlibrary Terminology version '1.0.0'\n\nusing FHIR version '4.0.1'\n\ninclude FHIRHelpers version '4.0.1' called FHIRHelpers\ninclude CommonTerminologies version '1.0.000' called Common\n\n// NOTE: Versioning is used in this example to illustrate completely how versioning is applied\n// References to specific versions of code systems and value sets should be used only when necessary\n\nvalueset &quot;Encounter Inpatient SNOMEDCT Value Set&quot;:\n   'http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.666.7.307|20160929'\n\ncode &quot;Venous foot pump, device (physical object)&quot;: '442023007' from Common.&quot;SNOMED CT:2017-09&quot;\ncode &quot;Right foot&quot;: '7769000' from Common.&quot;SNOMED CT:2017-09&quot;\n\nparameter &quot;Measurement Period&quot; Interval&lt;DateTime&gt;\n\ndefine &quot;Inpatient Encounter&quot;:\n  [&quot;Encounter&quot;: type in &quot;Encounter Inpatient SNOMEDCT Value Set&quot;] E\n    where E.status = 'finished'\n\n// DeviceUseStatement has a known issue with the publication tooling\n// so it is removed to allow this IG to publish until that is fixed\n//define &quot;Venous Foot Pumps Applied&quot;:\n//  [&quot;DeviceUseStatement&quot;: code in &quot;Venous foot pump, device (physical object)&quot;] D\n//    where D.status = 'completed'\n//      and D.bodySite ~ ToConcept(&quot;Right foot&quot;)\n</code></pre></td></tr>\n            </table>\n          </td>\n        </tr>\n        \n        \n        \n    </table>\n</div>\n</div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem",
      "valueReference" : {
        🔗 "reference" : "Device/software-system-example"
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cqi"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/cqm/Library/Terminology-FHIR",
  "version" : "1.0.0",
  "name" : "Terminology",
  "title" : "Terminology Library",
  "status" : "draft",
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/library-type",
        "code" : "logic-library"
      }
    ]
  },
  "date" : "2024-12-16T21:50:47+00:00",
  "publisher" : "HL7 International / Clinical Quality Information",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cqi"
        }
      ]
    }
  ],
  "description" : "This library is the primary measure library for the terminology example measure",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "relatedArtifact" : [
    {
      "type" : "depends-on",
      "display" : "FHIR model information",
      "resource" : "http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1"
    },
    {
      "type" : "depends-on",
      "display" : "Library FHIRHelpers",
      "resource" : "http://fhir.org/guides/common/Library/FHIRHelpers|4.0.1"
    },
    {
      "type" : "depends-on",
      "display" : "Code system SNOMED CT:2017-09",
      "resource" : "http://snomed.info/sct|http://snomed.info/sct/731000124108/version/201709"
    },
    {
      "type" : "depends-on",
      "display" : "Value set Encounter Inpatient SNOMEDCT Value Set",
      "resource" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.666.7.307|20160929"
    }
  ],
  "parameter" : [
    {
      "name" : "Measurement Period",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "type" : "Period"
    },
    {
      "name" : "Inpatient Encounter",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "type" : "Encounter"
    }
  ],
  "dataRequirement" : [
    {
      "type" : "Encounter",
      "profile" : [
        🔗 "http://hl7.org/fhir/StructureDefinition/Encounter"
      ],
      "codeFilter" : [
        {
          "path" : "type",
          "valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.666.7.307|20160929"
        },
        {
          "path" : "status",
          "code" : [
            {
              "system" : "http://hl7.org/fhir/encounter-status",
              "code" : "finished"
            }
          ]
        }
      ]
    }
  ],
  "content" : [
    {
      "contentType" : "text/cql",
      "data" : "LyoKVGhpcyBleGFtcGxlIGlzIHB1cmVseSBmb3IgaWxsdXN0cmF0aW9uIHB1cnBvc2VzIHRvIHNob3cgaG93IGFsbCB0aGUgZWxlbWVudHMgb2YgYQpGSElSLWJhc2VkIHF1YWxpdHkgbWVhc3VyZSBhcmUgcmVwcmVzZW50ZWQuIEl0IGlzIGludGVudGlvbmFsbHkgc2ltcGxpZmllZCB0byBzaG93CnNwZWNpZmljIGFzcGVjdHMgb2YgYSBtZWFzdXJlLCBhbmQgaXMgbm90IGludGVuZGVkIGFzIGFuIGV4YW1wbGUgb2YgYSBjbGluaWNhbGx5Cm1lYW5pbmdmdWwgbWVhc3VyZS4KKi8KbGlicmFyeSBUZXJtaW5vbG9neSB2ZXJzaW9uICcxLjAuMCcKCnVzaW5nIEZISVIgdmVyc2lvbiAnNC4wLjEnCgppbmNsdWRlIEZISVJIZWxwZXJzIHZlcnNpb24gJzQuMC4xJyBjYWxsZWQgRkhJUkhlbHBlcnMKaW5jbHVkZSBDb21tb25UZXJtaW5vbG9naWVzIHZlcnNpb24gJzEuMC4wMDAnIGNhbGxlZCBDb21tb24KCi8vIE5PVEU6IFZlcnNpb25pbmcgaXMgdXNlZCBpbiB0aGlzIGV4YW1wbGUgdG8gaWxsdXN0cmF0ZSBjb21wbGV0ZWx5IGhvdyB2ZXJzaW9uaW5nIGlzIGFwcGxpZWQKLy8gUmVmZXJlbmNlcyB0byBzcGVjaWZpYyB2ZXJzaW9ucyBvZiBjb2RlIHN5c3RlbXMgYW5kIHZhbHVlIHNldHMgc2hvdWxkIGJlIHVzZWQgb25seSB3aGVuIG5lY2Vzc2FyeQoKdmFsdWVzZXQgIkVuY291bnRlciBJbnBhdGllbnQgU05PTUVEQ1QgVmFsdWUgU2V0IjoKICAgJ2h0dHA6Ly9jdHMubmxtLm5paC5nb3YvZmhpci9WYWx1ZVNldC8yLjE2Ljg0MC4xLjExMzg4My4zLjY2Ni43LjMwN3wyMDE2MDkyOScKCmNvZGUgIlZlbm91cyBmb290IHB1bXAsIGRldmljZSAocGh5c2ljYWwgb2JqZWN0KSI6ICc0NDIwMjMwMDcnIGZyb20gQ29tbW9uLiJTTk9NRUQgQ1Q6MjAxNy0wOSIKY29kZSAiUmlnaHQgZm9vdCI6ICc3NzY5MDAwJyBmcm9tIENvbW1vbi4iU05PTUVEIENUOjIwMTctMDkiCgpwYXJhbWV0ZXIgIk1lYXN1cmVtZW50IFBlcmlvZCIgSW50ZXJ2YWw8RGF0ZVRpbWU+CgpkZWZpbmUgIklucGF0aWVudCBFbmNvdW50ZXIiOgogIFsiRW5jb3VudGVyIjogdHlwZSBpbiAiRW5jb3VudGVyIElucGF0aWVudCBTTk9NRURDVCBWYWx1ZSBTZXQiXSBFCiAgICB3aGVyZSBFLnN0YXR1cyA9ICdmaW5pc2hlZCcKCi8vIERldmljZVVzZVN0YXRlbWVudCBoYXMgYSBrbm93biBpc3N1ZSB3aXRoIHRoZSBwdWJsaWNhdGlvbiB0b29saW5nCi8vIHNvIGl0IGlzIHJlbW92ZWQgdG8gYWxsb3cgdGhpcyBJRyB0byBwdWJsaXNoIHVudGlsIHRoYXQgaXMgZml4ZWQKLy9kZWZpbmUgIlZlbm91cyBGb290IFB1bXBzIEFwcGxpZWQiOgovLyAgWyJEZXZpY2VVc2VTdGF0ZW1lbnQiOiBjb2RlIGluICJWZW5vdXMgZm9vdCBwdW1wLCBkZXZpY2UgKHBoeXNpY2FsIG9iamVjdCkiXSBECi8vICAgIHdoZXJlIEQuc3RhdHVzID0gJ2NvbXBsZXRlZCcKLy8gICAgICBhbmQgRC5ib2R5U2l0ZSB+IFRvQ29uY2VwdCgiUmlnaHQgZm9vdCIpCg=="
    }
  ]
}