FHIR Extensions Pack
5.3.0-ballot - (September 2025 Ballot) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.3.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Resource instance description

Official URL: http://hl7.org/fhir/StructureDefinition/resource-instance-description Version: 5.3.0-ballot
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. Note that this extension only used as part of the IG publication tooling process. Use the Artifact Title extension extension for use outside the IG publishing framework.

Context of Use

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

Usage info

Usages:

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

Changes since version 5.2.0:

  • The resource metadata has changed (description)

    • 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 with the type markdown: A natural language description for non-conformance and non-terminology resource instances that is represented in the resource for publication use. Note that this extension only used as part of the IG publication tooling process. Use the Artifact Title extension extension for use outside the IG publishing framework.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension C 0..1 Extension Pertains to goal
    Constraints: rid-1
    ... 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 & Constraints    Filter: Filtersdoco
    .. Extension C 0..1 Extension Pertains to goal
    Constraints: rid-1
    ... 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 with the type markdown: A natural language description for non-conformance and non-terminology resource instances that is represented in the resource for publication use. Note that this extension only used as part of the IG publication tooling process. Use the Artifact Title extension extension for use outside the IG publishing framework.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension C 0..1 Extension Pertains to goal
    Constraints: rid-1
    ... 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 & Constraints    Filter: Filtersdoco
    .. Extension C 0..1 Extension Pertains to goal
    Constraints: rid-1
    ... 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())

    R4B

    The extension is unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is unchanged in R3

    Search Parameters for this Extension

    (none found)