List

Fetch a list of patients available in the users organization.

Request

GET /v1/patients

Response

HTTP Status code

200

Body

{
  "data": [
    {
      "id": "9890ed24-405d-4688-abcd-b7f829d75939",
      "createdAt": "2024-09-17T15:45:00+02:00",
      "updatedAt": "2024-09-17T15:45:00+02:00",
      "activatedAt": "2023-05-23T16:00:00+02:00",
      "timezone": "Europe/Amsterdam",
      "language": "nl",
      "firstName": "Alice",
      "middleName": "van",
      "lastName": "Baker",
      "dateOfBirth": "2023-05-23",
      "sex": "female",
      "status": "active",
      "email": "[email protected]",
      "phone": "+31612345678",
      "accountName": "patient-1",
      "identifiers": [
        {
          "use": null,
          "type": {
            "coding": [
              {
                "system": "https://fhir.nhs.uk/Id/nhs-number",
                "code": "1234567890",
              }
            ]
          },
          "system": "https://fhir.nhs.uk/Id/nhs-number",
          "value": "1234567890",
          "assigner": null
        }
      ],
      "organization": {
        "id": "9890ed24-405d-4688-abcd-b7f829d75939",
        "name": "Hill Valley Hospital",
        "parentId": "9890ed24-405d-4688-abcd-b7f829d75939",
        "parentName": "string"
      },
      "group": {
        "id": "9890ed24-405d-4688-abcd-b7f829d75939",
        "name": "Test group"
      },
      "program": {
        "id": "9890ed24-405d-4688-abcd-b7f829d75939",
        "name": "Heart Failure Program",
        "startDate": "2023-05-23",
        "endDate": "2023-05-23"
      },
      "protocol": {
        "id": "9890ed24-405d-4688-abcd-b7f829d75939",
        "name": "Patient intake protocol"
      }
    }
  ],
  "meta": {}
}

Example

GET /v1/patients HTTP/1.1
Authorization: Bearer <api-key>
Host: api.luscii.com

HTTP/1.1 200 OK
Content-Type: application/json

{"meta":{"perPage":25,"nextCursor":"eyJpZCI6InBhdF8xMjM0NSJ9","nextPageUrl":"/v1/patients?cur
sor=eyJpZCI6InBhdF8xMjM0NSJ9","prevCursor":null,"prevPageUrl":null},"data":[{"id":"pat_12345"
,"createdAt":"2025-08-20T10:15:00Z","updatedAt":"2025-08-22T14:30:00Z","activatedAt":"2025-08
-21","timezone":"Europe/Amsterdam","language":"nl","firstName":"Jane","middleName":null,"last
Name":"Doe","dateOfBirth":"1975-02-20","sex":"female","status":"active","email":"jane.doe@exa
mple.com","phone":"+31612345678","accountName":"jane.doe","identifiers":[{"system":"hospital_
mrn","value":"A123456"}],"organization":{"id":"org_98765","name":"General Hospital","parentId
":null},"group":{"id":"grp_54321","name":"Cardiology"},"program":{"id":"prg_24680","name":"He
art Health Program"},"protocol":{"id":"prt_13579","name":"Cardiac Monitoring v1"}}]}

Get

Retrieve a specific user. This endpoint needs to be called with an API key with sufficient permissions for the requested user.

Request

Endpoint

GET /v1/patients/{patientId}

Path Parameters

Name	Type	Description
patientId `required`	string	Universal Unique Identifier for the patient e.g. `338ba7d5-4e7a-4784-9162-72dadd6233a8`

Response

HTTP Status code

200

Body

{
  "data": {
    "id": "9ee96ce4-7be7-4f37-b2cc-ff546a088244",
    "createdAt": "2024-02-17T12:34:56+01:00",
    "updatedAt": "2024-03-14T12:34:56+01:00",
    "activatedAt": "2024-02-17",
    "timezone": "Europe/Amsterdam",
    "language": "nl",
    "firstName": "Alice",
    "middleName": "van",
    "lastName": "Baker",
    "dateOfBirth": "2000-02-17",
    "sex": "female",
    "status": "active",
    "email": "[email protected]",
    "phone": "Unknown Type: string,null",
    "accountName": "patient-1",
    "identifiers": [
      {
        "use": "string",
        "type": {
          "coding": [
            {
              "system": "string",
              "code": "string",
              "display": "string"
            }
          ]
        },
        "system": "string",
        "value": "string",
        "assigner": {
          "display": "string"
        }
      }
    ],
    "organization": {
      "id": "4e2aeab7-0386-4a21-8bb5-6271d3ded7c7",
      "name": "Hill Valley Hospital",
      "parentId": "Unknown Type: string,null",
      "parentName": "Unknown Type: string,null"
    },
    "group": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Test group"
    },
    "program": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Heart Failure Program",
      "startDate": "2024-02-17",
      "endDate": "2024-02-17"
    },
    "protocol": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Patient intake protocol"
    }
  },
  "errors": [
    {
      "code": "string",
      "message": "string",
      "attribute": "string"
    }
  ],
  "meta": {}
}

Example

GET /v1/patients/338ba7d5-4e7a-4784-9162-72dadd6233a8 HTTP/1.1
Authorization: Bearer <api-key>
Host: api.luscii.com

HTTP/1.1 200 OK
Date: Wed, 30 Apr 2024 11:03:24 GMT
Content-Type: application/json

{"data":{"id":"9ee96ce4-7be7-4f37-b2cc-ff546a088244","createdAt":"2024-02-17T12:34:56+01:00",
"updatedAt":"2024-03-14T12:34:56+01:00","activatedAt":"2024-02-17","timezone":"Europe/Amsterd
am","language":"nl","firstName":"Alice","middleName":"van","lastName":"Baker","dateOfBirth":"
2000-02-17","sex":"female","status":"active","email":"[email protected]","phone":"Un
known Type: string,null","accountName":"patient-1","identifiers":[{"use":"string","type":{"co
ding":[{"system":"string","code":"string","display":"string"}]},"system":"string","value":"st
ring","assigner":{"display":"string"}}],"organization":{"id":"4e2aeab7-0386-4a21-8bb5-6271d3d
ed7c7","name":"Hill Valley Hospital","parentId":"Unknown Type: string,null","parentName":"Unk
nown Type: string,null"},"group":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Test gr
oup"},"program":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Heart Failure Program","
startDate":"2024-02-17","endDate":"2024-02-17"},"protocol":{"id":"3fa85f64-5717-4562-b3fc-2c9
63f66afa6","name":"Patient intake protocol"}},"errors":[{"code":"string","message":"string","
attribute":"string"}],"meta":{}}

Create

Request

POST /v1/patients

JSON Body Parameters

Name	Type	Description
accountName `required`	`string`	Username for the patient, must be globally unique
email `required`	`string`	Email address for the patient
patientNumber	`string`	A patient number
organizationId `required`	`uuid`	The identifier of the organization in which to create the patient
groupId `required`*	`uuid`	The identifier of the group in which to create the patient *If your organization has care networks enabled this property is instead prohibited.
programId `required`	`uuid`	The identifier of the program which the patient will be enrolled for
protocolId `required`	`uuid`	The identifier of the protocol which the patient will be enrolled for
smsLoginEnabled	`boolean`	Wether sms login will be enabled for the patient
timezone	`string`	Timezone of the patient, if not defined will default to `Europe/Amsterdam`
language	`string`	Language of the patient, one of: `nl`, `en`, `en_US`, `de`, `fr`
comments	`string`	Any optional comments added to the patient
firstName `required`	`string`	First name of the patient
middleName	`string`	Middle name of the patient
lastName `required`	`string`	Last name of the patient
dateOfBirth	`ISO 8601 date`	Date of birth of the patient
phoneNumber	`string`	Phone number of the patient in e.164 international phone number format, `required` if `smsLoginEnabled` is `true`
sex `required`	`string`	Born sex of the patient, either `male` or `female`
addressCountry	`string`	2 letter country code of the patients residence country i.e. `nl`,`de`,...
addressCity	`string`	City of residence for the patient
addressPostalCode	`string`	Postal code of the patients residence
addressStreet	`string`	Street name of the patients residence
addressHouseNumber	`string`	House number of the patients residence
addressHouseNumberSuffix	`string`	House number suffix of the patients residence

Response

HTTP Status code

201

Body

{
  "data": {
    "id": "9ee96ce4-7be7-4f37-b2cc-ff546a088244",
    "createdAt": "2024-02-17T12:34:56+01:00",
    "updatedAt": "2024-03-14T12:34:56+01:00",
    "activatedAt": "2023-05-23T16:00:00+02:00",
    "timezone": "Europe/Amsterdam",
    "language": "nl",
    "firstName": "Alice",
    "middleName": "van",
    "lastName": "Baker",
    "dateOfBirth": "2000-02-17",
    "sex": "female",
    "status": "active",
    "email": "[email protected]",
    "phone": "+31612345678",
    "accountName": "patient-1",
    "identifiers": [
      {
        "use": null,
        "type": {
          "coding": [
            {
              "system": "https://fhir.nhs.uk/Id/nhs-number",
              "code": "1234567890",
            }
          ]
        },
        "system": "https://fhir.nhs.uk/Id/nhs-number",
        "value": "1234567890",
        "assigner": null
      }
    ],
    "organization": {
      "id": "4e2aeab7-0386-4a21-8bb5-6271d3ded7c7",
      "name": "Hill Valley Hospital",
      "parentId": "Unknown Type: string,null",
      "parentName": "Unknown Type: string,null"
    },
    "group": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Test group"
    },
    "program": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Heart Failure Program",
      "startDate": "2024-02-17",
      "endDate": "2024-02-17"
    },
    "protocol": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Patient intake protocol"
    }
  },
  "errors": [
    {
      "code": "string",
      "message": "string",
      "attribute": "string"
    }
  ],
  "meta": {}
}

Example

POST /v1/patients HTTP/1.1
Authorization: Bearer <api-key>
Host: api.luscii.com
Content-Type: application/json

{"accountName":"john.smith","email":"[email protected]","patientNumber":"P123456","organiz
ationId":"org_98765","groupId":"grp_54321","programId":"prg_24680","protocolId":"prt_13579","sm
sLoginEnabled":true,"timezone":"Europe/Amsterdam","language":"nl","comments":"Patient enrolled 
via cardiology department.","firstName":"John","middleName":null,"lastName":"Smith","dateOfBirt
h":"1980-10-15","phoneNumber":"+31698765432","sex":"male","addressCountry":"NL","addressCity":"
Amsterdam","addressPostalCode":"1011AB","addressStreet":"Damrak","addressHouseNumber":"1","addr
essHouseNumberSuffix":"A"}

HTTP/1.1 201 Created
Content-Type: application/json

{"status":"success","meta":{"timestamp":"2025-08-26T09:30:00Z"},"data":{"id":"pat_67890","creat
edAt":"2025-08-26T09:30:00Z","updatedAt":"2025-08-26T09:30:00Z","activatedAt":null,"timezone":"
Europe/Amsterdam","language":"nl","firstName":"John","middleName":null,"lastName":"Smith","dateOfBirth":"1980-10-15","sex":"male","status":"active","email":"[email protected]","phone":"
+31698765432","accountName":"john.smith","identifiers":[{"system":"hospital_mrn","value":"P1234
56"}],"organization":{"id":"org_98765","name":"General Hospital","parentId":null},"group":{"id"
:"grp_54321","name":"Cardiology"},"program":{"id":"prg_24680","name":"Heart Health Program"},"p
rotocol":{"id":"prt_13579","name":"Cardiac Monitoring v1"}}}