FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) 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.2.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: Related artifact

Official URL: http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: RelatedArtifact
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1516

Documents the 'knowledge artifacts' relevant to the base resource such as citations, supporting evidence, documentation of processes, caveats around testing methodology.

Context of Use

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

Usage info

Usage:

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

Changes since version 1.0.0:

  • No changes
  • 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 of type RelatedArtifact: Documents the 'knowledge artifacts' relevant to the base resource such as citations, supporting evidence, documentation of processes, caveats around testing methodology.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Documentation relevant to the 'parent' resource
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact"
    ... value[x] 1..1 RelatedArtifact Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Documentation relevant to the 'parent' resource
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type RelatedArtifact: Documents the 'knowledge artifacts' relevant to the base resource such as citations, supporting evidence, documentation of processes, caveats around testing methodology.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Documentation relevant to the 'parent' resource
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact"
    ... value[x] 1..1 RelatedArtifact Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Documentation relevant to the 'parent' resource
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-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 unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is represented a little differently in R3:

    • 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 doco
    . . Extension 0..* Extension Documentation relevant to the 'parent' resource
    . . . 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/workflow-relatedArtifact"
    . . . value[x] 0 .. 0

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)