This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot-tc1: Release 5.3) based on FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 5.2.0. For a full list of available versions, see the Directory of published versions
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)
SearchParameter
CapabilityStatement.rest.searchParam
CapabilityStatement.rest.resource.searchParam
OperationDefinition
CapabilityStatement.rest.operation
CapabilityStatement.rest.resource.operation
(FHIR versions
R4
and after)
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 5.2.0:
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..1 | Extension | Indicates that a resource or element complies with another formally defined canonical resource | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/complies-with-canonical" | |
![]() ![]() ![]() |
1..1 | canonical() | Value of extension | |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..1 | Extension | Indicates that a resource or element complies with another formally defined canonical resource | |
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/complies-with-canonical" | |
![]() ![]() ![]() |
1..1 | canonical() | Value of extension | |
![]() |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..1 | Extension | Indicates that a resource or element complies with another formally defined canonical resource | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/complies-with-canonical" | |
![]() ![]() ![]() |
1..1 | canonical() | Value of extension | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..1 | Extension | Indicates that a resource or element complies with another formally defined canonical resource | |
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/complies-with-canonical" | |
![]() ![]() ![]() |
1..1 | canonical() | Value of extension | |
![]() |
Other representations of profile: CSV, Excel, Schematron
Id | Grade | Path(s) | Details | Requirements |
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() |
The extension is unchanged in R4B
The extension is unchanged in R4
The extension is represented a little differently in R3:
Name | Flags | Card. | Type |
Description & Constraints
Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..1 | Extension | Indicates that a resource or element complies with another formally defined canonical resource | |
![]() ![]() ![]() |
0 .. 0 | |||
![]() ![]() ![]() |
1 .. 1 | uri | "http://hl7.org/fhir/StructureDefinition/complies-with-canonical" | |
![]() ![]() ![]() |
1.. 1 | uri | Value of extension | |
![]() |
(none found)