Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Extension: description

FHIR Infrastructure Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/artifact-description

Status: draft. Extension maintained by: Health Level Seven, Inc. - CDS WG

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 why the {{title}} was built, 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).

Context of Use: Use on Element ID Element

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. description0..1markdownURL = 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

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = 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
... Slices for extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/artifact-description"
... value[x] 1..1markdownValue of extension

doco Documentation for this format

XML Template

<!-- description -->doco

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

JSON Template

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

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. description0..1markdownURL = 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

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = 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
... Slices for extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/artifact-description"
... value[x] 1..1markdownValue of extension

doco Documentation for this format

XML Template

<!-- description -->doco

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

JSON Template

{ // description
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/artifact-description", // R! 
    "valueMarkdown" : "<markdown>" // 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)