STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.10.0 RelatedResource

Clinical Decision Support

Work Group

Maturity Level: N/A

Ballot Status: STU 3

The RelatedResource structure defines resources related to a module such as previous and next versions of documents, documentation, citations, etc. Note that the name resource here is being used in a more general sense than the FHIR-specific Resource. The related resource may be a FHIR resource, or it may be another type of resource, represented using the Attachment data type.

Structure

Name	Flags	Card.	Type	Description & Constraints
RelatedResource	Σ		Element	Related resources for the module
type	Σ	1..1	code	documentation \| justification \| citation \| predecessor \| successor \| derived-from \| depends-on \| composed-of RelatedResourceType (Required)
display	Σ	0..1	string	Brief description of the related resource
citation	Σ	0..1	string	Bibliographic citation for the resource
url	Σ	0..1	uri	Url for the related resource
document	Σ	0..1	Attachment	The related document
resource	Σ	0..1	Reference(Any)	The related resource
Documentation for this format

UML Diagram (Legend)

XML Template

<[name] xmlns="http://hl7.org/fhir"> 
 <!-- from Element: extension -->
 <type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of -->
 <display value="[string]"/><!-- 0..1 Brief description of the related resource -->
 <citation value="[string]"/><!-- 0..1 Bibliographic citation for the resource -->
 <url value="[uri]"/><!-- 0..1 Url for the related resource -->
 <document><!-- 0..1 Attachment The related document --></document>
 <resource><!-- 0..1 Reference(Any) The related resource --></resource>
</[name]>

JSON Template

{
  "resourceType" : "RelatedResource",
  // from Element: extension
  "type" : "<code>", // R!  documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
  "display" : "<string>", // Brief description of the related resource
  "citation" : "<string>", // Bibliographic citation for the resource
  "url" : "<uri>", // Url for the related resource
  "document" : { Attachment }, // The related document
  "resource" : { Reference(Any) } // The related resource
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:RelatedResource.type [ code ]; # 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
  fhir:RelatedResource.display [ string ]; # 0..1 Brief description of the related resource
  fhir:RelatedResource.citation [ string ]; # 0..1 Bibliographic citation for the resource
  fhir:RelatedResource.url [ uri ]; # 0..1 Url for the related resource
  fhir:RelatedResource.document [ Attachment ]; # 0..1 The related document
  fhir:RelatedResource.resource [ Reference(Any) ]; # 0..1 The related resource
]

Changes since DSTU2

This complex-type did not exist in Release 2