linkages

Create Linkage

post
/organizations/{organizationId}/fhir/3/Linkage

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringLinkageThis is a Linkage resource
activebooleanIndicates whether the asserted set of linkages are considered to be "in effect".
authorReferenceIdentifies the user or organization responsible for asserting the linkages and who establishes the context for evaluating the nature of each linkage.
item*array(Linkage_Item)Identifies one of the records that is considered to refer to the same real-world occurrence as well as how the items hould be evaluated within the collection of linked items.

Response

Patch Linkage

patch
/organizations/{organizationId}/fhir/3/Linkage/{resourceId}

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

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringLinkageThis is a Linkage resource
activebooleanIndicates whether the asserted set of linkages are considered to be "in effect".
authorReferenceIdentifies the user or organization responsible for asserting the linkages and who establishes the context for evaluating the nature of each linkage.
item*array(Linkage_Item)Identifies one of the records that is considered to refer to the same real-world occurrence as well as how the items hould be evaluated within the collection of linked items.

Response

Read Linkage

get
/organizations/{organizationId}/fhir/3/Linkage/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Linkage

get
/organizations/{organizationId}/fhir/3/Linkage/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Linkage

get
/organizations/{organizationId}/fhir/3/Linkage/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Linkage

delete
/organizations/{organizationId}/fhir/3/Linkage/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Linkage

get
/organizations/{organizationId}/fhir/3/Linkage

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
itemstring
sourcestring

Params

organizationId*string|stringid|slug

Response

Search History Linkage

get
/organizations/{organizationId}/fhir/3/Linkage/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Linkage

post
/organizations/{organizationId}/fhir/3/Linkage/_search

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

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
itemstring
sourcestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringLinkageThis is a Linkage resource
activebooleanIndicates whether the asserted set of linkages are considered to be "in effect".
authorReferenceIdentifies the user or organization responsible for asserting the linkages and who establishes the context for evaluating the nature of each linkage.
item*array(Linkage_Item)Identifies one of the records that is considered to refer to the same real-world occurrence as well as how the items hould be evaluated within the collection of linked items.

Response

Update Linkage

put
/organizations/{organizationId}/fhir/3/Linkage/{resourceId}

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringLinkageThis is a Linkage resource
activebooleanIndicates whether the asserted set of linkages are considered to be "in effect".
authorReferenceIdentifies the user or organization responsible for asserting the linkages and who establishes the context for evaluating the nature of each linkage.
item*array(Linkage_Item)Identifies one of the records that is considered to refer to the same real-world occurrence as well as how the items hould be evaluated within the collection of linked items.

Response