This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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
What should be displayed to human (if default is not appropriate)
{ "resourceType": "StructureDefinition", "id": "rendered-value", "url": "http://hl7.org/fhir/StructureDefinition/rendered-value", "name": "What should be displayed to human (if default is not appropriate)", "title": "Rendered Value", "status": "draft", "publisher": "Health Level Seven International (FHIR Infrastructure)", "contact": [ { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/fiwg" } ] } ], "date": "2013-12-05", "description": "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": "1.8.0", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "contextType": "datatype", "context": [ "Identifier.value", "date", "dateTime", "time", "instant", "integer", "decimal", "string", "code" ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension:whatshouldbedisplayedtohumanifdefaultisnotappropriate", "path": "Extension", "short": "What should be displayed to human (if default is not appropriate)", "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.", "comments": "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": 0, "max": "1", "base": { "path": "Extension", "min": 0, "max": "*" }, "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "children().count() > id.count()", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "Extension" } ] }, { "id": "Extension:whatshouldbedisplayedtohumanifdefaultisnotappropriate.id", "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Extension:whatshouldbedisplayedtohumanifdefaultisnotappropriate.extension:extension", "path": "Extension.extension", "sliceName": "extension", "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "Extension:whatshouldbedisplayedtohumanifdefaultisnotappropriate.url", "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comments": "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 SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/rendered-value", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Extension:whatshouldbedisplayedtohumanifdefaultisnotappropriate.valueString", "path": "Extension.valueString", "short": "Value of extension", "definition": "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": 1, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] }, "differential": { "element": [ { "id": "Extension:whatshouldbedisplayedtohumanifdefaultisnotappropriate", "path": "Extension", "short": "What should be displayed to human (if default is not appropriate)", "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.", "comments": "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": 0, "max": "1" }, { "id": "Extension:whatshouldbedisplayedtohumanifdefaultisnotappropriate.extension:extension", "path": "Extension.extension", "sliceName": "extension", "max": "0" }, { "id": "Extension:whatshouldbedisplayedtohumanifdefaultisnotappropriate.url", "path": "Extension.url", "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/rendered-value" }, { "id": "Extension:whatshouldbedisplayedtohumanifdefaultisnotappropriate.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "string" } ] } ] } }
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.