java.lang.Object

java.lang.Enum<RelatedArtifact.RelatedArtifactType>

org.hl7.fhir.r5.model.RelatedArtifact.RelatedArtifactType

All Implemented Interfaces:: Serializable, Comparable<RelatedArtifact.RelatedArtifactType>

Enclosing class:: RelatedArtifact

public static enum RelatedArtifact.RelatedArtifactType extends Enum<RelatedArtifact.RelatedArtifactType>

Enum Constant Summary

Enum Constants

Enum Constant

Description

AMENDEDWITH

This artifact is amended with or changed by the target artifact.

AMENDS

This artifact amends or changes the target artifact.

APPENDEDWITH

This artifact has additional information in the target artifact.

APPENDS

This artifact adds additional information to the target artifact.

CITATION

Bibliographic citation for papers, references, or other relevant material for the knowledge resource.

CITEAS

The related artifact is the citation for this artifact.

CITEDBY

This artifact is cited by the target artifact.

CITES

This artifact cites the target artifact.

COMMENTIN

This artifact has comments about it in the target artifact.

COMMENTSON

This artifact contains comments about the target artifact.

COMPOSEDOF

This artifact is composed of the target artifact.

CONTAINEDIN

This artifact is contained in the target artifact.

CONTAINS

This artifact is a container in which the target artifact is contained.

CORRECTIONIN

This artifact has corrections to it in the target artifact.

CORRECTS

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

CREATEDWITH

This artifact was created with the target artifact.

DEPENDSON

This artifact depends on the target artifact.

DERIVEDFROM

This artifact is derived from the target artifact.

DOCUMENTATION

Additional documentation for the knowledge resource.

DOCUMENTS

This artifact provides additional documentation for the target artifact.

JUSTIFICATION

The target artifact is a summary of the justification for the knowledge resource including supporting evidence, relevant guidelines, or other clinically important information.

NULL

added to help the parsers with the generic types

PARTOF

This artifact is a part of the target artifact.

PREDECESSOR

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

REPLACEDWITH

This artifact is replaced with or superseded by the target artifact.

REPLACES

This artifact replaces or supersedes the target artifact.

RETRACTEDBY

This artifact is retracted by the target artifact.

RETRACTS

This artifact retracts the target artifact.

SIGNS

This artifact is a signature of the target artifact.

SIMILARTO

This artifact has characteristics in common with the target artifact.

SPECIFICATIONOF

The target artifact is a precise description of a concept in this artifact.

SUCCESSOR

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

SUPPORTEDWITH

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.

SUPPORTS

This artifact provides additional support for the target artifact.

TRANSFORMEDINTO

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

TRANSFORMEDWITH

This artifact was generated by transforming a related artifact (e.g., format or language conversion), noted separately with the ?transforms? relationship type.

TRANSFORMS

This artifact was generated by transforming the target artifact (e.g., format or language conversion).
Method Summary

Modifier and Type

Method

Description

static RelatedArtifact.RelatedArtifactType

fromCode(String codeString)

String

getDefinition()

String

getDisplay()

String

getSystem()

String

toCode()

static RelatedArtifact.RelatedArtifactType

valueOf(String name)

Returns the enum constant of this type with the specified name.

static RelatedArtifact.RelatedArtifactType[]

values()

Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details
- DOCUMENTATION
  
  public static final RelatedArtifact.RelatedArtifactType DOCUMENTATION
  
  Additional documentation for the knowledge resource. This would include additional instructions on usage as well as additional information on clinical context or appropriateness.
- JUSTIFICATION
  
  public static final RelatedArtifact.RelatedArtifactType JUSTIFICATION
  
  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.
- CITATION
  
  public static final RelatedArtifact.RelatedArtifactType CITATION
  
  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.
- PREDECESSOR
  
  public static final RelatedArtifact.RelatedArtifactType PREDECESSOR
  
  The previous version of the knowledge artifact, used to establish an ordering of versions of an artifact, independent of the status of each version.
- SUCCESSOR
  
  public static final RelatedArtifact.RelatedArtifactType SUCCESSOR
  
  The subsequent version of the knowledge artfact, used to establish an ordering of versions of an artifact, independent of the status of each version.
- DERIVEDFROM
  
  public static final RelatedArtifact.RelatedArtifactType DERIVEDFROM
  
  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.
- DEPENDSON
  
  public static final RelatedArtifact.RelatedArtifactType DEPENDSON
  
  This artifact depends on the target artifact. There is a requirement to use the target artifact in the creation or interpretation of this artifact.
- COMPOSEDOF
  
  public static final RelatedArtifact.RelatedArtifactType COMPOSEDOF
  
  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.).
- PARTOF
  
  public static final RelatedArtifact.RelatedArtifactType PARTOF
  
  This artifact is a part of the target artifact. The target artifact is composed of this artifact (and possibly other artifacts).
- AMENDS
  
  public static final RelatedArtifact.RelatedArtifactType AMENDS
  
  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.
- AMENDEDWITH
  
  public static final RelatedArtifact.RelatedArtifactType AMENDEDWITH
  
  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.
- APPENDS
  
  public static final RelatedArtifact.RelatedArtifactType APPENDS
  
  This artifact adds additional information to the target artifact. The additional information does not replace or change information in the target artifact.
- APPENDEDWITH
  
  public static final RelatedArtifact.RelatedArtifactType APPENDEDWITH
  
  This artifact has additional information in the target artifact.
- CITES
  
  public static final RelatedArtifact.RelatedArtifactType CITES
  
  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.
- CITEDBY
  
  public static final RelatedArtifact.RelatedArtifactType CITEDBY
  
  This artifact is cited by the target artifact.
- COMMENTSON
  
  public static final RelatedArtifact.RelatedArtifactType COMMENTSON
  
  This artifact contains comments about the target artifact.
- COMMENTIN
  
  public static final RelatedArtifact.RelatedArtifactType COMMENTIN
  
  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.
- CONTAINS
  
  public static final RelatedArtifact.RelatedArtifactType CONTAINS
  
  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.).
- CONTAINEDIN
  
  public static final RelatedArtifact.RelatedArtifactType CONTAINEDIN
  
  This artifact is contained in the target artifact. The target artifact is a data structure whose instances are collections of other objects.
- CORRECTS
  
  public static final RelatedArtifact.RelatedArtifactType CORRECTS
  
  This artifact identifies errors and replacement content for the target artifact.
- CORRECTIONIN
  
  public static final RelatedArtifact.RelatedArtifactType CORRECTIONIN
  
  This artifact has corrections to it in the target artifact. The target artifact identifies errors and replacement content for this artifact.
- REPLACES
  
  public static final RelatedArtifact.RelatedArtifactType REPLACES
  
  This artifact replaces or supersedes the target artifact. The target artifact may be considered deprecated.
- REPLACEDWITH
  
  public static final RelatedArtifact.RelatedArtifactType REPLACEDWITH
  
  This artifact is replaced with or superseded by the target artifact. This artifact may be considered deprecated.
- RETRACTS
  
  public static final RelatedArtifact.RelatedArtifactType RETRACTS
  
  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.
- RETRACTEDBY
  
  public static final RelatedArtifact.RelatedArtifactType RETRACTEDBY
  
  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.
- SIGNS
  
  public static final RelatedArtifact.RelatedArtifactType SIGNS
  
  This artifact is a signature of the target artifact.
- SIMILARTO
  
  public static final RelatedArtifact.RelatedArtifactType SIMILARTO
  
  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?.
- SUPPORTS
  
  public static final RelatedArtifact.RelatedArtifactType SUPPORTS
  
  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.
- SUPPORTEDWITH
  
  public static final RelatedArtifact.RelatedArtifactType SUPPORTEDWITH
  
  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.
- TRANSFORMS
  
  public static final RelatedArtifact.RelatedArtifactType TRANSFORMS
  
  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.
- TRANSFORMEDINTO
  
  public static final RelatedArtifact.RelatedArtifactType TRANSFORMEDINTO
  
  This artifact was transformed into the target artifact (e.g., by format or language conversion).
- TRANSFORMEDWITH
  
  public static final RelatedArtifact.RelatedArtifactType TRANSFORMEDWITH
  
  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.
- DOCUMENTS
  
  public static final RelatedArtifact.RelatedArtifactType DOCUMENTS
  
  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.
- SPECIFICATIONOF
  
  public static final RelatedArtifact.RelatedArtifactType SPECIFICATIONOF
  
  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.
- CREATEDWITH
  
  public static final RelatedArtifact.RelatedArtifactType CREATEDWITH
  
  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.
- CITEAS
  
  public static final RelatedArtifact.RelatedArtifactType CITEAS
  
  The related artifact is the citation for this artifact.
- NULL
  
  public static final RelatedArtifact.RelatedArtifactType NULL
  
  added to help the parsers with the generic types
Method Details
- values
  
  public static RelatedArtifact.RelatedArtifactType[] values()
  
  Returns an array containing the constants of this enum type, in the order they are declared.
  
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
  
  public static RelatedArtifact.RelatedArtifactType valueOf(String name)
  
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
  
  Parameters:
  
  name - the name of the enum constant to be returned.
  
  Returns:
  
  the enum constant with the specified name
  
  Throws:
  
  IllegalArgumentException - if this enum type has no constant with the specified name
  
  NullPointerException - if the argument is null
- fromCode
  
  public static RelatedArtifact.RelatedArtifactType fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- toCode
  
  public String toCode()
- getSystem
  
  public String getSystem()
- getDefinition
  
  public String getDefinition()
- getDisplay
  
  public String getDisplay()

Enum RelatedArtifact.RelatedArtifactType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Details

DOCUMENTATION

JUSTIFICATION

CITATION

PREDECESSOR

SUCCESSOR

DERIVEDFROM

DEPENDSON

COMPOSEDOF

PARTOF

AMENDS

AMENDEDWITH

APPENDS

APPENDEDWITH

CITES

CITEDBY

COMMENTSON

COMMENTIN

CONTAINS

CONTAINEDIN

CORRECTS

CORRECTIONIN

REPLACES

REPLACEDWITH

RETRACTS

RETRACTEDBY

SIGNS

SIMILARTO

SUPPORTS

SUPPORTEDWITH

TRANSFORMS

TRANSFORMEDINTO

TRANSFORMEDWITH

DOCUMENTS

SPECIFICATIONOF

CREATEDWITH

CITEAS

NULL

Method Details

values

valueOf

fromCode

toCode

getSystem

getDefinition

getDisplay