Patients

You need to create a patient to pass through to a Test Registration.

The Patient model

The Patient model contains all the information about the Patient.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the Patient.

  • Name
    first_name
    Type
    string
    Description

    Patient First Name.

  • Name
    last_name
    Type
    string
    Description

    Patient Last Name.

  • Name
    gender
    Type
    enum
    Description

    Patient gender.

  • Name
    date_of_birth
    Type
    string
    Description

    Patient Date of Birth.

  • Name
    ethnicity
    Type
    enum
    Description

    Patient ethnicity.

  • Name
    email
    Type
    string
    Description

    Patient email address.

  • Name
    foreign_id
    Type
    string
    Description

    You can put in your own reference here to use to search in future calls

  • Name
    phone_number
    Type
    string
    Description

    Patient Phone number in e.164 format.

  • Name
    address_id
    Type
    string
    Description

    Patient address ID

POST/api/patient

Create new Patient

This endpoint allows you to create a new patient.

Attributes

  • Name
    first_name
    Type
    string
    Required
    REQUIRED
    Description

    Patient first name

  • Name
    last_name
    Type
    string
    Required
    REQUIRED
    Description

    Patient last name

  • Name
    phone_number
    Type
    string
    Required
    REQUIRED
    Description

    Patient Phone number in e.164 format.

  • Name
    email
    Type
    string
    Description

    Patient email address.

  • Name
    date_of_birth
    Type
    string
    Description

    Patient Date of Birth. Format YYYY-MM-DD

  • Name
    gender
    Type
    enum
    Description

    Patient gender.

Returns

Returns the Patient object if successful.

Request

POST
/api/patient
curl -G https://api.londonmedicallaboratory.com/api/patient/ \
  -H "Authorization: Bearer {token}" \
  --data-raw '{
  "first_name": "John",
  "last_name": "Smith",
  "phone_number": "44749123456",
  "email": "john@example.com",
  "date_of_birth": "1976-01-01",
  "gender": "male"
}'

Response

{
    "id": "41b11600-e8dd-4a4b-b3d2-a2d490de4b2a",
    "first_name": "John",
    "last_name": "Smith",
    "gender": "male",
    "date_of_birth": "1976-01-01",
    "ethnicity": null,
    "email": "john@example.com",
    "foreign_id": null,
    "phone_number": "44749123456",
    "address_id": null
}