Patient

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":{}}