RelatedArtifact

• Datatypes
• Definitions
• Examples
• Mappings
• Profiles

Elements

• RelatedArtifact.type [1..1]: code The type of relationship to the related artifact
• RelatedArtifact.label [0..1]: string A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index
• RelatedArtifact.display [0..1]: string A brief description of the document or knowledge resource being referenced, suitable for display to a consumer
• RelatedArtifact.citation [0..1]: markdown 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
• RelatedArtifact.document [0..1]: Attachment Deprecated in favor of the new artifact[x] element. The document being referenced, represented as an attachment. This is exclusive with the resource element
• RelatedArtifact.resource [0..1]: canonical(Any) Deprecated in favor of the new artifact[x] element. The related artifact, such as a library, value set, profile, or other knowledge resource
• RelatedArtifact.resourceReference [0..1]: Reference(Any) 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.
• RelatedArtifact.artifact[x] [0..1]: markdown | Attachment | canonical(Any) | Reference(Any) The related artifact represented as a canonical or direct reference to a FHIR resource, an Attachment, or directly inline as markdown.

Bindings

• RelatedArtifact.type: RelatedArtifactType | strength: code list | reference: #related-artifact-type

Comments

• RelatedArtifact.type: 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.
• RelatedArtifact.citation: Additional structured information about citations should be captured as extensions
• RelatedArtifact.resource: 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
• RelatedArtifact.resourceReference: 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
• RelatedArtifact.artifact[x]: 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.