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

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use 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 For example, a sensitive identifier (e.g. social security number) partially number) partially obscured by asterisks; a asterisks; a drivers licence number licence number with dashes inserted; a date formatted as MMM dd, yyyy; etc. 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 data type: 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 usage info: insert a list of places where this extension is used or Element ID canonical

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension Rendered Value 0..1 string URL = http://hl7.org/fhir/StructureDefinition/rendered-value
Rendered Value: Provides a rendered version of the value intended for human display.  For For example, a sensitive identifier (e.g. social security number) partially number) partially obscured by asterisks; a asterisks; a drivers licence number licence number with dashes inserted; a date formatted as MMM dd, yyyy; etc. yyyy; etc.


Use on data type: 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

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/rendered-value
Rendered Value: Provides a rendered version of the value intended for human display.  For For example, a sensitive identifier (e.g. social security number) partially number) partially obscured by asterisks; a asterisks; a drivers licence number licence number with dashes inserted; a date formatted as MMM dd, yyyy; etc. yyyy; etc.


Use on data type: 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 I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/rendered-value" "http://hl7.org/fhir/StructureDefinition/rendered-value"
. . valueString . value[x] I 0..1 1..1 string Value of extension

doco Documentation for this format

XML Template 

<!-- Rendered Value -->doco

< xmlns="http://hl7.org/fhir"

<extension xmlns="http://hl7.org/fhir"

     url="http://hl7.org/fhir/StructureDefinition/rendered-value" >
  <!-- from Element: extension -->
 <

 <valueString value="[string]"/><!-- ?? 1..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" : "<string>" // C? R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension Rendered Value 0..1 string URL = http://hl7.org/fhir/StructureDefinition/rendered-value
Rendered Value: Provides a rendered version of the value intended for human display.  For For example, a sensitive identifier (e.g. social security number) partially number) partially obscured by asterisks; a asterisks; a drivers licence number licence number with dashes inserted; a date formatted as MMM dd, yyyy; etc. yyyy; etc.


Use on data type: 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

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/rendered-value
Rendered Value: Provides a rendered version of the value intended for human display.  For For example, a sensitive identifier (e.g. social security number) partially number) partially obscured by asterisks; a asterisks; a drivers licence number licence number with dashes inserted; a date formatted as MMM dd, yyyy; etc. yyyy; etc.


Use on data type: 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 I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/rendered-value" "http://hl7.org/fhir/StructureDefinition/rendered-value"
. . valueString . value[x] I 0..1 1..1 string Value of extension

doco Documentation for this format

XML Template 

<!-- Rendered Value -->doco

< xmlns="http://hl7.org/fhir"

<extension xmlns="http://hl7.org/fhir"

     url="http://hl7.org/fhir/StructureDefinition/rendered-value" >
  <!-- from Element: extension -->
 <

 <valueString value="[string]"/><!-- ?? 1..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" : "<string>" // C? R! Value of 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 )