STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 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: R4B R4 R3

Extension-rendered-value.xml

Raw XML (canonical form)

What should be displayed to human (if default is not appropriate)

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="rendered-value"/>
  <url value="http://hl7.org/fhir/StructureDefinition/rendered-value"/>
  <name value="What should be displayed to human (if default is not appropriate)"/>
  <display value="Rendered Value"/>
  <status value="draft"/>
  <publisher value="Health Level Seven International (FHIR Infrastructure)"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://www.hl7.org/Special/committees/fiwg"/>
    </telecom>
  </contact>
  <date value="2013-12-05"/>
  <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="1.4.0"/>
  <kind value="datatype"/>
  <abstract value="false"/>
  <contextType value="datatype"/>
  <context value="Identifier.value"/>
  <context value="date"/>
  <context value="dateTime"/>
  <context value="time"/>
  <context value="instant"/>
  <context value="integer"/>
  <context value="decimal"/>
  <baseType value="Extension"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/>
  <derivation value="constraint"/>
  <snapshot>
    <element>
      <path value="Extension"/>
      <short value="What should be displayed to human (if default is not appropriate)"/>
      <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."/>
      <comments 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>
      <type>
        <code value="Extension"/>
      </type>
    </element>
    <element>
      <path value="Extension.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="*"/>
      </base>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Extension.extension"/>
      <name value="extension"/>
      <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>
    </element>
    <element>
      <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."/>
      <comments 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 should be version specific.  This will ideally be the URI for the Resource
       Profile defining the extension, with the code for the extension after a #."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Extension.url"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="uri"/>
      </type>
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/rendered-value"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Extension.valueString"/>
      <short value="Value of extension"/>
      <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see
       Extensibility in the spec for 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>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="Extension"/>
      <short value="What should be displayed to human (if default is not appropriate)"/>
      <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."/>
      <comments 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"/>
      <type>
        <code value="Extension"/>
      </type>
    </element>
    <element>
      <path value="Extension.extension"/>
      <name value="extension"/>
      <max value="0"/>
    </element>
    <element>
      <path value="Extension.url"/>
      <type>
        <code value="uri"/>
      </type>
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/rendered-value"/>
    </element>
    <element>
      <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.