Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Cases

Create Case

This endpoint creates a new medical case.

post/mr/api/v1/cases

Headers

X-Pt-Idstring required

Patient ID

Request body

idstring required

Unique identifier for the case.

display_namestring required

Human-readable name for the case

hi_type'OPConsultation' | 'Prescription' | 'DischargeSummary' | 'DiagnosticReport' | 'ImmunizationRecord' | 'HealthDocumentRecord' | 'WellnessRecord'

Type of case

occurred_atinteger required

Timestamp when the event occurred (Unix timestamp)

typestring

Type of the case

partner_metaobject

metadata attached to the case.

Example request

{
  "id": "CASE_ID",
  "display_name": "Leg Injury",
  "hi_type": "OPConsultation",
  "occurred_at": 1678886400,
  "type": "OP",
  "partner_meta": {
    "facility_id": "GH",
    "uhid": "UHID_1234"
  }
}

Response

Case created successfully

idstring

Unique identifier for the newly created case

Example response

{
  "id": "case_12345"
}