Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

The API requires a Bearer token (JWT) for authentication.

Headers

X-Pt-Id
string

Eka User ID (OID)

X-Partner-Pt-Id
string

Partner User ID

X-Hip-Id
string

Partner HIP ID

Body

application/json
patient
object
required
period
object
required
purpose
enum<string>
required
Available options:
Self Requested,
Care management,
Public Health,
Disease Specific Health Research
record_types
string[] | null
required

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

appointment_id
string
care_contexts
object[]

This is Optional, mostly used in the context of subscription documents and auto approval

hip_identifier
object

This is Optional, mostly used in the context of subscription documents and auto approval

hiu
object

Response

No Content