FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) 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.3.0-ballot-tc1 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: Complies With Canonical

Official URL: http://hl7.org/fhir/StructureDefinition/complies-with-canonical Version: 5.3.0-ballot-tc1
Standards status: Trial-use Maturity Level: 1 Computable Name: CompliesWithCanonical

Indicates that a resource or element complies with another formally defined canonical resource. This extension allows systems to declare that their implementation satisfies multiple canonical definitions beyond the primary one referenced in corresponding 'definition' elements.

Compliance means that an implementation of a canonical resource (e.g., a search parameter or operation) satisfies all the normative requirements of the referenced canonical resource definition. When an implementation states that it complies with multiple canonical definitions, it means that it simultaneously satisfies all mandatory requirements from each referenced definition. This enables a single implementation to declare conformance to multiple sources without having to duplicate capability statement entries.

Context of Use

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

Usage info

Usages:

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

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.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

    Simple Extension with the type canonical: Indicates that a resource or element complies with another formally defined canonical resource. This extension allows systems to declare that their implementation satisfies multiple canonical definitions beyond the primary one referenced in corresponding 'definition' elements.

    Compliance means that an implementation of a canonical resource (e.g., a search parameter or operation) satisfies all the normative requirements of the referenced canonical resource definition. When an implementation states that it complies with multiple canonical definitions, it means that it simultaneously satisfies all mandatory requirements from each referenced definition. This enables a single implementation to declare conformance to multiple sources without having to duplicate capability statement entries.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Indicates that a resource or element complies with another formally defined canonical resource
    ... extension 0..0 Extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/complies-with-canonical"
    ... value[x] 1..1 canonical() Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Indicates that a resource or element complies with another formally defined canonical resource
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0 Extension
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/complies-with-canonical"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type canonical: Indicates that a resource or element complies with another formally defined canonical resource. This extension allows systems to declare that their implementation satisfies multiple canonical definitions beyond the primary one referenced in corresponding 'definition' elements.

    Compliance means that an implementation of a canonical resource (e.g., a search parameter or operation) satisfies all the normative requirements of the referenced canonical resource definition. When an implementation states that it complies with multiple canonical definitions, it means that it simultaneously satisfies all mandatory requirements from each referenced definition. This enables a single implementation to declare conformance to multiple sources without having to duplicate capability statement entries.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Indicates that a resource or element complies with another formally defined canonical resource
    ... extension 0..0 Extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/complies-with-canonical"
    ... value[x] 1..1 canonical() Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Indicates that a resource or element complies with another formally defined canonical resource
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0 Extension
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/complies-with-canonical"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must 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:

    • Map the type canonical to uri on the element Extension.value[x]
    • Note: Extensions that have been modified for R3 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0..1 Extension Indicates that a resource or element complies with another formally defined canonical resource
    . . . extension 0 .. 0 Extension
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/complies-with-canonical"
    . . . value[x] 1.. 1 uri Value of extension

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)