FHIR Extensions Pack
5.1.0-ballot1 - Ballot for Release 5.1.0 International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0-ballot: Releases Ballot 4) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 1.0.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.1.0-ballot1
Standards status: Trial-use Maturity Level: 2 Responsible: HL7 International / Clinical Decision Support Computable Name: LogicDefinition

Represents a specific logic definition used by the artifact.

Context of Use

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

  • Element ID Resource

Usage info

Usage:

Changes since version 1.0.0:

  • The resource metadata has changed (status, publisher)

    • 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.

    • 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..*ExtensionA logic definition used in the artifact
    ... extension:libraryName 1..1ExtensionWhich library
    .... extension 0..0
    .... url 1..1uri"libraryName"
    .... value[x] 1..1stringValue of extension
    ... extension:name 1..1ExtensionWhich definition
    .... extension 0..0
    .... url 1..1uri"name"
    .... value[x] 1..1stringValue of extension
    ... extension:statement 1..1ExtensionComplete declaration statement
    .... extension 0..0
    .... url 1..1uri"statement"
    .... value[x] 1..1stringValue of extension
    .... extension 0..0
    .... url 1..1uri"displayCategory"
    .... value[x] 1..1stringValue of extension
    ... extension:displaySequence 0..1ExtensionWhat order?
    .... extension 0..0
    .... url 1..1uri"displaySequence"
    .... value[x] 1..1integerValue of extension
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..*ExtensionA logic definition used in the artifact
    ... id 0..1idUnique id for inter-element referencing
    ... Slices for extension 3..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    ... extension:libraryName 1..1ExtensionWhich library
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"libraryName"
    .... value[x] 1..1stringValue of extension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"name"
    .... value[x] 1..1stringValue of extension
    ... extension:statement 1..1ExtensionComplete declaration statement
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"statement"
    .... value[x] 1..1stringValue of extension
    ... extension:displayCategory 0..1ExtensionWhat category?
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"displayCategory"
    .... value[x] 1..1stringValue of extension
    ... extension:displaySequence 0..1ExtensionWhat order?
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"displaySequence"
    .... value[x] 1..1integerValue of extension
    ... url 1..1uri"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.

    • 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..*ExtensionA logic definition used in the artifact
    ... extension:libraryName 1..1ExtensionWhich library
    .... extension 0..0
    .... url 1..1uri"libraryName"
    .... value[x] 1..1stringValue of extension
    ... extension:name 1..1ExtensionWhich definition
    .... extension 0..0
    .... url 1..1uri"name"
    .... value[x] 1..1stringValue of extension
    ... extension:statement 1..1ExtensionComplete declaration statement
    .... extension 0..0
    .... url 1..1uri"statement"
    .... value[x] 1..1stringValue of extension
    .... extension 0..0
    .... url 1..1uri"displayCategory"
    .... value[x] 1..1stringValue of extension
    ... extension:displaySequence 0..1ExtensionWhat order?
    .... extension 0..0
    .... url 1..1uri"displaySequence"
    .... value[x] 1..1integerValue of extension
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..*ExtensionA logic definition used in the artifact
    ... id 0..1idUnique id for inter-element referencing
    ... Slices for extension 3..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    ... extension:libraryName 1..1ExtensionWhich library
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"libraryName"
    .... value[x] 1..1stringValue of extension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"name"
    .... value[x] 1..1stringValue of extension
    ... extension:statement 1..1ExtensionComplete declaration statement
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"statement"
    .... value[x] 1..1stringValue of extension
    ... extension:displayCategory 0..1ExtensionWhat category?
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"displayCategory"
    .... value[x] 1..1stringValue of extension
    ... extension:displaySequence 0..1ExtensionWhat order?
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"displaySequence"
    .... value[x] 1..1integerValue of extension
    ... url 1..1uri"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)