@platform/sdk-patient-graph
Typed TypeScript client for services/patient-graph. The page is generated from the SDK package source plus its generated OpenAPI types.
Installation
npm install @platform/sdk-patient-graphYou’ll also need the shared auth/client helpers:
npm install @platform/hosts @platform/sdkQuick start
import { LoopClient } from "@platform/sdk";
import { platformHost, SERVICE_NAMES } from "@platform/hosts";
import { createPatientGraphClient } from "@platform/sdk-patient-graph";
const loop = new LoopClient({
clientId: process.env.LOOP_CLIENT_ID!,
clientSecret: process.env.LOOP_CLIENT_SECRET!,
redirectUri: "https://your-app.example.com/auth/loop/callback",
});
const patientGraph = createPatientGraphClient({
baseUrl: platformHost({ service: SERVICE_NAMES.PATIENT_GRAPH }),
accessToken: tokens.access_token,
});Use the convenience helpers below when the SDK exposes them, or call the typed endpoint methods directly with GET / POST / PATCH / DELETE.
Convenience helpers
deleteMyJournalEntry
Underlying REST endpoint: DELETE /v1/patients/me/journal/\{date\}
Parameters
date: string
Return type
Promise<{
data?: paths["/v1/patients/me/journal/{date}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.deleteMyJournalEntry("<date>");endProtocol
Underlying REST endpoint: DELETE /v1/patients/me/enrollments/\{protocol_slug\}
Parameters
protocolSlug: string
Return type
Promise<{
data?: paths["/v1/patients/me/enrollments/{protocol_slug}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.endProtocol("<protocolSlug>");listMyAuditLog
Underlying REST endpoint: GET /v1/audit-log/me
Parameters
query?: ListMyAuditLogQuery
Return type
Promise<{
data?: paths["/v1/audit-log/me"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.listMyAuditLog({
/* ListMyAuditLogQuery */
});listMyEnrollments
Underlying REST endpoint: GET /v1/patients/me/enrollments
Parameters
None
Return type
Promise<{
data?: paths["/v1/patients/me/enrollments"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.listMyEnrollments();listMyJournal
Underlying REST endpoint: GET /v1/patients/me/journal
Parameters
range: { from: string; to: string }
Return type
Promise<{
data?: paths["/v1/patients/me/journal"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.listMyJournal({
/* { from: string; to: string } */
});listMySavedProtocols
Underlying REST endpoint: GET /v1/saved-protocols
Parameters
None
Return type
Promise<{
data?: paths["/v1/saved-protocols"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.listMySavedProtocols();resetMyIntake
Underlying REST endpoint: POST /v1/patients/me/reset/intake
Parameters
None
Return type
Promise<{
data?: paths["/v1/patients/me/reset/intake"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.resetMyIntake();runTriage
Underlying REST endpoint: POST /v1/coaches/me/triage
Parameters
patients: TriagePatientInput[]
Return type
Promise<{
data?: paths["/v1/coaches/me/triage"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.runTriage([]);saveProtocol
Underlying REST endpoint: POST /v1/saved-protocols
Parameters
protocolSlug: string
Return type
Promise<{
data?: paths["/v1/saved-protocols"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.saveProtocol("<protocolSlug>");startProtocol
Underlying REST endpoint: POST /v1/patients/me/enrollments
Parameters
protocolSlug: string
Return type
Promise<{
data?: paths["/v1/patients/me/enrollments"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.startProtocol("<protocolSlug>");unsaveProtocol
Underlying REST endpoint: DELETE /v1/saved-protocols/\{protocol_slug\}
Parameters
protocolSlug: string
Return type
Promise<{
data?: paths["/v1/saved-protocols/{protocol_slug}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.unsaveProtocol("<protocolSlug>");upsertMyJournalEntry
Underlying REST endpoint: POST /v1/patients/me/journal
Parameters
body: UpsertJournalEntryInput
Return type
Promise<{
data?: paths["/v1/patients/me/journal"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.upsertMyJournalEntry({
/* UpsertJournalEntryInput */
});Endpoint calls
GET /readyz
Underlying REST endpoint: GET /readyz
Parameters
None
Return type
Promise<{
data?: paths["/readyz"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/readyz");GET /v1/adherence/calendar
Underlying REST endpoint: GET /v1/adherence/calendar
Parameters
query?: paths["/v1/adherence/calendar"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/adherence/calendar"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/adherence/calendar", {
params: {
query: {
/* paths["/v1/adherence/calendar"]["get"]["parameters"]["query"] */
},
},
});POST /v1/adherence/doses
Underlying REST endpoint: POST /v1/adherence/doses
Parameters
body: paths["/v1/adherence/doses"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/adherence/doses"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/adherence/doses", {
body: {
/* paths["/v1/adherence/doses"]["post"]["requestBody"]["content"]["application/json"] */
},
});DELETE /v1/adherence/doses/{id}
Underlying REST endpoint: DELETE /v1/adherence/doses/\{id\}
Parameters
path: paths["/v1/adherence/doses/{id}"]["delete"]["parameters"]["path"]query?: paths["/v1/adherence/doses/{id}"]["delete"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/adherence/doses/{id}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.DELETE("/v1/adherence/doses/{id}", {
params: {
path: {
id: "<id>",
},
query: {
/* paths["/v1/adherence/doses/{id}"]["delete"]["parameters"]["query"] */
},
},
});GET /v1/adherence/resolved-compounds
Underlying REST endpoint: GET /v1/adherence/resolved-compounds
Parameters
query: paths["/v1/adherence/resolved-compounds"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/adherence/resolved-compounds"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/adherence/resolved-compounds", {
params: {
query: {
/* paths["/v1/adherence/resolved-compounds"]["get"]["parameters"]["query"] */
},
},
});PUT /v1/adherence/sharps/me
Underlying REST endpoint: PUT /v1/adherence/sharps/me
Parameters
body: paths["/v1/adherence/sharps/me"]["put"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/adherence/sharps/me"]["put"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.PUT("/v1/adherence/sharps/me", {
body: {
/* paths["/v1/adherence/sharps/me"]["put"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/adherence/streak/me
Underlying REST endpoint: GET /v1/adherence/streak/me
Parameters
None
Return type
Promise<{
data?: paths["/v1/adherence/streak/me"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/adherence/streak/me");GET /v1/adherence/summary
Underlying REST endpoint: GET /v1/adherence/summary
Parameters
query: paths["/v1/adherence/summary"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/adherence/summary"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/adherence/summary", {
params: {
query: {
/* paths["/v1/adherence/summary"]["get"]["parameters"]["query"] */
},
},
});GET /v1/adherence/today-schedule
Underlying REST endpoint: GET /v1/adherence/today-schedule
Parameters
query: paths["/v1/adherence/today-schedule"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/adherence/today-schedule"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/adherence/today-schedule", {
params: {
query: {
/* paths["/v1/adherence/today-schedule"]["get"]["parameters"]["query"] */
},
},
});POST /v1/admin/data-quality/monitor
Underlying REST endpoint: POST /v1/admin/data-quality/monitor
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/data-quality/monitor"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/admin/data-quality/monitor");GET /v1/admin/dose-reminders/candidates
Underlying REST endpoint: GET /v1/admin/dose-reminders/candidates
Parameters
query?: paths["/v1/admin/dose-reminders/candidates"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/admin/dose-reminders/candidates"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/admin/dose-reminders/candidates", {
params: {
query: {
/* paths["/v1/admin/dose-reminders/candidates"]["get"]["parameters"]["query"] */
},
},
});GET /v1/admin/members/{user_id}/clinical-summary
Underlying REST endpoint: GET /v1/admin/members/\{user_id\}/clinical-summary
Parameters
path: paths["/v1/admin/members/{user_id}/clinical-summary"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/members/{user_id}/clinical-summary"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/admin/members/{user_id}/clinical-summary", {
params: {
path: {
user_id: "<user_id>",
},
},
});POST /v1/admin/sync/calls
Underlying REST endpoint: POST /v1/admin/sync/calls
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/sync/calls"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/admin/sync/calls");POST /v1/admin/sync/commerce
Underlying REST endpoint: POST /v1/admin/sync/commerce
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/sync/commerce"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/admin/sync/commerce");POST /v1/admin/sync/luna
Underlying REST endpoint: POST /v1/admin/sync/luna
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/sync/luna"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/admin/sync/luna");GET /v1/audit-log/me
Underlying REST endpoint: GET /v1/audit-log/me
Parameters
query?: paths["/v1/audit-log/me"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/audit-log/me"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/audit-log/me", {
params: {
query: {
/* paths["/v1/audit-log/me"]["get"]["parameters"]["query"] */
},
},
});POST /v1/coaches/me/triage
Underlying REST endpoint: POST /v1/coaches/me/triage
Parameters
body: paths["/v1/coaches/me/triage"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/coaches/me/triage"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/coaches/me/triage", {
body: {
/* paths["/v1/coaches/me/triage"]["post"]["requestBody"]["content"]["application/json"] */
},
});PATCH /v1/medications/{id}/status
Underlying REST endpoint: PATCH /v1/medications/\{id\}/status
Parameters
path: paths["/v1/medications/{id}/status"]["patch"]["parameters"]["path"]body: paths["/v1/medications/{id}/status"]["patch"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/medications/{id}/status"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.PATCH("/v1/medications/{id}/status", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/medications/{id}/status"]["patch"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/patients
Underlying REST endpoint: GET /v1/patients
Parameters
query: paths["/v1/patients"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/patients"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients", {
params: {
query: {
/* paths["/v1/patients"]["get"]["parameters"]["query"] */
},
},
});POST /v1/patients
Underlying REST endpoint: POST /v1/patients
Parameters
body: paths["/v1/patients"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients", {
body: {
/* paths["/v1/patients"]["post"]["requestBody"]["content"]["application/json"] */
},
});DELETE /v1/patients/{id}
Underlying REST endpoint: DELETE /v1/patients/\{id\}
Parameters
path: paths["/v1/patients/{id}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/patients/{id}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.DELETE("/v1/patients/{id}", {
params: {
path: {
id: "<id>",
},
},
});GET /v1/patients/{id}
Underlying REST endpoint: GET /v1/patients/\{id\}
Parameters
path: paths["/v1/patients/{id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/patients/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/{id}", {
params: {
path: {
id: "<id>",
},
},
});PUT /v1/patients/{id}
Underlying REST endpoint: PUT /v1/patients/\{id\}
Parameters
path: paths["/v1/patients/{id}"]["put"]["parameters"]["path"]body: paths["/v1/patients/{id}"]["put"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/{id}"]["put"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.PUT("/v1/patients/{id}", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/patients/{id}"]["put"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/patients/{id}/intake-response
Underlying REST endpoint: GET /v1/patients/\{id\}/intake-response
Parameters
path: paths["/v1/patients/{id}/intake-response"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/patients/{id}/intake-response"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/{id}/intake-response", {
params: {
path: {
id: "<id>",
},
},
});PUT /v1/patients/{id}/intake-response
Underlying REST endpoint: PUT /v1/patients/\{id\}/intake-response
Parameters
path: paths["/v1/patients/{id}/intake-response"]["put"]["parameters"]["path"]body: paths["/v1/patients/{id}/intake-response"]["put"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/{id}/intake-response"]["put"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.PUT("/v1/patients/{id}/intake-response", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/patients/{id}/intake-response"]["put"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/patients/{id}/profile
Underlying REST endpoint: GET /v1/patients/\{id\}/profile
Parameters
path: paths["/v1/patients/{id}/profile"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/patients/{id}/profile"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/{id}/profile", {
params: {
path: {
id: "<id>",
},
},
});GET /v1/patients/{id}/safe
Underlying REST endpoint: GET /v1/patients/\{id\}/safe
Parameters
path: paths["/v1/patients/{id}/safe"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/patients/{id}/safe"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/{id}/safe", {
params: {
path: {
id: "<id>",
},
},
});GET /v1/patients/{patient_id}/encounters
Underlying REST endpoint: GET /v1/patients/\{patient_id\}/encounters
Parameters
path: paths["/v1/patients/{patient_id}/encounters"]["get"]["parameters"]["path"]query?: paths["/v1/patients/{patient_id}/encounters"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/encounters"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/{patient_id}/encounters", {
params: {
path: {
patient_id: "<patient_id>",
},
query: {
/* paths["/v1/patients/{patient_id}/encounters"]["get"]["parameters"]["query"] */
},
},
});POST /v1/patients/{patient_id}/encounters
Underlying REST endpoint: POST /v1/patients/\{patient_id\}/encounters
Parameters
path: paths["/v1/patients/{patient_id}/encounters"]["post"]["parameters"]["path"]body: paths["/v1/patients/{patient_id}/encounters"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/encounters"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/{patient_id}/encounters", {
params: {
path: {
patient_id: "<patient_id>",
},
},
body: {
/* paths["/v1/patients/{patient_id}/encounters"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/patients/{patient_id}/genetic-profiles
Underlying REST endpoint: GET /v1/patients/\{patient_id\}/genetic-profiles
Parameters
path: paths["/v1/patients/{patient_id}/genetic-profiles"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/genetic-profiles"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/{patient_id}/genetic-profiles", {
params: {
path: {
patient_id: "<patient_id>",
},
},
});POST /v1/patients/{patient_id}/genetic-profiles
Underlying REST endpoint: POST /v1/patients/\{patient_id\}/genetic-profiles
Parameters
path: paths["/v1/patients/{patient_id}/genetic-profiles"]["post"]["parameters"]["path"]body: paths["/v1/patients/{patient_id}/genetic-profiles"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/genetic-profiles"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/{patient_id}/genetic-profiles", {
params: {
path: {
patient_id: "<patient_id>",
},
},
body: {
/* paths["/v1/patients/{patient_id}/genetic-profiles"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/patients/{patient_id}/medications
Underlying REST endpoint: GET /v1/patients/\{patient_id\}/medications
Parameters
path: paths["/v1/patients/{patient_id}/medications"]["get"]["parameters"]["path"]query?: paths["/v1/patients/{patient_id}/medications"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/medications"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/{patient_id}/medications", {
params: {
path: {
patient_id: "<patient_id>",
},
query: {
/* paths["/v1/patients/{patient_id}/medications"]["get"]["parameters"]["query"] */
},
},
});POST /v1/patients/{patient_id}/medications
Underlying REST endpoint: POST /v1/patients/\{patient_id\}/medications
Parameters
path: paths["/v1/patients/{patient_id}/medications"]["post"]["parameters"]["path"]body: paths["/v1/patients/{patient_id}/medications"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/medications"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/{patient_id}/medications", {
params: {
path: {
patient_id: "<patient_id>",
},
},
body: {
/* paths["/v1/patients/{patient_id}/medications"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/patients/{patient_id}/medications/check-interactions
Underlying REST endpoint: POST /v1/patients/\{patient_id\}/medications/check-interactions
Parameters
path: paths["/v1/patients/{patient_id}/medications/check-interactions"]["post"]["parameters"]["path"]body: paths["/v1/patients/{patient_id}/medications/check-interactions"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/medications/check-interactions"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/{patient_id}/medications/check-interactions", {
params: {
path: {
patient_id: "<patient_id>",
},
},
body: {
/* paths["/v1/patients/{patient_id}/medications/check-interactions"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/patients/{patient_id}/metrics
Underlying REST endpoint: GET /v1/patients/\{patient_id\}/metrics
Parameters
path: paths["/v1/patients/{patient_id}/metrics"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/metrics"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/{patient_id}/metrics", {
params: {
path: {
patient_id: "<patient_id>",
},
},
});POST /v1/patients/{patient_id}/metrics
Underlying REST endpoint: POST /v1/patients/\{patient_id\}/metrics
Parameters
path: paths["/v1/patients/{patient_id}/metrics"]["post"]["parameters"]["path"]body: paths["/v1/patients/{patient_id}/metrics"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/metrics"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/{patient_id}/metrics", {
params: {
path: {
patient_id: "<patient_id>",
},
},
body: {
/* paths["/v1/patients/{patient_id}/metrics"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/patients/{patient_id}/metrics/{metric_key}
Underlying REST endpoint: GET /v1/patients/\{patient_id\}/metrics/\{metric_key\}
Parameters
path: paths["/v1/patients/{patient_id}/metrics/{metric_key}"]["get"]["parameters"]["path"]query?: paths["/v1/patients/{patient_id}/metrics/{metric_key}"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/metrics/{metric_key}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/{patient_id}/metrics/{metric_key}", {
params: {
path: {
patient_id: "<patient_id>",
metric_key: "<metric_key>",
},
query: {
/* paths["/v1/patients/{patient_id}/metrics/{metric_key}"]["get"]["parameters"]["query"] */
},
},
});GET /v1/patients/{patient_id}/protocols/{protocol_id}/overrides
Underlying REST endpoint: GET /v1/patients/\{patient_id\}/protocols/\{protocol_id\}/overrides
Parameters
path: paths["/v1/patients/{patient_id}/protocols/{protocol_id}/overrides"]["get"]["parameters"]["path"]query?: paths["/v1/patients/{patient_id}/protocols/{protocol_id}/overrides"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/protocols/{protocol_id}/overrides"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/{patient_id}/protocols/{protocol_id}/overrides", {
params: {
path: {
patient_id: "<patient_id>",
protocol_id: "<protocol_id>",
},
query: {
/* paths["/v1/patients/{patient_id}/protocols/{protocol_id}/overrides"]["get"]["parameters"]["query"] */
},
},
});POST /v1/patients/{patient_id}/protocols/{protocol_id}/overrides
Underlying REST endpoint: POST /v1/patients/\{patient_id\}/protocols/\{protocol_id\}/overrides
Parameters
path: paths["/v1/patients/{patient_id}/protocols/{protocol_id}/overrides"]["post"]["parameters"]["path"]body: paths["/v1/patients/{patient_id}/protocols/{protocol_id}/overrides"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/protocols/{protocol_id}/overrides"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/{patient_id}/protocols/{protocol_id}/overrides", {
params: {
path: {
patient_id: "<patient_id>",
protocol_id: "<protocol_id>",
},
},
body: {
/* paths["/v1/patients/{patient_id}/protocols/{protocol_id}/overrides"]["post"]["requestBody"]["content"]["application/json"] */
},
});DELETE /v1/patients/{patient_id}/protocols/{protocol_id}/overrides/{override_id}
Underlying REST endpoint: DELETE /v1/patients/\{patient_id\}/protocols/\{protocol_id\}/overrides/\{override_id\}
Parameters
path: paths["/v1/patients/{patient_id}/protocols/{protocol_id}/overrides/{override_id}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/protocols/{protocol_id}/overrides/{override_id}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.DELETE("/v1/patients/{patient_id}/protocols/{protocol_id}/overrides/{override_id}", {
params: {
path: {
patient_id: "<patient_id>",
protocol_id: "<protocol_id>",
override_id: "<override_id>",
},
},
});PUT /v1/patients/{patient_id}/protocols/{protocol_id}/schedule
Underlying REST endpoint: PUT /v1/patients/\{patient_id\}/protocols/\{protocol_id\}/schedule
Parameters
path: paths["/v1/patients/{patient_id}/protocols/{protocol_id}/schedule"]["put"]["parameters"]["path"]body: paths["/v1/patients/{patient_id}/protocols/{protocol_id}/schedule"]["put"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/protocols/{protocol_id}/schedule"]["put"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.PUT("/v1/patients/{patient_id}/protocols/{protocol_id}/schedule", {
params: {
path: {
patient_id: "<patient_id>",
protocol_id: "<protocol_id>",
},
},
body: {
/* paths["/v1/patients/{patient_id}/protocols/{protocol_id}/schedule"]["put"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/patients/{patient_id}/providers
Underlying REST endpoint: GET /v1/patients/\{patient_id\}/providers
Parameters
path: paths["/v1/patients/{patient_id}/providers"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/providers"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/{patient_id}/providers", {
params: {
path: {
patient_id: "<patient_id>",
},
},
});POST /v1/patients/{patient_id}/providers
Underlying REST endpoint: POST /v1/patients/\{patient_id\}/providers
Parameters
path: paths["/v1/patients/{patient_id}/providers"]["post"]["parameters"]["path"]body: paths["/v1/patients/{patient_id}/providers"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/providers"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/{patient_id}/providers", {
params: {
path: {
patient_id: "<patient_id>",
},
},
body: {
/* paths["/v1/patients/{patient_id}/providers"]["post"]["requestBody"]["content"]["application/json"] */
},
});DELETE /v1/patients/{patient_id}/providers/{provider_id}
Underlying REST endpoint: DELETE /v1/patients/\{patient_id\}/providers/\{provider_id\}
Parameters
path: paths["/v1/patients/{patient_id}/providers/{provider_id}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: void;
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.DELETE("/v1/patients/{patient_id}/providers/{provider_id}", {
params: {
path: {
patient_id: "<patient_id>",
provider_id: "<provider_id>",
},
},
});GET /v1/patients/{patient_id}/timeline
Underlying REST endpoint: GET /v1/patients/\{patient_id\}/timeline
Parameters
path: paths["/v1/patients/{patient_id}/timeline"]["get"]["parameters"]["path"]query?: paths["/v1/patients/{patient_id}/timeline"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/patients/{patient_id}/timeline"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/{patient_id}/timeline", {
params: {
path: {
patient_id: "<patient_id>",
},
query: {
/* paths["/v1/patients/{patient_id}/timeline"]["get"]["parameters"]["query"] */
},
},
});POST /v1/patients/me/age-verification
Underlying REST endpoint: POST /v1/patients/me/age-verification
Parameters
body: paths["/v1/patients/me/age-verification"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/me/age-verification"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/me/age-verification", {
body: {
/* paths["/v1/patients/me/age-verification"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/patients/me/enrollments
Underlying REST endpoint: GET /v1/patients/me/enrollments
Parameters
None
Return type
Promise<{
data?: paths["/v1/patients/me/enrollments"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/me/enrollments");POST /v1/patients/me/enrollments
Underlying REST endpoint: POST /v1/patients/me/enrollments
Parameters
body: paths["/v1/patients/me/enrollments"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/me/enrollments"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/me/enrollments", {
body: {
/* paths["/v1/patients/me/enrollments"]["post"]["requestBody"]["content"]["application/json"] */
},
});DELETE /v1/patients/me/enrollments/{protocol_slug}
Underlying REST endpoint: DELETE /v1/patients/me/enrollments/\{protocol_slug\}
Parameters
path: paths["/v1/patients/me/enrollments/{protocol_slug}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/patients/me/enrollments/{protocol_slug}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.DELETE("/v1/patients/me/enrollments/{protocol_slug}", {
params: {
path: {
protocol_slug: "<protocol_slug>",
},
},
});PATCH /v1/patients/me/enrollments/{protocol_slug}
Underlying REST endpoint: PATCH /v1/patients/me/enrollments/\{protocol_slug\}
Parameters
path: paths["/v1/patients/me/enrollments/{protocol_slug}"]["patch"]["parameters"]["path"]body: paths["/v1/patients/me/enrollments/{protocol_slug}"]["patch"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/me/enrollments/{protocol_slug}"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.PATCH("/v1/patients/me/enrollments/{protocol_slug}", {
params: {
path: {
protocol_slug: "<protocol_slug>",
},
},
body: {
/* paths["/v1/patients/me/enrollments/{protocol_slug}"]["patch"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/patients/me/journal
Underlying REST endpoint: GET /v1/patients/me/journal
Parameters
query: paths["/v1/patients/me/journal"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/patients/me/journal"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/me/journal", {
params: {
query: {
/* paths["/v1/patients/me/journal"]["get"]["parameters"]["query"] */
},
},
});POST /v1/patients/me/journal
Underlying REST endpoint: POST /v1/patients/me/journal
Parameters
body: paths["/v1/patients/me/journal"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/me/journal"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/me/journal", {
body: {
/* paths["/v1/patients/me/journal"]["post"]["requestBody"]["content"]["application/json"] */
},
});DELETE /v1/patients/me/journal/{date}
Underlying REST endpoint: DELETE /v1/patients/me/journal/\{date\}
Parameters
path: paths["/v1/patients/me/journal/{date}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/patients/me/journal/{date}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.DELETE("/v1/patients/me/journal/{date}", {
params: {
path: {
date: "<date>",
},
},
});POST /v1/patients/me/jurisdiction
Underlying REST endpoint: POST /v1/patients/me/jurisdiction
Parameters
body: paths["/v1/patients/me/jurisdiction"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/me/jurisdiction"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/me/jurisdiction", {
body: {
/* paths["/v1/patients/me/jurisdiction"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/patients/me/onboarding
Underlying REST endpoint: GET /v1/patients/me/onboarding
Parameters
None
Return type
Promise<{
data?: paths["/v1/patients/me/onboarding"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/me/onboarding");POST /v1/patients/me/onboarding
Underlying REST endpoint: POST /v1/patients/me/onboarding
Parameters
body: paths["/v1/patients/me/onboarding"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/me/onboarding"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/me/onboarding", {
body: {
/* paths["/v1/patients/me/onboarding"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/patients/me/reset/intake
Underlying REST endpoint: POST /v1/patients/me/reset/intake
Parameters
None
Return type
Promise<{
data?: paths["/v1/patients/me/reset/intake"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/me/reset/intake");POST /v1/patients/me/ruo-acknowledgement
Underlying REST endpoint: POST /v1/patients/me/ruo-acknowledgement
Parameters
body: paths["/v1/patients/me/ruo-acknowledgement"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/me/ruo-acknowledgement"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/me/ruo-acknowledgement", {
body: {
/* paths["/v1/patients/me/ruo-acknowledgement"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/patients/me/today-snapshot
Underlying REST endpoint: GET /v1/patients/me/today-snapshot
Parameters
query?: paths["/v1/patients/me/today-snapshot"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/patients/me/today-snapshot"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/me/today-snapshot", {
params: {
query: {
/* paths["/v1/patients/me/today-snapshot"]["get"]["parameters"]["query"] */
},
},
});GET /v1/patients/me/treatments
Underlying REST endpoint: GET /v1/patients/me/treatments
Parameters
query?: paths["/v1/patients/me/treatments"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/patients/me/treatments"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/patients/me/treatments", {
params: {
query: {
/* paths["/v1/patients/me/treatments"]["get"]["parameters"]["query"] */
},
},
});POST /v1/patients/resolve
Underlying REST endpoint: POST /v1/patients/resolve
Parameters
body: paths["/v1/patients/resolve"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/patients/resolve"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/patients/resolve", {
body: {
/* paths["/v1/patients/resolve"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/protocols/{id}
Underlying REST endpoint: GET /v1/protocols/\{id\}
Parameters
path: paths["/v1/protocols/{id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/protocols/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/protocols/{id}", {
params: {
path: {
id: "<id>",
},
},
});PUT /v1/protocols/{id}/compounds
Underlying REST endpoint: PUT /v1/protocols/\{id\}/compounds
Parameters
path: paths["/v1/protocols/{id}/compounds"]["put"]["parameters"]["path"]body: paths["/v1/protocols/{id}/compounds"]["put"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/protocols/{id}/compounds"]["put"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.PUT("/v1/protocols/{id}/compounds", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/protocols/{id}/compounds"]["put"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/providers
Underlying REST endpoint: POST /v1/providers
Parameters
body: paths["/v1/providers"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/providers"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/providers", {
body: {
/* paths["/v1/providers"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/providers/{id}
Underlying REST endpoint: GET /v1/providers/\{id\}
Parameters
path: paths["/v1/providers/{id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/providers/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/providers/{id}", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/researcher-acknowledgements
Underlying REST endpoint: POST /v1/researcher-acknowledgements
Parameters
body: paths["/v1/researcher-acknowledgements"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/researcher-acknowledgements"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/researcher-acknowledgements", {
body: {
/* paths["/v1/researcher-acknowledgements"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/researcher-acknowledgements/me
Underlying REST endpoint: GET /v1/researcher-acknowledgements/me
Parameters
query?: paths["/v1/researcher-acknowledgements/me"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/researcher-acknowledgements/me"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/researcher-acknowledgements/me", {
params: {
query: {
/* paths["/v1/researcher-acknowledgements/me"]["get"]["parameters"]["query"] */
},
},
});GET /v1/saved-protocols
Underlying REST endpoint: GET /v1/saved-protocols
Parameters
None
Return type
Promise<{
data?: paths["/v1/saved-protocols"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.GET("/v1/saved-protocols");POST /v1/saved-protocols
Underlying REST endpoint: POST /v1/saved-protocols
Parameters
body: paths["/v1/saved-protocols"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/saved-protocols"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.POST("/v1/saved-protocols", {
body: {
/* paths["/v1/saved-protocols"]["post"]["requestBody"]["content"]["application/json"] */
},
});DELETE /v1/saved-protocols/{protocol_slug}
Underlying REST endpoint: DELETE /v1/saved-protocols/\{protocol_slug\}
Parameters
path: paths["/v1/saved-protocols/{protocol_slug}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/saved-protocols/{protocol_slug}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await patientGraph.DELETE("/v1/saved-protocols/{protocol_slug}", {
params: {
path: {
protocol_slug: "<protocol_slug>",
},
},
});