8.19 Resource Linkage - Content

8.19.1 Scope and Usage

This resource allows the assertion of linkages between multiple resource instances (generally of the same type) that are referring to the same underlying business objects. For example, multiple Condition records that refer to the same underlying problem/issue for a Patient; multiple AllergyIntolerance records that refer to the same reaction susceptibility; multiple Patient, Practioner and/or RelatedPerson records that refer to the same human being or animal.

FHIR supports a process for sharing electronic records. It is common for multiple records to exist that deal with the same real-world phenomenon. This can result from information being captured by different systems, information being captured within a single system by different users (either deliberately to represent distinct perspectives or accidentally when a new record is created rather than updating an existing record). These multiple records may be referred to as "duplicate" records, but in practice they aren't often actually "duplicate" in that the data represented (and the history of the records) will be at least somewhat distinct.

In some cases, the solution upon identifying duplicates is to deprecate one of the records (e.g. by changing the status to "entered in error") and move all relevant information to the surviving record. In other cases, the resource may support the ability to establish a linkage directly between the resources. However, in some cases, both records may need to survive or there's a desire to have both resources continue to be maintained, perhaps because the resources live on different servers or have different 'owners'. The Linkage resource is intended to satisfy this use-case.

8.19.2 Boundaries and Relationships

The Person resource should be used to link a person independent of a specific health-related context. Linkage can be used for all other use cases.

• Structure
• UML
• XML
• JSON
• Turtle
• R2 Diff
• All

Structure

Name	Flags	Card.	Type	Description & Constraints
Linkage	ΣI		DomainResource	Links records for 'same' item + Must have at least two items Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
active	Σ	0..1	boolean	Whether this linkage assertion is active or not
author	Σ	0..1	Reference(Practitioner | Organization)	Who is responsible for linkages
item	ΣI	1..*	BackboneElement	Item to be linked
type	Σ	1..1	code	source | alternate | historical LinkageType (Required)
resource	Σ	1..1	Reference()	Resource being linked
Documentation for this format

<Linkage xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <active value="[boolean]"/><!-- 0..1 Whether this linkage assertion is active or not -->
 <author><!-- 0..1 Reference(Practitioner|Organization) Who is responsible for linkages --></author>
 <item>  <!--  1..* Item to be linked -->
  <type value="[code]"/><!-- 1..1 source | alternate | historical -->
  <resource><!-- 1..1 Reference Resource being linked --></resource>
 </item>
</Linkage>

{
  "resourceType" : "Linkage",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "active" : <boolean>, // Whether this linkage assertion is active or not
  "author" : { Reference(Practitioner|Organization) }, // Who is responsible for linkages
  "item" : [{ // C? R!  Item to be linked
    "type" : "<code>", // R!  source | alternate | historical
    "resource" : { Reference } // R!  Resource being linked
  }]
}

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


[ a fhir:Linkage;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Linkage.active [ boolean ]; # 0..1 Whether this linkage assertion is active or not
  fhir:Linkage.author [ Reference(Practitioner|Organization) ]; # 0..1 Who is responsible for linkages
  fhir:Linkage.item [ # 1..* Item to be linked
    fhir:Linkage.item.type [ code ]; # 1..1 source | alternate | historical
    fhir:Linkage.item.resource [ Reference ]; # 1..1 Resource being linked
  ], ...;
]

Structure

Name	Flags	Card.	Type	Description & Constraints
Linkage	ΣI		DomainResource	Links records for 'same' item + Must have at least two items Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
active	Σ	0..1	boolean	Whether this linkage assertion is active or not
author	Σ	0..1	Reference(Practitioner | Organization)	Who is responsible for linkages
item	ΣI	1..*	BackboneElement	Item to be linked
type	Σ	1..1	code	source | alternate | historical LinkageType (Required)
resource	Σ	1..1	Reference()	Resource being linked
Documentation for this format

UML Diagram (Legend)

XML Template

<Linkage xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <active value="[boolean]"/><!-- 0..1 Whether this linkage assertion is active or not -->
 <author><!-- 0..1 Reference(Practitioner|Organization) Who is responsible for linkages --></author>
 <item>  <!--  1..* Item to be linked -->
  <type value="[code]"/><!-- 1..1 source | alternate | historical -->
  <resource><!-- 1..1 Reference Resource being linked --></resource>
 </item>
</Linkage>

JSON Template

{
  "resourceType" : "Linkage",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "active" : <boolean>, // Whether this linkage assertion is active or not
  "author" : { Reference(Practitioner|Organization) }, // Who is responsible for linkages
  "item" : [{ // C? R!  Item to be linked
    "type" : "<code>", // R!  source | alternate | historical
    "resource" : { Reference } // R!  Resource being linked
  }]
}

Turtle Template

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


[ a fhir:Linkage;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Linkage.active [ boolean ]; # 0..1 Whether this linkage assertion is active or not
  fhir:Linkage.author [ Reference(Practitioner|Organization) ]; # 0..1 Who is responsible for linkages
  fhir:Linkage.item [ # 1..* Item to be linked
    fhir:Linkage.item.type [ code ]; # 1..1 source | alternate | historical
    fhir:Linkage.item.resource [ Reference ]; # 1..1 Resource being linked
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.