Clinical Quality Language Specification
2.0.0 - R2 STU 1

Clinical Quality Language Specification - Downloaded Version 2.0.0 See the Directory of published versions

## : CQL Message Codes - JSON Representation

Page standards status: Trial-use | Maturity Level: 2

Raw json | Download

    {
      "resourceType" : "CodeSystem",
      "id" : "cql-message-codes",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem cql-message-codes</b></p><a name=\"cql-message-codes\"> </a><a name=\"hccql-message-codes\"> </a><p><b>Properties</b></p><p><b>This code system defines the following properties for its concepts</b></p><table class=\"grid\"><tr><td><b>Name</b></td><td><b>Code</b></td><td><b>URI</b></td><td><b>Type</b></td><td><b>Description</b></td><td><b>Value Set</b></td></tr><tr><td>Category</td><td>category</td><td>http://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#category</td><td>code</td><td>The language area, possible values are codes in the [CQL Message Category Codes](CodeSystem-cql-message-category-codes.html) code system</td><td><a href=\"ValueSet-cql-message-category.html\">CQL Message Category</a></td></tr><tr><td>Severity</td><td>severity</td><td>http://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#severity</td><td>code</td><td>Severity of the issue, possible values are codes in the [CQL Message Severity Codes](CodeSystem-cql-message-severity-codes.html) code system</td><td><a href=\"ValueSet-cql-message-severity.html\">CQL Message Severity</a></td></tr><tr><td>Source</td><td>source</td><td>http://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#source</td><td>code</td><td>The source of the issue, providing information about where the issue is originating and how it might be addressed, possible values are codes in the [CQL Message Source Codes](CodeSystem-cql-message-source-codes.html) code system</td><td><a href=\"ValueSet-cql-message-source.html\">CQL Message Source</a></td></tr><tr><td>Example Message</td><td>example</td><td>http://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#example</td><td>string</td><td>An example message providing a sample of what kinds of actual messages will be returned with this code.</td><td/></tr><tr><td>Notes</td><td>notes</td><td>http://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#notes</td><td>string</td><td>Notes about the message, especially how to address the issue being identified</td><td/></tr><tr><td>Specification Link</td><td>spec-link</td><td>http://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#spec-link</td><td>string</td><td>A URL to the point in the specification where this message is defined</td><td/></tr></table><p><b>Concepts</b></p><p>This case-sensitive code system <code>http://cql.hl7.org/CodeSystem/cql-message-codes</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td><td><b>Category</b></td><td><b>Severity</b></td><td><b>Source</b></td><td><b>Example Message</b></td><td><b>Notes</b></td><td><b>Specification Link</b></td></tr><tr><td style=\"white-space:nowrap\">000-00000<a name=\"cql-message-codes-000-00000\"> </a></td><td>Internal</td><td>Internal translator error</td><td>compile-time</td><td>error</td><td>content</td><td>Internal translator error</td><td>This message code typically indicates an unexpected error was encountered while attempting to compile CQL.</td><td>20-m-messages.html#messages</td></tr><tr><td style=\"white-space:nowrap\">001-00000<a name=\"cql-message-codes-001-00000\"> </a></td><td>Lexical</td><td>Lexical error</td><td>lexical</td><td>error</td><td>content</td><td>Lexical error</td><td>This is a general message code for lexical errors encountered while processing CQL. The actual message will typically contain more detailed information about the issue and how to address it.</td><td>20-m-messages.html#messages</td></tr><tr><td style=\"white-space:nowrap\">002-00000<a name=\"cql-message-codes-002-00000\"> </a></td><td>Syntax</td><td>Syntax error</td><td>syntax</td><td>error</td><td>content</td><td>Syntax error</td><td>This is a general message code for syntax errors encountered while processing CQL. The actual message will typically contain more detailed information about the issue and how to address it.</td><td>20-m-messages.html#messages</td></tr><tr><td style=\"white-space:nowrap\">003-00000<a name=\"cql-message-codes-003-00000\"> </a></td><td>Semantic</td><td>Semantic error</td><td>semantic</td><td>error</td><td>content</td><td>Semantic error</td><td>This is a general message code for semantic errors encountered while processing CQL. The actual message will typically contain more detailed information about the issue and how to address it.</td><td>20-m-messages.html#messages</td></tr><tr><td style=\"white-space:nowrap\">003-10000<a name=\"cql-message-codes-003-10000\"> </a></td><td>Conditional expression resulted in a choice type</td><td>Indicates that a conditional expression resulted in a choice type when none of the branches of the conditional were choice types. This can indicate a mistake and should be reviewed.</td><td>semantic</td><td>warning</td><td>content</td><td>Conditional expression resulted in a choice type `Choice&lt;Boolean, List&lt;Integer&gt;`</td><td>This message may be suppressed with the @suppressWarning tag</td><td>03-developersguide.html#type-inference-of-conditional-expressions</td></tr><tr><td style=\"white-space:nowrap\">100-00000<a name=\"cql-message-codes-100-00000\"> </a></td><td>Run-time</td><td>Runtime error</td><td>run-time</td><td>error</td><td>content</td><td>Run-time error</td><td>This is a general message code for run-time errors encountered while attempting to evaluate CQL. The actual message will typically contain more detailed information about the issue and how to address it.</td><td>20-m-messages.html#messages</td></tr></table></div>"
      },
      "extension" : [
        {
          "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/StructureDefinition/structuredefinition-fmm",
          "valueInteger" : 2
        }
      ],
      "url" : "http://cql.hl7.org/CodeSystem/cql-message-codes",
      "identifier" : [
        {
          "system" : "urn:ietf:rfc:3986",
          "value" : "urn:oid:2.16.840.1.113883.4.642.40.71.16.5"
        }
      ],
      "version" : "2.0.0",
      "name" : "CQLMessageCodes",
      "title" : "CQL Message Codes",
      "status" : "active",
      "experimental" : false,
      "date" : "2026-07-29T09:34:45+10:00",
      "publisher" : "Clinical Decision Support WG",
      "contact" : [
        {
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/dss/index.cfm"
            }
          ]
        }
      ],
      "description" : "Codes for messages returned by applications that process Clinical Quality Language, whether as part of authoring or evaluating. This code system is intended to be a place to identify codes for messages that are indicated by the specification itself. Implementation-specific, application-specific, and content-specific codes may be provided with codes from other code systems, but should ideally map to some code (possibly a more general code) in this code system.",
      "caseSensitive" : true,
      "valueSet" : "http://cql.hl7.org/ValueSet/cql-message-code",
      "content" : "complete",
      "property" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-property-valueset",
              "valueCanonical" : "http://cql.hl7.org/ValueSet/cql-message-category"
            }
          ],
          "code" : "category",
          "uri" : "http://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#category",
          "description" : "The language area, possible values are codes in the [CQL Message Category Codes](CodeSystem-cql-message-category-codes.html) code system",
          "type" : "code"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-property-valueset",
              "valueCanonical" : "http://cql.hl7.org/ValueSet/cql-message-severity"
            }
          ],
          "code" : "severity",
          "uri" : "http://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#severity",
          "description" : "Severity of the issue, possible values are codes in the [CQL Message Severity Codes](CodeSystem-cql-message-severity-codes.html) code system",
          "type" : "code"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-property-valueset",
              "valueCanonical" : "http://cql.hl7.org/ValueSet/cql-message-source"
            }
          ],
          "code" : "source",
          "uri" : "http://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#source",
          "description" : "The source of the issue, providing information about where the issue is originating and how it might be addressed, possible values are codes in the [CQL Message Source Codes](CodeSystem-cql-message-source-codes.html) code system",
          "type" : "code"
        },
        {
          "code" : "example",
          "uri" : "http://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#example",
          "description" : "An example message providing a sample of what kinds of actual messages will be returned with this code.",
          "type" : "string"
        },
        {
          "code" : "notes",
          "uri" : "http://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#notes",
          "description" : "Notes about the message, especially how to address the issue being identified",
          "type" : "string"
        },
        {
          "code" : "spec-link",
          "uri" : "http://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#spec-link",
          "description" : "A URL to the point in the specification where this message is defined",
          "type" : "string"
        }
      ],
      "concept" : [
        {
          "code" : "000-00000",
          "display" : "Internal",
          "definition" : "Internal translator error",
          "property" : [
            {
              "code" : "category",
              "valueCode" : "compile-time"
            },
            {
              "code" : "severity",
              "valueCode" : "error"
            },
            {
              "code" : "source",
              "valueCode" : "content"
            },
            {
              "code" : "example",
              "valueString" : "Internal translator error"
            },
            {
              "code" : "notes",
              "valueString" : "This message code typically indicates an unexpected error was encountered while attempting to compile CQL."
            },
            {
              "code" : "spec-link",
              "valueString" : "20-m-messages.html#messages"
            }
          ]
        },
        {
          "code" : "001-00000",
          "display" : "Lexical",
          "definition" : "Lexical error",
          "property" : [
            {
              "code" : "category",
              "valueCode" : "lexical"
            },
            {
              "code" : "severity",
              "valueCode" : "error"
            },
            {
              "code" : "source",
              "valueCode" : "content"
            },
            {
              "code" : "example",
              "valueString" : "Lexical error"
            },
            {
              "code" : "notes",
              "valueString" : "This is a general message code for lexical errors encountered while processing CQL. The actual message will typically contain more detailed information about the issue and how to address it."
            },
            {
              "code" : "spec-link",
              "valueString" : "20-m-messages.html#messages"
            }
          ]
        },
        {
          "code" : "002-00000",
          "display" : "Syntax",
          "definition" : "Syntax error",
          "property" : [
            {
              "code" : "category",
              "valueCode" : "syntax"
            },
            {
              "code" : "severity",
              "valueCode" : "error"
            },
            {
              "code" : "source",
              "valueCode" : "content"
            },
            {
              "code" : "example",
              "valueString" : "Syntax error"
            },
            {
              "code" : "notes",
              "valueString" : "This is a general message code for syntax errors encountered while processing CQL. The actual message will typically contain more detailed information about the issue and how to address it."
            },
            {
              "code" : "spec-link",
              "valueString" : "20-m-messages.html#messages"
            }
          ]
        },
        {
          "code" : "003-00000",
          "display" : "Semantic",
          "definition" : "Semantic error",
          "property" : [
            {
              "code" : "category",
              "valueCode" : "semantic"
            },
            {
              "code" : "severity",
              "valueCode" : "error"
            },
            {
              "code" : "source",
              "valueCode" : "content"
            },
            {
              "code" : "example",
              "valueString" : "Semantic error"
            },
            {
              "code" : "notes",
              "valueString" : "This is a general message code for semantic errors encountered while processing CQL. The actual message will typically contain more detailed information about the issue and how to address it."
            },
            {
              "code" : "spec-link",
              "valueString" : "20-m-messages.html#messages"
            }
          ]
        },
        {
          "code" : "003-10000",
          "display" : "Conditional expression resulted in a choice type",
          "definition" : "Indicates that a conditional expression resulted in a choice type when none of the branches of the conditional were choice types. This can indicate a mistake and should be reviewed.",
          "property" : [
            {
              "code" : "category",
              "valueCode" : "semantic"
            },
            {
              "code" : "severity",
              "valueCode" : "warning"
            },
            {
              "code" : "source",
              "valueCode" : "content"
            },
            {
              "code" : "example",
              "valueString" : "Conditional expression resulted in a choice type `Choice<Boolean, List<Integer>`"
            },
            {
              "code" : "notes",
              "valueString" : "This message may be suppressed with the @suppressWarning tag"
            },
            {
              "code" : "spec-link",
              "valueString" : "03-developersguide.html#type-inference-of-conditional-expressions"
            }
          ]
        },
        {
          "code" : "100-00000",
          "display" : "Run-time",
          "definition" : "Runtime error",
          "property" : [
            {
              "code" : "category",
              "valueCode" : "run-time"
            },
            {
              "code" : "severity",
              "valueCode" : "error"
            },
            {
              "code" : "source",
              "valueCode" : "content"
            },
            {
              "code" : "example",
              "valueString" : "Run-time error"
            },
            {
              "code" : "notes",
              "valueString" : "This is a general message code for run-time errors encountered while attempting to evaluate CQL. The actual message will typically contain more detailed information about the issue and how to address it."
            },
            {
              "code" : "spec-link",
              "valueString" : "20-m-messages.html#messages"
            }
          ]
        }
      ]
    }