FHIR Extensions Pack
5.1.0-snapshot1 - Working Copy International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0-snapshot1: Release 5.1) 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: Target invariant

Official URL: http://hl7.org/fhir/StructureDefinition/cqf-targetInvariant Version: 5.1.0-snapshot1
Standards status: Trial-use Maturity Level: 2 Responsible: HL7 International / Clinical Decision Support Computable Name: TargetInvariant
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:oid:2.16.840.1.113883.4.642.5.1694

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 may be used on the following element(s):

  • Element ID Element

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: 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..*ExtensionA constraint on the target resource
    ... extension:key 1..1ExtensionUnique identifier
    .... extension 0..0
    .... url 1..1uri"key"
    .... value[x] 1..1idValue of extension
    ... extension:requirements 0..1ExtensionWhy the invariant is defined
    .... extension 0..0
    .... url 1..1uri"requirements"
    .... value[x] 1..1stringValue of extension
    ... extension:severity 1..1Extensionerror | warning
    .... extension 0..0
    .... url 1..1uri"severity"
    .... value[x] 1..1codeValue of extension
    Binding: ConstraintSeverity (required)
    .... extension 0..0
    .... url 1..1uri"expression"
    .... value[x] 1..1ExpressionValue of extension
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-targetInvariant"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..*ExtensionA constraint on the target resource
    ... id 0..1idUnique id for inter-element referencing
    ... Slices for extension 3..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    ... extension:key 1..1ExtensionUnique identifier
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"key"
    .... value[x] 1..1idValue of extension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"requirements"
    .... value[x] 1..1stringValue of extension
    ... extension:severity 1..1Extensionerror | warning
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"severity"
    .... value[x] 1..1codeValue of extension
    Binding: ConstraintSeverity (required)
    ... extension:expression 1..1ExtensionThe invariant expression
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"expression"
    .... value[x] 1..1ExpressionValue of extension
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-targetInvariant"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: 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..*ExtensionA constraint on the target resource
    ... extension:key 1..1ExtensionUnique identifier
    .... extension 0..0
    .... url 1..1uri"key"
    .... value[x] 1..1idValue of extension
    ... extension:requirements 0..1ExtensionWhy the invariant is defined
    .... extension 0..0
    .... url 1..1uri"requirements"
    .... value[x] 1..1stringValue of extension
    ... extension:severity 1..1Extensionerror | warning
    .... extension 0..0
    .... url 1..1uri"severity"
    .... value[x] 1..1codeValue of extension
    Binding: ConstraintSeverity (required)
    .... extension 0..0
    .... url 1..1uri"expression"
    .... value[x] 1..1ExpressionValue of extension
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-targetInvariant"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..*ExtensionA constraint on the target resource
    ... id 0..1idUnique id for inter-element referencing
    ... Slices for extension 3..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    ... extension:key 1..1ExtensionUnique identifier
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"key"
    .... value[x] 1..1idValue of extension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"requirements"
    .... value[x] 1..1stringValue of extension
    ... extension:severity 1..1Extensionerror | warning
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"severity"
    .... value[x] 1..1codeValue of extension
    Binding: ConstraintSeverity (required)
    ... extension:expression 1..1ExtensionThe invariant expression
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"expression"
    .... value[x] 1..1ExpressionValue of extension
    ... url 1..1uri"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()

    Search Parameters for this Extension

    (none found)