| Package | hl7.fhir.uv.extensions |
| Type | StructureDefinition |
| Id | complies-with-canonical |
| FHIR Version | R5 |
| Source | http://hl7.org/fhir/extensions/https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-complies-with-canonical.html |
| URL | http://hl7.org/fhir/StructureDefinition/complies-with-canonical |
| Version | 5.3.0-ballot |
| Status | draft |
| Date | 2025-07-16 |
| Name | CompliesWithCanonical |
| Title | Complies With Canonical |
| Realm | uv |
| Authority | hl7 |
| Description | 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. |
| Type | Extension |
| Kind | complex-type |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition complies-with-canonical
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..1 | Extension | Indicates that a resource or element complies with another formally defined canonical resource | |
  extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/complies-with-canonical" | |
  value[x] | 1..1 | canonical() | Value of extension | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "complies-with-canonical",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/complies-with-canonical",
"version": "5.3.0-ballot",
"name": "CompliesWithCanonical",
"title": "Complies With Canonical",
"status": "draft",
"experimental": false,
"date": "2025-07-16",
"publisher": "HL7 International / FHIR Infrastructure",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "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.\n\nCompliance 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.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "SearchParameter"
},
{
"type": "element",
"expression": "CapabilityStatement.rest.searchParam"
},
{
"type": "element",
"expression": "CapabilityStatement.rest.resource.searchParam"
},
{
"type": "element",
"expression": "OperationDefinition"
},
{
"type": "element",
"expression": "CapabilityStatement.rest.operation"
},
{
"extension": [
{
"extension": [
{
"url": "startFhirVersion",
"valueCode": "4.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
}
],
"type": "element",
"expression": "CapabilityStatement.rest.resource.operation"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
}
],
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Indicates that a resource or element complies with another formally defined canonical resource",
"definition": "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.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/complies-with-canonical",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "canonical"
}
],
"condition": [
"ext-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Indicates that a resource or element complies with another formally defined canonical resource",
"definition": "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.",
"comment": "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.",
"min": 0,
"max": "1"
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/complies-with-canonical"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 1,
"type": [
{
"code": "canonical"
}
]
}
]
}
}