RelatedArtifact
type: StructureDefinition
node role: treeRoot
id:
  v: RelatedArtifact
text:
  status:
    v: generated
  div:
    v: Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> <img src="[binary]" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> RelatedArtifact ΣN Element Related artifacts for a knowledge resource + Warning: Citation must be inline or a canonical reference to a Citation + Warning: Documentation must be an attachment + Warning: Justification must be an attachment or a reference to an ArtifactAssessment Elements defined in Ancestors: id, <a href="types.html#Element" title="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.">extension #xD; type Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of Binding: RelatedArtifactType (Required) #xD; label Σ 0..1 string Short label #xD; display Σ 0..1 string Brief description of the related artifact #xD; citation Σ 0..1 markdown Bibliographic citation for the artifact #xD; <img src="[binary]" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Data Type" class="hierarchy"/> document Σ 0..1 Attachment What document is being referenced #xD; <img src="[binary]" alt="." style="background-color: white; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> resource Σ 0..1 canonical(Any) What artifact is being referenced #xD; <img src="[binary]" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> resourceReference Σ 0..1 Reference(Any) What artifact, if not a conformance resource #xD; <img src="[bina…
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
    l: structuredefinition-wg
  value: Code
    v: fhir
url:
  v: http://hl7.org/fhir/StructureDefinition/RelatedArtifact
  l: RelatedArtifact
version:
  v: 6.0.0-ballot4
name:
  v: RelatedArtifact
status:
  v: active
experimental:
  v: false
date:
  v: 2026-04-10T12:14:02+00:00
publisher:
  v: HL7 International / FHIR Infrastructure
contact:
  telecom:
    system:
      v: url
    value:
      v: http://hl7.org/fhir
contact:
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/fiwg
description:
  v: RelatedArtifact Type: Related artifacts such as dependencies, components, additional documentation, justification, or bibliographic references.
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
      l: m49.htm
    code:
      v: 001
    display:
      v: World
purpose:
  v: Knowledge resources must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
fhir version:
  v: 6.0.0-ballot4
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: complex-type
abstract:
  v: false
type:
  v: RelatedArtifact
  l: RelatedArtifact
base definition:
  v: http://hl7.org/fhir/StructureDefinition/DataType
  l: DataType
derivation:
  v: specialization
snapshot:
  element:
    id:
      v: RelatedArtifact
    path:
      v: RelatedArtifact
    short:
      v: Related artifacts for a knowledge resource
    definition:
      v: Related artifacts such as dependencies, components, additional documentation, justification, or bibliographic references.
    comment:
      v: Each related artifact is either a reference to another knowledge resource, or represented directly inline as an Attachment or markdown.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: RelatedArtifact
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        l: Element
    constraint:
      key:
        v: rla-1
      severity:
        v: warning
      human:
        v: Citation must be inline or a canonical reference to a Citation
      expression:
        v: type = 'citation' implies ((citation.exists() xor resource.exists()) or (artifact is markdown or artifact is canonical))
      source:
        v: http://hl7.org/fhir/StructureDefinition/RelatedArtifact
        l: RelatedArtifact
    constraint:
      key:
        v: rla-2
      severity:
        v: warning
      human:
        v: Documentation must be an attachment
      expression:
        v: type = 'documentation' implies (document.exists() or artifact is Attachment)
      source:
        v: http://hl7.org/fhir/StructureDefinition/RelatedArtifact
        l: RelatedArtifact
    constraint:
      key:
        v: rla-3
      severity:
        v: warning
      human:
        v: Justification must be an attachment or a reference to an ArtifactAssessment
      expression:
        v: type = 'justification' implies ((document.exists() or resourceReference.exists()) or (artifact is Attachment or artifact is Reference))
      source:
        v: http://hl7.org/fhir/StructureDefinition/RelatedArtifact
        l: RelatedArtifact
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: RelatedArtifact.id
    path:
      v: RelatedArtifact.id
    representation:
      v: xmlAttr
    short:
      v: Unique id for inter-element referencing
    definition:
      v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Element.id
      min:
        v: 0
      max:
        v: 1
    type:
      extension:
        value: Url
      code:
        v: http://hl7.org/fhirpath/System.String
        l: System.String
    condition:
      v: ele-1
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: RelatedArtifact.extension

Url
v: string
l: string

v: RelatedArtifact.extension

discriminator:
  type:
    v: value
  path:
    v: url
description:
  v: Extensions are always sliced by (at least) url
rules:
  v: open

v: Additional content defined by implementations

v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

v: extensions

v: user content

v: 0

v: *

path:
  v: Element.extension
min:
  v: 0
max:
  v: *

code:
  v: Extension
  l: Extension

key:
  v: ele-1
severity:
  v: error
human:
  v: All FHIR elements must have a @value or children
expression:
  v: hasValue() or (children().count() > id.count())
source:
  v: http://hl7.org/fhir/StructureDefinition/Element
  l: Element

v: false

v: false

identity:
  v: rim
map:
  v: n/a

id:
  v: RelatedArtifact.type
path:
  v: RelatedArtifact.type
short:
  v: documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of
definition:
  v: The type of relationship to the related artifact.
comment:
  v: The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: RelatedArtifact.type
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/binding-definition
      l: binding-definition
    value: Markdown
      v: The type of relationship to the related artifact.
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: RelatedArtifactType
  strength:
    v: required
  description:
    v: The type of relationship to the related artifact.
  value set:
    v: http://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot4
    l: http://hl7.org/fhir/ValueSet/related-artifact-type

id:
  v: RelatedArtifact.label
path:
  v: RelatedArtifact.label
short:
  v: Short label
definition:
  v: A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedArtifact.label
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: RelatedArtifact.display
path:
  v: RelatedArtifact.display
short:
  v: Brief description of the related artifact
definition:
  v: A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedArtifact.display
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: RelatedArtifact.citation
path:
  v: RelatedArtifact.citation
short:
  v: Bibliographic citation for the artifact
definition:
  v: Deprecated in favor of the new artifact[x] element. A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
comment:
  v: Additional structured information about citations should be captured as extensions.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedArtifact.citation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: markdown
    l: markdown
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: RelatedArtifact.document
path:
  v: RelatedArtifact.document
short:
  v: What document is being referenced
definition:
  v: Deprecated in favor of the new artifact[x] element. The document being referenced, represented as an attachment. This is exclusive with the resource element.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedArtifact.document
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Attachment
    l: Attachment
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: RelatedArtifact.resource
path:
  v: RelatedArtifact.resource
short:
  v: What artifact is being referenced
definition:
  v: Deprecated in favor of the new artifact[x] element. The related artifact, such as a library, value set, profile, or other knowledge resource.
comment:
  v: If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedArtifact.resource
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: canonical
    l: canonical
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: RelatedArtifact.resourceReference
path:
  v: RelatedArtifact.resourceReference
short:
  v: What artifact, if not a conformance resource
definition:
  v: Deprecated in favor of the new artifact[x] element. The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.
comment:
  v: If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedArtifact.resourceReference
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: RelatedArtifact.artifact[x]
path:
  v: RelatedArtifact.artifact[x]
short:
  v: What document, citation, artifact, or resource is being referenced
definition:
  v: The related artifact represented as a canonical or direct reference to a FHIR resource, an Attachment, or directly inline as markdown.
comment:
  v: For artifacts represented as FHIR resources, a canonical or Reference to the FHIR Resource. If the target is a CanonicalResource, this SHOULD be a canonical reference. For documentation and justification, what document is being referenced, represented as an Attachment. For citations, either a bibliographic citation for the related artifact represented as markdown, or a reference to a Citation resource. The text SHOULD be formatted according to an accepted citation format.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedArtifact.artifact[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: markdown
    l: markdown
type:
  code:
    v: Attachment
    l: Attachment
type:
  code:
    v: canonical
    l: canonical
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true

element:
  id:
    v: RelatedArtifact
  path:
    v: RelatedArtifact
  short:
    v: Related artifacts for a knowledge resource
  definition:
    v: Related artifacts such as dependencies, components, additional documentation, justification, or bibliographic references.
  comment:
    v: Each related artifact is either a reference to another knowledge resource, or represented directly inline as an Attachment or markdown.
  min:
    v: 0
  max:
    v: *
  constraint:
    key:
      v: rla-1
    severity:
      v: warning
    human:
      v: Citation must be inline or a canonical reference to a Citation
    expression:
      v: type = 'citation' implies ((citation.exists() xor resource.exists()) or (artifact is markdown or artifact is canonical))
    source:
      v: http://hl7.org/fhir/StructureDefinition/RelatedArtifact
      l: RelatedArtifact
  constraint:
    key:
      v: rla-3
    severity:
      v: warning
    human:
      v: Justification must be an attachment or a reference to an ArtifactAssessment
    expression:
      v: type = 'justification' implies ((document.exists() or resourceReference.exists()) or (artifact is Attachment or artifact is Reference))
    source:
      v: http://hl7.org/fhir/StructureDefinition/RelatedArtifact
      l: RelatedArtifact
  constraint:
    key:
      v: rla-2
    severity:
      v: warning
    human:
      v: Documentation must be an attachment
    expression:
      v: type = 'documentation' implies (document.exists() or artifact is Attachment)
    source:
      v: http://hl7.org/fhir/StructureDefinition/RelatedArtifact
      l: RelatedArtifact
element:
  id:
    v: RelatedArtifact.type
  path:
    v: RelatedArtifact.type
  short:
    v: documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of
  definition:
    v: The type of relationship to the related artifact.
  comment:
    v: The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: code
      l: code
  is summary:
    v: true
  binding:
    extension:
      url:
        v: http://hl7.org/fhir/tools/StructureDefinition/binding-definition
        l: binding-definition
      value: Markdown
        v: The type of relationship to the related artifact.
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
        l: elementdefinition-bindingName
      value: String
        v: RelatedArtifactType
    strength:
      v: required
    description:
      v: The type of relationship to the related artifact.
    value set:
      v: http://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot4
      l: http://hl7.org/fhir/ValueSet/related-artifact-type
element:
  id:
    v: RelatedArtifact.label
  path:
    v: RelatedArtifact.label
  short:
    v: Short label
  definition:
    v: A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
  is summary:
    v: true
element:
  id:
    v: RelatedArtifact.display
  path:
    v: RelatedArtifact.display
  short:
    v: Brief description of the related artifact
  definition:
    v: A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
  is summary:
    v: true
element:
  id:
    v: RelatedArtifact.citation
  path:
    v: RelatedArtifact.citation
  short:
    v: Bibliographic citation for the artifact
  definition:
    v: Deprecated in favor of the new artifact[x] element. A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
  comment:
    v: Additional structured information about citations should be captured as extensions.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: markdown
      l: markdown
  is summary:
    v: true
element:
  id:
    v: RelatedArtifact.document
  path:
    v: RelatedArtifact.document
  short:
    v: What document is being referenced
  definition:
    v: Deprecated in favor of the new artifact[x] element. The document being referenced, represented as an attachment. This is exclusive with the resource element.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Attachment
      l: Attachment
  is summary:
    v: true
element:
  id:
    v: RelatedArtifact.resource
  path:
    v: RelatedArtifact.resource
  short:
    v: What artifact is being referenced
  definition:
    v: Deprecated in favor of the new artifact[x] element. The related artifact, such as a library, value set, profile, or other knowledge resource.
  comment:
    v: If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: canonical
      l: canonical
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/Resource
      l: Resource
  is summary:
    v: true
element:
  id:
    v: RelatedArtifact.resourceReference
  path:
    v: RelatedArtifact.resourceReference
  short:
    v: What artifact, if not a conformance resource

v: Deprecated in favor of the new artifact[x] element. The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

v: If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.

v: 0

v: 1

code:
  v: Reference
  l: Reference
target profile:
  v: http://hl7.org/fhir/StructureDefinition/Resource
  l: Resource

v: true

id:
  v: RelatedArtifact.artifact[x]
path:
  v: RelatedArtifact.artifact[x]
short:
  v: What document, citation, artifact, or resource is being referenced
definition:
  v: The related artifact represented as a canonical or direct reference to a FHIR resource, an Attachment, or directly inline as markdown.
comment:
  v: For artifacts represented as FHIR resources, a canonical or Reference to the FHIR Resource. If the target is a CanonicalResource, this SHOULD be a canonical reference. For documentation and justification, what document is being referenced, represented as an Attachment. For citations, either a bibliographic citation for the related artifact represented as markdown, or a reference to a Citation resource. The text SHOULD be formatted according to an accepted citation format.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: markdown
    l: markdown
type:
  code:
    v: Attachment
    l: Attachment
type:
  code:
    v: canonical
    l: canonical
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
is summary:
  v: true