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

This page is part of the FHIR Core Extensions Registry (v5.2.0-ballot: Release 5.2) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 5.1.0. For a full list of available versions, see the Directory of published versions

Extension: Logic definition

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

Represents a specific logic definition used by the artifact. When logic is referenced from knowledge artifacts, this extension allows each referenced definition to be represented independently so that consumers know which specific expressions are being referenced (i.e. not all expressions in a given library are always used), as well as allows processing applications (such as narrative generation) to easily surface the definitions to provide capabilities such as navigation.

Context of Use

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

  • Element ID DomainResource

Usage info

Usage:

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

    Complex Extension: Represents a specific logic definition used by the artifact. When logic is referenced from knowledge artifacts, this extension allows each referenced definition to be represented independently so that consumers know which specific expressions are being referenced (i.e. not all expressions in a given library are always used), as well as allows processing applications (such as narrative generation) to easily surface the definitions to provide capabilities such as navigation.

    • libraryName: string: The name of the library that contains this definition. This is the library name, not the library alias within any particular library usage, and SHOULD be the fully qualified name of the library (i.e. namespace included).
    • name: string: The name of the definition, e.g. Initial Population. For function definitions, this SHOULD include the function parameters (e.g. "Measure Observation"(Encounter Encounter)).
    • statement: string: The complete declaration statement for the definition. For example, define "Initial Population": [Encounter: "Inpatient"] E where duration in days of E.period > 2.
    • displayCategory: string: A string value providing a display category for the logic definition displayed in any human readable representation.
    • displaySequence: integer: An integer value indicating the order in which this definition should be displayed in any human readable representation.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A logic definition used in the artifact
    ... Slices for extension Content/Rules for all slices
    .... extension:libraryName 1..1 Extension Which library
    ..... extension 0..0
    ..... url 1..1 uri "libraryName"
    ..... value[x] 1..1 string Value of extension
    .... extension:name 1..1 Extension Which definition
    ..... extension 0..0
    ..... url 1..1 uri "name"
    ..... value[x] 1..1 string Value of extension
    .... extension:statement 1..1 Extension Complete declaration statement
    ..... extension 0..0
    ..... url 1..1 uri "statement"
    ..... value[x] 1..1 string Value of extension
    .... extension:displayCategory 0..1 Extension What category?
    ..... extension 0..0
    ..... url 1..1 uri "displayCategory"
    ..... value[x] 1..1 string Value of extension
    .... extension:displaySequence 0..1 Extension What order?
    ..... extension 0..0
    ..... url 1..1 uri "displaySequence"
    ..... value[x] 1..1 integer Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A logic definition used in the artifact
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 3..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:libraryName 1..1 Extension Which library
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "libraryName"
    ..... value[x] 1..1 string Value of extension
    .... extension:name 1..1 Extension Which definition
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "name"
    ..... value[x] 1..1 string Value of extension
    .... extension:statement 1..1 Extension Complete declaration statement
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "statement"
    ..... value[x] 1..1 string Value of extension
    .... extension:displayCategory 0..1 Extension What category?
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "displayCategory"
    ..... value[x] 1..1 string Value of extension
    .... extension:displaySequence 0..1 Extension What order?
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "displaySequence"
    ..... value[x] 1..1 integer Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Represents a specific logic definition used by the artifact. When logic is referenced from knowledge artifacts, this extension allows each referenced definition to be represented independently so that consumers know which specific expressions are being referenced (i.e. not all expressions in a given library are always used), as well as allows processing applications (such as narrative generation) to easily surface the definitions to provide capabilities such as navigation.

    • libraryName: string: The name of the library that contains this definition. This is the library name, not the library alias within any particular library usage, and SHOULD be the fully qualified name of the library (i.e. namespace included).
    • name: string: The name of the definition, e.g. Initial Population. For function definitions, this SHOULD include the function parameters (e.g. "Measure Observation"(Encounter Encounter)).
    • statement: string: The complete declaration statement for the definition. For example, define "Initial Population": [Encounter: "Inpatient"] E where duration in days of E.period > 2.
    • displayCategory: string: A string value providing a display category for the logic definition displayed in any human readable representation.
    • displaySequence: integer: An integer value indicating the order in which this definition should be displayed in any human readable representation.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A logic definition used in the artifact
    ... Slices for extension Content/Rules for all slices
    .... extension:libraryName 1..1 Extension Which library
    ..... extension 0..0
    ..... url 1..1 uri "libraryName"
    ..... value[x] 1..1 string Value of extension
    .... extension:name 1..1 Extension Which definition
    ..... extension 0..0
    ..... url 1..1 uri "name"
    ..... value[x] 1..1 string Value of extension
    .... extension:statement 1..1 Extension Complete declaration statement
    ..... extension 0..0
    ..... url 1..1 uri "statement"
    ..... value[x] 1..1 string Value of extension
    .... extension:displayCategory 0..1 Extension What category?
    ..... extension 0..0
    ..... url 1..1 uri "displayCategory"
    ..... value[x] 1..1 string Value of extension
    .... extension:displaySequence 0..1 Extension What order?
    ..... extension 0..0
    ..... url 1..1 uri "displaySequence"
    ..... value[x] 1..1 integer Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A logic definition used in the artifact
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 3..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:libraryName 1..1 Extension Which library
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "libraryName"
    ..... value[x] 1..1 string Value of extension
    .... extension:name 1..1 Extension Which definition
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "name"
    ..... value[x] 1..1 string Value of extension
    .... extension:statement 1..1 Extension Complete declaration statement
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "statement"
    ..... value[x] 1..1 string Value of extension
    .... extension:displayCategory 0..1 Extension What category?
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "displayCategory"
    ..... value[x] 1..1 string Value of extension
    .... extension:displaySequence 0..1 Extension What order?
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "displaySequence"
    ..... value[x] 1..1 integer Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"

    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()

    Search Parameters for this Extension

    (none found)