RelatedArtifact [FHIR for FAIR] - FHIR for FAIR - FHIR Implementation Guide v1.0.0

FHIR for FAIR - FHIR Implementation Guide
1.0.0 - STU 1 International flag

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: RelatedArtifact [FHIR for FAIR]

Official URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/RelatedArtifact-uv-f4f				Version: 1.0.0
Active as of 2024-01-05				Computable Name: RelatedArtifactF4F

This profile enhances the current RelatedArtifact data with the enhancements identified in FHIR R5

Usage:

Use this DataType Constraint: Library [Study Level Medatata], ResearchStudy [Study Level Medatata] and Content as RelatedArtifact [Library]

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from RelatedArtifact

Name	Card.	Type	Description & Constraints
RelatedArtifact		RelatedArtifact
classifier	0..1	CodeableConcept	Classifier [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier
resourceReference	0..1	Reference(Resource)	ResourceReference [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference
relationshipType	0..1	CodeableConcept	Type [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactType Binding: RelatedArtifactType [ValueSet] (extensible)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
RelatedArtifact		0..*	RelatedArtifact	Related artifacts for a knowledge resource
classifier		0..1	CodeableConcept	Classifier [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier
resourceReference		0..1	Reference(Resource)	ResourceReference [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference
relationshipType		0..1	CodeableConcept	Type [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactType Binding: RelatedArtifactType [ValueSet] (extensible)
type	Σ	1..1	code	documentation \| justification \| citation \| predecessor \| successor \| derived-from \| depends-on \| composed-of Binding: RelatedArtifactType (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedArtifact.type	required	RelatedArtifactType

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
RelatedArtifact		0..*	RelatedArtifact	Related artifacts for a knowledge resource
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
classifier		0..1	CodeableConcept	Classifier [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier
resourceReference		0..1	Reference(Resource)	ResourceReference [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference
relationshipType		0..1	CodeableConcept	Type [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactType Binding: RelatedArtifactType [ValueSet] (extensible)
type	Σ	1..1	code	documentation \| justification \| citation \| predecessor \| successor \| derived-from \| depends-on \| composed-of Binding: RelatedArtifactType (required)
label	Σ	0..1	string	Short label
display	Σ	0..1	string	Brief description of the related artifact
citation	Σ	0..1	markdown	Bibliographic citation for the artifact
url	Σ	0..1	url	Where the artifact can be accessed
document	Σ	0..1	Attachment	What document is being referenced
resource	Σ	0..1	canonical(Resource)	What resource is being referenced
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedArtifact.type	required	RelatedArtifactType

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from RelatedArtifact

Summary

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from RelatedArtifact

Name	Card.	Type	Description & Constraints
RelatedArtifact		RelatedArtifact
classifier	0..1	CodeableConcept	Classifier [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier
resourceReference	0..1	Reference(Resource)	ResourceReference [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference
relationshipType	0..1	CodeableConcept	Type [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactType Binding: RelatedArtifactType [ValueSet] (extensible)
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
RelatedArtifact		0..*	RelatedArtifact	Related artifacts for a knowledge resource
classifier		0..1	CodeableConcept	Classifier [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier
resourceReference		0..1	Reference(Resource)	ResourceReference [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference
relationshipType		0..1	CodeableConcept	Type [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactType Binding: RelatedArtifactType [ValueSet] (extensible)
type	Σ	1..1	code	documentation \| justification \| citation \| predecessor \| successor \| derived-from \| depends-on \| composed-of Binding: RelatedArtifactType (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedArtifact.type	required	RelatedArtifactType

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
RelatedArtifact		0..*	RelatedArtifact	Related artifacts for a knowledge resource
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
classifier		0..1	CodeableConcept	Classifier [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier
resourceReference		0..1	Reference(Resource)	ResourceReference [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference
relationshipType		0..1	CodeableConcept	Type [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactType Binding: RelatedArtifactType [ValueSet] (extensible)
type	Σ	1..1	code	documentation \| justification \| citation \| predecessor \| successor \| derived-from \| depends-on \| composed-of Binding: RelatedArtifactType (required)
label	Σ	0..1	string	Short label
display	Σ	0..1	string	Brief description of the related artifact
citation	Σ	0..1	markdown	Bibliographic citation for the artifact
url	Σ	0..1	url	Where the artifact can be accessed
document	Σ	0..1	Attachment	What document is being referenced
resource	Σ	0..1	canonical(Resource)	What resource is being referenced
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedArtifact.type	required	RelatedArtifactType

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from RelatedArtifact

Summary

Extensions

This structure refers to these extensions:

Other representations of profile: CSV, Excel, Schematron

IG © 2020+ Health Level Seven International - SOA Work Group. Package hl7.fhir.uv.fhir-for-fair#1.0.0 based on FHIR 4.3.0. Generated 2024-01-05
Links: Table of Contents | QA Report | Version History | | Propose a change