Update patient information

patch

https://api.preprod.rofim.doctor/services/interoperability/patient

Updates a patient's information. The patient can be identified by their IPP or ROFIM ID. The AA params target the patient by the IPP / assigning authority couple and select which patientIds entry an ipp update applies to.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

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

ROFIM patient identifier

ipp

string

Patient IPP

aaNamespaceId

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.

aaUniversalId

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.

Body Params

firstName

string

lastName

string

usualName

string

gender

string

enum

Patient gender:

1: male
2: female

Allowed:

birthDate

date

^\d{4}-\d{2}-\d{2}$

birthPlace

object

address

object

nss

string

Social Security Number. Can be set to 'NC' if not known.

healthNationalId

object

French patient unique identifier (Identité Nationale de Santé, or INS).
The complete health national identifier (INS) is composed of value + key, where value is the main part and key is the control key (last 2 digits).

ipp

string

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.

patientIds

array of objects

All patient identifiers (HL7 CX) with their assigning authorities.

patientIds

string

Patient's email. Mandatory for teleconsultations if phone not set.

phone

string

Patient's phone. Mandatory for teleconsultations if no email set.

twinRank

number

primaryPhysicianRpps

string

RPPS number of the primary physician

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated patient

400Bad Request - Patient identifier required

401Unauthorized

403Forbidden - Assigning authority outside the client authorities, or patient not accessible to the client

404Not Found - Patient not found