v1

latestOpenAPI 3.0.32026-08-061614181.2 KB

Merge two identities (mergeIdentities)

Merges a "toRetire" source identity into a "toSurvive" source identity. After a merge, the retired source is marked as merged and the surviving identity contains combined data. The response returns the surviving linkId. Note: only provider identities of the same type can be merged together (ie Practitioner to Practitioner, not Practitioner and Health Facility).

post/mergeIdentities

Request body

trackingIdstring

Optional client-defined correlation ID.

Response

Merge 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.