FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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: R4B R4 R3 R4 R3

Extension-rendered-value.xml

FHIR Infrastructure Work Group Maturity Level : N/A Ballot Standards Status : Informative

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

Rendered Value

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


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="rendered-value"/> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/rendered-value"/> 
  <version value="4.0.1"/> 
  <name value="Rendered Value"/> 
  <title value="Rendered Value"/> 
  <status value="draft"/> 
  <date value="2013-12-05"/> 
  <publisher value="Health Level Seven International (FHIR Infrastructure)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://www.hl7.org/Special/committees/fiwg"/> 
    </telecom> 
  </contact> 
  Provides a rendered version of the value intended for human display.  For example, a sensitive
   identifier (e.g. social security number) partially obscured by asterisks; a drivers licence number
   with dashes inserted; a date formatted as MMM dd, yyyy; etc.
  

  <description value="Provides a rendered version of the value intended for human display.  For example, a sensitive
   identifier (e.g. social security number) partially obscured by asterisks; a drivers licence
   number with dashes inserted; a date formatted as MMM dd, yyyy; etc."/> 
  <fhirVersion value="4.0.1"/> 
  <mapping> 
    <identity value="rim"/> 
    <uri value="http://hl7.org/v3"/> 
    <name value="RIM Mapping"/> 
  </mapping> 
  <kind value="complex-type"/> 
  <abstract value="false"/> 
  
  
  
  
  
  
  
  
  
  

  <context> 
    <type value="element"/> 
    <expression value="Identifier.value"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="date"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="dateTime"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="time"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="instant"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="integer"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="decimal"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="string"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="code"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="canonical"/> 
  </context> 
  <type value="Extension"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
  <derivation value="constraint"/> 
  <snapshot> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="What should be displayed to human (if default is not appropriate)"/> 
      Provides a rendered version of the value intended for human display.  For example, a sensitive
       identifier (e.g. social security number) partially obscured by asterisks; a drivers licence number
       with dashes inserted; a date formatted as MMM dd, yyyy; etc.
      In some cases, this extension may be present and the value won't be present.  For example
       if the recipient only has permission to see a partially masked view of a value.  The rendering
       may be realm-specific.  (E.g. the use of ',' vs. '.' when rendering numbers.).

      <definition value="Provides a rendered version of the value intended for human display.  For example, a sensitive
       identifier (e.g. social security number) partially obscured by asterisks; a drivers licence
       number with dashes inserted; a date formatted as MMM dd, yyyy; etc."/> 
      <comment value="In some cases, this extension may be present and the value won't be present.  For example

       if the recipient only has permission to see a partially masked view of a value.  The rendering
       may be realm-specific.  (E.g. the use of ',' vs. '.' when rendering numbers.)."/> 

      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <condition value="ele-1"/> 
      <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())"/> 
        <xpath value="@value|f:*|h:div"/> 
        

        <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()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/> 
        

        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
    </element> 
    <element id="Extension.id">
      <path value="Extension.id"/> 
      <representation value="xmlAttr"/> 
      
      unique id for the element within a resource (for internal references). This may be any

      <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> 
      <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"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="n/a"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <rules value="open"/> 
      </slicing> 
      
      May be used to represent additional information that is not part of the basic definition
       of the element. 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.
      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.
      
      

      <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())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <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()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <representation value="xmlAttr"/> 
      <short value="identifies the meaning of the extension"/> 
      <definition value="Source of the definition for the extension code - a logical name or a URL."/> 
      <comment value="The definition may point directly to a computable or human-readable definition of the
       extensibility codes, or it may be a logical URI as declared in some other specification.
       The definition SHALL be a URI for the Structure Definition defining the extension."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.url"/> 
        <min value="1"/> 
        <max value="1"/> 
      </base> 
      <type> 
        

        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="uri"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/rendered-value"/> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    
      

    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <short value="Value of extension"/> 
      Value of extension - may be a resource or one of a constrained set of the data types (see
       Extensibility in the spec for list).
      

      <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://
      hl7.org/fhir/extensibility.html) for a list)."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="string"/> 
      </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())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <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="Extension">
      <path value="Extension"/> 
      <short value="What should be displayed to human (if default is not appropriate)"/> 
      Provides a rendered version of the value intended for human display.  For example, a sensitive
       identifier (e.g. social security number) partially obscured by asterisks; a drivers licence number
       with dashes inserted; a date formatted as MMM dd, yyyy; etc.
      In some cases, this extension may be present and the value won't be present.  For example
       if the recipient only has permission to see a partially masked view of a value.  The rendering
       may be realm-specific.  (E.g. the use of ',' vs. '.' when rendering numbers.).

      <definition value="Provides a rendered version of the value intended for human display.  For example, a sensitive
       identifier (e.g. social security number) partially obscured by asterisks; a drivers licence
       number with dashes inserted; a date formatted as MMM dd, yyyy; etc."/> 
      <comment value="In some cases, this extension may be present and the value won't be present.  For example

       if the recipient only has permission to see a partially masked view of a value.  The rendering
       may be realm-specific.  (E.g. the use of ',' vs. '.' when rendering numbers.)."/> 

      <min value="0"/> 
      <max value="1"/> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <max value="0"/> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      
        
      

      <fixedUri value="http://hl7.org/fhir/StructureDefinition/rendered-value"/> 
    </element> 
    
      

    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <min value="1"/> 
      <type> 
        <code value="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.