FHIR Extensions Pack
5.1.0 - 5.1.0 (April 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0: Release 5.1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: Resource instance description

Official URL: http://hl7.org/fhir/StructureDefinition/resource-instance-description Version: 5.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: ResourceInstanceDescription
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1431

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

Context of Use

This extension may be used on the following element(s):

  • Element ID Resource

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension of type markdown: A natural language description for non-conformance and non-terminology resource instances that is represented in the resource for publication use.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension C 0..1 Extension Pertains to goal
    rid-1: Cannot be used where description already exists or description is of type string or markdown.
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/resource-instance-description"
    ... value[x] 1..1 markdown Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension C 0..1 Extension Pertains to goal
    rid-1: Cannot be used where description already exists or description is of type string or markdown.
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/resource-instance-description"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type markdown: A natural language description for non-conformance and non-terminology resource instances that is represented in the resource for publication use.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension C 0..1 Extension Pertains to goal
    rid-1: Cannot be used where description already exists or description is of type string or markdown.
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/resource-instance-description"
    ... value[x] 1..1 markdown Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension C 0..1 Extension Pertains to goal
    rid-1: Cannot be used where description already exists or description is of type string or markdown.
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/resource-instance-description"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    rid-1errorExtensionCannot be used where description already exists or description is of type string or markdown.
    : %resource.description.exists().not() or ((%resource.description is string).not() and (%resource.description is markdown).not())

    Search Parameters for this Extension

    (none found)