This page is part of the FHIR Specification (v5.0.0-snapshot1: Release 5 Snapshot #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
. Page versions: R5 R4B R4
| Modeling and Methodology Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for canonical
{
"resourceType" : "StructureDefinition",
"id" : "canonical",
"meta" : {
"lastUpdated" : "2021-12-19T08:15:41.873+11:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/canonical",
"version" : "5.0.0-snapshot1",
"name" : "canonical",
"status" : "active",
"date" : "2021-12-19T08:15:41+11:00",
"publisher" : "HL7 FHIR Standard",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "Base StructureDefinition for canonical type: A URI that is a reference to a canonical URL on a FHIR resource",
"fhirVersion" : "5.0.0-snapshot1",
"kind" : "primitive-type",
"abstract" : false,
"type" : "canonical",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/uri",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "canonical",
"path" : "canonical",
"short" : "Primitive Type canonical",
"definition" : "A URI that is a reference to a canonical URL on a FHIR resource",
"comment" : "see [Canonical References](references.html#canonical)",
"min" : 0,
"max" : "*",
"base" : {
"path" : "canonical",
"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())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "canonical.id",
"path" : "canonical.id",
"representation" : ["xmlAttr"],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "canonical.extension",
"path" : "canonical.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"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())",
"xpath" : "@value|f:*|h:div",
"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()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "canonical.value",
"path" : "canonical.value",
"representation" : ["xmlAttr"],
"short" : "Primitive value for canonical",
"definition" : "Primitive value for canonical",
"min" : 0,
"max" : "1",
"base" : {
"path" : "uri.value",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/regex",
"valueString" : "\\S*"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "canonical",
"path" : "canonical",
"short" : "Primitive Type canonical",
"definition" : "A URI that is a reference to a canonical URL on a FHIR resource",
"comment" : "see [Canonical References](references.html#canonical)",
"min" : 0,
"max" : "*"
},
{
"id" : "canonical.value",
"path" : "canonical.value",
"representation" : ["xmlAttr"],
"short" : "Primitive value for canonical",
"definition" : "Primitive value for canonical",
"min" : 0,
"max" : "1",
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "canonical"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/regex",
"valueString" : "\\S*"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}]
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.