Docs
API Referencesdks@platform/sdk-clinical

@platform/sdk-clinical

Typed TypeScript client for services/clinical. The page is generated from the SDK package source plus its generated OpenAPI types.

Installation

npm install @platform/sdk-clinical

You’ll also need the shared auth/client helpers:

npm install @platform/hosts @platform/sdk

Quick start

import { LoopClient } from "@platform/sdk";
import { platformHost, SERVICE_NAMES } from "@platform/hosts";
import { createClinicalClient } from "@platform/sdk-clinical";
 
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 clinical = createClinicalClient({
  baseUrl: platformHost({ service: SERVICE_NAMES.CLINICAL }),
  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

createShareToken

Underlying REST endpoint: POST /v1/user-stacks/\{id\}/share

Parameters

  • stackId: string

Return type

SdkResponse<{ token: string }>

Example

const result = await clinical.createShareToken("<stackId>");

createStack

Underlying REST endpoint: POST /v1/user-stacks

Parameters

  • input: CreateUserStackInput

Return type

SdkResponse<UserStackResponse>

Example

const result = await clinical.createStack({
  /* CreateUserStackInput */
});

createVial

Underlying REST endpoint: POST /v1/vials

Parameters

  • input: CreateVialInput

Return type

SdkResponse<VialRecord>

Example

const result = await clinical.createVial({
  /* CreateVialInput */
});

deleteStack

Underlying REST endpoint: DELETE /v1/user-stacks/\{id\}

Parameters

  • id: string

Return type

SdkResponse<{ deleted: true }>

Example

const result = await clinical.deleteStack("<id>");

discardVial

Underlying REST endpoint: PATCH /v1/vials/\{id\}/discard

Parameters

  • id: string

Return type

SdkResponse<VialRecord>

Example

const result = await clinical.discardVial("<id>");

enrollProtocol

Underlying REST endpoint: POST /v1/enrollments

Parameters

  • input: EnrollmentCreateInput

Return type

SdkResponse<EnrollmentRecord>

Example

const result = await clinical.enrollProtocol({
  /* EnrollmentCreateInput */
});

forkStack

Underlying REST endpoint: POST /v1/user-stacks/\{id\}/fork

Parameters

  • fromId: string

Return type

SdkResponse<UserStackResponse>

Example

const result = await clinical.forkStack("<fromId>");

getLabDocument

Underlying REST endpoint: GET /v1/bloodwork/view/\{id\}

Parameters

  • id: string

Return type

SdkResponse<LabDocumentResult>

Example

const result = await clinical.getLabDocument("<id>");

getMyStack

Underlying REST endpoint: GET /v1/user-stacks/\{id\}

Parameters

  • id: string

Return type

SdkResponse<UserStackResponse>

Example

const result = await clinical.getMyStack("<id>");

getSharedStack

Underlying REST endpoint: GET /v1/user-stacks/shared/\{token\}

Parameters

  • token: string

Return type

SdkResponse<UserStackResponse>

Example

const result = await clinical.getSharedStack("<token>");

getWearableMetrics

Underlying REST endpoint: GET /v1/wearables/metrics

Parameters

None

Return type

SdkResponse<WearableMetricRecord[]>

Example

const result = await clinical.getWearableMetrics();

listMyStacks

Underlying REST endpoint: GET /v1/user-stacks

Parameters

None

Return type

SdkResponse<{ stacks: UserStackResponse[] }>

Example

const result = await clinical.listMyStacks();

listMyVials

Underlying REST endpoint: GET /v1/vials/me

Parameters

None

Return type

SdkResponse<ListMyVialsResponse>

Example

const result = await clinical.listMyVials();

markCycleEnded

Underlying REST endpoint: POST /v1/user-stacks/\{id\}/cycle/\{action\}

Parameters

  • stackId: string

Return type

SdkResponse<UserStackResponse>

Example

const result = await clinical.markCycleEnded("<stackId>");

markCycleStarted

Underlying REST endpoint: POST /v1/user-stacks/\{id\}/cycle/\{action\}

Parameters

  • stackId: string

Return type

SdkResponse<UserStackResponse>

Example

const result = await clinical.markCycleStarted("<stackId>");

updateStack

Underlying REST endpoint: PATCH /v1/user-stacks/\{id\}

Parameters

  • id: string
  • input: UpdateUserStackInput

Return type

SdkResponse<UserStackResponse>

Example

const result = await clinical.updateStack("<id>", {
  /* UpdateUserStackInput */
});

updateWearableMetricVisibility

Underlying REST endpoint: PATCH /v1/wearables/metrics

Parameters

  • input: UpdateWearableMetricVisibilityInput

Return type

SdkResponse<WearableMetricRecord[]>

Example

const result = await clinical.updateWearableMetricVisibility({
  /* UpdateWearableMetricVisibilityInput */
});

uploadLabPdf

Underlying REST endpoint: POST /v1/bloodwork/upload

Parameters

  • input: UploadLabPdfInput

Return type

SdkResponse<UploadLabPdfResult>

Example

const result = await clinical.uploadLabPdf({
  /* UploadLabPdfInput */
});

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 clinical.GET("/readyz");

GET /v1/admin/adverse-events

Underlying REST endpoint: GET /v1/admin/adverse-events

Parameters

None

Return type

Promise<{
  data?: paths["/v1/admin/adverse-events"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/admin/adverse-events");

GET /v1/admin/adverse-events/{id}

Underlying REST endpoint: GET /v1/admin/adverse-events/\{id\}

Parameters

  • path: paths["/v1/admin/adverse-events/{id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/admin/adverse-events/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/admin/adverse-events/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/admin/adverse-events/{id}/photos/{photoIndex}

Underlying REST endpoint: GET /v1/admin/adverse-events/\{id\}/photos/\{photoIndex\}

Parameters

  • path: paths["/v1/admin/adverse-events/{id}/photos/{photoIndex}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/admin/adverse-events/{id}/photos/{photoIndex}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/admin/adverse-events/{id}/photos/{photoIndex}", {
  params: {
    path: {
      id: "<id>",
      photoIndex: "<photoIndex>",
    },
  },
});

POST /v1/admin/adverse-events/{id}/review

Underlying REST endpoint: POST /v1/admin/adverse-events/\{id\}/review

Parameters

  • path: paths["/v1/admin/adverse-events/{id}/review"]["post"]["parameters"]["path"]
  • body: paths["/v1/admin/adverse-events/{id}/review"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/admin/adverse-events/{id}/review"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/admin/adverse-events/{id}/review", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/admin/adverse-events/{id}/review"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

PATCH /v1/admin/adverse-events/{id}/safety

Underlying REST endpoint: PATCH /v1/admin/adverse-events/\{id\}/safety

Parameters

  • path: paths["/v1/admin/adverse-events/{id}/safety"]["patch"]["parameters"]["path"]
  • body: paths["/v1/admin/adverse-events/{id}/safety"]["patch"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/admin/adverse-events/{id}/safety"]["patch"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.PATCH("/v1/admin/adverse-events/{id}/safety", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/admin/adverse-events/{id}/safety"]["patch"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/admin/adverse-events/signal

Underlying REST endpoint: GET /v1/admin/adverse-events/signal

Parameters

  • query: paths["/v1/admin/adverse-events/signal"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/admin/adverse-events/signal"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/admin/adverse-events/signal", {
  params: {
    query: {
      /* paths["/v1/admin/adverse-events/signal"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/admin/lab-catalog/markers

Underlying REST endpoint: POST /v1/admin/lab-catalog/markers

Parameters

  • body: paths["/v1/admin/lab-catalog/markers"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/admin/lab-catalog/markers"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/admin/lab-catalog/markers", {
  body: {
    /* paths["/v1/admin/lab-catalog/markers"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/adverse-events

Underlying REST endpoint: POST /v1/adverse-events

Parameters

  • body: paths["/v1/adverse-events"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/adverse-events"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/adverse-events", {
  body: {
    /* paths["/v1/adverse-events"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/biomarkers/parse

Underlying REST endpoint: POST /v1/biomarkers/parse

Parameters

  • body: paths["/v1/biomarkers/parse"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/biomarkers/parse"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/biomarkers/parse", {
  body: {
    /* paths["/v1/biomarkers/parse"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/biomarkers/parse/vendor

Underlying REST endpoint: POST /v1/biomarkers/parse/vendor

Parameters

  • body: paths["/v1/biomarkers/parse/vendor"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/biomarkers/parse/vendor"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/biomarkers/parse/vendor", {
  body: {
    /* paths["/v1/biomarkers/parse/vendor"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/bloodwork/upload

Underlying REST endpoint: POST /v1/bloodwork/upload

Parameters

  • body: paths["/v1/bloodwork/upload"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/bloodwork/upload"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/bloodwork/upload", {
  body: {
    /* paths["/v1/bloodwork/upload"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/bloodwork/view/{id}

Underlying REST endpoint: GET /v1/bloodwork/view/\{id\}

Parameters

  • path: paths["/v1/bloodwork/view/{id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/bloodwork/view/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/bloodwork/view/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/check-ins

Underlying REST endpoint: GET /v1/check-ins

Parameters

None

Return type

Promise<{
  data?: paths["/v1/check-ins"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/check-ins");

POST /v1/check-ins

Underlying REST endpoint: POST /v1/check-ins

Parameters

  • body: paths["/v1/check-ins"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/check-ins"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/check-ins", {
  body: {
    /* paths["/v1/check-ins"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/check-ins/next

Underlying REST endpoint: GET /v1/check-ins/next

Parameters

  • query: paths["/v1/check-ins/next"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/check-ins/next"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/check-ins/next", {
  params: {
    query: {
      /* paths["/v1/check-ins/next"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/conditions/evaluate

Underlying REST endpoint: POST /v1/conditions/evaluate

Parameters

  • body: paths["/v1/conditions/evaluate"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/conditions/evaluate"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/conditions/evaluate", {
  body: {
    /* paths["/v1/conditions/evaluate"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/contraindications/check

Underlying REST endpoint: POST /v1/contraindications/check

Parameters

  • body: paths["/v1/contraindications/check"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/contraindications/check"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/contraindications/check", {
  body: {
    /* paths["/v1/contraindications/check"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/drug-list

Underlying REST endpoint: GET /v1/drug-list

Parameters

  • query?: paths["/v1/drug-list"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/drug-list"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/drug-list", {
  params: {
    query: {
      /* paths["/v1/drug-list"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/enrollments

Underlying REST endpoint: POST /v1/enrollments

Parameters

  • body: paths["/v1/enrollments"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/enrollments"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/enrollments", {
  body: {
    /* paths["/v1/enrollments"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/health-engine/score

Underlying REST endpoint: POST /v1/health-engine/score

Parameters

  • body: paths["/v1/health-engine/score"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/health-engine/score"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/health-engine/score", {
  body: {
    /* paths["/v1/health-engine/score"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/intake-eligibility/evaluate

Underlying REST endpoint: POST /v1/intake-eligibility/evaluate

Parameters

  • body: paths["/v1/intake-eligibility/evaluate"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/intake-eligibility/evaluate"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/intake-eligibility/evaluate", {
  body: {
    /* paths["/v1/intake-eligibility/evaluate"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/lab-catalog/availability

Underlying REST endpoint: GET /v1/lab-catalog/availability

Parameters

  • query: paths["/v1/lab-catalog/availability"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/lab-catalog/availability"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/lab-catalog/availability", {
  params: {
    query: {
      /* paths["/v1/lab-catalog/availability"]["get"]["parameters"]["query"] */
    },
  },
});

GET /v1/lab-catalog/markers

Underlying REST endpoint: GET /v1/lab-catalog/markers

Parameters

  • query?: paths["/v1/lab-catalog/markers"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/lab-catalog/markers"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/lab-catalog/markers", {
  params: {
    query: {
      /* paths["/v1/lab-catalog/markers"]["get"]["parameters"]["query"] */
    },
  },
});

GET /v1/lab-catalog/panels

Underlying REST endpoint: GET /v1/lab-catalog/panels

Parameters

None

Return type

Promise<{
  data?: paths["/v1/lab-catalog/panels"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/lab-catalog/panels");

GET /v1/lab-catalog/price

Underlying REST endpoint: GET /v1/lab-catalog/price

Parameters

  • query: paths["/v1/lab-catalog/price"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/lab-catalog/price"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/lab-catalog/price", {
  params: {
    query: {
      /* paths["/v1/lab-catalog/price"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/lab-orders

Underlying REST endpoint: POST /v1/lab-orders

Parameters

  • header: paths["/v1/lab-orders"]["post"]["parameters"]["header"]
  • body: paths["/v1/lab-orders"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/lab-orders"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/lab-orders", {
  params: {
    header: {
      /* paths["/v1/lab-orders"]["post"]["parameters"]["header"] */
    },
  },
  body: {
    /* paths["/v1/lab-orders"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/lab-orders/{id}

Underlying REST endpoint: GET /v1/lab-orders/\{id\}

Parameters

  • path: paths["/v1/lab-orders/{id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/lab-orders/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/lab-orders/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

DELETE /v1/patients/{id}/clinical

Underlying REST endpoint: DELETE /v1/patients/\{id\}/clinical

Parameters

  • path: paths["/v1/patients/{id}/clinical"]["delete"]["parameters"]["path"]
  • query?: paths["/v1/patients/{id}/clinical"]["delete"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/patients/{id}/clinical"]["delete"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.DELETE("/v1/patients/{id}/clinical", {
  params: {
    path: {
      id: "<id>",
    },
    query: {
      /* paths["/v1/patients/{id}/clinical"]["delete"]["parameters"]["query"] */
    },
  },
});

GET /v1/patients/{patient_id}/biomarkers/{code}/trend

Underlying REST endpoint: GET /v1/patients/\{patient_id\}/biomarkers/\{code\}/trend

Parameters

  • path: paths["/v1/patients/{patient_id}/biomarkers/{code}/trend"]["get"]["parameters"]["path"]
  • query?: paths["/v1/patients/{patient_id}/biomarkers/{code}/trend"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/patients/{patient_id}/biomarkers/{code}/trend"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/patients/{patient_id}/biomarkers/{code}/trend", {
  params: {
    path: {
      patient_id: "<patient_id>",
      code: "<code>",
    },
    query: {
      /* paths["/v1/patients/{patient_id}/biomarkers/{code}/trend"]["get"]["parameters"]["query"] */
    },
  },
});

GET /v1/patients/{patientId}/retest-cycles

Underlying REST endpoint: GET /v1/patients/\{patientId\}/retest-cycles

Parameters

  • path: paths["/v1/patients/{patientId}/retest-cycles"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/patients/{patientId}/retest-cycles"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/patients/{patientId}/retest-cycles", {
  params: {
    path: {
      patientId: "<patientId>",
    },
  },
});

GET /v1/physicians

Underlying REST endpoint: GET /v1/physicians

Parameters

None

Return type

Promise<{
  data?: paths["/v1/physicians"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/physicians");

POST /v1/physicians

Underlying REST endpoint: POST /v1/physicians

Parameters

  • body: paths["/v1/physicians"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/physicians"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/physicians", {
  body: {
    /* paths["/v1/physicians"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/protocol-engine/evaluate

Underlying REST endpoint: POST /v1/protocol-engine/evaluate

Parameters

  • body: paths["/v1/protocol-engine/evaluate"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/protocol-engine/evaluate"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/protocol-engine/evaluate", {
  body: {
    /* paths["/v1/protocol-engine/evaluate"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/protocols

Underlying REST endpoint: GET /v1/protocols

Parameters

None

Return type

Promise<{
  data?: paths["/v1/protocols"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/protocols");

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 clinical.GET("/v1/protocols/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/protocols/match

Underlying REST endpoint: POST /v1/protocols/match

Parameters

  • body: paths["/v1/protocols/match"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/protocols/match"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/protocols/match", {
  body: {
    /* paths["/v1/protocols/match"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/recommendation-lift

Underlying REST endpoint: GET /v1/recommendation-lift

Parameters

  • query: paths["/v1/recommendation-lift"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/recommendation-lift"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/recommendation-lift", {
  params: {
    query: {
      /* paths["/v1/recommendation-lift"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/recommendations/generate

Underlying REST endpoint: POST /v1/recommendations/generate

Parameters

  • body: paths["/v1/recommendations/generate"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/recommendations/generate"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/recommendations/generate", {
  body: {
    /* paths["/v1/recommendations/generate"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/red-flags/{patient_id}

Underlying REST endpoint: GET /v1/red-flags/\{patient_id\}

Parameters

  • path: paths["/v1/red-flags/{patient_id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/red-flags/{patient_id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/red-flags/{patient_id}", {
  params: {
    path: {
      patient_id: "<patient_id>",
    },
  },
});

POST /v1/red-flags/evaluate

Underlying REST endpoint: POST /v1/red-flags/evaluate

Parameters

  • body: paths["/v1/red-flags/evaluate"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/red-flags/evaluate"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/red-flags/evaluate", {
  body: {
    /* paths["/v1/red-flags/evaluate"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/retest-cycles

Underlying REST endpoint: POST /v1/retest-cycles

Parameters

  • body: paths["/v1/retest-cycles"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/retest-cycles"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/retest-cycles", {
  body: {
    /* paths["/v1/retest-cycles"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/retest-cycles/{id}

Underlying REST endpoint: GET /v1/retest-cycles/\{id\}

Parameters

  • path: paths["/v1/retest-cycles/{id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/retest-cycles/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/retest-cycles/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/retest-cycles/stats

Underlying REST endpoint: GET /v1/retest-cycles/stats

Parameters

None

Return type

Promise<{
  data?: paths["/v1/retest-cycles/stats"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/retest-cycles/stats");

GET /v1/user-stacks

Underlying REST endpoint: GET /v1/user-stacks

Parameters

None

Return type

Promise<{
  data?: paths["/v1/user-stacks"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/user-stacks");

POST /v1/user-stacks

Underlying REST endpoint: POST /v1/user-stacks

Parameters

  • body: paths["/v1/user-stacks"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/user-stacks"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/user-stacks", {
  body: {
    /* paths["/v1/user-stacks"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

DELETE /v1/user-stacks/{id}

Underlying REST endpoint: DELETE /v1/user-stacks/\{id\}

Parameters

  • path: paths["/v1/user-stacks/{id}"]["delete"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/user-stacks/{id}"]["delete"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.DELETE("/v1/user-stacks/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/user-stacks/{id}

Underlying REST endpoint: GET /v1/user-stacks/\{id\}

Parameters

  • path: paths["/v1/user-stacks/{id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/user-stacks/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/user-stacks/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

PATCH /v1/user-stacks/{id}

Underlying REST endpoint: PATCH /v1/user-stacks/\{id\}

Parameters

  • path: paths["/v1/user-stacks/{id}"]["patch"]["parameters"]["path"]
  • body: paths["/v1/user-stacks/{id}"]["patch"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/user-stacks/{id}"]["patch"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.PATCH("/v1/user-stacks/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/user-stacks/{id}"]["patch"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/user-stacks/{id}/cycle/{action}

Underlying REST endpoint: POST /v1/user-stacks/\{id\}/cycle/\{action\}

Parameters

  • path: paths["/v1/user-stacks/{id}/cycle/{action}"]["post"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/user-stacks/{id}/cycle/{action}"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/user-stacks/{id}/cycle/{action}", {
  params: {
    path: {
      id: "<id>",
      action: "<action>",
    },
  },
});

POST /v1/user-stacks/{id}/fork

Underlying REST endpoint: POST /v1/user-stacks/\{id\}/fork

Parameters

  • path: paths["/v1/user-stacks/{id}/fork"]["post"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/user-stacks/{id}/fork"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/user-stacks/{id}/fork", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/user-stacks/{id}/share

Underlying REST endpoint: POST /v1/user-stacks/\{id\}/share

Parameters

  • path: paths["/v1/user-stacks/{id}/share"]["post"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/user-stacks/{id}/share"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/user-stacks/{id}/share", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/user-stacks/shared/{token}

Underlying REST endpoint: GET /v1/user-stacks/shared/\{token\}

Parameters

  • path: paths["/v1/user-stacks/shared/{token}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/user-stacks/shared/{token}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/user-stacks/shared/{token}", {
  params: {
    path: {
      token: "<token>",
    },
  },
});

GET /v1/vials

Underlying REST endpoint: GET /v1/vials

Parameters

  • query: paths["/v1/vials"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/vials"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/vials", {
  params: {
    query: {
      /* paths["/v1/vials"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/vials

Underlying REST endpoint: POST /v1/vials

Parameters

  • body: paths["/v1/vials"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/vials"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/vials", {
  body: {
    /* paths["/v1/vials"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

PATCH /v1/vials/{id}/discard

Underlying REST endpoint: PATCH /v1/vials/\{id\}/discard

Parameters

  • path: paths["/v1/vials/{id}/discard"]["patch"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/vials/{id}/discard"]["patch"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.PATCH("/v1/vials/{id}/discard", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/vials/me

Underlying REST endpoint: GET /v1/vials/me

Parameters

None

Return type

Promise<{
  data?: paths["/v1/vials/me"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/vials/me");

GET /v1/vials/refill-due

Underlying REST endpoint: GET /v1/vials/refill-due

Parameters

None

Return type

Promise<{
  data?: paths["/v1/vials/refill-due"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/vials/refill-due");

GET /v1/wearables/connections

Underlying REST endpoint: GET /v1/wearables/connections

Parameters

None

Return type

Promise<{
  data?: paths["/v1/wearables/connections"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/wearables/connections");

DELETE /v1/wearables/connections/{provider}

Underlying REST endpoint: DELETE /v1/wearables/connections/\{provider\}

Parameters

  • path: paths["/v1/wearables/connections/{provider}"]["delete"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/wearables/connections/{provider}"]["delete"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.DELETE("/v1/wearables/connections/{provider}", {
  params: {
    path: {
      provider: "<provider>",
    },
  },
});

POST /v1/wearables/link/exchange

Underlying REST endpoint: POST /v1/wearables/link/exchange

Parameters

  • body: paths["/v1/wearables/link/exchange"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/wearables/link/exchange"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/wearables/link/exchange", {
  body: {
    /* paths["/v1/wearables/link/exchange"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/wearables/link/token

Underlying REST endpoint: POST /v1/wearables/link/token

Parameters

  • body?: paths["/v1/wearables/link/token"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/wearables/link/token"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.POST("/v1/wearables/link/token", {
  body: {
    /* paths["/v1/wearables/link/token"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/wearables/metrics

Underlying REST endpoint: GET /v1/wearables/metrics

Parameters

None

Return type

Promise<{
  data?: paths["/v1/wearables/metrics"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.GET("/v1/wearables/metrics");

PATCH /v1/wearables/metrics

Underlying REST endpoint: PATCH /v1/wearables/metrics

Parameters

  • body: paths["/v1/wearables/metrics"]["patch"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/wearables/metrics"]["patch"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await clinical.PATCH("/v1/wearables/metrics", {
  body: {
    /* paths["/v1/wearables/metrics"]["patch"]["requestBody"]["content"]["application/json"] */
  },
});

Related

@platform/sdk-cash@platform/sdk-commerce