Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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: RenderedValue

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

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

Version: 5.0.0-ballot

Name: RenderedValue

Title: Rendered Value

Modifier: This extension is not a modifier extension

Status: draft

Definition: 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.

Committee: FHIR Infrastructure Work Group

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

Summary

Name	Flags	Card.	Type	Description & Constraints
RenderedValue		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/rendered-value RenderedValue: 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
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/rendered-value RenderedValue: 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	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/rendered-value"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- RenderedValue -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/rendered-value" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // RenderedValue
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/rendered-value", // R! 
    "valueString" : "<string>" // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
RenderedValue		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/rendered-value RenderedValue: 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
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/rendered-value RenderedValue: 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	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/rendered-value"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- RenderedValue -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/rendered-value" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // RenderedValue
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/rendered-value", // R! 
    "valueString" : "<string>" // I 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)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.