API Reference

Update a patient's IPP

patch deprecated
https://api.preprod.rofim.doctor/services/interoperability/patient/ipp

Sets a new IPP for a given patient, upserted under the authority targeted by the AA params, or under the client's default authority when no AA params are provided.

The patient can be scoped to a doctor or to a department. If neither are provided, all patients with a matching IPP are updated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Current IPP of the patient(s) to update. Required when id is not provided.

string
^[0-9a-fA-F]{24}$

ROFIM patient identifier. Required when ipp is not provided.

string

Assigning authority namespace ID (HD.1). Strict match: used alone, only matches identifiers without universalId. Must belong to the client's authorities (403 otherwise). Requires ipp or id.

string

Assigning authority universal ID (HD.2). Strict match: used alone, only matches identifiers without namespaceId. Must belong to the client's authorities (403 otherwise). Requires ipp or id.

string
^[0-9a-fA-F]{24}$

ROFIM department identifier

string
^\d{11}$

Healthcare Professional unique identifier (RPPS, ADELI or AM, 11 digits). MUST be sent as a JSON string (with quotes).

Body Params
string
required
deprecated

The Permanent Patient Identifier (Identifiant Permanent du Patient, or IPP). Deprecated: use patientIds instead. Always holds the last written identifier value, whichever client wrote it. Per-authority values are available in patientIds. When an assigning authority is configured on the client's establishment in the ROFIM portal, legacy ipp values written through this API are backfilled as patientIds entries under that authority.

Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?