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
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
Rendered Value
{ "resourceType" : "StructureDefinition", "id" : "rendered-value", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "fhir" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger" : 1 }], "url" : "http://hl7.org/fhir/StructureDefinition/rendered-value", "version" : "4.2.0", "name" : "Rendered Value", "title" : "Rendered Value", "status" : "draft", "date" : "2013-12-05", "publisher" : "Health Level Seven International (FHIR Infrastructure)", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "http://www.hl7.org/Special/committees/fiwg" }] }], "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" : "4.2.0", "mapping" : [{ "identity" : "rim", "uri" : "http://hl7.org/v3", "name" : "RIM Mapping" }], "kind" : "complex-type", "abstract" : false, "context" : [{ "type" : "element", "expression" : "Identifier.value" }, { "type" : "element", "expression" : "date" }, { "type" : "element", "expression" : "dateTime" }, { "type" : "element", "expression" : "time" }, { "type" : "element", "expression" : "instant" }, { "type" : "element", "expression" : "integer" }, { "type" : "element", "expression" : "decimal" }, { "type" : "element", "expression" : "string" }, { "type" : "element", "expression" : "code" }, { "type" : "element", "expression" : "canonical" }], "type" : "Extension", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension", "derivation" : "constraint", "snapshot" : { "element" : [{ "id" : "Extension", "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.", "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.).", "min" : 0, "max" : "1", "base" : { "path" : "Extension", "min" : 0, "max" : "*" }, "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (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" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false }, { "id" : "Extension.id", "path" : "Extension.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "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" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Extension.extension", "path" : "Extension.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Extension", "definition" : "An Extension", "min" : 0, "max" : "0", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (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" }], "isModifier" : false, "isSummary" : false }, { "id" : "Extension.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.", "comment" : "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" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "uri" }], "code" : "http://hl7.org/fhirpath/System.String" }], "fixedUri" : "http://hl7.org/fhir/StructureDefinition/rendered-value", "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Extension.value[x]", "path" : "Extension.value[x]", "short" : "Value of extension", "definition" : "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "min" : 1, "max" : "1", "base" : { "path" : "Extension.value[x]", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }] }, "differential" : { "element" : [{ "id" : "Extension", "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.", "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.).", "min" : 0, "max" : "1" }, { "id" : "Extension.extension", "path" : "Extension.extension", "max" : "0" }, { "id" : "Extension.url", "path" : "Extension.url", "fixedUri" : "http://hl7.org/fhir/StructureDefinition/rendered-value" }, { "id" : "Extension.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.