Extension: Resource instance description

FHIR Infrastructure Work Group

Maturity Level: 1

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/resource-instance-description`				Version: 5.0.0-snapshot3
draft as of 2022-05-14				Computable Name: ResourceInstanceDescription
Flags: Non-Modifier				OID: 2.16.840.1.113883.4.642.5.1431

Context of Use: Use on Element ID Resource

Definition

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.

Summary

Name	Flags	Card.	Type	Description & Constraints
ResourceInstanceDescription		0..1	markdown	URL = http://hl7.org/fhir/StructureDefinition/resource-instance-description ResourceInstanceDescription: 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
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/resource-instance-description ResourceInstanceDescription: 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..1	uri	"http://hl7.org/fhir/StructureDefinition/resource-instance-name"
value[x]	1..1	markdown	Value of extension
Documentation for this format

XML Template

<!-- ResourceInstanceDescription -->

<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

{ // ResourceInstanceDescription
  // 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

Name	Flags	Card.	Type	Description & Constraints
ResourceInstanceDescription		0..1	markdown	URL = http://hl7.org/fhir/StructureDefinition/resource-instance-description ResourceInstanceDescription: 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
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/resource-instance-description ResourceInstanceDescription: 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..1	uri	"http://hl7.org/fhir/StructureDefinition/resource-instance-name"
value[x]	1..1	markdown	Value of extension
Documentation for this format

XML Template

<!-- ResourceInstanceDescription -->

<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

{ // ResourceInstanceDescription
  // 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: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
rid-1: Cannot be used where description already exists or description is of type string or markdown. (xpath: %resource.description.exists().not() or ((%resource.description is string).not() and (%resource.description is markdown).not()))
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.