FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Direct reference code

Official URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 2 Responsible: HL7 International / Clinical Decision Support Computable Name: DirectReferenceCode
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1739

Indicates that the given code is directly referenced by artifact logic (e.g. as a direct-reference code in CQL). Terminology dependencies used in logic can be collected and reported, typically using the relatedArtifact element with a type of depends-on. However, direct-reference codes cannot be represented in the relatedArtifact element, so this extension provides a means to support communicating direct-reference code dependencies of knowledge artifacts. As with value set dependencies, direct-reference codes may be the terminology target of a data requirement.

Context of Use

This extension may be used on the following element(s)

Usage info

Usages:

Changes since version 1.0.0:

  • The resource metadata has changed (status, publisher, description)
  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension with the type Coding: Indicates that the given code is directly referenced by artifact logic (e.g. as a direct-reference code in CQL). Terminology dependencies used in logic can be collected and reported, typically using the relatedArtifact element with a type of depends-on. However, direct-reference codes cannot be represented in the relatedArtifact element, so this extension provides a means to support communicating direct-reference code dependencies of knowledge artifacts. As with value set dependencies, direct-reference codes may be the terminology target of a data requirement.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension A code directly referenced by the artifact
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode"
    ... value[x] 1..1 Coding Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension A code directly referenced by the artifact
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type Coding: Indicates that the given code is directly referenced by artifact logic (e.g. as a direct-reference code in CQL). Terminology dependencies used in logic can be collected and reported, typically using the relatedArtifact element with a type of depends-on. However, direct-reference codes cannot be represented in the relatedArtifact element, so this extension provides a means to support communicating direct-reference code dependencies of knowledge artifacts. As with value set dependencies, direct-reference codes may be the terminology target of a data requirement.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension A code directly referenced by the artifact
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode"
    ... value[x] 1..1 Coding Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension A code directly referenced by the artifact
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    R4B

    The extension is unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is unchanged in R3

    Search Parameters for this Extension

    (none found)