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: Target invariant

Official URL: http://hl7.org/fhir/StructureDefinition/cqf-targetInvariant Version: 5.2.0-ballot
Standards status: Deprecated Maturity Level: 2 Responsible: HL7 International / Clinical Decision Support Computable Name: TargetInvariant
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1694

DEPRECATED: Use the targetConstraint extension instead. Specifies an invariant that is enforced on instantiated resources. This extension can be applied to any element of a definitional resource (such as ActivityDefinition or Measure) and indicates that the invariant should be enforced on resources that are instantiated from the definition. For example, this extension can be used to define a constraint such as numerator count must be less than or equal to denominator count.

This extension allows invariants to be specified as part of definitional resources as an alternative to having to define a profile to enforce the constraint.

Context of Use

This extension is deprecated and should no longer be used

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

Usage info

Usage:

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

Changes since version 1.0.0:

  • The resource metadata has changed (status, publisher, description, purpose)
  • 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: DEPRECATED: Use the targetConstraint extension instead. Specifies an invariant that is enforced on instantiated resources. This extension can be applied to any element of a definitional resource (such as ActivityDefinition or Measure) and indicates that the invariant should be enforced on resources that are instantiated from the definition. For example, this extension can be used to define a constraint such as numerator count must be less than or equal to denominator count.

    • key: id: A unique identifier for the invariant (unique in the context of the resource).
    • requirements: string: A brief description of why the invariant is necessary or appropriate.
    • severity: code: Whether the invariant indicates an error condition or a warning.
    • expression: Expression: An expression providing a formal representation of the invariant condition.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A constraint on the target resource
    ... Slices for extension Content/Rules for all slices
    .... extension:key 1..1 Extension Unique identifier
    ..... extension 0..0
    ..... url 1..1 uri "key"
    ..... value[x] 1..1 id Value of extension
    .... extension:requirements 0..1 Extension Why the invariant is defined
    ..... extension 0..0
    ..... url 1..1 uri "requirements"
    ..... value[x] 1..1 string Value of extension
    .... extension:severity 1..1 Extension error | warning
    ..... extension 0..0
    ..... url 1..1 uri "severity"
    ..... value[x] 1..1 code Value of extension
    Binding: ConstraintSeverity (required)
    .... extension:expression 1..1 Extension The invariant expression
    ..... extension 0..0
    ..... url 1..1 uri "expression"
    ..... value[x] 1..1 Expression Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-targetInvariant"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A constraint on the target resource
    ... 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:key 1..1 Extension Unique identifier
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "key"
    ..... value[x] 1..1 id Value of extension
    .... extension:requirements 0..1 Extension Why the invariant is defined
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "requirements"
    ..... value[x] 1..1 string Value of extension
    .... extension:severity 1..1 Extension error | warning
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "severity"
    ..... value[x] 1..1 code Value of extension
    Binding: ConstraintSeverity (required)
    .... extension:expression 1..1 Extension The invariant expression
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "expression"
    ..... value[x] 1..1 Expression Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-targetInvariant"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: DEPRECATED: Use the targetConstraint extension instead. Specifies an invariant that is enforced on instantiated resources. This extension can be applied to any element of a definitional resource (such as ActivityDefinition or Measure) and indicates that the invariant should be enforced on resources that are instantiated from the definition. For example, this extension can be used to define a constraint such as numerator count must be less than or equal to denominator count.

    • key: id: A unique identifier for the invariant (unique in the context of the resource).
    • requirements: string: A brief description of why the invariant is necessary or appropriate.
    • severity: code: Whether the invariant indicates an error condition or a warning.
    • expression: Expression: An expression providing a formal representation of the invariant condition.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A constraint on the target resource
    ... Slices for extension Content/Rules for all slices
    .... extension:key 1..1 Extension Unique identifier
    ..... extension 0..0
    ..... url 1..1 uri "key"
    ..... value[x] 1..1 id Value of extension
    .... extension:requirements 0..1 Extension Why the invariant is defined
    ..... extension 0..0
    ..... url 1..1 uri "requirements"
    ..... value[x] 1..1 string Value of extension
    .... extension:severity 1..1 Extension error | warning
    ..... extension 0..0
    ..... url 1..1 uri "severity"
    ..... value[x] 1..1 code Value of extension
    Binding: ConstraintSeverity (required)
    .... extension:expression 1..1 Extension The invariant expression
    ..... extension 0..0
    ..... url 1..1 uri "expression"
    ..... value[x] 1..1 Expression Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-targetInvariant"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A constraint on the target resource
    ... 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:key 1..1 Extension Unique identifier
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "key"
    ..... value[x] 1..1 id Value of extension
    .... extension:requirements 0..1 Extension Why the invariant is defined
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "requirements"
    ..... value[x] 1..1 string Value of extension
    .... extension:severity 1..1 Extension error | warning
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "severity"
    ..... value[x] 1..1 code Value of extension
    Binding: ConstraintSeverity (required)
    .... extension:expression 1..1 Extension The invariant expression
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "expression"
    ..... value[x] 1..1 Expression Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-targetInvariant"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:severity.value[x]requiredConstraintSeverity
    http://hl7.org/fhir/ValueSet/constraint-severity
    from the FHIR Standard

    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 represented a little differently in R3:

    • Replace the type Expression with a set of extensions for the content of the type along with the _datatype extension
    • Note: Extensions that have been modified for R3 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints doco
    . . Extension 0..* Extension A constraint on the target resource
    . . . Slices for extension Content/Rules for all slices
    . . . . extension:key 1..1 Extension Unique identifier
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "key"
    . . . . . value[x] 1.. 1 id Value of extension
    . . . . extension:requirements 0..1 Extension Why the invariant is defined
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "requirements"
    . . . . . value[x] 1.. 1 string Value of extension
    . . . . extension:severity 1..1 Extension error | warning
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "severity"
    . . . . . value[x] 1.. 1 code Value of extension
    Binding: ConstraintSeverity ( required )
    . . . . extension:expression 1..1 Extension The invariant expression
    . . . . . Slices for extension 0 ..* Extension Extension
    Slice: Unordered, Open by value:url
    . . . . . . extension:_datatype 1..1 (Complex) DataType name 'Expression' from R5
    URL: http://hl7.org/fhir/StructureDefinition/_datatype
    . . . . . . . value[x] 1.. 1 string Value of extension
    Fixed Value: Expression
    . . . . . . extension:description 0..1 Extension Natural language description of the condition
    . . . . . . . extension 0 .. 0
    . . . . . . . url 1 .. 1 uri "description"
    . . . . . . . value[x] 1.. 1 string Value of extension
    . . . . . . extension:name 0..1 Extension Short name assigned to expression for reuse
    . . . . . . . extension 0 .. 0
    . . . . . . . url 1 .. 1 uri "name"
    . . . . . . . value[x] 1.. 1 code Value of extension
    . . . . . . extension:language 0..1 Extension text/cql | text/fhirpath | application/x-fhir-query | etc.
    . . . . . . . extension 0 .. 0
    . . . . . . . url 1 .. 1 uri "language"
    . . . . . . . value[x] 1.. 1 code Value of extension
    Binding: ExpressionLanguage ( extensible ): The media type of the expression language.

    Additional Bindings Purpose
    MimeTypes Max Binding
    . . . . . . extension:expression 0..1 Extension Expression in specified language
    . . . . . . . extension 0 .. 0
    . . . . . . . url 1 .. 1 uri "expression"
    . . . . . . . value[x] 1.. 1 string Value of extension
    . . . . . . extension:reference 0..1 Extension Where the expression is found
    . . . . . . . extension 0 .. 0
    . . . . . . . url 1 .. 1 uri "reference"
    . . . . . . . value[x] 1.. 1 uri Value of extension
    . . . . . url 1 .. 1 uri "expression"
    . . . . . value[x] 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/cqf-targetInvariant"
    . . . value[x] 0 .. 0

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)