FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: Measure/EXMRatio-FHIR

Packagehl7.fhir.uv.cqm
Resource TypeMeasure
IdEXMRatio-FHIR
FHIR VersionR4
Sourcehttp://hl7.org/fhir/uv/cqm/https://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-07
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

Knowledge Artifact Metadata
Name (machine-readable) EXMRatioMeasure
Title (human-readable) EXM Ratio Measure
Status Active
Experimental true
Description

An example FHIR-based publishable measure

Purpose

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

Clinical Usage Users of this measure should be aware of...
Approval Date 2019-02-17
Effective Period 2018-01-01..2018-12-31
Use Context Clinical Venue = EC
Topic Health Quality Measure Document
Measure Developer Example Measure Content Developer:
Measure Steward HL7 International / Clinical Quality Information
Steward Contact Details http://www.hl7.org/Special/committees/cqi
Copyright

Example Copyright Statement

Measure Metadata
Version Number 2.0.0
Measure Scoring Ratio
Measure Type Process
Rationale

The rationale of this measure is...

Improvement Notation Decreased score indicates improvement
Measure Population Criteria (ID: group-1)
Initial Population ID: initial-population
Description: No description provided Logic Definition: Initial Population
Numerator ID: numerator
Description: No description provided Logic Definition: Numerator
Denominator ID: denominator
Description: No description provided Logic Definition: Denominator
Measure Observation ID: denominator-observation
Description: No description provided Logic Definition: Measure Denominator Observation
Measure Observation ID: numerator-observation
Description: No description provided Logic Definition: Measure Numerator Observation
Measure Logic
Primary Library EXMRatio - Example Ratio Measure Library
Dependency Description: Value set Inpatient
Resource: http://example.org/fhir/ValueSet/inpatient
Canonical URL: http://example.org/fhir/ValueSet/inpatient
Parameter Name: Numerator
Use: Out
Min Cardinality: 0
Max Cardinality: *
Type: Encounter
Parameter Name: Denominator
Use: Out
Min Cardinality: 0
Max Cardinality: *
Type: Encounter
Parameter Name: Initial Population
Use: Out
Min Cardinality: 0
Max Cardinality: *
Type: Encounter
Measure Logic Data Requirements
Data Requirement Type: Encounter
Profile(s): Encounter
Must Support Elements: type
Code Filter(s):
Path: type
ValueSet: http://example.org/fhir/ValueSet/inpatient
Measure Logic Definitions
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"
Generated using version 0.4.6 of the sample-content-ig Liquid templates

Source

{
  "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"
        }
      ],
      "name": "EffectiveDataRequirements",
      "status": "active",
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/library-type",
            "code": "module-definition"
          }
        ]
      },
      "relatedArtifact": [
        {
          "type": "depends-on",
          "display": "Value set Inpatient",
          "resource": "http://example.org/fhir/ValueSet/inpatient"
        }
      ],
      "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"
          ],
          "codeFilter": [
            {
              "path": "type",
              "valueSet": "http://example.org/fhir/ValueSet/inpatient"
            }
          ]
        }
      ]
    }
  ],
  "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"
      }
    },
    {
      "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-07",
  "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": "Measure 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": "Measure Numerator Observation"
          }
        }
      ]
    }
  ]
}