Skip to main content
POST
/
v1
/
notes
Create clinical note
curl --request POST \
  --url https://api.clinikapi.com/v1/notes \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "patientId": "<string>",
  "title": "<string>",
  "content": "<string>",
  "authorId": "<string>",
  "encounterId": "<string>",
  "contentType": "text/plain",
  "category": "<string>",
  "date": "<string>",
  "relatesTo": [
    {
      "targetId": "<string>"
    }
  ],
  "securityLabel": [
    {
      "system": "<string>",
      "code": "<string>",
      "display": "<string>"
    }
  ],
  "authenticatorId": "<string>",
  "custodianId": "<string>",
  "servicePeriod": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "facilityType": "<string>",
  "practiceSetting": "<string>"
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
patientId
string
required
title
string
required
Maximum string length: 500
content
string
required
Maximum string length: 100000
authorId
string

Practitioner who authored the note

encounterId
string
type
enum<string>
Available options:
progress-note,
discharge-summary,
consultation-note,
history-and-physical,
operative-note,
procedure-note,
referral-note,
transfer-summary,
other
contentType
string
default:text/plain
docStatus
enum<string>
Available options:
preliminary,
final,
amended
category
string
Maximum string length: 100
date
string
relatesTo
object[]

Relationships to other documents

securityLabel
object[]

Document security tags

authenticatorId
string

Who authenticated the document (Practitioner ID)

custodianId
string

Organization maintaining the document

servicePeriod
object

Time period of the clinical service documented

facilityType
string

Kind of facility where patient was seen

Maximum string length: 200
practiceSetting
string

Clinical specialty (e.g. cardiology, oncology)

Maximum string length: 200

Response

201

Note created