Create patient

post

https://vitalsapi.luscii.com/v1/patients

Create a patient with the given data

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Accessible by HC_ADMIN, HC_PRIMARY, and HC_SECONDARY.

Body Params

Supported fields for patient creation

accountName

string

Patient account name

string

Patient email address

patientNumber

string | null

Patient number (identifier for the patient, will result in a FHIR identifier (PI))

organizationId

uuid

UUID of the organization the patient belongs to

groupId

uuid

UUID of the group the patient belongs to

programId

uuid

Program UUID

protocolId

uuid

Protocol UUID

smsLoginEnabled

boolean | null

Enable OTP login via SMS

timezone

string | null

Time zone (defaults to CET)

language

string | null

Language in two-letter ISO code

comments

string | null

Additional notes or metadata

firstName

string

The patient's first name.

middleName

string | null

The patient's middle name, if any.

lastName

string

The patient's last name.

dateOfBirth

date | null

Date of birth

phoneNumber

string

Phone number in E.164 format

sex

string

enum

Patient sex (male or female)

Allowed:

addressCountry

string | null

ISO-3166-1 country code

addressCity

string | null

City name

addressPostalCode

string | null

Postal code

addressStreet

string | null

Street name

addressHouseNumber

string | null

House number

addressHouseNumberSuffix

string | null

House number suffix

identifiers

array of objects

The patient's identifiers in FHIR format.

identifiers

Responses

403

Forbidden, e.g. trying to access the endpoint without authorization

422

Unprocessable entity, i.e. Validation error

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

201The created patient