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

This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot-tc1: 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: Artifact related artifact

Official URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact Version: 5.3.0-ballot-tc1
Standards status: Trial-use Maturity Level: 2 Responsible: HL7 International / Clinical Decision Support Computable Name: ArtifactRelatedArtifact
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1754

Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

This extension is defined to support representing artifact metadata on resources that are not already canonical resources that have the corresponding element, and that behave in a definitional way. For example, it would not be appropriate to use this extension on a patient-specific resource such as MedicationRequest or CarePlan. For resources where this element was added in R5, the cross-version extension should be used rather than this extension (CodeSystem,ConceptMap,NamingSystem,ValueSet).

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

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • The resource metadata has changed (purpose)
  • The data elements list has changed

    • 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 RelatedArtifact: Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Additional documentation, citations, etc.
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
    ... value[x] 1..1 RelatedArtifact Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Additional documentation, citations, etc.
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type RelatedArtifact: Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Additional documentation, citations, etc.
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
    ... value[x] 1..1 RelatedArtifact Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Additional documentation, citations, etc.
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"

    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 ConditionDefinition 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 Additional documentation, citations, etc.
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
    . . . value[x] 1.. 1 RelatedArtifact Value of extension

    doco Documentation for this format

    R4

    The extension is represented a little differently in R4:

    • Adjust the extension context ClinicalUseDefinition to Basic
    • Adjust the extension context ConditionDefinition to Basic
    • Adjust the extension context SubstanceDefinition to Basic
    • Adjust the extension context SubscriptionTopic 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 Additional documentation, citations, etc.
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
    . . . value[x] 1.. 1 RelatedArtifact Value of extension

    doco Documentation for this format

    R3

    The extension is represented a little differently in R3:

    • Adjust the extension context ClinicalUseDefinition to Basic
    • Adjust the extension context ConditionDefinition to Basic
    • Adjust the extension context DeviceDefinition to Basic
    • Adjust the extension context ExampleScenario to Basic
    • Adjust the extension context MedicationKnowledge to Basic
    • Adjust the extension context ObservationDefinition to Basic
    • Adjust the extension context SpecimenDefinition to Basic
    • Adjust the extension context SubstanceDefinition to Basic
    • Adjust the extension context SubscriptionTopic to Basic
    • Adjust the extension context TerminologyCapabilities to Basic
    • Replace the type RelatedArtifact with a set of extensions for the content of the type along with the _datatype extension
    • 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 Additional documentation, citations, etc.
    . . . Slices for extension 0 ..* Extension Extension
    Slice: Unordered, Open by value:url
    . . . . extension:_datatype 1..1 (Complex) DataType name 'RelatedArtifact' from R5
    URL: http://hl7.org/fhir/StructureDefinition/_datatype
    . . . . . value[x] 1.. 1 string Value of extension
    Fixed Value: RelatedArtifact
    . . . . extension:type 1..1 Extension documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "type"
    . . . . . value[x] 1.. 1 code Value of extension
    Binding: RelatedArtifactType ( required ) : The type of relationship to the related artifact.
    . . . . extension:classifier 0..* Extension Additional classifiers
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "classifier"
    . . . . . value[x] 1.. 1 CodeableConcept Value of extension
    Binding: CitationArtifactClassifier ( example ) : Additional classifiers for the related artifact.
    . . . . extension:label 0..1 Extension Short label
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "label"
    . . . . . value[x] 1.. 1 string Value of extension
    . . . . extension:display 0..1 Extension Brief description of the related artifact
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "display"
    . . . . . value[x] 1.. 1 string Value of extension
    . . . . extension:citation 0..1 Extension Bibliographic citation for the artifact
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "citation"
    . . . . . value[x] 1.. 1 markdown Value of extension
    . . . . extension:document 0..1 Extension What document is being referenced
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "document"
    . . . . . value[x] 1.. 1 Attachment Value of extension
    . . . . extension:resource 0..1 Extension What artifact is being referenced
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "resource"
    . . . . . value[x] 1.. 1 uri Value of extension
    . . . . extension:resourceReference 0..1 Extension What artifact, if not a conformance resource
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "resourceReference"
    . . . . . value[x] 1.. 1 Reference ( Resource ) Value of extension
    . . . . extension:publicationStatus 0..1 Extension draft | active | retired | unknown
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "publicationStatus"
    . . . . . value[x] 1.. 1 code Value of extension
    Binding: PublicationStatus ( required ) : Publication status of an artifact being referred to.
    . . . . extension:publicationDate 0..1 Extension Date of publication of the artifact being referred to
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "publicationDate"
    . . . . . value[x] 1.. 1 date Value of extension
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
    . . . value[x] 0 .. 0

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)