Skip to main content
POST
Create Case

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Pt-Id
string
required

Patient ID

Body

application/json
id
string
required

Unique identifier for the case.

Example:

"CASE_ID"

display_name
string
required

Human-readable name for the case

Example:

"Leg Injury"

occurred_at
integer<unixtime>
required

Timestamp when the event occurred (Unix timestamp)

Example:

1678886400

hi_type
enum<string>

Type of case

Available options:
OPConsultation,
Prescription,
DischargeSummary,
DiagnosticReport,
ImmunizationRecord,
HealthDocumentRecord,
WellnessRecord
Example:

"OPConsultation"

type
string

Type of the case

Example:

"OP"

partner_meta
object

metadata attached to the case.

Example:

Response

Case created successfully

id
string

Unique identifier for the newly created case

Example:

"case_12345"