FHIR Extensions Pack
5.3.0-ballot-tc1 - (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-tc1 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: Artifact Canonical Reference

Official URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference Version: 5.3.0-ballot-tc1
Standards status: Deprecated Maturity Level: 1 Responsible: HL7 International / Clinical Decision Support Computable Name: ArtifactCanonicalReference
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1692

DEPRECATED: A reference to a canonical resource.

NOTE: This extension has been deprecated because it is too general. If needed, extensions should be created that are more specific to the particular use case being addressed.

To allow resources to define a reference to a canonical resource.

Context of Use

This extension is deprecated and should no longer be used

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, description, purpose)

    • 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 canonical: DEPRECATED: A reference to a canonical resource.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension The artifact
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference"
    ... value[x] 1..1 canonical() Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension The artifact
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type canonical: DEPRECATED: A reference to a canonical resource.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension The artifact
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference"
    ... value[x] 1..1 canonical() Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension The artifact
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference"

    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 unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is represented a little differently in R3:

    • Map the type canonical to uri on the element Extension.value[x]
    • 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..1 Extension The artifact
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference"
    . . . value[x] 1.. 1 uri Value of extension

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)