RelatedArtifact | Medplum
On this page
Base StructureDefinition for RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.
- Schema
Elements
| Name | Required | Type | Description |
|---|---|---|---|
| id | string | Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
|
| extension | Extension[] | Additional content defined by implementations Details 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 manageable, 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. |
|
| type | ✓ | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Details The type of relationship to the related artifact. |
| label | string | Short label Details A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. |
|
| display | string | Brief description of the related artifact Details A brief description of the document or knowledge resource being referenced, suitable for display to a consumer. |
|
| citation | markdown | Bibliographic citation for the artifact Details 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. |
|
| url | url | Where the artifact can be accessed Details A url for the artifact that can be followed to access the actual content. If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference). |
|
| document | Attachment | What document is being referenced Details The document being referenced, represented as an attachment. This is exclusive with the resource element. |
|
| resource | canonical | What resource is being referenced Details The related resource, 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. |