FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example StructureDefinition/oid (XML)

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

Raw XML (canonical form + also see XML Format Specification)

StructureDefinition for oid

<?xml version="1.0" encoding="UTF-8"?>

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="oid"/> 
  <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-length"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/oid"/> 
  <version value="6.0.0-ballot2"/> 
  <name value="oid"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2024-12-03T22:56:58+00:00"/> 
  <publisher value="HL7 International / FHIR Infrastructure"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://www.hl7.org/Special/committees/fiwg"/> 
    </telecom> 
  </contact> 
  <description value="oid type: An OID represented as a URI"/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <fhirVersion value="6.0.0-ballot2"/> 
  <kind value="primitive-type"/> 
  <abstract value="false"/> 
  <type value="oid"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/uri"/> 
  <derivation value="specialization"/> 
  <snapshot> 
    <element id="oid">
      <path value="oid"/> 
      <short value="Primitive Type oid"/> 
      <definition value="An OID represented as a URI"/> 
      <comment value="RFC 3001. See also ISO/IEC 8824:1990 €"/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="oid"/> 
        <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="oid.id">
      <path value="oid.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> 
      <!--  Note: special primitive values have a FHIRPath system type. e.g. this is compiler
       magic (h)  -->
      <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="oid.extension">
      <path value="oid.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() &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="oid.value">
      <path value="oid.value"/> 
      <representation value="xmlAttr"/> 
      <short value="Primitive value for oid"/> 
      <definition value="Primitive value for oid"/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="uri.value"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <!--  Note: special primitive values have a FHIRPath system type. e.g. this is compiler
       magic (i)  -->
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="oid"/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/regex">
          <valueString value="urn:oid:[0-2](\.(0|[1-9][0-9]*))+"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
  </snapshot> 
  <differential> 
    <element id="oid">
      <path value="oid"/> 
      <short value="Primitive Type oid"/> 
      <definition value="An OID represented as a URI"/> 
      <comment value="RFC 3001. See also ISO/IEC 8824:1990 €"/> 
      <min value="0"/> 
      <max value="*"/> 
    </element> 
    <element id="oid.value">
      <path value="oid.value"/> 
      <representation value="xmlAttr"/> 
      <short value="Primitive value for oid"/> 
      <definition value="Primitive value for oid"/> 
      <min value="0"/> 
      <max value="1"/> 
      <!--  Note: special primitive values have a FHIRPath system type. e.g. this is compiler
       magic (g)  -->
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="oid"/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/regex">
          <valueString value="urn:oid:[0-2](\.(0|[1-9][0-9]*))+"/> 
        </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.