This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
Example StructureDefinition/canonical (XML)
Raw XML (canonical form + also see XML Format Specification)
StructureDefinition for canonical
<?xml version="1.0" encoding="UTF-8"?>
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="canonical"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">to do</div>
</text>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="normative"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
<valueCode value="4.0.0"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
<valueCode value="has-target"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
<valueCode value="has-length"/>
</extension>
<url value="http://hl7.org/fhir/StructureDefinition/canonical"/>
<version value="5.0.0"/>
<name value="canonical"/>
<status value="active"/>
<experimental value="false"/>
<date value="2023-03-26T15:21:02+11:00"/>
<publisher value="HL7 FHIR Standard"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://hl7.org/fhir"/>
</telecom>
</contact>
<description value="canonical type: A URI that is a reference to a canonical URL on a FHIR resource"/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
<display value="World"/>
</coding>
</jurisdiction>
<fhirVersion value="5.0.0"/>
<kind value="primitive-type"/>
<abstract value="false"/>
<type value="canonical"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/uri"/>
<derivation value="specialization"/>
<snapshot>
<element id="canonical">
<path value="canonical"/>
<short value="Primitive Type canonical"/>
<definition value="A URI that is a reference to a canonical URL on a FHIR resource"/>
<comment value="see [Canonical References](references.html#canonical)"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="canonical"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="canonical.id">
<path value="canonical.id"/>
<representation value="xmlAttr"/>
<short value="xml:id (or equivalent in JSON)"/>
<definition value="unique id for the element within a resource (for internal references)"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="canonical.extension">
<path value="canonical.extension"/>
<short value="Additional content defined by implementations"/>
<definition value="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 managable, 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 value="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 value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="canonical.value">
<path value="canonical.value"/>
<representation value="xmlAttr"/>
<short value="Primitive value for canonical"/>
<definition value="Primitive value for canonical"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="uri.value"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="canonical"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/regex">
<valueString value="\S*"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
</snapshot>
<differential>
<element id="canonical">
<path value="canonical"/>
<short value="Primitive Type canonical"/>
<definition value="A URI that is a reference to a canonical URL on a FHIR resource"/>
<comment value="see [Canonical References](references.html#canonical)"/>
<min value="0"/>
<max value="*"/>
</element>
<element id="canonical.value">
<path value="canonical.value"/>
<representation value="xmlAttr"/>
<short value="Primitive value for canonical"/>
<definition value="Primitive value for canonical"/>
<min value="0"/>
<max value="1"/>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="canonical"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/regex">
<valueString value="\S*"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
</element>
</differential>
</StructureDefinition>
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.
Foundation
|
Propose a change