curl --request POST \
--url https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"patient_id": 123,
"form_id": 123,
"data": {},
"appointment_id": 123,
"state": "final",
"appt_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
'import requests
url = "https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes"
payload = {
"patient_id": 123,
"form_id": 123,
"data": {},
"appointment_id": 123,
"state": "final",
"appt_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patient_id: 123,
form_id: 123,
data: {},
appointment_id: 123,
state: 'final',
appt_date: '2023-12-25',
created_at: '2023-11-07T05:31:56Z',
metadata: {}
})
};
fetch('https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'patient_id' => 123,
'form_id' => 123,
'data' => [
],
'appointment_id' => 123,
'state' => 'final',
'appt_date' => '2023-12-25',
'created_at' => '2023-11-07T05:31:56Z',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes"
payload := strings.NewReader("{\n \"patient_id\": 123,\n \"form_id\": 123,\n \"data\": {},\n \"appointment_id\": 123,\n \"state\": \"final\",\n \"appt_date\": \"2023-12-25\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"patient_id\": 123,\n \"form_id\": 123,\n \"data\": {},\n \"appointment_id\": 123,\n \"state\": \"final\",\n \"appt_date\": \"2023-12-25\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patient_id\": 123,\n \"form_id\": 123,\n \"data\": {},\n \"appointment_id\": 123,\n \"state\": \"final\",\n \"appt_date\": \"2023-12-25\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"source": "form_response",
"patient_id": 123,
"form_id": 123,
"form_type": "practitioner",
"form_name": "<string>",
"data": {},
"state": "draft",
"pinned": true,
"created_at": "2026-09-01T14:31:00Z",
"updated_at": "2026-09-01T14:31:00Z",
"appt_date": "2023-12-25",
"practitioner": {},
"note_author": {},
"appointment": {},
"canvases": {},
"formatted_fields": [
{}
],
"formatted_soap": {},
"spinal_codes": [
{}
],
"scribe_attachment": {},
"files": [
{}
],
"patient_details": [
{}
],
"form_schema": {},
"revision_number": 123,
"is_current": true,
"previous_revision_id": 123,
"revised_by_uid": 123,
"finalized_at": "2023-11-07T05:31:56Z",
"finalized_by_uid": 123,
"metadata": {}
}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}Create a clinical note
Creates a finalized (or draft) clinical note on the patient record, filed against one of the account’s own practitioner/scribe form templates (form_id — list /form_templates to find one and see its fields). Allowed to integration keys with the write scope, and to connected assistants whose PracticeHub role allows patient visit notes (own-patients limits apply; a role restricted to saving drafts always creates drafts). Answer keys not defined by the form’s schema are refused (unknown_field) so imported content can never be silently dropped. For historical imports, created back-dates the note so it keeps its place in the record’s chronology.
curl --request POST \
--url https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"patient_id": 123,
"form_id": 123,
"data": {},
"appointment_id": 123,
"state": "final",
"appt_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
'import requests
url = "https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes"
payload = {
"patient_id": 123,
"form_id": 123,
"data": {},
"appointment_id": 123,
"state": "final",
"appt_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patient_id: 123,
form_id: 123,
data: {},
appointment_id: 123,
state: 'final',
appt_date: '2023-12-25',
created_at: '2023-11-07T05:31:56Z',
metadata: {}
})
};
fetch('https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'patient_id' => 123,
'form_id' => 123,
'data' => [
],
'appointment_id' => 123,
'state' => 'final',
'appt_date' => '2023-12-25',
'created_at' => '2023-11-07T05:31:56Z',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes"
payload := strings.NewReader("{\n \"patient_id\": 123,\n \"form_id\": 123,\n \"data\": {},\n \"appointment_id\": 123,\n \"state\": \"final\",\n \"appt_date\": \"2023-12-25\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"patient_id\": 123,\n \"form_id\": 123,\n \"data\": {},\n \"appointment_id\": 123,\n \"state\": \"final\",\n \"appt_date\": \"2023-12-25\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{clinic}.{region}.practicehub.io/v3/api/clinical_notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patient_id\": 123,\n \"form_id\": 123,\n \"data\": {},\n \"appointment_id\": 123,\n \"state\": \"final\",\n \"appt_date\": \"2023-12-25\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"source": "form_response",
"patient_id": 123,
"form_id": 123,
"form_type": "practitioner",
"form_name": "<string>",
"data": {},
"state": "draft",
"pinned": true,
"created_at": "2026-09-01T14:31:00Z",
"updated_at": "2026-09-01T14:31:00Z",
"appt_date": "2023-12-25",
"practitioner": {},
"note_author": {},
"appointment": {},
"canvases": {},
"formatted_fields": [
{}
],
"formatted_soap": {},
"spinal_codes": [
{}
],
"scribe_attachment": {},
"files": [
{}
],
"patient_details": [
{}
],
"form_schema": {},
"revision_number": 123,
"is_current": true,
"previous_revision_id": 123,
"revised_by_uid": 123,
"finalized_at": "2023-11-07T05:31:56Z",
"finalized_by_uid": 123,
"metadata": {}
}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}Authorizations
API key from Developers → API Keys, sent as Authorization: Bearer .
Headers
Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.
255Body
The patient the note belongs to
An active practitioner/scribe form template of the account to file the note against — list /form_templates to find one
Answers keyed by the form schema's field names (the template's schema lists them). Keys the schema does not define are refused (unknown_field)
The documented appointment; must belong to the patient
final stamps finalized_at / finalized_by
draft, final Defaults to the form's own type
practitioner, scribe Date of the documented visit
Historical-import override, UTC: back-dates the note's created_at/updated_at (and, for a final note, finalized_at) so imports keep their chronology
Integrator-owned key/value metadata (max 50 keys). Values are strings (≤500 chars), numbers or booleans and read back with the type they were written with. On write, a null value removes the key. Filter with metadata[key]=op:value; number operands compare numerically.
Show child attributes
Show child attributes
Response
The clinical note
A clinical note in the unified note shape the app itself reads: the raw answers (data, keyed by the form schema's field names), the human-readable rendering (formatted_fields, resolved against the schema snapshot taken when the note was written), and the note's clinical context.
Show child attributes
Show child attributes
Was this page helpful?