Create Patient's Chart Note

POST

/api/service/v1/patient/chart-note

This endpoint allows you to add a chart note for a specific patient.

Path Variables: None

Query Parameters: None

Request Body:

Field	Type	Description
patient_id	integer	Required. Id of patient returned from create patient API.
note_category_id	integer	Optional. Note Category id to which you want to attach this patient note. If not available then notes will be attached to default note category.
note	string	Required. Any markdown text you want to add as a patient note.

Success Response:

{
"message": "Clinical note added successfully.",
"id": {{id}},
"patient_id": {{patientId}},
"note_category_id": {{note_category_id}},
"note": {{chart_note}}}

Failure Response:

{
    "error_message": "Request Failed. The selected patient id is invalid. "
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Example

{
	"patient_id": {{patient_id}},
	"note": {{chart_note}}
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/service/v1/patient/chart-note' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
	"patient_id": {{patient_id}},
	"note": {{chart_note}}
}'

Responses

🟢200Example

application/json

Body

Example

{
    "message": "Clinical note added successfully.",
    "id": {{id}},
    "patient_id": {{patientId}},
    "note_category_id": {{note_category_id}},
    "note": {{chart_note}}
}

Modified at 2024-08-01 04:57:23

Assign Service to Patient

Get Provider's Appointment Slots