Extension: description

FHIR Infrastructure Work Group

Maturity Level: 1

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/artifact-description`				Version: 5.0.0-snapshot3
draft as of 2022-02-07				Computable Name: description
Flags: Non-Modifier				OID: TBD

Context of Use: Use on Element ID Element

Definition

A free text natural language description of the {{title}} from a consumer's perspective.

Comment:

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the {{title}} as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the {{title}} is presumed to be the predominant language in the place the {{title}} was created).

Summary

Name	Flags	Card.	Type	Description & Constraints
description		0..1	markdown	URL = http://hl7.org/fhir/StructureDefinition/artifact-description description: A free text natural language description of the {{title}} from a consumer's perspective. Use on Element ID Element
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/artifact-description description: A free text natural language description of the {{title}} from a consumer's perspective. Use on Element ID Element
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-description"
value[x]	1..1	markdown	Value of extension
Documentation for this format

XML Template

<!-- description -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/artifact-description" >
  <!-- from Element: extension -->
 <valueMarkdown value="[markdown]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
description		0..1	markdown	URL = http://hl7.org/fhir/StructureDefinition/artifact-description description: A free text natural language description of the {{title}} from a consumer's perspective. Use on Element ID Element
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/artifact-description description: A free text natural language description of the {{title}} from a consumer's perspective. Use on Element ID Element
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-description"
value[x]	1..1	markdown	Value of extension
Documentation for this format

XML Template

<!-- description -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/artifact-description" >
  <!-- from Element: extension -->
 <valueMarkdown value="[markdown]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

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

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.