Clinical Document Architecture
2.0.0-sd - release

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-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

Data Type Profile: ruid - XML Profile

Active as of 2024-10-25

XML representation of the ruid data type profile.

Raw xml | Download


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="ruid"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>Primitive type 'ruid'</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/tools/StructureDefinition/logical-container">
    <valueUri
              value="http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
    <valueCode value="can-bind"/>
  </extension>
  <url value="http://hl7.org/cda/stds/core/StructureDefinition/ruid"/>
  <version value="2.0.0-sd"/>
  <name value="ruid"/>
  <title value="ruid: HL7 Reserved Identifier Scheme"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-10-25T20:25:09+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="HL7 Reserved Identifier Scheme (RUID)\nA globally unique string defined exclusively by HL7. Identifiers in this scheme are only defined by balloted HL7 specifications. Local communities or systems must never use such reserved identifiers based on bilateral negotiations.

HL7 reserved identifiers are strings that consist only of (US-ASCII) letters, digits and hyphens, where the first character must be a letter. HL7 may assign these reserved identifiers as mnemonic identifiers for major concepts of interest to HL7."/>
  <fhirVersion value="5.0.0"/>
  <kind value="primitive-type"/>
  <abstract value="false"/>
  <type value="string"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/string"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="string">
      <path value="string"/>
      <short value="Primitive Type string"/>
      <definition value="A sequence of Unicode characters"/>
      <comment
               value="Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="string"/>
        <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>
      <constraint>
        <key value="ruid-pattern"/>
        <severity value="error"/>
        <human
               value="An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen."/>
        <expression
                    value="matches('^[A-Za-z][A-Za-z0-9\\-]*$') and matches('^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$').not()"/>
      </constraint>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="string.id">
      <path value="string.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="string.extension">
      <path value="string.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="string.value">
      <path value="string.value"/>
      <representation value="xmlAttr"/>
      <short value="Primitive value for string"/>
      <definition value="The actual value"/>
      <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="string"/>
        </extension>
        <extension url="http://hl7.org/fhir/StructureDefinition/regex">
          <valueString value="^[\s\S]+$"/>
        </extension>
        <code value="http://hl7.org/fhirpath/System.String"/>
      </type>
      <maxLength value="1048576"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </snapshot>
  <differential>
    <element id="string">
      <path value="string"/>
      <constraint>
        <key value="ruid-pattern"/>
        <severity value="error"/>
        <human
               value="An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen."/>
        <expression
                    value="matches('^[A-Za-z][A-Za-z0-9\\-]*$') and matches('^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$').not()"/>
      </constraint>
    </element>
    <element id="string.id">
      <path value="string.id"/>
      <min value="0"/>
    </element>
    <element id="string.extension">
      <path value="string.extension"/>
      <max value="0"/>
    </element>
  </differential>
</StructureDefinition>