v1

latestOpenAPI 3.0.32026-08-061614181.2 KB

Link two identities (linkIdentities)

Links two existing identities together without retiring either source. This is typically used when you determine that two separate source identities belong to the same real-world provider, and they should be represented as a single link ID. Note: only provider identities of the same type can be linked together (ie Practitioner to Practitioner, not Practitioner and Health Facility).

post/linkIdentities

Request body

trackingIdstring

Optional client-defined correlation ID.

Response

Link identities response

auditIdstring

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

warningsstring[]

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsstring[]

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.