Release 4B Ballot #1 5

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0: R5 - STU ). The This is the current published version which supercedes in it's permanent home (it will always be available at this version is 5.0.0 . URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R5 R4B

Datatype.profile.xml

Example StructureDefinition/DataType (XML)

Modeling and Methodology Work Group Maturity Level : N/A Standards Status : Informative

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

StructureDefinition for DataType

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


  
  
    
    
      
        
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            
          
          
            
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            
            
              
                
              
            
          
        
        
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data:image/png;base64,iVBORw0KGg
          oAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCs
          PVYVAgIJrA/sAAAAASUVORK5CYII=)
            data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3
            RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAwN
            dCABMPwMo2ctnoQAAAABJRU5ErkJggg==
            data:image/png;base64,R0lGODlhEAAQAPZ/APrkusOiYvvfqbiXWaV2G+jGhdq1b8GgYf3v1frw3vTUlsWkZNewbcSjY/DQka
            d4Hb6dXv3u0f3v1ObEgfPTlerJiP3w1v79+e7OkPrfrfnjuNOtZPrpydaxa+/YrvvdpP779ZxvFPvnwKKBQaFyF/369M2vdaqHRPz
            58/HNh/vowufFhfroxO3OkPrluv779tK0e6JzGProwvrow9m4eOnIifPTlPDPkP78+Naxaf3v0/zowfXRi+bFhLWUVv379/rnwPvs
            zv3rye3LiPvnv+3MjPDasKiIS/789/3x2f747eXDg+7Mifvu0tu7f+/QkfDTnPXWmPrjsvrjtPbPgrqZW+/QlPz48K2EMv36866OU
            Pvowat8Ivvgq/Pbrvzgq/PguvrgrqN0Gda2evfYm9+7d/rpw9q6e/LSku/Rl/XVl/LSlfrkt+zVqe7Wqv3x1/bNffbOf59wFdS6if
            3u0vrqyP3owPvepfXQivDQkO/PkKh9K7STVf779P///wD/ACH5BAEKAH8ALAAAAAAQABAAAAemgH+CgxeFF4OIhBdKGwFChYl/hYw
            bdkoBPnaQkosbG3d3VEpSUlonUoY1Gzo6QkI8SrGxWBOFG4uySgY5ZWR3PFy2hnaWZXC/PHcPwkpJk1ShoHcxhQEXSUmtFy6+0iSF
            VResrjoTPDzdcoU+F65CduVU6KAhhQa3F8Tx8nchBoYuqoTLZoAKFRIhqGwqJAULFx0GYpBQeChRIR4TJm6KJMhQRUSBAAA7 
            
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            
            padding-left: 3px; padding-right: 3px; border: 1px grey solid; font-weight: bold; color:
             black; background-color: #e6ffe6
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4pxReuseable Types
            Elements defined in Ancestors: 
            Unique id for the element within a resource (for internal references). This may be any
             string value that does not contain spaces., 
            May be used to represent additional information that is not part of the basic definition
             of the element. 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
             can define an extension, there is a set of requirements that SHALL be met as part of the
             definition of the extension.
          
        

        
          
            
            
               Documentation for this format
            
          
        
      
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
    
      
      
    
  
  Base StructureDefinition for DataType Type: The base class for all re-useable types defined
   as part of the FHIR Specification.
  
  
    
    
    
  
  
  
  
  
  
  
    
      
        
      
      
        
      
      
      
      
      
      
      
        
        
        
      
      
      
        
        
        
        
        
        
      
      
      
        
        
      
    
    
      
      
      
      Unique id for the element within a resource (for internal references). This may be any
       string value that does not contain spaces.
      
      
      
        
        
        
      
    <!--  Note: special primitive values have a FHIRPath system type. e.g. this is compiler magic
       (j)  -->
      
        
          
        
        
      
      
      
      
        
        
      
    
    
      
      
        
          
          
        
        
        
      
      

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="DataType"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align:
       top;">
        <tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align:

         top">
          <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a>           </th>           <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a>           </th>           <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a>           </th>           <th class="hierarchy" style="width: 100px">            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a>           </th>           <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description &amp; Constraints</a>             <span style="float: right">              <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format">                <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/>               </a>             </span>           </th>         </tr>         <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:

         white">
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data:image/png;bas
          e64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAgDsHd9/w4EQIOamFnaBgAA4M
          MKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)">
            <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/>             <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Data Type"/>              <a href="types-definitions.html#DataType" title="DataType : The base class for all re-useable types defined as part of the FHIR

             Specification.">DataType</a> 
          </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="uml.html#abstract" style="padding-left: 3px; padding-right: 3px; color: black; null" title="This is an abstract type">«A»</a>             <a href="versions.html#std-process" style="padding-left: 3px; padding-right: 3px; border: 1px grey solid; font-weight: bold;

             color: black; background-color: #e6ffe6" title="Standards Status = Normative">N</a> 
          </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px"/> 
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="types.html#Element">Element</a>           </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">Reuseable Types
            <br/>              <br/>  Elements defined in Ancestors:             <a href="types.html#Element" title="Unique id for the element within a resource (for internal references). This may

             be any string value that does not contain spaces.">id</a> , 
            <a href="types.html#Element" title="May be used to represent additional information that is not part of the basic definition

             of the element. 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.">extension</a> 
          </td>         </tr>         <tr>           <td class="hierarchy" colspan="5">            <br/>              <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format">              <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/>  Documentation for this format            </a>           </td>         </tr>       </table>     </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>   <url value="http://hl7.org/fhir/StructureDefinition/DataType"/>   <version value="5.0.0"/>   <name value="DataType"/>   <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="DataType Type: The base class for all re-useable types defined as part of the FHIR

   Specification."/> 
  <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"/>   <mapping>     <identity value="rim"/>     <uri value="http://hl7.org/v3"/>     <name value="RIM Mapping"/>   </mapping>   <kind value="complex-type"/>   <abstract value="true"/>   <type value="DataType"/>   <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>   <derivation value="specialization"/>   <snapshot>     <element id="DataType">      <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>       <path value="DataType"/>       <short value="Reuseable Types"/>       <definition value="The base class for all re-useable types defined as part of the FHIR Specification."/>       <min value="0"/>       <max value="*"/>       <base>         <path value="DataType"/>         <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"/>       <mapping>         <identity value="rim"/>         <map value="n/a"/>       </mapping>     </element>     <element id="DataType.id">      <path value="DataType.id"/>       <representation value="xmlAttr"/>       <short value="Unique id for inter-element referencing"/>       <definition value="Unique id for the element within a resource (for internal references). This may

       be any string value that does not contain spaces."/> 
      <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 (j)  -->
      <type>         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">          <valueUrl value="id"/>         </extension>         <code value="http://hl7.org/fhirpath/System.String"/>       </type>       <condition value="ele-1"/>       <isModifier value="false"/>       <isSummary value="false"/>       <mapping>         <identity value="rim"/>         <map value="n/a"/>       </mapping>     </element>     <element id="DataType.extension">      <path value="DataType.extension"/>       <slicing>         <discriminator>           <type value="value"/>           <path value="url"/>         </discriminator>         <description value="Extensions are always sliced by (at least) url"/>         <rules value="open"/>       </slicing>       <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 element. 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
       can define an extension, there is a set of requirements that SHALL be met as part of the
       definition of the extension.
      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.
      
      
      
      
      
        
        
        
      
      
        
      
      
        
        
        
        
        
        
      
      
        
        
        
        
        
        
      
      
      
      
        
        
      
    
  
  
    
      
        
      
      
        
      
      
      
      
      
      
      
        
        
      
    
  

       of the element. 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"/>       <mapping>         <identity value="rim"/>         <map value="n/a"/>       </mapping>     </element>   </snapshot>   <differential>     <element id="DataType">      <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>       <path value="DataType"/>       <short value="Reuseable Types"/>       <definition value="The base class for all re-useable types defined as part of the FHIR Specification."/>       <min value="0"/>       <max value="*"/>       <mapping>         <identity value="rim"/>         <map value="n/a"/>       </mapping>     </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.