This page is part of the FHIR for FAIR - FHIR Implementation Guide (v1.0.0: STU 1) based on FHIR v4.3.0. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Active as of 2022-09-28 |
Definitions for the RelatedArtifact-uv-f4f data type profile.
| 1. RelatedArtifact | |
| Definition | Related artifacts such as additional documentation, justification, or bibliographic references. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Comments | Each related artifact is either an attachment, or a reference to another knowledge resource, but not both. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) |
| 2. RelatedArtifact.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | id |
| 3. RelatedArtifact.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Comments | 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on RelatedArtifact.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. RelatedArtifact.extension:classifier | |
| SliceName | classifier |
| Definition | This extension enanches the current RelatedArtifact data type with the classifier element as specified in R5 |
| Control | 0..1 |
| Type | Extension(ExtRelatedArtifactClassifier) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 5. RelatedArtifact.extension:resourceReference | |
| SliceName | resourceReference |
| Definition | This extension enanches the current RelatedArtifact data type allowing to reference FHIR resources |
| Control | 0..1 |
| Type | Extension(ExtRelatedArtifactResourceReference) (Extension Type: Reference(Resource)) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 6. RelatedArtifact.extension:relationshipType | |
| SliceName | relationshipType |
| Definition | This extension enanches the current RelatedArtifact data type with extending the supported relationship types as specified in R5 |
| Control | 0..1 |
| Type | Extension(ExtRelatedArtifactType) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 7. RelatedArtifact.type | |
| Definition | The type of relationship to the related artifact. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RelatedArtifactType |
| Type | code |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 8. RelatedArtifact.label | |
| Definition | A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. |
| Control | 0..1 |
| Type | string |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 9. RelatedArtifact.display | |
| Definition | A brief description of the document or knowledge resource being referenced, suitable for display to a consumer. |
| Control | 0..1 |
| Type | string |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 10. RelatedArtifact.citation | |
| Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. |
| Control | 0..1 |
| Type | markdown |
| Comments | Additional structured information about citations should be captured as extensions. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 11. RelatedArtifact.url | |
| Definition | A url for the artifact that can be followed to access the actual content. |
| Control | 0..1 |
| Type | url |
| Comments | 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). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 12. RelatedArtifact.document | |
| Definition | The document being referenced, represented as an attachment. This is exclusive with the resource element. |
| Control | 0..1 |
| Type | Attachment |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 13. RelatedArtifact.resource | |
| Definition | The related resource, such as a library, value set, profile, or other knowledge resource. |
| Control | 0..1 |
| Type | canonical(Resource) |
| Comments | 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |