FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.cqm
Resource TypeMeasure
IdMeasure-EXMRatio-FHIR.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/HL7/fhir-cqm/Measure-EXMRatio-FHIR.html
URLhttp://example.org/fhir/measures/measure-ratio-exm
Version2.0.0
Statusactive
Date2025-08-13
NameEXMRatioMeasure
TitleEXM Ratio Measure
Realmuv
Authorityhl7
DescriptionAn example FHIR-based publishable measure
PurposeThis measure has been developed to support improvement in clinical care.
CopyrightExample Copyright Statement

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Metadata
Title EXM Ratio Measure
Version 2.0.0
Identifier EXMRatio-FHIR
Identifier urn:oid:2.16.840.1.113883.4.642.40.61.29.10
Effective Period 2018-01-01 + 1 year(s)
Approval Date 2019-02-17
Last Review Date 2019-02-17
Experimental true
Use Context Clinical Venue = EC
Jurisdiction Global (Whole world)
Topic Health Quality Measure Document
Steward (Publisher) HL7 International / Clinical Quality Information
Developer Example Measure Content Developer
Description

An example FHIR-based publishable measure
Purpose

This measure has been developed to support improvement in clinical care.
Copyright

Example Copyright Statement
Disclaimer

Example disclaimer
Measure Basis Encounter
Measure Scoring Ratio
Measure Scoring Unit /1000.d
Measure Type Process
Rationale

The rationale of this measure is...
Improvement Notation Decreased score indicates improvement
Guidance (Usage) Users of this measure should be aware of...
Measure Group (Rate) (ID: primary)
Initial Population ID: primary-exmratio-initial-population
Description: No description provided Criteria: Initial Population
Numerator ID: primary-exmratio-numerator
Description: No description provided Criteria: Numerator
Denominator ID: primary-exmratio-denominator
Description: No description provided Criteria: Denominator
Measure Observation ID: primary-exmratio-denominator-observation
Description: No description provided Criteria: Denominator Observation
Input Population: denominator AggregateMethod: sum
Measure Observation ID: primary-exmratio-numerator-observation
Description: No description provided Criteria: Numerator Observation
Input Population: numerator AggregateMethod: sum
Measure Logic
Primary Library EXMRatio - Example Ratio Measure Library
Contents Population Criteria
Logic Definitions
Terminology
Dependencies
Data Requirements
Population Criteria
Measure Group (Rate) (ID: primary)
Initial Population 
define "Initial Population":
  "Qualifying Encounters"
Definition
Numerator 
define "Numerator":
  "Initial Population"
Definition
Denominator 
define "Denominator":
  "Initial Population"
Definition
Measure Observation 
define function "Denominator Observation"(Encounter "Encounter"):
  duration in hours of Global.Hospitalization(Encounter) / 24
Definition
Measure Observation 
define function "Numerator Observation"(Encounter "Encounter"):
  Count(
    "Falls with Major Injury" Falls
      where Global."Normalize Interval"(Falls.effective) during Encounter.period
  )
Definition
Logic Definitions
Logic Definition Library Name: MATGlobalCommonFunctions 
define function "Hospitalization"(TheEncounter FHIR.Encounter):
	( "ED Visit"(TheEncounter) ) X
    return
        if X is null then TheEncounter.period
        else Interval[start of FHIRHelpers.ToInterval(X.period), end of FHIRHelpers.ToInterval(TheEncounter.period)]
Logic Definition Library Name: MATGlobalCommonFunctions 
define function "ED Visit"(TheEncounter FHIR.Encounter):
    singleton from (
        [Encounter: "Emergency Department Visit"] EDVisit
            where EDVisit.status = 'finished'
                and EDVisit.period ends 1 hour or less on or before start of FHIRHelpers.ToInterval(TheEncounter.period)
    )
Logic Definition Library Name: FHIRHelpers 
define function ToString(value EncounterStatus): value.value
Logic Definition Library Name: FHIRHelpers 
/*
@description: Converts the given [Period](https://hl7.org/fhir/datatypes.html#Period)
value to a CQL DateTime Interval
@comment: If the start value of the given period is unspecified, the starting
boundary of the resulting interval will be open (meaning the start of the interval
is unknown, as opposed to interpreted as the beginning of time).
*/
define function ToInterval(period FHIR.Period):
    if period is null then
        null
    else
        if period."start" is null then
            Interval(period."start".value, period."end".value]
        else
            Interval[period."start".value, period."end".value]
Logic Definition Library Name: EXMRatio 
define "Qualifying Encounters":
  ["Encounter": "Inpatient"]
Logic Definition Library Name: EXMRatio 
define "Initial Population":
  "Qualifying Encounters"
Logic Definition Library Name: EXMRatio 
define "Numerator":
  "Initial Population"
Logic Definition Library Name: EXMRatio 
define "Denominator":
  "Initial Population"
Logic Definition Library Name: EXMRatio 
define "Falls with Major Injury":
  ["Observation": "Fall"]
Logic Definition Library Name: EXMRatio 
define function "Denominator Observation"(Encounter "Encounter"):
  duration in hours of Global.Hospitalization(Encounter) / 24
Logic Definition Library Name: EXMRatio 
define function "Numerator Observation"(Encounter "Encounter"):
  Count(
    "Falls with Major Injury" Falls
      where Global."Normalize Interval"(Falls.effective) during Encounter.period
  )
Terminology
Value Set Description: Value set Inpatient
Resource: http://example.org/fhir/ValueSet/inpatient
Canonical URL: http://example.org/fhir/ValueSet/inpatient
Value Set Description: Value set Emergency Department Visit
Resource: Emergency Department Visit
Canonical URL: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.117.1.7.1.292
Value Set Description: Value set Fall
Resource: http://example.org/fhir/ValueSet/fall
Canonical URL: http://example.org/fhir/ValueSet/fall
Dependencies
Dependency Description: Library Global
Resource: MAT Global Common Functions FHIR Libraryversion: null5.0.000)
Canonical URL: http://hl7.org/fhir/uv/cqm/Library/MATGlobalCommonFunctions|5.0.000
Dependency Description: Library FHIRHelpers
Resource: http://hl7.org/fhir/uv/cql/Library/FHIRHelpers|4.0.1
Canonical URL: http://hl7.org/fhir/uv/cql/Library/FHIRHelpers|4.0.1
Data Requirements
Data Requirement Type: Encounter
Profile(s): Encounter
Must Support Elements: type, status, period
Code Filter(s):
Path: type
ValueSet: Emergency Department Visit
Data Requirement Type: Encounter
Profile(s): Encounter
Must Support Elements: type, period
Code Filter(s):
Path: type
ValueSet: http://example.org/fhir/ValueSet/inpatient
Data Requirement Type: Observation
Profile(s): Observation
Must Support Elements: code, effective
Code Filter(s):
Path: code
ValueSet: http://example.org/fhir/ValueSet/fall
Generated using version 0.4.9 of the sample-content-ig Liquid templates

Source1

{
  "resourceType": "Measure",
  "id": "EXMRatio-FHIR",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-ratiomeasure",
      "http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-computablemeasure",
      "http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-cqlmeasure",
      "http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-computablemeasure"
    ]
  },
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "contained": [
    {
      "resourceType": "Library",
      "id": "effective-data-requirements",
      "extension": [
        {
          "extension": [
            {
              "url": "libraryName",
              "valueString": "EXMRatio"
            },
            {
              "url": "name",
              "valueString": "Qualifying Encounters"
            },
            {
              "url": "statement",
              "valueString": "define \"Qualifying Encounters\":\n  [\"Encounter\": \"Inpatient\"]"
            },
            {
              "url": "displaySequence",
              "valueInteger": 0
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
        },
        {
          "extension": [
            {
              "url": "libraryName",
              "valueString": "EXMRatio"
            },
            {
              "url": "name",
              "valueString": "Initial Population"
            },
            {
              "url": "statement",
              "valueString": "define \"Initial Population\":\n  \"Qualifying Encounters\""
            },
            {
              "url": "displaySequence",
              "valueInteger": 1
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
        },
        {
          "extension": [
            {
              "url": "libraryName",
              "valueString": "EXMRatio"
            },
            {
              "url": "name",
              "valueString": "Numerator"
            },
            {
              "url": "statement",
              "valueString": "define \"Numerator\":\n  \"Initial Population\""
            },
            {
              "url": "displaySequence",
              "valueInteger": 2
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
        },
        {
          "extension": [
            {
              "url": "libraryName",
              "valueString": "EXMRatio"
            },
            {
              "url": "name",
              "valueString": "Denominator"
            },
            {
              "url": "statement",
              "valueString": "define \"Denominator\":\n  \"Initial Population\""
            },
            {
              "url": "displaySequence",
              "valueInteger": 3
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
        },
        {
          "extension": [
            {
              "url": "libraryName",
              "valueString": "EXMRatio"
            },
            {
              "url": "name",
              "valueString": "Falls with Major Injury"
            },
            {
              "url": "statement",
              "valueString": "define \"Falls with Major Injury\":\n  [\"Observation\": \"Fall\"]"
            },
            {
              "url": "displaySequence",
              "valueInteger": 4
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
        },
        {
          "extension": [
            {
              "url": "libraryName",
              "valueString": "EXMRatio"
            },
            {
              "url": "name",
              "valueString": "Denominator Observation"
            },
            {
              "url": "statement",
              "valueString": "define function \"Denominator Observation\"(Encounter \"Encounter\"):\n  duration in hours of Global.Hospitalization(Encounter) / 24"
            },
            {
              "url": "displaySequence",
              "valueInteger": 5
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
        },
        {
          "extension": [
            {
              "url": "libraryName",
              "valueString": "MATGlobalCommonFunctions"
            },
            {
              "url": "name",
              "valueString": "Hospitalization"
            },
            {
              "url": "statement",
              "valueString": "define function \"Hospitalization\"(TheEncounter FHIR.Encounter):\n\t( \"ED Visit\"(TheEncounter) ) X\n    return\n        if X is null then TheEncounter.period\n        else Interval[start of FHIRHelpers.ToInterval(X.period), end of FHIRHelpers.ToInterval(TheEncounter.period)]"
            },
            {
              "url": "displaySequence",
              "valueInteger": 6
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
        },
        {
          "extension": [
            {
              "url": "libraryName",
              "valueString": "MATGlobalCommonFunctions"
            },
            {
              "url": "name",
              "valueString": "ED Visit"
            },
            {
              "url": "statement",
              "valueString": "define function \"ED Visit\"(TheEncounter FHIR.Encounter):\n    singleton from (\n        [Encounter: \"Emergency Department Visit\"] EDVisit\n            where EDVisit.status = 'finished'\n                and EDVisit.period ends 1 hour or less on or before start of FHIRHelpers.ToInterval(TheEncounter.period)\n    )"
            },
            {
              "url": "displaySequence",
              "valueInteger": 7
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
        },
        {
          "extension": [
            {
              "url": "libraryName",
              "valueString": "FHIRHelpers"
            },
            {
              "url": "name",
              "valueString": "ToString"
            },
            {
              "url": "statement",
              "valueString": "define function ToString(value EncounterStatus): value.value"
            },
            {
              "url": "displaySequence",
              "valueInteger": 8
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
        },
        {
          "extension": [
            {
              "url": "libraryName",
              "valueString": "FHIRHelpers"
            },
            {
              "url": "name",
              "valueString": "ToInterval"
            },
            {
              "url": "statement",
              "valueString": "/*\n@description: Converts the given [Period](https://hl7.org/fhir/datatypes.html#Period)\nvalue to a CQL DateTime Interval\n@comment: If the start value of the given period is unspecified, the starting\nboundary of the resulting interval will be open (meaning the start of the interval\nis unknown, as opposed to interpreted as the beginning of time).\n*/\ndefine function ToInterval(period FHIR.Period):\n    if period is null then\n        null\n    else\n        if period.\"start\" is null then\n            Interval(period.\"start\".value, period.\"end\".value]\n        else\n            Interval[period.\"start\".value, period.\"end\".value]"
            },
            {
              "url": "displaySequence",
              "valueInteger": 9
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
        },
        {
          "extension": [
            {
              "url": "libraryName",
              "valueString": "EXMRatio"
            },
            {
              "url": "name",
              "valueString": "Numerator Observation"
            },
            {
              "url": "statement",
              "valueString": "define function \"Numerator Observation\"(Encounter \"Encounter\"):\n  Count(\n    \"Falls with Major Injury\" Falls\n      where Global.\"Normalize Interval\"(Falls.effective) during Encounter.period\n  )"
            },
            {
              "url": "displaySequence",
              "valueInteger": 10
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
        }
      ],
      "name": "EffectiveDataRequirements",
      "status": "active",
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/library-type",
            "code": "module-definition"
          }
        ]
      },
      "relatedArtifact": [
        {
          "type": "depends-on",
          "display": "Library Global",
          "resource": "http://hl7.org/fhir/uv/cqm/Library/MATGlobalCommonFunctions|5.0.000"
        },
        {
          "type": "depends-on",
          "display": "Library FHIRHelpers",
          "resource": "http://hl7.org/fhir/uv/cql/Library/FHIRHelpers|4.0.1"
        },
        {
          "type": "depends-on",
          "display": "Value set Inpatient",
          "resource": "http://example.org/fhir/ValueSet/inpatient"
        },
        {
          "type": "depends-on",
          "display": "Value set Emergency Department Visit",
          "resource": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.117.1.7.1.292"
        },
        {
          "type": "depends-on",
          "display": "Value set Fall",
          "resource": "http://example.org/fhir/ValueSet/fall"
        }
      ],
      "parameter": [
        {
          "name": "Numerator",
          "use": "out",
          "min": 0,
          "max": "*",
          "type": "Encounter"
        },
        {
          "name": "Denominator",
          "use": "out",
          "min": 0,
          "max": "*",
          "type": "Encounter"
        },
        {
          "name": "Initial Population",
          "use": "out",
          "min": 0,
          "max": "*",
          "type": "Encounter"
        }
      ],
      "dataRequirement": [
        {
          "type": "Encounter",
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/Encounter"
          ],
          "mustSupport": [
            "type",
            "status",
            "period"
          ],
          "codeFilter": [
            {
              "path": "type",
              "valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.117.1.7.1.292"
            }
          ]
        },
        {
          "type": "Encounter",
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/Encounter"
          ],
          "mustSupport": [
            "type",
            "period"
          ],
          "codeFilter": [
            {
              "path": "type",
              "valueSet": "http://example.org/fhir/ValueSet/inpatient"
            }
          ]
        },
        {
          "type": "Observation",
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/Observation"
          ],
          "mustSupport": [
            "code",
            "effective"
          ],
          "codeFilter": [
            {
              "path": "code",
              "valueSet": "http://example.org/fhir/ValueSet/fall"
            }
          ]
        }
      ]
    }
  ],
  "extension": [
    {
      "url": "http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-populationBasis",
      "valueCode": "Encounter"
    },
    {
      "url": "http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-scoringUnit",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://unitsofmeasure.org",
            "code": "/1000.d"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem",
      "valueReference": {
        "reference": "Device/software-system-example"
      }
    },
    {
      "id": "effective-data-requirements",
      "url": "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-effectiveDataRequirements",
      "valueCanonical": "#effective-data-requirements"
    }
  ],
  "url": "http://example.org/fhir/measures/measure-ratio-exm",
  "identifier": [
    {
      "system": "http://example.org/fhir/cqi/ecqm/Measure/Identifier/exm",
      "value": "EXMRatio-FHIR"
    },
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.40.61.29.10"
    }
  ],
  "version": "2.0.0",
  "name": "EXMRatioMeasure",
  "title": "EXM Ratio Measure",
  "status": "active",
  "experimental": true,
  "date": "2025-08-13",
  "publisher": "HL7 International / Clinical Quality Information",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/cqi"
        }
      ]
    }
  ],
  "description": "An example FHIR-based publishable measure",
  "useContext": [
    {
      "code": {
        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code": "venue",
        "display": "Clinical Venue"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/uv/cqm/CodeSystem/intended-venue-codes",
            "code": "ec",
            "display": "EC"
          }
        ]
      }
    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "purpose": "This measure has been developed to support improvement in clinical care.",
  "usage": "Users of this measure should be aware of...",
  "copyright": "Example Copyright Statement",
  "approvalDate": "2019-02-17",
  "lastReviewDate": "2019-02-17",
  "effectivePeriod": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodAnchor",
        "valueDateTime": "2018-01-01"
      },
      {
        "url": "http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodDuration",
        "valueDuration": {
          "value": 1,
          "system": "http://unitsofmeasure.org",
          "code": "a"
        }
      }
    ],
    "start": "2018-01-01",
    "end": "2018-12-31"
  },
  "topic": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "57024-2"
        }
      ],
      "text": "Health Quality Measure Document"
    }
  ],
  "author": [
    {
      "name": "Example Measure Content Developer"
    }
  ],
  "library": [
    "http://hl7.org/fhir/uv/cqm/Library/EXMRatio"
  ],
  "disclaimer": "Example disclaimer",
  "scoring": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/measure-scoring",
        "code": "ratio",
        "display": "Ratio"
      }
    ]
  },
  "type": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/measure-type",
          "code": "process"
        }
      ]
    }
  ],
  "rationale": "The rationale of this measure is...",
  "improvementNotation": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/measure-improvement-notation",
        "code": "decrease",
        "display": "Decreased score indicates improvement"
      }
    ]
  },
  "group": [
    {
      "id": "group-1",
      "extension": [
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Measure.group.linkId",
          "valueString": "primary"
        }
      ],
      "population": [
        {
          "id": "initial-population",
          "extension": [
            {
              "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Measure.group.population.linkId",
              "valueString": "primary-exmratio-initial-population"
            }
          ],
          "code": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/measure-population",
                "code": "initial-population",
                "display": "Initial Population"
              }
            ]
          },
          "criteria": {
            "language": "text/cql-identifier",
            "expression": "Initial Population"
          }
        },
        {
          "id": "numerator",
          "extension": [
            {
              "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Measure.group.population.linkId",
              "valueString": "primary-exmratio-numerator"
            }
          ],
          "code": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/measure-population",
                "code": "numerator",
                "display": "Numerator"
              }
            ]
          },
          "criteria": {
            "language": "text/cql-identifier",
            "expression": "Numerator"
          }
        },
        {
          "id": "denominator",
          "extension": [
            {
              "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Measure.group.population.linkId",
              "valueString": "primary-exmratio-denominator"
            }
          ],
          "code": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/measure-population",
                "code": "denominator",
                "display": "Denominator"
              }
            ]
          },
          "criteria": {
            "language": "text/cql-identifier",
            "expression": "Denominator"
          }
        },
        {
          "id": "denominator-observation",
          "extension": [
            {
              "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Measure.group.population.linkId",
              "valueString": "primary-exmratio-denominator-observation"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/cqf-criteriaReference",
              "valueString": "denominator"
            },
            {
              "url": "http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-aggregateMethod",
              "valueCode": "sum"
            }
          ],
          "code": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/measure-population",
                "code": "measure-observation",
                "display": "Measure Observation"
              }
            ]
          },
          "criteria": {
            "language": "text/cql-identifier",
            "expression": "Denominator Observation"
          }
        },
        {
          "id": "numerator-observation",
          "extension": [
            {
              "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Measure.group.population.linkId",
              "valueString": "primary-exmratio-numerator-observation"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/cqf-criteriaReference",
              "valueString": "numerator"
            },
            {
              "url": "http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-aggregateMethod",
              "valueCode": "sum"
            }
          ],
          "code": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/measure-population",
                "code": "measure-observation",
                "display": "Measure Observation"
              }
            ]
          },
          "criteria": {
            "language": "text/cql-identifier",
            "expression": "Numerator Observation"
          }
        }
      ]
    }
  ]
}