Clarity Patient GPT

Patient GPT allows you to ask any question of Patient data through the lens of your compliance documentation. The output of the prompts can be files or if you have an EHR integration you can push the output into a secondary system.

The GPT model

The GPT model allows you to interact with your Patient records. You can use this model to transform a Patient record collection into any other format like FHIR, HL7, or your own unique JSON format.

Use-Cases for Prompts

Please convert my Patient into FHIR R4
Please summarize and display to me or to my EHR
Ask a Clinical or Diagnosis question of a Patient
Please convert a Patient record into my own JSON file and return

Properties

Name
input
Type
string
Description
Your prompt for the Patient data.
Name
conversationId
Type
string
Description
The ID of the Conversation initiated.

POST/v1/patients/:patientId/ask

Create a Conversation

This endpoint allows you to create a new conversation between you and your Patient data.

Required attributes

Name
patientId
Type
string
Description
The ID of your Patient

Request

GET

/v1/patients/:patientId:/answer

curl https://api.clarityapp.ai/v1/patients/:patientId/ask \
  -H "Authorization: Bearer {token}"

Response

{
  "jobId": "string"
}

GET/v1/patients/:patientId/answer

Retrieve a Conversation

This endpoint allows you to retrieve an Answer previously asked by passing your JobId. Refer to the list at the top of this page to see which properties are included with group objects.

Required attributes

Name
patientId
Type
string
Description
The ID of your Patient
Name
jobId
Type
string
Description
Job ID of your question

Request

GET

/v1/groups/L7cGNIBKZiNJ6wqF

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

Response

{
  "result": {
    "answer": "string"
  }
}