Release 5 R6 Ballot (2nd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot2: Release 6 Ballot (2nd Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions

Example StructureDefinition/PrimitiveType (XML)

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

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

StructureDefinition for PrimitiveType

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


  
  
    
    

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="PrimitiveType"/> 
  <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;

       top;">

        <tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align:
         top

         top">

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

           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
            
          

           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
            
          
          
            
          

           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 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
            
            
              
                
              
            
          
        

           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

         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==)
            
             

          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#PrimitiveType" title="PrimitiveType : The base type for all re-useable types defined that have a simple
             property.
          

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

           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
          

             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

           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
            
          

           solid; padding:0px 4px 0px 4px">
            <a href="types.html#DataType">DataType</a>           </td> 
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4pxParent type for DataTypes with a simple value
            
            Elements defined in Ancestors: 

           solid; padding:0px 4px 0px 4px">Parent type for DataTypes with a simple value
            <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., 

             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.
          
        

        
          
            
            
               Documentation for this format
            
          
        
      
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
  
    
      
      
    
  

             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>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">    <valueCode value="fhir"/>   </extension>   <url value="http://hl7.org/fhir/StructureDefinition/PrimitiveType"/>   <version value="6.0.0-ballot2"/>   <name value="PrimitiveType"/>   <status value="active"/>   <experimental value="false"/>   <date value="2024-08-12T16:52:12+08: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="PrimitiveType Type: The base type for all re-useable types defined that have a
   simple property.
  
    
      
      
      
    
  
  
  
    
    
    
  
  
  
  
  
  
  
    
      
        
      
      
        
      
      
      
      
      
      
      
        
        
        
      
      
        
        
        
        
        
      
      
      
        
        
      
    
    
      
      
      

   simple property."/> 
  <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"/>   <mapping>     <identity value="rim"/>     <uri value="http://hl7.org/v3"/>     <name value="RIM Mapping"/>   </mapping>   <kind value="complex-type"/>   <abstract value="true"/>   <type value="PrimitiveType"/>   <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DataType"/>   <derivation value="specialization"/>   <snapshot>     <element id="PrimitiveType">      <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="PrimitiveType"/>       <short value="Parent type for DataTypes with a simple value"/>       <definition value="The base type for all re-useable types defined that have a simple property."/>       <min value="0"/>       <max value="*"/>       <base>         <path value="PrimitiveType"/>         <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="PrimitiveType.id">      <path value="PrimitiveType.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.
      
      
      
        
        
        
      

       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)  -->
      
        
          
        
        
      
      
      
      
      
        
        
      
    
    
      
      
        
          
          
        
        
        
      
      

       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="PrimitiveType.extension">      <path value="PrimitiveType.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 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.

       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.
      
      
      
      
      
        
        
        
      
      
        
      
      
        
        
        
        
        
      
      
        
        
        
        
        
      
      
      
      
        
        
      
    
  
  
    
      
        
      
      
        
      
      
      
      
      
      
      
        
        
      
    
  

       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>       <isModifier value="false"/>       <isSummary value="false"/>       <mapping>         <identity value="rim"/>         <map value="n/a"/>       </mapping>     </element>   </snapshot>   <differential>     <element id="PrimitiveType">      <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="PrimitiveType"/>       <short value="Parent type for DataTypes with a simple value"/>       <definition value="The base type for all re-useable types defined that have a simple property."/>       <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.