Create a Patient

post

https://patient-api.portals.care/users

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Use this POST request to create a new patient account.

In the request body, you must provide the following data of the patient:

email
firstName
lastName
gender
phone
dob (date of birth).

Body Params

A Data Transfer Object (DTO) for registering a new patient user. This schema requires essential patient information to create an account.

string

required

The patient's email address. Must be a valid format and unique within the system.

password

string

The patient's password. It must meet security requirements, including minimum length and character complexity.

firstName

string

required

The patient's first name.

lastName

string

required

The patient's last name.

gender

object

required

The patient's gender.

phone

string

required

The patient's phone number, with digits only. The system will format it with the country code.

uname

string

A unique username formatted as email#organization. This field is often automatically generated by the system.

roles

array of strings

An array of roles assigned to the patient. For patient users, this is typically ['patient'].

roles

dob

string

required

The patient's date of birth in YYYY-MM-DD format.

meta

object

Additional metadata about the patient.

notificationsCount

number

The count of unread notifications for the patient. Defaults to 0 upon creation.

emrId

number

The unique identifier for the patient in an external Electronic Medical Record (EMR) system.

referrer

string

The identifier of the referrer, if the patient was referred by another user.

hcCard

object

An object containing the patient's health card information.

acceptMarketing

boolean

A boolean indicating whether the patient accepts marketing communications.

isInsuranceAvailable

boolean

A boolean indicating if insurance information is available for the patient. Defaults to false.

providers

array of strings

An array of provider IDs associated with the patient.

providers

verifications

object

An object containing verification statuses, such as email or phone number verification.

provinceCode

string

The two-letter province or state code of the patient's primary address.

groups

array of strings

An array of group IDs the patient is a member of.

groups

Headers

organization

string

Your unique Organization ID. This header is only required when using a custom portal domain, otherwise it is optional.

Response

Language

Loading…

Response

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

application/json

201