Patient creation

post

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

Creates a new patient in the system.
Both email and phone are optional fields, but at least one is
required for creating a teleconsultation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

medicalActor

required

Represents a medical actor identified by exactly ONE of: the healthcare professional's RPPS, the ROFIM department ID, or the ROFIM internal user ID (fallback when no RPPS is available).

firstName

string

required

lastName

string

required

gender

string

enum

Patient gender:

1: male
2: female

Allowed:

usualName

string

birthDate

date

required

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

birthPlace

object

address

object

nss

string

required

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

Patient identifiers (HL7 CX). If not provided and ipp is set, a single patientId with ipp value will be created automatically. An empty array is ignored.

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

201The created patient

400Bad Request - Validation error

401Unauthorized

403Forbidden - Assigning authority outside the client authorities, doctor or department not allowed, or duplicated doctor

404Not Found