# Linkage

Canonical page: https://docs.ovok.com/api/fhir/r4/linkage

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/Linkage/[id]` |
| Vread | `GET` | `/fhir/R4/Linkage/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Linkage/[id]` |
| Patch | `PATCH` | `/fhir/R4/Linkage/[id]` |
| Delete | `DELETE` | `/fhir/R4/Linkage/[id]` |
| Create | `POST` | `/fhir/R4/Linkage` |
| Search | `GET` | `/fhir/R4/Linkage` |
| History | `GET` | `/fhir/R4/Linkage/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-active"></span>`active` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | Whether this linkage assertion is active or not |
| <span id="element-author"></span>`author` | [Reference](/fhir-elements/complex/reference) | `0..1` | Who is responsible for linkages |
| <span id="element-item"></span>`item` | [BackboneElement](/fhir-elements/complex/backbone-element) | `1..*` | Item to be linked |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `author` | reference | Author of the Linkage |
| `item` | reference | Matches on any item in the Linkage |
| `source` | reference | Matches on any item in the Linkage with a type of 'source' |

## Reference [#reference]

Official FHIR R4 spec: [Linkage](https://hl7.org/fhir/R4/linkage.html).  
Maturity: Draft (FMM 0).
