@healthcloudai/hc-sdk 3.23.0 → 3.24.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/dist/index.cjs +101 -5
  2. package/dist/index.d.cts +1107 -3
  3. package/dist/index.d.ts +1107 -3
  4. package/dist/index.js +98 -5
  5. package/docs/clients/ProviderClient.md +7 -0
  6. package/docs/configuration.md +2 -2
  7. package/docs/docs-manifest.json +26 -3
  8. package/docs/examples/index.md +7 -0
  9. package/docs/index.md +7 -0
  10. package/docs/models/CreateProviderPatientRequest.md +22 -0
  11. package/docs/models/LabOrder.md +35 -0
  12. package/docs/models/LabOrderDiagnosis.md +18 -0
  13. package/docs/models/LabOrderErrorResponse.md +21 -0
  14. package/docs/models/LabOrderItemRequest.md +17 -0
  15. package/docs/models/LabOrderProvider.md +20 -0
  16. package/docs/models/LabOrderRequisitionResponse.md +20 -0
  17. package/docs/models/LabOrderTest.md +19 -0
  18. package/docs/models/LabOrderUnsentItem.md +19 -0
  19. package/docs/models/ListLabOrdersResponse.md +18 -0
  20. package/docs/models/PlaceLabOrderRequest.md +27 -0
  21. package/docs/models/PlaceLabOrderResponse.md +20 -0
  22. package/docs/models/ProviderEncounterStatusCounts.md +21 -0
  23. package/docs/models/ProviderHomeSummaryResponse.md +19 -0
  24. package/docs/models/ProviderPatientListResponse.md +19 -0
  25. package/docs/models/ProviderPatientResponse.md +17 -0
  26. package/docs/models/index.md +16 -0
  27. package/docs/operations/provider.createPatient.md +155 -0
  28. package/docs/operations/provider.getHomeSummary.md +115 -0
  29. package/docs/operations/provider.getLabOrder.md +179 -0
  30. package/docs/operations/provider.getLabOrderRequisition.md +148 -0
  31. package/docs/operations/provider.listLabOrders.md +198 -0
  32. package/docs/operations/provider.listPatients.md +154 -0
  33. package/docs/operations/provider.placeLabOrder.md +384 -0
  34. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -21,12 +21,67 @@ function isServiceName(value) {
21
21
  return SERVICES.includes(value);
22
22
  }
23
23
  function resolveBaseUrl(environment, service) {
24
+ assertEnvironment(environment);
24
25
  if (service === "ams") {
26
+ if (environment === "dev") return "https://dev-ams-services.health.cloud/api/ams";
25
27
  const prefix = environment === "prod" ? "" : `${environment}-`;
26
28
  return `https://${prefix}amsservices.health.cloud/api/ams`;
27
29
  }
28
30
  return `https://${environment}-api-${service}.health.cloud`;
29
31
  }
32
+ function normalizeBaseUrl(value) {
33
+ const message = "Invalid service base URL: expected HTTPS (or literal loopback HTTP); no credentials, query or fragment";
34
+ try {
35
+ if (typeof value !== "string" || /[^\x21-\x7e]|[\\?#]/.test(value) || !/^https?:\/\//i.test(value)) {
36
+ throw new Error();
37
+ }
38
+ const authority = value.slice(value.indexOf("://") + 3).split("/")[0];
39
+ if (!authority || /[@%]/.test(authority) || authority.endsWith(":")) throw new Error();
40
+ const url = new URL(value);
41
+ const host = url.hostname;
42
+ const allowedScheme = url.protocol === "https:" || url.protocol === "http:" && (host === "127.0.0.1" || host === "[::1]");
43
+ if (!allowedScheme || !host || url.username || url.password || url.port && Number(url.port) < 1) {
44
+ throw new Error();
45
+ }
46
+ if (!host.startsWith("[") && (!/^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$/.test(host) || host.split(".").some(
47
+ (label) => !label || label.length > 63 || label.startsWith("-") || label.endsWith("-")
48
+ ))) throw new Error();
49
+ const rawHost = authority.startsWith("[") ? authority.slice(0, authority.indexOf("]") + 1) : authority.split(":")[0];
50
+ if (!host.startsWith("[") && host !== rawHost.toLowerCase()) throw new Error();
51
+ const rawPath = value.slice(value.indexOf("://") + 3 + authority.length);
52
+ if (rawPath.includes("//") || /%(?![0-9a-f]{2})|%2f/i.test(rawPath)) throw new Error();
53
+ const decoded = decodePathBytes(rawPath);
54
+ if (hasControls(decoded) || /[\\?#%]/.test(decoded) || decoded.split("/").some((s) => s === "." || s === "..")) {
55
+ throw new Error();
56
+ }
57
+ return `${url.origin}${rawPath.replace(/\/+$/, "")}`;
58
+ } catch {
59
+ throw new Error(message);
60
+ }
61
+ }
62
+ function normalizeOverrides(values) {
63
+ if (values === void 0) return {};
64
+ if (values === null || typeof values !== "object" || Array.isArray(values)) throw new Error("Invalid service URL overrides");
65
+ const result = {};
66
+ for (const [service, value] of Object.entries(values)) {
67
+ if (!isServiceName(service)) throw new Error("Invalid service URL overrides: expected known service names");
68
+ result[service] = normalizeBaseUrl(value);
69
+ }
70
+ return result;
71
+ }
72
+ function joinServiceUrl(base, path) {
73
+ if (hasControls(path) || /[\\?#]/.test(path) || path.includes("://") || path.startsWith("//") || path.split("/").some((segment) => {
74
+ const decoded = decodePathBytes(segment);
75
+ return decoded === "." || decoded === "..";
76
+ })) throw new Error("Invalid service request path");
77
+ return `${base.replace(/\/+$/, "")}/${path.replace(/^\/+/, "")}`;
78
+ }
79
+ function hasControls(value) {
80
+ return Array.from(value).some((character) => character.charCodeAt(0) < 32 || character.charCodeAt(0) === 127);
81
+ }
82
+ function decodePathBytes(value) {
83
+ return value.replace(/%([0-9a-f]{2})/gi, (_, hex) => String.fromCharCode(parseInt(hex, 16)));
84
+ }
30
85
  function assertTimeout(timeout, label = "timeout") {
31
86
  if (typeof timeout !== "number" || !Number.isFinite(timeout) || timeout <= 0) {
32
87
  throw new Error(`Invalid HealthCloud SDK ${label}: expected a positive number of milliseconds, got ${String(timeout)}`);
@@ -62,12 +117,13 @@ var SDKError = class extends Error {
62
117
  var HttpClient = class {
63
118
  constructor(state) {
64
119
  this.state = state;
120
+ this.baseUrlOverrides = normalizeOverrides(state.baseUrlOverrides);
65
121
  }
66
122
  async request(service, method, path, options = {}) {
67
123
  var _a, _b;
68
124
  const url = this.buildUrl(service, path, options);
69
125
  const headers = this.buildHeaders(options);
70
- const init = { method, headers };
126
+ const init = { method, headers, redirect: "error" };
71
127
  if (method !== "GET" && method !== "DELETE" && options.body !== void 0) {
72
128
  init.body = this.serializeBody(options.body, headers);
73
129
  }
@@ -84,6 +140,9 @@ var HttpClient = class {
84
140
  let payload;
85
141
  try {
86
142
  response = await fetch(url, init);
143
+ if (response.redirected || response.status >= 300 && response.status < 400 || response.type === "opaqueredirect") {
144
+ throw new SDKError({ message: "Service redirects are not allowed", statusCode: response.status });
145
+ }
87
146
  payload = await this.parseResponse(response);
88
147
  } catch (error) {
89
148
  if (didTimeout) {
@@ -97,7 +156,7 @@ var HttpClient = class {
97
156
  throw error;
98
157
  }
99
158
  throw new SDKError({
100
- message: error instanceof Error ? error.message : "Network request failed.",
159
+ message: "Network request failed.",
101
160
  statusCode: 0,
102
161
  cause: error
103
162
  });
@@ -133,8 +192,8 @@ var HttpClient = class {
133
192
  buildUrl(service, path, options) {
134
193
  var _a, _b, _c;
135
194
  const normalizedPath = this.resolvePath(path, (_a = options.pathParams) != null ? _a : {});
136
- const base = (_c = (_b = this.state.baseUrlOverrides) == null ? void 0 : _b[service]) != null ? _c : resolveBaseUrl(this.state.environment, service);
137
- const url = new URL(`${base}${normalizedPath}`);
195
+ const base = (_c = (_b = this.baseUrlOverrides) == null ? void 0 : _b[service]) != null ? _c : resolveBaseUrl(this.state.environment, service);
196
+ const url = new URL(joinServiceUrl(base, normalizedPath));
138
197
  if (options.query) {
139
198
  for (const [key, value] of Object.entries(options.query)) {
140
199
  this.appendQuery(url, key, value);
@@ -3719,6 +3778,37 @@ var ProviderClient = class extends BaseServiceClient {
3719
3778
  getAppointment(appointmentId) {
3720
3779
  return this.send("GET", "/appointments/{appointment_id}", { pathParams: { appointment_id: appointmentId } });
3721
3780
  }
3781
+ /**
3782
+ * List or search the calling practitioner's own patients (GET /patients), one page at a time. Never tenant-wide: only patients assigned to the caller. `q` matches the start of a given or
3783
+ * family name; pass the previous page's `next_page_token` as `page_token` to read on. `page_size` is 1-100 (default 20).
3784
+ */
3785
+ listPatients(filters) {
3786
+ return this.send("GET", "/patients", { query: filters });
3787
+ }
3788
+ /** Create a patient assigned to the calling practitioner (POST /patients). Returns the patient's demographic summary. */
3789
+ createPatient(request) {
3790
+ return this.send("POST", "/patients", { body: request });
3791
+ }
3792
+ /** Counts for the home screen (GET /dashboard/summary): the caller's own patients and encounters by status. */
3793
+ getHomeSummary() {
3794
+ return this.send("GET", "/dashboard/summary", {});
3795
+ }
3796
+ /** Place a real Quest lab order for a patient (POST /patients/{patient_id}/lab-orders). Confirm the tests with the clinician first. */
3797
+ placeLabOrder(patientId, request) {
3798
+ return this.send("POST", "/patients/{patient_id}/lab-orders", { pathParams: { patient_id: patientId }, body: request });
3799
+ }
3800
+ /** List a patient's lab orders (GET /patients/{patient_id}/lab-orders), optionally by `status` (submitting, accepted or rejected). */
3801
+ listLabOrders(patientId, filters) {
3802
+ return this.send("GET", "/patients/{patient_id}/lab-orders", { pathParams: { patient_id: patientId }, query: filters });
3803
+ }
3804
+ /** Get one lab order (GET /patients/{patient_id}/lab-orders/{order_id}). */
3805
+ getLabOrder(patientId, orderId) {
3806
+ return this.send("GET", "/patients/{patient_id}/lab-orders/{order_id}", { pathParams: { patient_id: patientId, order_id: orderId } });
3807
+ }
3808
+ /** Get a lab order's Quest requisition PDF (GET /patients/{patient_id}/lab-orders/{order_id}/requisition). */
3809
+ getLabOrderRequisition(patientId, orderId) {
3810
+ return this.send("GET", "/patients/{patient_id}/lab-orders/{order_id}/requisition", { pathParams: { patient_id: patientId, order_id: orderId } });
3811
+ }
3722
3812
  /** Get a patient's consolidated health record (provider tenant scope). */
3723
3813
  getPatientRecord(patientId) {
3724
3814
  return this.send("GET", "/patients/{patient_id}/record", { pathParams: { patient_id: patientId } });
@@ -7010,7 +7100,7 @@ var HCSDK = class {
7010
7100
  environment: config.environment,
7011
7101
  tenantId: config.tenantId,
7012
7102
  accessToken: config.accessToken,
7013
- baseUrlOverrides: config.baseUrlOverrides,
7103
+ baseUrlOverrides: normalizeOverrides(config.baseUrlOverrides),
7014
7104
  timeout: (_b = config.timeout) != null ? _b : DEFAULT_TIMEOUT_MS
7015
7105
  };
7016
7106
  this.http = new HttpClient(this.state);
@@ -7183,6 +7273,9 @@ export {
7183
7273
  assertTimeout,
7184
7274
  isJsonRpcError,
7185
7275
  isServiceName,
7276
+ joinServiceUrl,
7277
+ normalizeBaseUrl,
7278
+ normalizeOverrides,
7186
7279
  resolveBaseUrl,
7187
7280
  withTenantId
7188
7281
  };
@@ -3,10 +3,14 @@
3
3
  - [`completePractitionerOnboarding`](../operations/provider.completePractitionerOnboarding.md) — Record onboarding completion for the practitioner's current flow
4
4
  - [`confirmPassword`](../operations/provider.confirmResetPassword.md) — Complete a password reset
5
5
  - [`connect`](../operations/provider.connect.md) — Health check
6
+ - [`createPatient`](../operations/provider.createPatient.md) — Create a patient on the calling practitioner's care team
6
7
  - [`createPractitionerLocation`](../operations/provider.createPractitionerLocation.md) — Add a practice location
7
8
  - [`deletePractitionerLocation`](../operations/provider.deletePractitionerLocation.md) — Remove a practice location
8
9
  - [`getAppointment`](../operations/provider.getAppointment.md) — Get one appointment with patient demographics
9
10
  - [`getEncounter`](../operations/provider.getEncounter.md) — Get one encounter with patient demographics
11
+ - [`getHomeSummary`](../operations/provider.getHomeSummary.md) — Counts for the provider's home screen
12
+ - [`getLabOrder`](../operations/provider.getLabOrder.md) — Get one Quest lab order requisition
13
+ - [`getLabOrderRequisition`](../operations/provider.getLabOrderRequisition.md) — Get the Quest requisition PDF of a lab order
10
14
  - [`getPatientRecord`](../operations/provider.getPatientRecord.md) — Get a patient's consolidated health record (provider tenant scope)
11
15
  - [`getPhoto`](../operations/provider.getPhoto.md) — Get a practitioner photo
12
16
  - [`getPhotoUploadUrl`](../operations/provider.getPhotoUploadUrl.md) — Get a presigned photo upload URL
@@ -14,9 +18,12 @@
14
18
  - [`getPractitionerLocation`](../operations/provider.getPractitionerLocation.md) — Get one practice location
15
19
  - [`listAppointments`](../operations/provider.listAppointments.md) — List tenant appointments
16
20
  - [`listEncounters`](../operations/provider.listEncounters.md) — List tenant encounters
21
+ - [`listLabOrders`](../operations/provider.listLabOrders.md) — List a tenant patient's Quest lab orders
22
+ - [`listPatients`](../operations/provider.listPatients.md) — List or search the calling practitioner's patients
17
23
  - [`listPractitionerLocations`](../operations/provider.listPractitionerLocations.md) — List the practitioner's practice locations
18
24
  - [`login`](../operations/provider.login.md) — Log in a practitioner
19
25
  - [`logout`](../operations/provider.logout.md) — Sign out the practitioner and revoke their tokens
26
+ - [`placeLabOrder`](../operations/provider.placeLabOrder.md) — Place a Quest lab order for a tenant patient
20
27
  - [`refreshToken`](../operations/provider.refreshToken.md) — Refresh practitioner access tokens
21
28
  - [`register`](../operations/provider.register.md) — Register a practitioner
22
29
  - [`resendEmailVerification`](../operations/provider.resendVerificationCode.md) — Resend the email verification OTP
@@ -1,9 +1,9 @@
1
1
  # Configuration
2
2
 
3
- - `environment`: Required: `dev`, `uat`, or `prod`. API defaults use `https://{environment}-api-{service}.health.cloud`, including `prod-api-`. AMS uses `https://amsservices.health.cloud/api/ams` in prod and dev-/uat- prefixed AMS hosts otherwise.
3
+ - `environment`: API defaults use https://{environment}-api-{service}.health.cloud. AMS DEV uses https://dev-ams-services.health.cloud/api/ams (AWS); UAT remains https://uat-amsservices.health.cloud/api/ams and PROD remains https://amsservices.health.cloud/api/ams. No fallback to another deployment.
4
4
  - `tenantId`: Tenant used by tenant-aware authentication operations.
5
5
  - `accessToken`: Optional bearer token for authenticated APIs.
6
- - `baseUrlOverrides`: Optional per-service override intended for controlled development and testing.
6
+ - `baseUrlOverrides`: Optional service-to-URL mapping. Complete HTTPS service base URL including any base path (HTTP allowed only for literal loopback 127.0.0.1 or [::1]); trailing slash is normalized. Credentials, query, fragment, ambiguous paths and redirects are refused. TLS verification stays enabled. Overrides are copied per SDK instance and take precedence over environment defaults; configure before construction. An AMS/MCP override does not change patient authentication or Tenant Admin login/refresh URLs. Native fetch must enforce redirect: error and normal certificate validation. Node/browser transport behavior is covered; React Native adapters need a separate runtime verification.
7
7
  - `timeout`: Optional request timeout in milliseconds. Defaults to 30000; timed-out requests are aborted and reject with SDKError.
8
8
 
9
9
  ## Initialization
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:3cc44dfe6b6c58864456a393ecf73a669aa0cc1a30d87b4cdf8333bc27f77d79",
2
+ "docsDataContentDigest": "sha256:71c4ff351e248aa74fa2dc1635a1c9d4b36f70ff8b78a449a319420451327802",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AmsClient.md",
@@ -508,6 +508,7 @@
508
508
  "models/CreateMedicationRequest.md",
509
509
  "models/CreateMedicationResponse.md",
510
510
  "models/CreatePatientTokenRequest.md",
511
+ "models/CreateProviderPatientRequest.md",
511
512
  "models/CreateProviderTokenRequest.md",
512
513
  "models/CreateQuestionnaireRequest.md",
513
514
  "models/CreateQuestionnaireResponse.md",
@@ -1242,6 +1243,14 @@
1242
1243
  "models/KnowledgeCollection.md",
1243
1244
  "models/KnowledgeEntrySummary.md",
1244
1245
  "models/KnowledgeSearchResult.md",
1246
+ "models/LabOrder.md",
1247
+ "models/LabOrderDiagnosis.md",
1248
+ "models/LabOrderErrorResponse.md",
1249
+ "models/LabOrderItemRequest.md",
1250
+ "models/LabOrderProvider.md",
1251
+ "models/LabOrderRequisitionResponse.md",
1252
+ "models/LabOrderTest.md",
1253
+ "models/LabOrderUnsentItem.md",
1245
1254
  "models/LicenseVerification.md",
1246
1255
  "models/ListActionsResponse.md",
1247
1256
  "models/ListActivityResponse.md",
@@ -1256,6 +1265,7 @@
1256
1265
  "models/ListImmunizationsResponse.md",
1257
1266
  "models/ListImpiloDevicesResponse.md",
1258
1267
  "models/ListKnowledgeResponse.md",
1268
+ "models/ListLabOrdersResponse.md",
1259
1269
  "models/ListMedicalConceptsGetResponse.md",
1260
1270
  "models/ListNotificationsResponse.md",
1261
1271
  "models/ListObservationsResponse.md",
@@ -1403,6 +1413,8 @@
1403
1413
  "models/PersonRelationship.md",
1404
1414
  "models/Phone.md",
1405
1415
  "models/PhoneType.md",
1416
+ "models/PlaceLabOrderRequest.md",
1417
+ "models/PlaceLabOrderResponse.md",
1406
1418
  "models/PlaceTestOrderRequest.md",
1407
1419
  "models/PlaceTestOrderResponse.md",
1408
1420
  "models/PlaidCreateIdentityVerificationRequest.md",
@@ -1433,7 +1445,9 @@
1433
1445
  "models/ProviderEncounterListResponse.md",
1434
1446
  "models/ProviderEncounterRecord.md",
1435
1447
  "models/ProviderEncounterResponse.md",
1448
+ "models/ProviderEncounterStatusCounts.md",
1436
1449
  "models/ProviderGender.md",
1450
+ "models/ProviderHomeSummaryResponse.md",
1437
1451
  "models/ProviderIdentifier.md",
1438
1452
  "models/ProviderIdentifierType.md",
1439
1453
  "models/ProviderLanguage.md",
@@ -1446,9 +1460,11 @@
1446
1460
  "models/ProviderLocationRequest.md",
1447
1461
  "models/ProviderOnboardingStatus.md",
1448
1462
  "models/ProviderPatientAddress.md",
1463
+ "models/ProviderPatientListResponse.md",
1449
1464
  "models/ProviderPatientPhone.md",
1450
1465
  "models/ProviderPatientRecordResources.md",
1451
1466
  "models/ProviderPatientRecordResponse.md",
1467
+ "models/ProviderPatientResponse.md",
1452
1468
  "models/ProviderPatientSummary.md",
1453
1469
  "models/ProviderPostgraduateTraining.md",
1454
1470
  "models/ProviderProfessionalLiability.md",
@@ -3217,10 +3233,14 @@
3217
3233
  "operations/provider.completePractitionerOnboarding.md",
3218
3234
  "operations/provider.confirmResetPassword.md",
3219
3235
  "operations/provider.connect.md",
3236
+ "operations/provider.createPatient.md",
3220
3237
  "operations/provider.createPractitionerLocation.md",
3221
3238
  "operations/provider.deletePractitionerLocation.md",
3222
3239
  "operations/provider.getAppointment.md",
3223
3240
  "operations/provider.getEncounter.md",
3241
+ "operations/provider.getHomeSummary.md",
3242
+ "operations/provider.getLabOrder.md",
3243
+ "operations/provider.getLabOrderRequisition.md",
3224
3244
  "operations/provider.getPatientRecord.md",
3225
3245
  "operations/provider.getPhoto.md",
3226
3246
  "operations/provider.getPhotoUploadUrl.md",
@@ -3228,9 +3248,12 @@
3228
3248
  "operations/provider.getPractitionerLocation.md",
3229
3249
  "operations/provider.listAppointments.md",
3230
3250
  "operations/provider.listEncounters.md",
3251
+ "operations/provider.listLabOrders.md",
3252
+ "operations/provider.listPatients.md",
3231
3253
  "operations/provider.listPractitionerLocations.md",
3232
3254
  "operations/provider.login.md",
3233
3255
  "operations/provider.logout.md",
3256
+ "operations/provider.placeLabOrder.md",
3234
3257
  "operations/provider.refreshToken.md",
3235
3258
  "operations/provider.register.md",
3236
3259
  "operations/provider.resendVerificationCode.md",
@@ -3256,7 +3279,7 @@
3256
3279
  "operations/vitals.recordVitals.md"
3257
3280
  ],
3258
3281
  "language": "nodejs",
3259
- "modelCount": 2144,
3260
- "operationCount": 1055,
3282
+ "modelCount": 2160,
3283
+ "operationCount": 1062,
3261
3284
  "schemaVersion": 1
3262
3285
  }
@@ -1020,10 +1020,14 @@ Generated call examples use exact public surface signatures. Workflow examples r
1020
1020
  - [Record onboarding completion for the practitioner's current flow](../operations/provider.completePractitionerOnboarding.md)
1021
1021
  - [Complete a password reset](../operations/provider.confirmResetPassword.md)
1022
1022
  - [Health check](../operations/provider.connect.md)
1023
+ - [Create a patient on the calling practitioner's care team](../operations/provider.createPatient.md)
1023
1024
  - [Add a practice location](../operations/provider.createPractitionerLocation.md)
1024
1025
  - [Remove a practice location](../operations/provider.deletePractitionerLocation.md)
1025
1026
  - [Get one appointment with patient demographics](../operations/provider.getAppointment.md)
1026
1027
  - [Get one encounter with patient demographics](../operations/provider.getEncounter.md)
1028
+ - [Counts for the provider's home screen](../operations/provider.getHomeSummary.md)
1029
+ - [Get one Quest lab order requisition](../operations/provider.getLabOrder.md)
1030
+ - [Get the Quest requisition PDF of a lab order](../operations/provider.getLabOrderRequisition.md)
1027
1031
  - [Get a patient's consolidated health record (provider tenant scope)](../operations/provider.getPatientRecord.md)
1028
1032
  - [Get a practitioner photo](../operations/provider.getPhoto.md)
1029
1033
  - [Get a presigned photo upload URL](../operations/provider.getPhotoUploadUrl.md)
@@ -1031,9 +1035,12 @@ Generated call examples use exact public surface signatures. Workflow examples r
1031
1035
  - [Get one practice location](../operations/provider.getPractitionerLocation.md)
1032
1036
  - [List tenant appointments](../operations/provider.listAppointments.md)
1033
1037
  - [List tenant encounters](../operations/provider.listEncounters.md)
1038
+ - [List a tenant patient's Quest lab orders](../operations/provider.listLabOrders.md)
1039
+ - [List or search the calling practitioner's patients](../operations/provider.listPatients.md)
1034
1040
  - [List the practitioner's practice locations](../operations/provider.listPractitionerLocations.md)
1035
1041
  - [Log in a practitioner](../operations/provider.login.md)
1036
1042
  - [Sign out the practitioner and revoke their tokens](../operations/provider.logout.md)
1043
+ - [Place a Quest lab order for a tenant patient](../operations/provider.placeLabOrder.md)
1037
1044
  - [Refresh practitioner access tokens](../operations/provider.refreshToken.md)
1038
1045
  - [Register a practitioner](../operations/provider.register.md)
1039
1046
  - [Resend the email verification OTP](../operations/provider.resendVerificationCode.md)
package/docs/index.md CHANGED
@@ -1028,10 +1028,14 @@ This directory is generated from the shared structured docs data. Do not edit ge
1028
1028
  - [Record onboarding completion for the practitioner's current flow](operations/provider.completePractitionerOnboarding.md) (`provider.completePractitionerOnboarding`)
1029
1029
  - [Complete a password reset](operations/provider.confirmResetPassword.md) (`provider.confirmResetPassword`)
1030
1030
  - [Health check](operations/provider.connect.md) (`provider.connect`)
1031
+ - [Create a patient on the calling practitioner's care team](operations/provider.createPatient.md) (`provider.createPatient`)
1031
1032
  - [Add a practice location](operations/provider.createPractitionerLocation.md) (`provider.createPractitionerLocation`)
1032
1033
  - [Remove a practice location](operations/provider.deletePractitionerLocation.md) (`provider.deletePractitionerLocation`)
1033
1034
  - [Get one appointment with patient demographics](operations/provider.getAppointment.md) (`provider.getAppointment`)
1034
1035
  - [Get one encounter with patient demographics](operations/provider.getEncounter.md) (`provider.getEncounter`)
1036
+ - [Counts for the provider's home screen](operations/provider.getHomeSummary.md) (`provider.getHomeSummary`)
1037
+ - [Get one Quest lab order requisition](operations/provider.getLabOrder.md) (`provider.getLabOrder`)
1038
+ - [Get the Quest requisition PDF of a lab order](operations/provider.getLabOrderRequisition.md) (`provider.getLabOrderRequisition`)
1035
1039
  - [Get a patient's consolidated health record (provider tenant scope)](operations/provider.getPatientRecord.md) (`provider.getPatientRecord`)
1036
1040
  - [Get a practitioner photo](operations/provider.getPhoto.md) (`provider.getPhoto`)
1037
1041
  - [Get a presigned photo upload URL](operations/provider.getPhotoUploadUrl.md) (`provider.getPhotoUploadUrl`)
@@ -1039,9 +1043,12 @@ This directory is generated from the shared structured docs data. Do not edit ge
1039
1043
  - [Get one practice location](operations/provider.getPractitionerLocation.md) (`provider.getPractitionerLocation`)
1040
1044
  - [List tenant appointments](operations/provider.listAppointments.md) (`provider.listAppointments`)
1041
1045
  - [List tenant encounters](operations/provider.listEncounters.md) (`provider.listEncounters`)
1046
+ - [List a tenant patient's Quest lab orders](operations/provider.listLabOrders.md) (`provider.listLabOrders`)
1047
+ - [List or search the calling practitioner's patients](operations/provider.listPatients.md) (`provider.listPatients`)
1042
1048
  - [List the practitioner's practice locations](operations/provider.listPractitionerLocations.md) (`provider.listPractitionerLocations`)
1043
1049
  - [Log in a practitioner](operations/provider.login.md) (`provider.login`)
1044
1050
  - [Sign out the practitioner and revoke their tokens](operations/provider.logout.md) (`provider.logout`)
1051
+ - [Place a Quest lab order for a tenant patient](operations/provider.placeLabOrder.md) (`provider.placeLabOrder`)
1045
1052
  - [Refresh practitioner access tokens](operations/provider.refreshToken.md) (`provider.refreshToken`)
1046
1053
  - [Register a practitioner](operations/provider.register.md) (`provider.register`)
1047
1054
  - [Resend the email verification OTP](operations/provider.resendVerificationCode.md) (`provider.resendVerificationCode`)
@@ -0,0 +1,22 @@
1
+ # CreateProviderPatientRequest
2
+
3
+ Model ID: `CreateProviderPatientRequest`
4
+
5
+ A new patient, assigned to the calling practitioner.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `date_of_birth` | `string` | Yes | date | | | No | Patient's date of birth (ISO date, not in the future). |
14
+ | `email` | `string|null` | No | | | | Yes | Patient's email address, when known. |
15
+ | `first_name` | `string` | Yes | | | | No | Patient's first (given) name. |
16
+ | `gender` | `string` | Yes | | male, female, other, unknown | | No | Administrative gender. |
17
+ | `last_name` | `string` | Yes | | | | No | Patient's last (family) name. |
18
+ | `phone` | `string|null` | No | | | | Yes | Patient's mobile phone number, 10-15 digits with an optional leading +. |
19
+
20
+ ## Example
21
+
22
+ None declared in canonical OpenAPI.
@@ -0,0 +1,35 @@
1
+ # LabOrder
2
+
3
+ Model ID: `LabOrder`
4
+
5
+ One Quest requisition (one FHIR ServiceRequest).
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `abn_required` | `boolean` | Yes | | | | No | Quest flagged an Advance Beneficiary Notice. |
14
+ | `ack_code` | `string|null` | No | | | | Yes | Quest MSA-1 acknowledgment code (AA, AE, AR). |
15
+ | `authored_at` | `string|null` | No | | | | Yes | When the order was placed, ISO 8601 with offset. |
16
+ | `collection_modality` | `string` | Yes | | psc, home_kit | | No | |
17
+ | `diagnoses` | array of [`LabOrderDiagnosis`](./LabOrderDiagnosis.md) | Yes | | | | No | |
18
+ | `expected_collection_at` | `string|null` | No | | | | Yes | OBR-7: expected PSC visit or kit collection. |
19
+ | `fhir_status` | `string` | Yes | | | | No | ServiceRequest.status: draft, active, completed (Quest reported every test final) or revoked. |
20
+ | `lab` | `string` | Yes | | | | No | Quest performing lab, MET. |
21
+ | `order_group_id` | `string` | Yes | | | | No | Shared by the requisitions of one placed order (ServiceRequest.requisition). |
22
+ | `order_id` | `string` | Yes | | | | No | FHIR ServiceRequest id. |
23
+ | `ordering_provider` | [`LabOrderProvider`](./LabOrderProvider.md) | Yes | | | | No | |
24
+ | `patient_id` | `string` | Yes | | | | No | |
25
+ | `placer_order_number` | `string` | Yes | | | | No | Quest Lab Reference Number (ORC-2), printed on the requisition. |
26
+ | `quest_http_status` | `integer|null` | No | | | | Yes | HTTP status when Quest refused the request itself. |
27
+ | `requester` | `string|null` | No | | | | Yes | Who placed the order, e.g. Practitioner/{id}. |
28
+ | `requisition_available` | `boolean` | Yes | | | | No | A requisition PDF is stored; see .../requisition. |
29
+ | `source` | `string` | Yes | | provider_app, athena_ori | | No | |
30
+ | `status` | `string` | Yes | | submitting, accepted, rejected | | No | submitting: Quest's answer is not known yet; retry POST with the same idempotency_key. accepted: Quest answered AA. rejected: Quest refused it; the idempotency_key is used up. |
31
+ | `tests` | array of [`LabOrderTest`](./LabOrderTest.md) | Yes | | | | No | |
32
+
33
+ ## Example
34
+
35
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # LabOrderDiagnosis
2
+
3
+ Model ID: `LabOrderDiagnosis`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `code` | `string` | Yes | | | | No | ICD-10-CM code with its dot, e.g. R53.83. |
14
+ | `description` | `string|null` | No | | | | Yes | Printed on the requisition (DG1-4). |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # LabOrderErrorResponse
2
+
3
+ Model ID: `LabOrderErrorResponse`
4
+
5
+ 4xx/503 body of the lab-order routes; ``fields`` name request or configuration fields only.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `code` | `string` | Yes | | | | No | Stable error code, e.g. aoe_answer_missing or quest_rejected. |
14
+ | `error` | `string` | Yes | | | | No | Human-readable explanation of why the request failed. |
15
+ | `fields` | `array` | No | | | | No | Offending fields, e.g. aoe_answers.395.75400658; a panel member is catalog_items.{id}. |
16
+ | `order_group_id` | `string|null` | No | | | | Yes | Set with code quest_rejected. |
17
+ | `orders` | array of [`LabOrder`](./LabOrder.md) | No | | | | No | With code quest_rejected: every requisition, so accepted ones are not re-ordered. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,17 @@
1
+ # LabOrderItemRequest
2
+
3
+ Model ID: `LabOrderItemRequest`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `catalog_item_id` | `string` | Yes | uuid | | | No | Diagnostic catalog test or panel id; a panel is expanded to its tests. |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # LabOrderProvider
2
+
3
+ Model ID: `LabOrderProvider`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `first_name` | `string` | Yes | | | | No | |
14
+ | `last_name` | `string` | Yes | | | | No | |
15
+ | `npi` | `string` | Yes | | | | No | Ordering provider NPI sent in ORC-12/OBR-16. |
16
+ | `source` | `string` | Yes | | roster, default_provider | | No | roster: the caller's own entry in the tenant's Quest roster. default_provider: the tenant default provider, for callers the tenant authorizes to order under it. |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # LabOrderRequisitionResponse
2
+
3
+ Model ID: `LabOrderRequisitionResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `content_type` | `string` | Yes | | | | No | application/pdf |
14
+ | `data_b64` | `string` | Yes | | | | No | Base64 requisition PDF, as Quest returned it. |
15
+ | `document_id` | `string` | Yes | | | | No | FHIR DocumentReference id. |
16
+ | `order_id` | `string` | Yes | | | | No | |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # LabOrderTest
2
+
3
+ Model ID: `LabOrderTest`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `catalog_item_id` | `string` | Yes | | | | No | Catalog test that put this code on the requisition. |
14
+ | `description` | `string` | Yes | | | | No | Quest compendium description. |
15
+ | `quest_code` | `string` | Yes | | | | No | Quest order code sent in OBR-4. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # LabOrderUnsentItem
2
+
3
+ Model ID: `LabOrderUnsentItem`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `catalog_item_id` | `string` | Yes | | | | No | |
14
+ | `name` | `string` | Yes | | | | No | |
15
+ | `reason` | `string` | Yes | | | | No | Rapid tests are ordered through the kit flow, not Quest. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # ListLabOrdersResponse
2
+
3
+ Model ID: `ListLabOrdersResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `orders` | array of [`LabOrder`](./LabOrder.md) | Yes | | | | No | |
14
+ | `total` | `integer` | Yes | | | | No | |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -0,0 +1,27 @@
1
+ # PlaceLabOrderRequest
2
+
3
+ Model ID: `PlaceLabOrderRequest`
4
+
5
+ Body of POST /patients/{patient_id}/lab-orders.
6
+
7
+ The service checks the rest: AOE answers against the stored Quest
8
+ compendium, ASCII-only text, the IANA time zone and the 60-character NTE limit.
9
+
10
+ Type: `object`
11
+
12
+ ## Fields
13
+
14
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
15
+ |---|---|---:|---|---|---|---:|---|
16
+ | `aoe_answers` | `object` | No | | | | No | Ask-at-order-entry answers: Quest test code -> question code -> answer. Every active question of every ordered Quest code is required; the question text comes from the compendium. |
17
+ | `collection_timezone` | `string` | Yes | | | | No | IANA time zone of the collection site, e.g. America/New_York. |
18
+ | `comments` | `array` | No | | | | No | Order notes, at most 60 characters each (NTE). |
19
+ | `diagnoses` | array of [`LabOrderDiagnosis`](./LabOrderDiagnosis.md) | Yes | | | | No | Unique ICD-10-CM codes. |
20
+ | `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter of this patient the order belongs to. |
21
+ | `expected_collection_date` | `string|null` | No | | | | Yes | Expected PSC visit, local date; defaults to tomorrow. Not before today. |
22
+ | `idempotency_key` | `string` | Yes | uuid | | | No | New UUID per order. A retry after 202, a timeout or a 5xx must reuse it with the same body. |
23
+ | `items` | array of [`LabOrderItemRequest`](./LabOrderItemRequest.md) | Yes | | | | No | Catalog tests and panels. |
24
+
25
+ ## Example
26
+
27
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # PlaceLabOrderResponse
2
+
3
+ Model ID: `PlaceLabOrderResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `order_group_id` | `string` | Yes | | | | No | |
14
+ | `orders` | array of [`LabOrder`](./LabOrder.md) | Yes | | | | No | One per Quest requisition: one per collection modality. |
15
+ | `replayed` | `boolean` | Yes | | | | No | Every requisition already existed and was not sent again by this call. |
16
+ | `unsent_items` | array of [`LabOrderUnsentItem`](./LabOrderUnsentItem.md) | No | | | | No | |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.