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

FHIR IG Statistics: StructureDefinition/MeasureCriteria

Packagehl7.fhir.uv.saner
TypeStructureDefinition
IdMeasureCriteria
FHIR VersionR4
Sourcehttp://hl7.org/fhir/uv/saner/https://build.fhir.org/ig/HL7/fhir-saner/StructureDefinition-MeasureCriteria.html
URLhttp://hl7.org/fhir/uv/saner/StructureDefinition/MeasureCriteria
Version1.0.1
Statusdraft
Date2024-05-18T21:25:01+00:00
NameMeasureCriteria
Realmuv
Authorityhl7
DescriptionConstraints on documentation for the evaluation of a Measure
TypeExpression
Kindcomplex-type

Resources that use this resource

StructureDefinition
MeasureAlternateCriteriaAlternate criteria for performing a measure
PublicHealthMeasurePublic Health Measure

Resources that this resource uses

StructureDefinition
MeasureAlternateCriteriaAlternate criteria for performing a measure

Narrative

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Expression Expression
... Slices for extension Content/Rules for all slices
.... alternateCriteria 0..1MeasureCriteriaOther expressions for computing the criterion
URL: http://hl7.org/fhir/uv/saner/StructureDefinition/MeasureAlternateCriteria
... description S1..1stringDescribe what the criterion does to a human (non-engineer)
... name S0..1idname should align with code.
... language S1..1codeProvide the language for the criterion
... expression S1..1stringA measure must describe how to automate the computation in an expression that can be evaluated in the specified language

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "MeasureCriteria",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "pher"
    }
  ],
  "url": "http://hl7.org/fhir/uv/saner/StructureDefinition/MeasureCriteria",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.40.42.42.5"
    }
  ],
  "version": "1.0.1",
  "name": "MeasureCriteria",
  "status": "draft",
  "experimental": false,
  "date": "2024-05-18T21:25:01+00:00",
  "publisher": "HL7 International / Public Health",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/pher"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "email",
          "value": "pher@lists.hl7.org"
        }
      ]
    },
    {
      "name": "Keith W. Boone",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:kboone@ainq.com"
        }
      ]
    }
  ],
  "description": "Constraints on documentation for the evaluation of a Measure",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "type": "Expression",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Expression",
  "derivation": "constraint",
  "snapshot": {
    "element": [
      {
        "id": "Expression",
        "path": "Expression",
        "short": "An expression that can be used to generate a value",
        "definition": "A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Expression",
          "min": 0,
          "max": "*"
        },
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "exp-1",
            "severity": "error",
            "human": "An expression or a reference must be provided",
            "expression": "expression.exists() or reference.exists()",
            "xpath": "exists(f:expression) or exists(f:reference)",
            "source": "http://hl7.org/fhir/StructureDefinition/Expression"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Expression.id",
        "path": "Expression.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "string"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Expression.extension",
        "path": "Expression.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Additional content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
        "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Expression.extension:alternateCriteria",
        "path": "Expression.extension",
        "sliceName": "alternateCriteria",
        "short": "Other expressions for computing the criterion",
        "definition": "Provides Alternate criteria for performing a measure, (e.g., CQL, Drools, et cetera)",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/uv/saner/StructureDefinition/MeasureAlternateCriteria"
            ]
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false
      },
      {
        "id": "Expression.description",
        "path": "Expression.description",
        "short": "Describe what the criterion does to a human (non-engineer)",
        "definition": "A brief, natural language description of the condition that effectively communicates the intended semantics.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Expression.description",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mustSupport": true,
        "isModifier": false,
        "isSummary": true
      },
      {
        "id": "Expression.name",
        "path": "Expression.name",
        "short": "name should align with code.",
        "definition": "A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Expression.name",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "id"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mustSupport": true,
        "isModifier": false,
        "isSummary": true
      },
      {
        "id": "Expression.language",
        "path": "Expression.language",
        "short": "Provide the language for the criterion",
        "definition": "The media type of the language for the expression.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Expression.language",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mustSupport": true,
        "isModifier": false,
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
              "valueCanonical": "http://www.rfc-editor.org/bcp/bcp13.txt"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "ExpressionLanguage"
            }
          ],
          "strength": "extensible",
          "description": "The media type of the expression language.",
          "valueSet": "http://hl7.org/fhir/ValueSet/expression-language"
        }
      },
      {
        "id": "Expression.expression",
        "path": "Expression.expression",
        "short": "A measure must describe how to automate the computation in an expression that can be evaluated in the specified language",
        "definition": "An expression in the specified language that returns a value.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Expression.expression",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mustSupport": true,
        "isModifier": false,
        "isSummary": true
      },
      {
        "id": "Expression.reference",
        "path": "Expression.reference",
        "short": "Where the expression is found",
        "definition": "A URI that defines where the expression is found.",
        "comment": "If both a reference and an expression is found, the reference SHALL point to the same expression.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Expression.reference",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "uri"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": true
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Expression.extension:alternateCriteria",
        "path": "Expression.extension",
        "sliceName": "alternateCriteria",
        "short": "Other expressions for computing the criterion",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/uv/saner/StructureDefinition/MeasureAlternateCriteria"
            ]
          }
        ]
      },
      {
        "id": "Expression.description",
        "path": "Expression.description",
        "short": "Describe what the criterion does to a human (non-engineer)",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Expression.name",
        "path": "Expression.name",
        "short": "name should align with code.",
        "mustSupport": true
      },
      {
        "id": "Expression.language",
        "path": "Expression.language",
        "short": "Provide the language for the criterion",
        "mustSupport": true
      },
      {
        "id": "Expression.expression",
        "path": "Expression.expression",
        "short": "A measure must describe how to automate the computation in an expression that can be evaluated in the specified language",
        "min": 1,
        "mustSupport": true
      }
    ]
  }
}