FHIR for FAIR - FHIR Implementation Guide
1.0.0 - STU 1

FHIR for FAIR - FHIR Implementation Guide, published by Health Level Seven International - SOA Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-for-fair/ and changes regularly. See the Directory of published versions

## Data Type Profile: RelatedArtifactF4F - Detailed Descriptions

Active as of 2024-01-05

Definitions for the RelatedArtifact-uv-f4f data type profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. RelatedArtifact
2. RelatedArtifact.extension:classifier
Slice Name | classifier
Control | 0..1
Type | Extension(Classifier [RelatedArtifact]) (Extension Type: CodeableConcept)
4. RelatedArtifact.extension:resourceReference
Slice Name | resourceReference
Control | 0..1
Type | Extension(ResourceReference [RelatedArtifact]) (Extension Type: Reference(Resource))
6. RelatedArtifact.extension:relationshipType
Slice Name | relationshipType
Control | 0..1
Type | Extension(Type [RelatedArtifact]) (Extension Type: CodeableConcept)

Guidance on how to interpret the contents of this table can be found here

0. RelatedArtifact
Definition | Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Related artifacts for a knowledge resource
Comments | Each related artifact is either an attachment, or a reference to another knowledge resource, but not both.
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Invariants | 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.extension:classifier
Slice Name | classifier
Definition | This extension enanches the current RelatedArtifact data type with the classifier element as specified in R5
Short | Classifier [RelatedArtifact]
Control | 0..1
Type | Extension(Classifier [RelatedArtifact]) (Extension Type: CodeableConcept)
Is Modifier | false
Summary | false
Invariants | 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())
4. RelatedArtifact.extension:resourceReference
Slice Name | resourceReference
Definition | This extension enanches the current RelatedArtifact data type allowing to reference FHIR resources
Short | ResourceReference [RelatedArtifact]
Control | 0..1
Type | Extension(ResourceReference [RelatedArtifact]) (Extension Type: Reference(Resource))
Is Modifier | false
Summary | false
Invariants | 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
Slice Name | relationshipType
Definition | This extension enanches the current RelatedArtifact data type with extending the supported relationship types as specified in R5
Short | Type [RelatedArtifact]
Control | 0..1
Type | Extension(Type [RelatedArtifact]) (Extension Type: CodeableConcept)
Is Modifier | false
Summary | false
Invariants | 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())
8. RelatedArtifact.type
Definition | The type of relationship to the related artifact.
Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Control | 1..1
Binding | The codes SHALL be taken from RelatedArtifactType http://hl7.org/fhir/ValueSet/related-artifact-type|4.3.0
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. RelatedArtifact
Definition | Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Related artifacts for a knowledge resource
Comments | Each related artifact is either an attachment, or a reference to another knowledge resource, but not both.
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Invariants | 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
4. 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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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: value @ url
6. RelatedArtifact.extension:classifier
Slice Name | classifier
Definition | This extension enanches the current RelatedArtifact data type with the classifier element as specified in R5
Short | Classifier [RelatedArtifact]
Control | 0..1
Type | Extension(Classifier [RelatedArtifact]) (Extension Type: CodeableConcept)
Is Modifier | false
Summary | false
Invariants | 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()`)
8. RelatedArtifact.extension:resourceReference
Slice Name | resourceReference
Definition | This extension enanches the current RelatedArtifact data type allowing to reference FHIR resources
Short | ResourceReference [RelatedArtifact]
Control | 0..1
Type | Extension(ResourceReference [RelatedArtifact]) (Extension Type: Reference(Resource))
Is Modifier | false
Summary | false
Invariants | 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()`)
10. RelatedArtifact.extension:relationshipType
Slice Name | relationshipType
Definition | This extension enanches the current RelatedArtifact data type with extending the supported relationship types as specified in R5
Short | Type [RelatedArtifact]
Control | 0..1
Type | Extension(Type [RelatedArtifact]) (Extension Type: CodeableConcept)
Is Modifier | false
Summary | false
Invariants | 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()`)
12. RelatedArtifact.type
Definition | The type of relationship to the related artifact.
Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Control | 1..1
Binding | The codes SHALL be taken from RelatedArtifactType
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. 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.
Short | Short label
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. RelatedArtifact.display
Definition | A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Short | Brief description of the related artifact
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. RelatedArtifact.citation
Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
Short | Bibliographic citation for the artifact
Comments | Additional structured information about citations should be captured as extensions.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. RelatedArtifact.url
Definition | A url for the artifact that can be followed to access the actual content.
Short | Where the artifact can be accessed
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).
Control | 0..1
Type | url
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. RelatedArtifact.document
Definition | The document being referenced, represented as an attachment. This is exclusive with the resource element.
Short | What document is being referenced
Control | 0..1
Type | Attachment
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. RelatedArtifact.resource
Definition | The related resource, such as a library, value set, profile, or other knowledge resource.
Short | What resource is being referenced
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.
Control | 0..1
Type | canonical(Resource)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)