FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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 R3 R2

String.profile.xml

Modeling and Methodology Work GroupMaturity Level: N/ABallot Status: Informative

Raw XML (canonical form)

StructureDefinition for string

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="string"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">to do</div> 
  </text> 
  <url value="http://hl7.org/fhir/StructureDefinition/string"/> 
  <name value="string"/> 
  <status value="draft"/> 
  <date value="2019-10-24T11:53:00+11:00"/> 
  <publisher value="HL7 FHIR Standard"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="Base StructureDefinition for string Type: A sequence of Unicode characters"/> 
  <fhirVersion value="3.0.2"/> 
  <kind value="primitive-type"/> 
  <abstract value="false"/> 
  <type value="string"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/> 
  <derivation value="specialization"/> 
  <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 may not exceed 1MB in size"/> 
      <min value="0"/> 
      <max value="*"/> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() | (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="Element"/> 
      </constraint> 
    </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> 
        <code value="string"/> 
      </type> 
    </element> 
    <element id="string.extension">
      <path value="string.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. In order 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 is allowed to 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> 
    </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"/> 
    <!--  Note: primitive values do not have an assigned type. e.g. this is compiler magic. XML,
       JSON and RDF types provided by extension  -->
      <type> 
        <code> 
          <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type">
            <valueString value="string"/> 
          </extension> 
          <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type">
            <valueString value="xsd:string"/> 
          </extension> 
          <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type">
            <valueString value="xsd:string"/> 
          </extension> 
        </code> 
      </type> 
      <maxLength value="1048576"/> 
    </element> 
  </snapshot> 
  <differential> 
    <element id="string">
      <path value="string"/> 
      <short value="Primitive Type string"/> 
      <definition value="A sequence of Unicode characters"/> 
      <comment value="Note that FHIR strings may not exceed 1MB in size"/> 
      <min value="0"/> 
      <max value="*"/> 
    </element> 
    <element id="string.value">
      <path value="string.value"/> 
      <representation value="xmlAttr"/> 
      <short value="Primitive value for string"/> 
      <definition value="Primitive value for string"/> 
      <min value="0"/> 
      <max value="1"/> 
    <!--  Note: primitive values do not have an assigned type. e.g. this is compiler magic. XML,
       JSON and RDF types provided by extension  -->
      <type> 
        <code> 
          <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type">
            <valueString value="string"/> 
          </extension> 
          <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type">
            <valueString value="xsd:string"/> 
          </extension> 
          <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type">
            <valueString value="xsd:string"/> 
          </extension> 
        </code> 
      </type> 
      <maxLength value="1048576"/> 
    </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.