FHIR IG analytics

Resources that use this resource

Resources that this resource uses

No resources found

Narrative

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

Source1

{
  "resourceType": "OperationDefinition",
  "id": "cqm-data-requirements",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cqi"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 4,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/cqm/ImplementationGuide/hl7.fhir.uv.cqm"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/cqm/ImplementationGuide/hl7.fhir.uv.cqm"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/cqm/OperationDefinition/cqm-data-requirements",
  "version": "2.0.0-cibuild",
  "name": "DataRequirements",
  "status": "draft",
  "kind": "operation",
  "date": "2026-06-22",
  "publisher": "HL7 International / Clinical Quality Information",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/cqi"
        }
      ]
    }
  ],
  "description": "The data-requirements operation aggregates and returns the parameters and data requirements for a measure or set of measures and all dependencies as a single module definition",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "code": "data-requirements",
  "comment": "The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the measure or set of measures. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the libraries referenced by the measures. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements). This operation defines what resources are subsequently referenced in the evaluatedResources element of the MeasureReport when submitting measure data",
  "resource": [
    "Measure",
    "Library"
  ],
  "system": true,
  "type": true,
  "instance": true,
  "parameter": [
    {
      "name": "url",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Identifies a measure or other artifact for which data requirements will be determined (specified as an optionally-versioned canonical reference). The server must know the measure or artifact (i.e. it is defined explicitly in the server's measures or artifacts). It is an error to use this parameter when the operation is invoked on an instance. Note that for backwards compatibility, canonical references in artifact operation parameters are represented using the `uri` type, rather than the R4 `canonical` type.",
      "type": "uri"
    },
    {
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Any input parameters for the artifact(s). If the artifact is a logic library, or references logic libraries, parameters defined in this input will be bound by name to parameters defined in the logic library (or referenced libraries). If the logic library is a CQL library, parameter types are mapped to CQL as specified in the Using CQL with FHIR implementation guide. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL.",
      "type": "Parameters"
    },
    {
      "name": "periodStart",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive",
      "type": "date"
    },
    {
      "name": "periodEnd",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive",
      "type": "date"
    },
    {
      "name": "defaultArtifactVersion",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Specifies a version to use for a canonical or artifact resource if the artifact referencing \nthe resource does not already specify a version. The format is the same as a canonical URL:\n[url]|[version] - e.g. http://loinc.org|2.56 \n\nNote that this is a generalization of the `system-version` parameter defined in the $expand operation \nto apply to any canonical resource, including code systems.",
      "type": "uri"
    },
    {
      "name": "checkArtifactVersion",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Edge Case: Specifies a version to use for a canonical or artifact resource. If the artifact referencing \nthe resource specifies a different version, an error is returned instead of the package. The\nformat is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56 \n\nNote that this is a generalization of the `check-system-version` parameter defined in the $expand operation to \napply to any canonical resource, including code systems.",
      "type": "uri"
    },
    {
      "name": "forceArtifactVersion",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Edge Case: Specifies a version to use for a canonical or artifact resource. This parameter overrides any\nspecified version in the artifact (and any artifacts it depends on). The\nformat is the same as a canonical URL: [system]|[version] - e.g.\nhttp://loinc.org|2.56. Note that this has obvious safety issues, in that it may\nresult in a value set expansion giving a different list of codes that is both\nwrong and unsafe, and implementers should only use this capability reluctantly.\n\nIt primarily exists to deal with situations where specifications have fallen\ninto decay as time passes. If the version of a canonical is overridden, the version used SHALL\nexplicitly be represented in the expansion parameters. \n\nNote that this is a generalization of the `force-system-version` parameter defined in the $expand operation \nto apply to any canonical resource, including code systems.",
      "type": "uri"
    },
    {
      "name": "manifest",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Specifies an asset-collection library that defines version\nbindings for code systems and other canonical resources referenced by the value\nset(s) being expanded and other canonical resources referenced by the artifact.\nWhen specified, the expansion parameters of the manifest are used to provide expansion\nbehavior and canonical resolution for dependencies encountered while processing the \noperation.",
      "type": "canonical",
      "targetProfile": [
        "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-manifestlibrary"
      ]
    },
    {
      "name": "artifactEndpointConfiguration",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Configuration information to resolve canonical artifacts\n* `artifactRoute`: An optional route used to determine whether this endpoint is expected to be able to resolve artifacts that match the route (i.e. start with the route, up to and including the entire url)\n* `endpointUri`: The URI of the endpoint, exclusive with the `endpoint` parameter\n* `endpoint`: An Endpoint resource describing the endpoint, exclusive with the `endpointUri` parameter\n\n**Processing semantics**:\n\nCreate a canonical-like reference (e.g.\n`{canonical.url}|{canonical.version}` or similar extensions for non-canonical artifacts).\n\n* Given a single `artifactEndpointConfiguration`\n  * When `artifactRoute` is present\n    * And canonical or artifact reference *starts with* `artifactRoute`\n    * Then attempt to resolve with `endpointUri` or `endpoint`\n  * When `artifactRoute` is not present\n    * Then attempt to resolve with `endpointUri` or `endpoint`\n* Given multiple `artifactEndpointConfiguration`s\n  * Then rank order each configuration (see below)\n  * And attempt to resolve with `endpointUri` or `endpoint` in order until resolved\n\nRank each `artifactEndpointConfiguration` such that:\n* if `artifactRoute` is present *and* canonical or artifact reference *starts with* `artifactRoute`: rank based on number of matching characters \n* if `artifactRoute` is *not* present: include but rank lower\n\nNOTE: For evenly ranked `artifactEndpointConfiguration`s, order as defined in the\nOperationDefinition.",
      "part": [
        {
          "name": "artifactRoute",
          "use": "in",
          "min": 0,
          "max": "1",
          "type": "uri"
        },
        {
          "name": "endpointUri",
          "use": "in",
          "min": 0,
          "max": "1",
          "type": "uri"
        },
        {
          "name": "endpoint",
          "use": "in",
          "min": 0,
          "max": "1",
          "type": "Endpoint"
        }
      ]
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the measure(s).",
      "type": "Library"
    }
  ]
}