Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). 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 R2

Extension: display-hint

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint

Status: draft. Extension maintained by: Health Level Seven, Inc. - [WG Name] WG

Hinting information for the narrative generator - a series of name: value; pairs.

Comment:

known names: default (default value - don't represent if this value).

Context of Use: Use on Element ID ElementDefinition

Summary

Name	Flags	Card.	Type	Description & Constraints
display-hint		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint display-hint: Hinting information for the narrative generator - a series of name: value; pairs. Use on Element ID ElementDefinition
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint display-hint: Hinting information for the narrative generator - a series of name: value; pairs. Use on Element ID ElementDefinition
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint"
value[x]	I	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- display-hint -->

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

JSON Template

{ // display-hint
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", // R! 
    "valueString" : "<string>" // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
display-hint		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint display-hint: Hinting information for the narrative generator - a series of name: value; pairs. Use on Element ID ElementDefinition
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint display-hint: Hinting information for the narrative generator - a series of name: value; pairs. Use on Element ID ElementDefinition
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint"
value[x]	I	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- display-hint -->

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

JSON Template

{ // display-hint
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", // 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)