Skip to main content
POST
/
user
/
patient
/
{patient_id}
/
ai-summary
Save Patient Ai Summary
curl --request POST \
  --url https://api.decodahealth.com/user/patient/{patient_id}/ai-summary \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "summary": "<string>",
  "suggestions": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "patientId": "<string>",
  "summary": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "suggestions": [
    "<string>"
  ],
  "feedbackType": "POSITIVE",
  "feedbackText": "<string>",
  "feedbackProviderId": "<string>",
  "updatedDate": "2023-11-07T05:31:56Z"
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Path Parameters

​
patient_id
string
required

Body

application/json

Schema for creating/updating a patient AI summary.

​
summary
string
required

The AI-generated summary text to save

​
suggestions
string[] | null

AI-generated follow-up question suggestions

Response

Successful Response

Detail schema for patient AI summary.

​
id
string
required

Unique identifier for the summary

​
patientId
string
required

ID of the patient this summary belongs to

​
summary
string
required

The AI-generated summary text

​
createdDate
string<date-time>
required

When the summary was created

​
suggestions
string[] | null

AI-generated follow-up question suggestions

​
feedbackType
enum<string> | null

Type of feedback (positive/negative)

Available options:
POSITIVE,
NEGATIVE
​
feedbackText
string | null

Optional feedback text

​
feedbackProviderId
string | null

ID of provider who gave feedback

​
updatedDate
string<date-time> | null

When the summary was last updated