Patient

Upsert d'un patient

Un endpoint unique d'insertion et de mise à jour (Upsert) de patient est mis à disposition des intégrateurs.

Il vous permet d'envoyer systématiquement toutes les informations nécessaires dont vous disposez pour cet utilisateur. Cela vous évite de maintenir une table de correspondance pour savoir quels sont les enregistrements déjà créés.

Endpoint

[PUT] /v1/Patient/:externalId

Le paramètre :externalId dans le path correspond à l'identifiant du patient dans votre système. Ce fonctionnement permet d'éviter de votre côté l'enregistrement d'une table de correspondance entre nos identifiants internes et les votres.

Authentification

Cette appel ne peut -être effectué que grâce à la clé API, il ne demande aucune délégation utilisateur.

X-Api-Key: [YOUR-API-KEY]

Format d'entrée

Le format d'entrée est du JSON, il faudra le fixer avec l'entête HTTP:

Content-Type: application/json

Propriété	Libellé	Description
first_name	Prénom du patient
last_name	Nom du patient
phone_number	Numéro de téléphone mobile	Format international ou local
country_code	Code pays du numéro de téléphone	Code ISO 3166-1 alpha-2 pour validation du numéro de téléphone si format local fourni
gender	Sexe du patient	MALE (homme) ou FEMALE (femme)
email	Addresse email du patient
birth_date	Date de naissance du patient	Format YYY-mm-dd

Exemple

{
  "first_name": "Jeanne",
  "last_name": "MARTIN",
  "phone_number": "+33698400000",
  "country_code": "FR"
  "gender": "MALE",
  "email": "sylvain@hellocare.com",
  "birth_date": "1982-02-06"
}

Format de sortie

Le format de sortie est du JSON. Le code retour HTTP vous indiquera si la ressource a été créée (code 201) ou mise à jour (code 200).

Exemple

{
    "patient": {
        "uid": "5c46d3bf-38c0-4ef4-8ef9-1242d5588411",
        "created_at": "2018-07-11T14:48:40+00:00",
        "email": "jeanne.martin@example.com",
        "profile": {
            "first_name": "Jeanne",
            "last_name": "MARTIN",
            "gender": "MALE",
            "phone_number": "+33698400000",
            "email": "jeanne.martin@example.com",
            "birth_date": "1954-09-26T00:00:00+00:00",
            "age": 63
        },
        "organization": {
            "uid": "9826fe6d-cdb0-4a0c-9632-041b3168b950",
            "name": "Future Corp.",
            "code": "future",
            "logo": "https://hehp.imgix.net/f1976b49-dd35-4bbf-83fd-2095bb9aa6a2.ai"
        }
    }
}