Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.1-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Data Type Profile: xs:ID - XML Profile

XML representation of the xs-ID data type profile.

Raw xml | Download

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="xs-ID"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>Primitive type 'xs:ID'</p>
    </div>
  </text>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
    <valueCode value="has-length"/>
  </extension>
  <url value="http://hl7.org/cda/stds/core/StructureDefinition/xs-ID"/>
  <version value="2.0.1-sd"/>
  <name value="xs:ID"/>
  <title value="xs:ID"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-12-18T02:39:25+00:00"/>
  <publisher value="Health Level 7"/>
  <contact>
    <name value="HL7 International - Structured Documents"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/structure"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="structdog@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="ID represents the ID attribute type from [XML 1.0 (Second Edition)]. The &quot;value space&quot; of ID is the set of all strings that &quot;match&quot; the NCName production in [Namespaces in XML]. The &quot;lexical space&quot; of ID is the set of all strings that &quot;match&quot; the NCName production in [Namespaces in XML]."/>
  <fhirVersion value="5.0.0"/>
  <kind value="primitive-type"/>
  <abstract value="false"/>
  <type value="id"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/id"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="id">
      <path value="id"/>
      <short value="Primitive Type id"/>
      <definition
                  value="Any combination of letters, numerals, &quot;-&quot; and &quot;.&quot;, with a length limit of 64 characters.  (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.)  Ids are case-insensitive."/>
      <comment value="RFC 4122"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="id"/>
        <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() &gt; id.count())"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
      </constraint>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="id.id">
      <path value="id.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="0"/>
      <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="id.extension">
      <path value="id.extension"/>
      <short value="Extension"/>
      <definition value="An Extension"/>
      <min value="0"/>
      <max value="0"/>
      <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() &gt; 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="id.value">
      <path value="id.value"/>
      <representation value="xmlAttr"/>
      <short value="Primitive value for id"/>
      <definition value="Primitive value for id"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="string.value"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="id"/>
        </extension>
        <extension url="http://hl7.org/fhir/StructureDefinition/regex">
          <valueString value="[A-Za-z0-9\-\.]{1,64}"/>
        </extension>
        <code value="http://hl7.org/fhirpath/System.String"/>
      </type>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </snapshot>
  <differential>
    <element id="id.id">
      <path value="id.id"/>
      <max value="0"/>
    </element>
    <element id="id.extension">
      <path value="id.extension"/>
      <max value="0"/>
    </element>
  </differential>
</StructureDefinition>