Using CQL With FHIR
3.0.0-ballot - STU 3 Ballot International flag

This page is part of the Using CQL with FHIR Implementation Guide (v3.0.0-ballot: STU 3 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.0.0. For a full list of available versions, see the Directory of published versions

: CQL Resolve Namespace

Page standards status: Trial-use Maturity Level: 1

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "cql-resolve-namespace",
  "language" : "en",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition cql-resolve-namespace</b></p><a name=\"cql-resolve-namespace\"> </a><a name=\"hccql-resolve-namespace\"> </a><p>URL: [base]/$resolve-namespace</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>name</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The name of the namespace as used in CQL declarations (e.g. hl7.fhir.uv.cql). For libraries published in FHIR NPM packages, this corresponds to the FHIR NPM packageId (and the <code>packageId</code> element of the ImplementationGuide resource).</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>The uri of the namespace with the given name (e.g. http://hl7.org/fhir/uv/cql). For libraries published in FHIR NPM packages, this corresponds to the baseCanonical of the FHIR NPM package.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 1
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cds"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/cql/OperationDefinition/cql-resolve-namespace",
  "version" : "3.0.0-ballot",
  "name" : "CQLResolveNamespace",
  "title" : "CQL Resolve Namespace",
  "status" : "active",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2026-08-11",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description" : "Resolves the given namespace name to a namespace uri. For libraries published in FHIR NPM packages, the namespace name corresponds to the FHIR NPM packageId (and the `packageId` element of the ImplementationGuide resource), and the uri corresponds to the base canonical for the FHIR NPM package. For example, the namespace name for the Using CQL With FHIR implementation guide (this IG) is `hl7.fhir.uv.cql`, and the namespace uri is `http://hl7.org/fhir/uv/cql`.\n\nA package feed is one way to populate this mapping of namespace names to namespace URIs, but it is not the only way. A repository could potentially provide other ways to create this mapping.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "purpose" : "This operation is defined to support resolving namespaces used in CQL libraries.",
  "affectsState" : false,
  "code" : "resolve-namespace",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "name",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The name of the namespace as used in CQL declarations (e.g. hl7.fhir.uv.cql). For libraries published in FHIR NPM packages, this corresponds to the FHIR NPM packageId (and the `packageId` element of the ImplementationGuide resource).",
      "type" : "string"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The uri of the namespace with the given name (e.g. http://hl7.org/fhir/uv/cql). For libraries published in FHIR NPM packages, this corresponds to the baseCanonical of the FHIR NPM package.",
      "type" : "uri"
    }
  ]
}