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

FHIR IG Statistics: CodeSystem/cql-message-codes

Packagehl7.cql
Resource TypeCodeSystem
Idcql-message-codes
FHIR VersionR4
Sourcehttp://cql.hl7.org/https://build.fhir.org/ig/HL7/cql/CodeSystem-cql-message-codes.html
URLhttp://cql.hl7.org/CodeSystem/cql-message-codes
Version2.0.0-cibuild
Statusactive
Date2025-07-25T22:11:07+00:00
NameCQLMessageCodes
TitleCQL Message Codes
Authorityhl7
DescriptionCodes 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.
Contentcomplete

Resources that use this resource

ValueSet
cql-message-codeCQL Message Code

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: CodeSystem cql-message-codes

Properties

This code system defines the following properties for its concepts

NameCodeURITypeDescription
categorycategoryhttp://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#categorycodeThe language area, possible values are codes in the [CQL Message Category Codes](CodeSystem-cql-message-category-codes.html) code system
severityseverityhttp://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#severitycodeSeverity of the issue, possible values are codes in the [CQL Message Severity Codes](CodeSystem-cql-message-severity-codes.html) code system
sourcesourcehttp://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#sourcecodeThe 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
exampleexamplehttp://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#examplestringAn example message
notesnoteshttp://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#notesstringNotes about the message, especially how to address the issue being identified
spec-linkspec-linkhttp://cql.hl7.org/CodeSystem/cql-message-characteristic-codes#spec-linkstringA URL to the specification where this message is defined

Concepts

This case-sensitive code system http://cql.hl7.org/CodeSystem/cql-message-codes defines the following codes:

CodeDisplayDefinitioncategoryseveritysourceexamplenotesspec-link
000-00000 InternalInternal translator errorcompile-timeerrorcontentInternal translator errorThis message code typically indicates an unexpected error was encountered while attempting to compile CQL.http://cql.hl7.org/20-m-messages.html#messages
001-00000 LexicalLexical errorlexicalerrorcontentLexical errorThis 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.http://cql.hl7.org/20-m-messages.html#messages
002-00000 SyntaxSyntax errorsyntaxerrorcontentSyntax errorThis 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.http://cql.hl7.org/20-m-messages.html#messages
003-00000 SemanticSemantic errorsemanticerrorcontentSemantic errorThis 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.http://cql.hl7.org/20-m-messages.html#messages
003-10000 Conditional expression resulted in a choice typeIndicates 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.semanticwarningcontentConditional expression resulted in a choice type `Choice<Boolean, List<Integer>`This message may be suppressed with the @suppressWarning taghttp://cql.hl7.org/03-developersguide.html#type-inference-of-conditional-expressions
100-00000 Run-timeRuntime errorrun-timeerrorcontentRun-time errorThis 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.http://cql.hl7.org/20-m-messages.html#messages

Source

{
  "resourceType": "CodeSystem",
  "id": "cql-message-codes",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "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",
  "version": "2.0.0-cibuild",
  "name": "CQLMessageCodes",
  "title": "CQL Message Codes",
  "status": "active",
  "experimental": false,
  "date": "2025-07-25T22:11:07+00: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-category",
  "content": "complete",
  "property": [
    {
      "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"
    },
    {
      "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"
    },
    {
      "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",
      "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 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": "http://cql.hl7.org/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": "http://cql.hl7.org/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": "http://cql.hl7.org/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": "http://cql.hl7.org/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": "http://cql.hl7.org/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": "http://cql.hl7.org/20-m-messages.html#messages"
        }
      ]
    }
  ]
}