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: Definition Term

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

Specifies a term and its associated definition.

An artifact specification must be able to provide definitions for terms that are used to help communicate the artifact intent.

Context of Use

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

  • Element ID Resource

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • New Content

    • 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: Specifies a term and its associated definition.

    • term: string: Specifies the term used in artifact guidance.
    • definition: markdown: Specifies the definition of the term used in artifact guidance.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Defined term
    ... Slices for extension Content/Rules for all slices
    .... extension:term 1..1 Extension Term being defined
    ..... url 1..1 uri "term"
    ..... value[x] 0..1 string Value of extension
    .... extension:definition 1..1 Extension Definition of the term
    ..... url 1..1 uri "definition"
    ..... value[x] 0..1 markdown Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-definitionTerm"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Defined term
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:term 1..1 Extension Term being defined
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "term"
    ..... value[x] 0..1 string Value of extension
    .... extension:definition 1..1 Extension Definition of the term
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "definition"
    ..... value[x] 0..1 markdown Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-definitionTerm"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Specifies a term and its associated definition.

    • term: string: Specifies the term used in artifact guidance.
    • definition: markdown: Specifies the definition of the term used in artifact guidance.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Defined term
    ... Slices for extension Content/Rules for all slices
    .... extension:term 1..1 Extension Term being defined
    ..... url 1..1 uri "term"
    ..... value[x] 0..1 string Value of extension
    .... extension:definition 1..1 Extension Definition of the term
    ..... url 1..1 uri "definition"
    ..... value[x] 0..1 markdown Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-definitionTerm"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Defined term
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:term 1..1 Extension Term being defined
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "term"
    ..... value[x] 0..1 string Value of extension
    .... extension:definition 1..1 Extension Definition of the term
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "definition"
    ..... value[x] 0..1 markdown Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-definitionTerm"

    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)