Name Flags Card. Type Description & Constraints 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; document Σ 0..1 Attachment What document is being referenced #xD; resource Σ 0..1 canonical(Any) What artifact is being referenced #xD; resourceReference Σ 0..1 Reference(Any) What artifact, if not a conformance resource #xD; artifact[x] Σ 0..1 What document, citation, artifact, or resource is being referenced #xD; artifactMarkdown markdown #xD; artifactAttachment Attachment #xD; artifactCanonical canonical(Any) #xD; artifactReference Reference(Any) #xD; Documentation for this format
RelatedArtifact Type: Related artifacts such as dependencies, components, additional documentation, justification, or bibliographic references.
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.
Related artifacts for a knowledge resource
Related artifacts such as dependencies, components, additional documentation, justification, or bibliographic references.
Each related artifact is either a reference to another knowledge resource, or represented directly inline as an Attachment or markdown.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Citation must be inline or a canonical reference to a Citation
type = 'citation' implies ((citation.exists() xor resource.exists()) or (artifact is markdown or artifact is canonical))
type = 'documentation' implies (document.exists() or artifact is Attachment)
Justification must be an attachment or a reference to an ArtifactAssessment
type = 'justification' implies ((document.exists() or resourceReference.exists()) or (artifact is Attachment or artifact is Reference))
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
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.
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.
documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of
The type of relationship to the related artifact.
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.
A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
Brief description of the related artifact
A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
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.
Additional structured information about citations should be captured as extensions.
Deprecated in favor of the new artifact[x] element. The document being referenced, represented as an attachment. This is exclusive with the resource element.
Deprecated in favor of the new artifact[x] element. The related artifact, such as a library, value set, profile, or other knowledge 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.
What artifact, if not a conformance resource
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.
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.
What document, citation, artifact, or resource is being referenced
The related artifact represented as a canonical or direct reference to a FHIR resource, an Attachment, or directly inline as markdown.
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.