Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: relatedArtifact

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact

Version: 5.0.0-ballot

Name: relatedArtifact

Title: null

Modifier: This extension is not a modifier extension

Status: draft

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

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: Health Level Seven, Inc. - CDS WG

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

Comment:

Each related artifact is either an attachment, or a reference to another resource, but not both.

Context of Use: Use on Element ID Element

Summary

Name	Flags	Card.	Type	Description & Constraints
relatedArtifact		0..*	RelatedArtifact	URL = http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact relatedArtifact: Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Use on Element ID Element
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact relatedArtifact: Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Use on Element ID Element
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
value[x]	1..1	RelatedArtifact	Value of extension
Documentation for this format

XML Template

<!-- relatedArtifact -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" >
  <!-- from Element: extension -->
 <valueRelatedArtifact><!-- I 1..1 RelatedArtifact Value of extension --></valueRelatedArtifact>
</extension>

JSON Template

{ // relatedArtifact
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact", // R! 
    "valueRelatedArtifact" : { RelatedArtifact } // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
relatedArtifact		0..*	RelatedArtifact	URL = http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact relatedArtifact: Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Use on Element ID Element
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact relatedArtifact: Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Use on Element ID Element
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
value[x]	1..1	RelatedArtifact	Value of extension
Documentation for this format

XML Template

<!-- relatedArtifact -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" >
  <!-- from Element: extension -->
 <valueRelatedArtifact><!-- I 1..1 RelatedArtifact Value of extension --></valueRelatedArtifact>
</extension>

JSON Template

{ // relatedArtifact
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact", // R! 
    "valueRelatedArtifact" : { RelatedArtifact } // I R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.