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

This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot: Release 5.3) based on FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 5.2.0. For a full list of available versions, see the Directory of published versions

Extension: CanonicalResource Short Description (Experimental)

Official URL: http://hl7.org/fhir/StructureDefinition/canonicalresource-short-description Version: 5.3.0-ballot
Standards status: Deprecated Maturity Level: 1 Computable Name: CRShortDescription
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1679

A single paragraph plain string short description alternative to CanonicalResource.description for display in lists etc.

This is an experimental extension definition; the definition is intended for testing purposes, education or evaluation, and the definition is not anticipated to be matured to a point where it is intended for genuine usage.

Context of Use

This extension is deprecated and should no longer be used

Replaced by DataType Short String

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

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • The resource metadata has changed (status)

    • 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 string: A single paragraph plain string short description alternative to CanonicalResource.description for display in lists etc.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Short description - single paragraph, plain string
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-short-description"
    ... value[x] 1..1 string Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Short description - single paragraph, plain string
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-short-description"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type string: A single paragraph plain string short description alternative to CanonicalResource.description for display in lists etc.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Short description - single paragraph, plain string
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-short-description"
    ... value[x] 1..1 string Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Short description - single paragraph, plain string
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-short-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()

    R4B

    The extension is represented a little differently in R4B:

    • Adjust the extension context CanonicalResource to Basic
    • Note: Extensions that have been modified for R4B are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0..* Extension Short description - single paragraph, plain string
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-short-description"
    . . . value[x] 1.. 1 string Value of extension

    doco Documentation for this format

    R4

    The extension is represented a little differently in R4:

    • Adjust the extension context CanonicalResource to Basic
    • Note: Extensions that have been modified for R4 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0..* Extension Short description - single paragraph, plain string
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-short-description"
    . . . value[x] 1.. 1 string Value of extension

    doco Documentation for this format

    R3

    The extension is represented a little differently in R3:

    • Adjust the extension context CanonicalResource to Basic
    • Note: Extensions that have been modified for R3 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0..* Extension Short description - single paragraph, plain string
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-short-description"
    . . . value[x] 1.. 1 string Value of extension

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)