FHIR R6 Patient Care Incubator
0.1.0 - ci-build International flag

FHIR R6 Patient Care Incubator, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/pc-incubator/ and changes regularly. See the Directory of published versions

Resource Profile: Linkage

Official URL: http://hl7.org/fhir/StructureDefinition/Linkage Version: 0.1.0
Standards status: Draft Maturity Level: 0 Computable Name: Linkage
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1479

Identifies two or more records (resource instances) that refer to the same real-world "occurrence".

Scope and Usage

This resource allows the assertion of linkages between multiple resource instances (generally of the same type) that refer 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, Practitioner 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 or 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 after identifying duplicates is to deprecate one of the records (e.g. by changing the status to "Entered in Error") and to move all relevant information to the surviving record. In other cases, both records may need to persist, perhaps because the resources live on different servers or have different 'owners'.

[%stu-note dstu%] While the Maturity Level did not change, the Standards Status did change to Draft for consistency with the current Maturity Level of 0. The Patient Care Work Group welcomes feedback here whether implementers believe the resource is substantially complete, tested across its scope, and implemented in production. [%end-note%]

Boundaries and Relationships

Do not use Linkage for Patient, Person, and Encounter, see the explanation on Patient for more details. 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.

Usages:

  • This Resource is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Linkage C 0..* DomainResource Links records for 'same' item

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
Constraints: lnk-1
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... active Σ 0..1 boolean Whether this linkage assertion is active or not
... author Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Who is responsible for linkages
... item ΣC 1..* BackboneElement Item to be linked
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 1..1 code source | alternate | historical
Binding: LinkageType (required): Used to distinguish different roles a resource can play within a set of linked resources.
.... resource Σ 1..1 Reference(Resource) Resource being linked

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Linkage.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
Linkage.item.type Base required Linkage Type 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Linkage If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Linkage If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Linkage If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Linkage If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Linkage A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
lnk-1 error Linkage Must have at least two items item.count()>1

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Linkage C 0..* DomainResource Links records for 'same' item

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
Constraints: lnk-1
... active Σ 0..1 boolean Whether this linkage assertion is active or not
... author Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Who is responsible for linkages
... item ΣC 1..* BackboneElement Item to be linked
.... type Σ 1..1 code source | alternate | historical
Binding: LinkageType (required): Used to distinguish different roles a resource can play within a set of linked resources.
.... resource Σ 1..1 Reference(Resource) Resource being linked

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Linkage.item.type Base required Linkage Type 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
lnk-1 error Linkage Must have at least two items item.count()>1
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Linkage C 0..* DomainResource Links records for 'same' item

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
Constraints: lnk-1
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... active Σ 0..1 boolean Whether this linkage assertion is active or not
... author Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Who is responsible for linkages
... item ΣC 1..* BackboneElement Item to be linked
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 1..1 code source | alternate | historical
Binding: LinkageType (required): Used to distinguish different roles a resource can play within a set of linked resources.
.... resource Σ 1..1 Reference(Resource) Resource being linked

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Linkage.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
Linkage.item.type Base required Linkage Type 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Linkage If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Linkage If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Linkage If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Linkage If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Linkage A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
lnk-1 error Linkage Must have at least two items item.count()>1

This structure is derived from DomainResource

Summary

Mandatory: 0 element(3 nested mandatory elements)

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Linkage C 0..* DomainResource Links records for 'same' item

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
Constraints: lnk-1
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... active Σ 0..1 boolean Whether this linkage assertion is active or not
... author Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Who is responsible for linkages
... item ΣC 1..* BackboneElement Item to be linked
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 1..1 code source | alternate | historical
Binding: LinkageType (required): Used to distinguish different roles a resource can play within a set of linked resources.
.... resource Σ 1..1 Reference(Resource) Resource being linked

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Linkage.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
Linkage.item.type Base required Linkage Type 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Linkage If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Linkage If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Linkage If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Linkage If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Linkage A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
lnk-1 error Linkage Must have at least two items item.count()>1

Differential View

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Linkage C 0..* DomainResource Links records for 'same' item

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
Constraints: lnk-1
... active Σ 0..1 boolean Whether this linkage assertion is active or not
... author Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Who is responsible for linkages
... item ΣC 1..* BackboneElement Item to be linked
.... type Σ 1..1 code source | alternate | historical
Binding: LinkageType (required): Used to distinguish different roles a resource can play within a set of linked resources.
.... resource Σ 1..1 Reference(Resource) Resource being linked

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Linkage.item.type Base required Linkage Type 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
lnk-1 error Linkage Must have at least two items item.count()>1

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Linkage C 0..* DomainResource Links records for 'same' item

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
Constraints: lnk-1
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... active Σ 0..1 boolean Whether this linkage assertion is active or not
... author Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Who is responsible for linkages
... item ΣC 1..* BackboneElement Item to be linked
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 1..1 code source | alternate | historical
Binding: LinkageType (required): Used to distinguish different roles a resource can play within a set of linked resources.
.... resource Σ 1..1 Reference(Resource) Resource being linked

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Linkage.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
Linkage.item.type Base required Linkage Type 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Linkage If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Linkage If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Linkage If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Linkage If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Linkage A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
lnk-1 error Linkage Must have at least two items item.count()>1

This structure is derived from DomainResource

Summary

Mandatory: 0 element(3 nested mandatory elements)

Maturity: 0

 

​Other representations of profile: CSV, Excel, Schematron

Notes: