Create a draft note
curl --request POST \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clinician_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": {},
"note_type": "<string>",
"custom_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"origin_assistant_name": "<string>",
"citations": [
{}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patient_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
clinician_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
content: {},
note_type: '<string>',
custom_template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
origin_assistant_name: '<string>',
citations: [{}]
})
};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.clinikehr.com/v1/clinics/{clinic_id}/notes"
payload = {
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clinician_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": {},
"note_type": "<string>",
"custom_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"origin_assistant_name": "<string>",
"citations": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "draft",
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"note_type": "<string>",
"is_signed": true,
"signed_at": "2023-11-07T05:31:56Z",
"origin": "staff",
"origin_assistant_name": "<string>",
"is_reviewed": true,
"reviewed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"custom_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": {},
"citations": [
{}
]
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}Notes
Create a draft note
Permission: notes:write Create a DRAFT note. Always status=draft — this route can never sign, lock, finalize or co-sign. clinician_id is the clinic_staff.id the draft is FOR, never the API caller. Unknown content keys are refused (unknown_field) naming both the offending keys and the full valid list for whichever template note_type/custom_template_id resolves to. The answer carries the new note’s details with content: null; read the note with GET …/notes/{note_id} to see its content.
POST
/
v1
/
clinics
/
{clinic_id}
/
notes
Create a draft note
curl --request POST \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clinician_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": {},
"note_type": "<string>",
"custom_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"origin_assistant_name": "<string>",
"citations": [
{}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patient_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
clinician_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
content: {},
note_type: '<string>',
custom_template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
origin_assistant_name: '<string>',
citations: [{}]
})
};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.clinikehr.com/v1/clinics/{clinic_id}/notes"
payload = {
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clinician_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": {},
"note_type": "<string>",
"custom_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"origin_assistant_name": "<string>",
"citations": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "draft",
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"note_type": "<string>",
"is_signed": true,
"signed_at": "2023-11-07T05:31:56Z",
"origin": "staff",
"origin_assistant_name": "<string>",
"is_reviewed": true,
"reviewed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"custom_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": {},
"citations": [
{}
]
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Optional. A unique value you choose for this request, such as a UUID. When sent, a retry with the same key returns the first answer instead of applying the change twice. See Retries and idempotency.
Minimum string length:
1Path Parameters
Body
application/json
clinic_staff.id — the clinician the draft is FOR, never the API caller.
Keyed by generateFieldId(section.title, index) for a template note, or free-form for a blank note. Unknown keys are refused (unknown_field), naming both the offending keys and the full valid list.
A static template's exact name, or omitted for a blank note.
This clinic's own custom template id.
When given, origin=assistant_external instead of api.
Response
OK.
Show child attributes
Show child attributes