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* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Linkage | This is a Linkage resource |
| active | boolean | Indicates whether the asserted set of linkages are considered to be "in effect". | |
| author | Reference | Identifies 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
keyboard_arrow_down
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* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Linkage | This is a Linkage resource |
| active | boolean | Indicates whether the asserted set of linkages are considered to be "in effect". | |
| author | Reference | Identifies 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
keyboard_arrow_down
Read Linkage
get
/organizations/{organizationId}/fhir/3/Linkage/{resourceId}
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Linkage
get
/organizations/{organizationId}/fhir/3/Linkage/{resourceId}/_history
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Linkage
get
/organizations/{organizationId}/fhir/3/Linkage/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Linkage
delete
/organizations/{organizationId}/fhir/3/Linkage/{resourceId}
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Linkage
get
/organizations/{organizationId}/fhir/3/Linkage
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| author | string | ||
| item | string | ||
| source | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Linkage
get
/organizations/{organizationId}/fhir/3/Linkage/_history
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
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* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| author | string | ||
| item | string | ||
| source | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Linkage | This is a Linkage resource |
| active | boolean | Indicates whether the asserted set of linkages are considered to be "in effect". | |
| author | Reference | Identifies 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
keyboard_arrow_down
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* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Linkage | This is a Linkage resource |
| active | boolean | Indicates whether the asserted set of linkages are considered to be "in effect". | |
| author | Reference | Identifies 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
keyboard_arrow_down