Patients

Clarity can help you truly understand your Patient on a deeper level than ever before. On this page, we'll dive into the different endpoints you can use to manage your Patients for our GPT, eFax or EHR systems.

The Patient model

The patient model contains all the information about your Patients and their documents. It also contains a reference to the conversation between you and the Patient with information about when they were last active on Clarity.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the Patient.

  • Name
    firstname
    Type
    string
    Description

    First Name for the Patient.

  • Name
    lastname
    Type
    string
    Description

    Last Name for the Patient.

  • Name
    files
    Type
    array
    Description

    File array for Patient

GET/v1/patient

List all Patients

This endpoint allows you to retrieve a list of all your Patients created by you our synced by one of your integrations.

Request

GET
/v1/patient
curl -G https://api.clarityapp.ai/v1/patient \
  -H "Authorization: Bearer {token}"

Response

{
  "demographics": {
    "firstName": "string",
    "lastName": "string"
  },
  "files": {
    "fileName": "eFax.pdf"
  }
}
POST/v1/patient

Create a Patient

This endpoint allows you to add a new Patient to your Patient list in Patients. Clarity stores basic Patient information such as First Name

Required attributes

  • Name
    firstName
    Type
    string
    Description

    The First Name of the Patient

  • Name
    lastName
    Type
    string
    Description

    The Last Name of the Patient

Optional attributes

  • Name
    file
    Type
    array
    Description

    The array of files for the Patient

Request

POST
/v1/patient
curl https://api.clarityapp.ai/v1/patient \
  -H "Authorization: Bearer {token}"

Response

  {
    "uploadUrl": "string",
    "instructions": "string"
  }
GET/v1/patient/:id

Retrieve a Patient

This endpoint allows you to retrieve a Patient by providing their id. Refer to the list at the top of this page to see which properties are included with contact objects.

Request

GET
/v1/patient/:id
curl https://api.clarityapp.ai/v1/patient/WAz8eIbvDR60rouK \
  -H "Authorization: Bearer {token}"

Response

  {
    "demographics": {
      "firstName": "string",
      "lastName": "string"
    }
  }
PUT/v1/patient/:id

Update a Patient

This endpoint allows you to perform an update on a Patient.

Optional attributes

  • Name
    firstName
    Type
    string
    Description

    First Name of the Patient

  • Name
    lastName
    Type
    string
    Description

    Last Name of the Patient

  • Name
    files
    Type
    array
    Description

    File array of the Patient

Request

PUT
/v1/patient/WAz8eIbvDR60rouK
curl -X PUT https://api.clarityapp.ai/v1/patient/WAz8eIbvDR60rouK \
  -H "Authorization: Bearer {token}" \
  -d display_name="UncleFrank"

Response

  {
    "patient": {
      "firstName": "Kevin",
      "lastName": "Smith"
    },
    "file": {
      "fileName": "eFax.pdf",
      "fileName": "clinincaldocument.pdf"
    }
  }
DELETE/v1/patient/:id

Delete a Patient

This endpoint allows you to delete Patients from your Patient List. This method just deletes it from Clarity not from your integrated system. If you do have a full sync of an EHR activated this Patient will re-appear until you change your syncing logic.

Request

DELETE
/v1/patient/WAz8eIbvDR60rouK
curl -X DELETE https://api.clarityapp.ai/v1/patient/WAz8eIbvDR60rouK \
  -H "Authorization: Bearer {token}"

Was this page helpful?