Current Build

Extension: Rendered Value

FHIR Infrastructure Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/rendered-value

Status: draft. Extension maintained by: Health Level Seven International (FHIR Infrastructure)

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:

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

Context of Use: Use on Element ID Identifier.value, Element ID date, Element ID dateTime, Element ID time, Element ID instant, Element ID integer, Element ID decimal, Element ID string, Element ID code or Element ID canonical

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Rendered Value0..1stringURL = http://hl7.org/fhir/StructureDefinition/rendered-value
Rendered 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.


Use on Element ID Identifier.value, Element ID date, Element ID dateTime, Element ID time, Element ID instant, Element ID integer, Element ID decimal, Element ID string, Element ID code or Element ID canonical

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/rendered-value
Rendered 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.


Use on Element ID Identifier.value, Element ID date, Element ID dateTime, Element ID time, Element ID instant, Element ID integer, Element ID decimal, Element ID string, Element ID code or Element ID canonical
... extension I0..0
... url 1..1url"http://hl7.org/fhir/StructureDefinition/rendered-value"
... value[x] I0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
... value[x]:valueString I0..1stringValue of extension

doco Documentation for this format

XML Template

<!-- Rendered Value -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/rendered-value" >
  <!-- from Element: extension -->
 <-- valueString sliced by type:$this  in the specified orderClosed-->
 <valueString value="[string]"/><!-- ?? 0..1 Value of extension -->
</extension>

JSON Template

{ // Rendered Value
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/rendered-value", // R! 
    "valueString" : [ //  sliced by type:$this  in the specified order, Closed 
      { // Value of extension // C?
        // from Element: extension
      }
    ],
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Rendered Value0..1stringURL = http://hl7.org/fhir/StructureDefinition/rendered-value
Rendered 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.


Use on Element ID Identifier.value, Element ID date, Element ID dateTime, Element ID time, Element ID instant, Element ID integer, Element ID decimal, Element ID string, Element ID code or Element ID canonical

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/rendered-value
Rendered 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.


Use on Element ID Identifier.value, Element ID date, Element ID dateTime, Element ID time, Element ID instant, Element ID integer, Element ID decimal, Element ID string, Element ID code or Element ID canonical
... extension I0..0
... url 1..1url"http://hl7.org/fhir/StructureDefinition/rendered-value"
... value[x] I0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
... value[x]:valueString I0..1stringValue of extension

doco Documentation for this format

XML Template

<!-- Rendered Value -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/rendered-value" >
  <!-- from Element: extension -->
 <-- valueString sliced by type:$this  in the specified orderClosed-->
 <valueString value="[string]"/><!-- ?? 0..1 Value of extension -->
</extension>

JSON Template

{ // Rendered Value
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/rendered-value", // R! 
    "valueString" : [ //  sliced by type:$this  in the specified order, Closed 
      { // Value of extension // C?
        // from Element: extension
      }
    ],
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)
  • ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)