{
  "description": "Describes the extent to which the FHIR query patterns given for a data requirement (i.e. the cqf-fhirQueryPattern extensions present on the data requirement) cover the criteria of that data requirement. Because the query patterns for a data requirement are considered as a set (i.e. the union of the results of the query patterns represents the data for the data requirement), coverage is a characteristic of the data requirement as a whole, rather than of any individual query pattern. A coverage of `total` indicates that no further filtering of the results is required; any other value indicates that the consumer must apply the criteria of the data requirement to the results of the query patterns.",
  "_filename": "StructureDefinition-cql-fhirQueryPatternCoverage.json",
  "package_name": "hl7.fhir.uv.cql",
  "date": "2026-08-04",
  "derivation": "constraint",
  "publisher": "HL7 International / Clinical Decision Support",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "display": "World"
    } ]
  } ],
  "name": "CQLFHIRQueryPatternCoverage",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "Extension",
  "experimental": "false",
  "resourceType": "StructureDefinition",
  "title": "CQL FHIR Query Pattern Coverage",
  "package_version": "3.0.0-ballot",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode": "cds"
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger": 1
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode": "trial-use"
  } ],
  "snapshot": {
    "element": [ {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "ext-1",
        "human": "Must have either extensions or value[x], not both",
        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
        "source": "http://hl7.org/fhir/StructureDefinition/Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "Extension",
      "min": 0,
      "definition": "Describes the extent to which the FHIR query patterns given for a data requirement (i.e. the cqf-fhirQueryPattern extensions present on the data requirement) cover the criteria of that data requirement. Because the query patterns for a data requirement are considered as a set (i.e. the union of the results of the query patterns represents the data for the data requirement), coverage is a characteristic of the data requirement as a whole, rather than of any individual query pattern.",
      "isModifier": false,
      "short": "How completely do the query patterns cover the data requirement?",
      "max": "1",
      "id": "Extension",
      "condition": [ "ele-1" ],
      "comment": "This extension does not change the expectation that the query patterns for a data requirement are sound, meaning that the union of their results includes all the data described by the data requirement. Criteria that cannot be expressed as search parameters are omitted from the query patterns, rather than approximated with criteria that could exclude required data, and the resulting loss of precision is communicated with this extension. Consuming systems apply the criteria of the data requirement to the results of the query patterns unless the coverage is `total`.",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Extension"
      }
    }, {
      "path": "Extension.id",
      "min": 0,
      "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
      "isModifier": false,
      "short": "Unique id for inter-element referencing",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "http://hl7.org/fhirpath/System.String",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUrl": "string"
        } ]
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "Extension.id",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Element.id"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "ext-1",
        "human": "Must have either extensions or value[x], not both",
        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
        "source": "http://hl7.org/fhir/StructureDefinition/Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "Extension.extension",
      "min": 0,
      "definition": "An Extension",
      "isModifier": false,
      "short": "Extension",
      "slicing": {
        "rules": "open",
        "description": "Extensions are always sliced by (at least) url",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      },
      "type": [ {
        "code": "Extension"
      } ],
      "max": "0",
      "id": "Extension.extension",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element.extension"
      },
      "isSummary": false
    }, {
      "path": "Extension.url",
      "min": 1,
      "definition": "Source of the definition for the extension code - a logical name or a URL.",
      "isModifier": false,
      "short": "identifies the meaning of the extension",
      "fixedUri": "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-fhirQueryPatternCoverage",
      "mapping": [ {
        "map": "N/A",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "uri"
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "Extension.url",
      "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
      "base": {
        "max": "1",
        "min": 1,
        "path": "Extension.url"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "Extension.value[x]",
      "min": 1,
      "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
      "isModifier": false,
      "short": "Value of extension",
      "mapping": [ {
        "map": "N/A",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "code"
      } ],
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/uv/cql/ValueSet/query-pattern-coverage"
      },
      "max": "1",
      "id": "Extension.value[x]",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Extension.value[x]"
      },
      "isSummary": false
    } ],
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
      "valueString": "4.0.1"
    } ]
  },
  "status": "active",
  "id": "7ebe7794-ce35-4424-af17-717b369e0787",
  "kind": "complex-type",
  "url": "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-fhirQueryPatternCoverage",
  "identifier": [ {
    "value": "urn:oid:2.16.840.1.113883.4.642.40.37.42.18",
    "system": "urn:ietf:rfc:3986"
  } ],
  "context": [ {
    "type": "element",
    "expression": "DataRequirement"
  } ],
  "version": "3.0.0-ballot",
  "differential": {
    "element": [ {
      "id": "Extension",
      "max": "1",
      "min": 0,
      "path": "Extension",
      "short": "How completely do the query patterns cover the data requirement?",
      "comment": "This extension does not change the expectation that the query patterns for a data requirement are sound, meaning that the union of their results includes all the data described by the data requirement. Criteria that cannot be expressed as search parameters are omitted from the query patterns, rather than approximated with criteria that could exclude required data, and the resulting loss of precision is communicated with this extension. Consuming systems apply the criteria of the data requirement to the results of the query patterns unless the coverage is `total`.",
      "definition": "Describes the extent to which the FHIR query patterns given for a data requirement (i.e. the cqf-fhirQueryPattern extensions present on the data requirement) cover the criteria of that data requirement. Because the query patterns for a data requirement are considered as a set (i.e. the union of the results of the query patterns represents the data for the data requirement), coverage is a characteristic of the data requirement as a whole, rather than of any individual query pattern."
    }, {
      "id": "Extension.extension",
      "max": "0",
      "path": "Extension.extension"
    }, {
      "id": "Extension.url",
      "path": "Extension.url",
      "type": [ {
        "code": "uri"
      } ],
      "fixedUri": "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-fhirQueryPatternCoverage"
    }, {
      "id": "Extension.value[x]",
      "min": 1,
      "path": "Extension.value[x]",
      "type": [ {
        "code": "code"
      } ],
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/uv/cql/ValueSet/query-pattern-coverage"
      }
    } ]
  },
  "contact": [ {
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/dss",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}