Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

4.4.1.759 ValueSet http://hl7.org/fhir/ValueSet/related-artifact-type

FHIR Infrastructure Work Group Maturity Level: 5Trial Use Use Context: Any

This is a value set defined by the FHIR project.

Summary

Defining URL:http://hl7.org/fhir/ValueSet/related-artifact-type
Version:5.0.0-ballot
Name:RelatedArtifactType
Title:RelatedArtifactType
Status:draft
Definition:

The type of relationship to the related artifact.

Committee:FHIR Infrastructure Work Group
OID:2.16.840.1.113883.4.642.3.99 (for OID based terminology systems)
Flags:Immutable

This value set is used in the following places:


 

This expansion generated 07 Sep 2022


This value set contains 36 concepts

Expansion based on RelatedArtifactType v5.0.0-ballot (CodeSystem)

CodeSystemDisplayDefinition
  documentationhttp://hl7.org/fhir/related-artifact-typeDocumentation

Additional documentation for the knowledge resource. This would include additional instructions on usage as well as additional information on clinical context or appropriateness.

  justificationhttp://hl7.org/fhir/related-artifact-typeJustification

The target artifact is a summary of the justification for the knowledge resource including supporting evidence, relevant guidelines, or other clinically important information. This information is intended to provide a way to make the justification for the knowledge resource available to the consumer of interventions or results produced by the knowledge resource.

  citationhttp://hl7.org/fhir/related-artifact-typeCitation

Bibliographic citation for papers, references, or other relevant material for the knowledge resource. This is intended to allow for citation of related material, but that was not necessarily specifically prepared in connection with this knowledge resource.

  predecessorhttp://hl7.org/fhir/related-artifact-typePredecessor

The previous version of the knowledge artifact, used to establish an ordering of versions of an artifact, independent of the status of each version.

  successorhttp://hl7.org/fhir/related-artifact-typeSuccessor

The subsequent version of the knowledge artfact, used to establish an ordering of versions of an artifact, independent of the status of each version.

  derived-fromhttp://hl7.org/fhir/related-artifact-typeDerived From

This artifact is derived from the target artifact. This is intended to capture the relationship in which a particular knowledge resource is based on the content of another artifact, but is modified to capture either a different set of overall requirements, or a more specific set of requirements such as those involved in a particular institution or clinical setting. The artifact may be derived from one or more target artifacts.

  depends-onhttp://hl7.org/fhir/related-artifact-typeDepends On

This artifact depends on the target artifact. There is a requirement to use the target artifact in the creation or interpretation of this artifact.

  composed-ofhttp://hl7.org/fhir/related-artifact-typeComposed Of

This artifact is composed of the target artifact. This artifact is constructed with the target artifact as a component. The target artifact is a part of this artifact. (A dataset is composed of data.).

  part-ofhttp://hl7.org/fhir/related-artifact-typePart Of

This artifact is a part of the target artifact. The target artifact is composed of this artifact (and possibly other artifacts).

  amendshttp://hl7.org/fhir/related-artifact-typeAmends

This artifact amends or changes the target artifact. This artifact adds additional information that is functionally expected to replace information in the target artifact. This artifact replaces a part but not all of the target artifact.

  amended-withhttp://hl7.org/fhir/related-artifact-typeAmended With

This artifact is amended with or changed by the target artifact. There is information in this artifact that should be functionally replaced with information in the target artifact.

  appendshttp://hl7.org/fhir/related-artifact-typeAppends

This artifact adds additional information to the target artifact. The additional information does not replace or change information in the target artifact.

  appended-withhttp://hl7.org/fhir/related-artifact-typeAppended With

This artifact has additional information in the target artifact.

  citeshttp://hl7.org/fhir/related-artifact-typeCites

This artifact cites the target artifact. This may be a bibliographic citation for papers, references, or other relevant material for the knowledge resource. This is intended to allow for citation of related material, but that was not necessarily specifically prepared in connection with this knowledge resource.

  cited-byhttp://hl7.org/fhir/related-artifact-typeCited By

This artifact is cited by the target artifact.

  comments-onhttp://hl7.org/fhir/related-artifact-typeIs Comment On

This artifact contains comments about the target artifact.

  comment-inhttp://hl7.org/fhir/related-artifact-typeHas Comment In

This artifact has comments about it in the target artifact. The type of comments may be expressed in the targetClassifier element such as reply, review, editorial, feedback, solicited, unsolicited, structured, unstructured.

  containshttp://hl7.org/fhir/related-artifact-typeContains

This artifact is a container in which the target artifact is contained. A container is a data structure whose instances are collections of other objects. (A database contains the dataset.).

  contained-inhttp://hl7.org/fhir/related-artifact-typeContained In

This artifact is contained in the target artifact. The target artifact is a data structure whose instances are collections of other objects.

  correctshttp://hl7.org/fhir/related-artifact-typeCorrects

This artifact identifies errors and replacement content for the target artifact.

  correction-inhttp://hl7.org/fhir/related-artifact-typeCorrection In

This artifact has corrections to it in the target artifact. The target artifact identifies errors and replacement content for this artifact.

  replaceshttp://hl7.org/fhir/related-artifact-typeReplaces

This artifact replaces or supersedes the target artifact. The target artifact may be considered deprecated.

  replaced-withhttp://hl7.org/fhir/related-artifact-typeReplaced With

This artifact is replaced with or superseded by the target artifact. This artifact may be considered deprecated.

  retractshttp://hl7.org/fhir/related-artifact-typeRetracts

This artifact retracts the target artifact. The content that was published in the target artifact should be considered removed from publication and should no longer be considered part of the public record.

  retracted-byhttp://hl7.org/fhir/related-artifact-typeRetracted By

This artifact is retracted by the target artifact. The content that was published in this artifact should be considered removed from publication and should no longer be considered part of the public record.

  signshttp://hl7.org/fhir/related-artifact-typeSigns

This artifact is a signature of the target artifact.

  similar-tohttp://hl7.org/fhir/related-artifact-typeSimilar To

This artifact has characteristics in common with the target artifact. This relationship may be used in systems to “deduplicate” knowledge artifacts from different sources, or in systems to show “similar items”.

  supportshttp://hl7.org/fhir/related-artifact-typeSupports

This artifact provides additional support for the target artifact. The type of support is not documentation as it does not describe, explain, or instruct regarding the target artifact.

  supported-withhttp://hl7.org/fhir/related-artifact-typeSupported With

The target artifact contains additional information related to the knowledge artifact but is not documentation as the additional information does not describe, explain, or instruct regarding the knowledge artifact content or application. This could include an associated dataset.

  transformshttp://hl7.org/fhir/related-artifact-typeTransforms

This artifact was generated by transforming the target artifact (e.g., format or language conversion). This is intended to capture the relationship in which a particular knowledge resource is based on the content of another artifact, but changes are only apparent in form and there is only one target artifact with the “transforms” relationship type.

  transformed-intohttp://hl7.org/fhir/related-artifact-typeTransformed Into

This artifact was transformed into the target artifact (e.g., by format or language conversion).

  transformed-withhttp://hl7.org/fhir/related-artifact-typeTransformed With

This artifact was generated by transforming a related artifact (e.g., format or language conversion), noted separately with the “transforms” relationship type. This transformation used the target artifact to inform the transformation. The target artifact may be a conversion script or translation guide.

  documentshttp://hl7.org/fhir/related-artifact-typeDocuments

This artifact provides additional documentation for the target artifact. This could include additional instructions on usage as well as additional information on clinical context or appropriateness.

  specification-ofhttp://hl7.org/fhir/related-artifact-typeSpecification Of

The target artifact is a precise description of a concept in this artifact. This may be used when the RelatedArtifact datatype is used in elements contained in this artifact.

  created-withhttp://hl7.org/fhir/related-artifact-typeCreated With

This artifact was created with the target artifact. The target artifact is a tool or support material used in the creation of the artifact, and not content that the artifact was derived from.

  cite-ashttp://hl7.org/fhir/related-artifact-typeCite As

The related artifact is the citation for this artifact.

 

See the full registry of value sets defined as part of FHIR.


Explanation of the columns that may appear on this page:

LvlA few code lists that FHIR defines are hierarchical - each code is assigned a level. For value sets, levels are mostly used to organize codes for user convenience, but may follow code system hierarchy - see Code System for further information
SourceThe source of the definition of the code (when the value set draws in codes defined elsewhere)
CodeThe code (used as the code in the resource instance). If the code is in italics, this indicates that the code is not selectable ('Abstract')
DisplayThe display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application
DefinitionAn explanation of the meaning of the concept
CommentsAdditional notes about how to use the code