FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Extension: Artifact related artifact

Official URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact				Version: 5.2.0-ballot
Standards status: Trial-use		Maturity Level: 2	Responsible: HL7 International / Clinical Decision Support	Computable Name: ArtifactRelatedArtifact
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1754

Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

This extension is defined to support representing artifact metadata on resources that are not already canonical resources that have the corresponding element, and that behave in a definitional way. For example, it would not be appropriate to use this extension on a patient-specific resource such as MedicationRequest or CarePlan.

Context of Use

This extension may be used on the following element(s):

• Element ID: Resource

Usage info

Usage:

• This Extension is not used by any profiles in this Implementation Guide

Formal Views of Extension Content

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

 

Other representations of profile: CSV, Excel, Schematron

Constraints

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

R4B

The extension is unchanged in R4B

R4

The extension is unchanged in R4

R3

The extension is represented a little differently in R3:

• Replace the type RelatedArtifact with a set of extensions for the content of the type along with the _datatype extension
• Note: Extensions that have been modified for R3 are still draft while real-world experience is collected

Name	Flags	Card.	Type	Description & Constraints
Extension		0..*	Extension	Additional documentation, citations, etc.
Slices for extension		0 ..*	Extension	Extension Slice: Unordered, Open by value:url
extension:_datatype		1..1	(Complex)	DataType name 'RelatedArtifact' from R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype
value[x]		1.. 1	string	Value of extension Fixed Value: RelatedArtifact
extension:type		1..1	Extension	documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
extension		0 .. 0
url		1 .. 1	uri	"type"
value[x]		1.. 1	code	Value of extension Binding: RelatedArtifactType ( required ): The type of relationship to the related artifact.
extension:classifier		0..*	Extension	Additional classifiers
extension		0 .. 0
url		1 .. 1	uri	"classifier"
value[x]		1.. 1	CodeableConcept	Value of extension Binding: CitationArtifactClassifier ( example ): Additional classifiers for the related artifact.
extension:label		0..1	Extension	Short label
extension		0 .. 0
url		1 .. 1	uri	"label"
value[x]		1.. 1	string	Value of extension
extension:display		0..1	Extension	Brief description of the related artifact
extension		0 .. 0
url		1 .. 1	uri	"display"
value[x]		1.. 1	string	Value of extension
extension:citation		0..1	Extension	Bibliographic citation for the artifact
extension		0 .. 0
url		1 .. 1	uri	"citation"
value[x]		1.. 1	markdown	Value of extension
extension:document		0..1	Extension	What document is being referenced
extension		0 .. 0
url		1 .. 1	uri	"document"
value[x]		1.. 1	Attachment	Value of extension
extension:resource		0..1	Extension	What artifact is being referenced
extension		0 .. 0
url		1 .. 1	uri	"resource"
value[x]		1.. 1	uri	Value of extension
extension:resourceReference		0..1	Extension	What artifact, if not a conformance resource
extension		0 .. 0
url		1 .. 1	uri	"resourceReference"
value[x]		1.. 1	Reference ( Resource )	Value of extension
extension:publicationStatus		0..1	Extension	draft | active | retired | unknown
extension		0 .. 0
url		1 .. 1	uri	"publicationStatus"
value[x]		1.. 1	code	Value of extension Binding: PublicationStatus ( required ): Publication status of an artifact being referred to.
extension:publicationDate		0..1	Extension	Date of publication of the artifact being referred to
extension		0 .. 0
url		1 .. 1	uri	"publicationDate"
value[x]		1.. 1	date	Value of extension
url		1 .. 1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
value[x]		0 .. 0
Documentation for this format

Search Parameters for this Extension

(none found)