FHIR CI-Build

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

Extension: resource-instance-description

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

Summary

Defining URL:http://hl7.org/fhir/StructureDefinition/resource-instance-description
Version:5.0.0-cibuild
Name:resource-instance-description
Title:resource instance description
Modifier:This extension is not a modifier extension
Status:draft
Definition:A natural language description for non-conformance and non-terminology resource instances that is represented in the resource for publication use.
Committee:FHIR Infrastructure Work Group

Status: draft. Extension maintained by: HL7

A natural language description for non-conformance and non-terminology resource instances that is represented in the resource for publication use.

Comment:

This extension provide a mechanism to have a natural language description for non-conformance and non-terminology resource instances that is represented in the resource for publication use. This information is intended to populate the ImplementationGuide.definition.resource.description and ImplementationGuide.definition.resource.name.

Context of Use: Use on Element ID Resource

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. resource-instance-description0..1markdownURL = http://hl7.org/fhir/StructureDefinition/resource-instance-description
resource-instance-description: A natural language description for non-conformance and non-terminology resource instances that is represented in the resource for publication use.


Use on Element ID Resource

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/resource-instance-description
resource-instance-description: A natural language description for non-conformance and non-terminology resource instances that is represented in the resource for publication use.


Use on Element ID Resource
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/resource-instance-name"
... value[x] 1..1markdownValue of extension

doco Documentation for this format

XML Template

<!-- resource-instance-description -->doco

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

JSON Template

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

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. resource-instance-description0..1markdownURL = http://hl7.org/fhir/StructureDefinition/resource-instance-description
resource-instance-description: A natural language description for non-conformance and non-terminology resource instances that is represented in the resource for publication use.


Use on Element ID Resource

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/resource-instance-description
resource-instance-description: A natural language description for non-conformance and non-terminology resource instances that is represented in the resource for publication use.


Use on Element ID Resource
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/resource-instance-name"
... value[x] 1..1markdownValue of extension

doco Documentation for this format

XML Template

<!-- resource-instance-description -->doco

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

JSON Template

{ // resource-instance-description
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/resource-instance-name", // R! 
    "valueMarkdown" : "<markdown>" // I 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')]))
  • rid-1: Cannot be used where description already exists or description is of type string or markdown. (xpath: remove when tooling allows)
  • 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)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.