@healthcloudai/hc-sdk 3.30.1 → 3.31.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.
package/dist/index.js CHANGED
@@ -24,8 +24,8 @@ function resolveBaseUrl(environment, service) {
24
24
  assertEnvironment(environment);
25
25
  if (service === "ams") {
26
26
  if (environment === "dev") return "https://dev-ams-services.health.cloud/api/ams";
27
- const prefix = environment === "prod" ? "" : `${environment}-`;
28
- return `https://${prefix}amsservices.health.cloud/api/ams`;
27
+ if (environment === "prod") return "https://ams-services.health.cloud/api/ams";
28
+ return "https://uat-amsservices.health.cloud/api/ams";
29
29
  }
30
30
  return `https://${environment}-api-${service}.health.cloud`;
31
31
  }
@@ -4037,6 +4037,16 @@ var ProviderClient = class extends BaseServiceClient {
4037
4037
  createPracticeInvite(request) {
4038
4038
  return this.send("POST", "/practice/invites", { body: request != null ? request : {} });
4039
4039
  }
4040
+ /**
4041
+ * Every appointment patients booked through the practice scheduler (GET /practice/appointments), for the practice
4042
+ * whose owner is the authenticated provider. Never EHR-only or other practices' rows. Window `start_date`..`end_date`
4043
+ * (YYYY-MM-DD; default today..+30 days, at most 90 days); `status` is a FHIR Appointment status; `limit` is 1-200
4044
+ * (default 100). Each row has `appointment_id`, `patient_id`, `start`, `end`, `status`, `telehealth_link`, `reason`
4045
+ * and a `patient` summary. Practice owner only (403 otherwise).
4046
+ */
4047
+ listPracticeAppointments(filters) {
4048
+ return this.send("GET", "/practice/appointments", { query: filters });
4049
+ }
4040
4050
  /**
4041
4051
  * Ask the patient to schedule a telehealth appointment (POST /encounters/{id}/telehealth-request). Records a proposed
4042
4052
  * telehealth appointment and sends the patient a generic notice. At most one request per encounter per hour: a repeat
@@ -28,6 +28,7 @@
28
28
  - [`listLabCatalog`](../operations/provider.listLabCatalog.md) — List the tests and panels a provider can order
29
29
  - [`listLabOrders`](../operations/provider.listLabOrders.md) — List a tenant patient's Quest lab orders
30
30
  - [`listPatients`](../operations/provider.listPatients.md) — List or search the calling practitioner's patients
31
+ - [`listPracticeAppointments`](../operations/provider.listPracticeAppointments.md) — List all appointments of the practice
31
32
  - [`listPractitionerLocations`](../operations/provider.listPractitionerLocations.md) — List the practitioner's practice locations
32
33
  - [`login`](../operations/provider.login.md) — Log in a practitioner
33
34
  - [`logout`](../operations/provider.logout.md) — Sign out the practitioner and revoke their tokens
@@ -1,6 +1,6 @@
1
1
  # Configuration
2
2
 
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.
3
+ - `environment`: API defaults use https://{environment}-api-{service}.health.cloud. AMS DEV uses https://dev-ams-services.health.cloud/api/ams and PROD uses https://ams-services.health.cloud/api/ams (AWS); UAT remains https://uat-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
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.
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:24644360c14d6f45a0e6b0738ecee17ec9120a878b9a80e336bae7bc27be043e",
2
+ "docsDataContentDigest": "sha256:c82602be04902d6cdda398ccaf482e890c324f908907b9979fdfa0c6e615f1d8",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AmsClient.md",
@@ -1501,6 +1501,8 @@
1501
1501
  "models/ProviderPatientResponse.md",
1502
1502
  "models/ProviderPatientSummary.md",
1503
1503
  "models/ProviderPostgraduateTraining.md",
1504
+ "models/ProviderPracticeAppointment.md",
1505
+ "models/ProviderPracticeAppointmentsResponse.md",
1504
1506
  "models/ProviderProfessionalLiability.md",
1505
1507
  "models/ProviderQueueEncounter.md",
1506
1508
  "models/ProviderQueuePatient.md",
@@ -3309,6 +3311,7 @@
3309
3311
  "operations/provider.listLabCatalog.md",
3310
3312
  "operations/provider.listLabOrders.md",
3311
3313
  "operations/provider.listPatients.md",
3314
+ "operations/provider.listPracticeAppointments.md",
3312
3315
  "operations/provider.listPractitionerLocations.md",
3313
3316
  "operations/provider.login.md",
3314
3317
  "operations/provider.logout.md",
@@ -3344,7 +3347,7 @@
3344
3347
  "operations/vitals.recordVitals.md"
3345
3348
  ],
3346
3349
  "language": "nodejs",
3347
- "modelCount": 2204,
3348
- "operationCount": 1083,
3350
+ "modelCount": 2206,
3351
+ "operationCount": 1084,
3349
3352
  "schemaVersion": 1
3350
3353
  }
@@ -1052,6 +1052,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
1052
1052
  - [List the tests and panels a provider can order](../operations/provider.listLabCatalog.md)
1053
1053
  - [List a tenant patient's Quest lab orders](../operations/provider.listLabOrders.md)
1054
1054
  - [List or search the calling practitioner's patients](../operations/provider.listPatients.md)
1055
+ - [List all appointments of the practice](../operations/provider.listPracticeAppointments.md)
1055
1056
  - [List the practitioner's practice locations](../operations/provider.listPractitionerLocations.md)
1056
1057
  - [Log in a practitioner](../operations/provider.login.md)
1057
1058
  - [Sign out the practitioner and revoke their tokens](../operations/provider.logout.md)
package/docs/index.md CHANGED
@@ -1060,6 +1060,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
1060
1060
  - [List the tests and panels a provider can order](operations/provider.listLabCatalog.md) (`provider.listLabCatalog`)
1061
1061
  - [List a tenant patient's Quest lab orders](operations/provider.listLabOrders.md) (`provider.listLabOrders`)
1062
1062
  - [List or search the calling practitioner's patients](operations/provider.listPatients.md) (`provider.listPatients`)
1063
+ - [List all appointments of the practice](operations/provider.listPracticeAppointments.md) (`provider.listPracticeAppointments`)
1063
1064
  - [List the practitioner's practice locations](operations/provider.listPractitionerLocations.md) (`provider.listPractitionerLocations`)
1064
1065
  - [Log in a practitioner](operations/provider.login.md) (`provider.login`)
1065
1066
  - [Sign out the practitioner and revoke their tokens](operations/provider.logout.md) (`provider.logout`)
@@ -0,0 +1,25 @@
1
+ # ProviderPracticeAppointment
2
+
3
+ Model ID: `ProviderPracticeAppointment`
4
+
5
+ One appointment booked through the practice scheduler.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `appointment_id` | `string` | Yes | | | | No | Stable appointment identifier; Athena-authoritative tenants return Athena's native appointment ID. |
14
+ | `end` | `string|null` | No | | | | Yes | Appointment end in ISO 8601 date-time format. |
15
+ | `patient` | [`ProviderPatientSummary`](./ProviderPatientSummary.md) | No | | | | Yes | Demographic snapshot (first/last name, gender, DOB, address, phone) of the associated patient. On list responses, only the first 20 items carry a summary; by-ID responses always include it when readable. |
16
+ | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID associated with the appointment. |
17
+ | `provider_id` | `string|null` | No | | | | Yes | FHIR Practitioner resource ID, when available. |
18
+ | `reason` | `string|null` | No | | | | Yes | The reason the patient gave when booking, when one was stored. |
19
+ | `start` | `string|null` | No | | | | Yes | Appointment start in ISO 8601 date-time format. |
20
+ | `status` | `string` | Yes | | scheduled, confirmed, cancelled, completed, no_show | | No | Normalized appointment lifecycle status. |
21
+ | `telehealth_link` | `string|null` | No | | | | Yes | Video-visit link, when one has been created for this appointment. |
22
+
23
+ ## Example
24
+
25
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # ProviderPracticeAppointmentsResponse
2
+
3
+ Model ID: `ProviderPracticeAppointmentsResponse`
4
+
5
+ GET /practice/appointments: every practice-scheduler appointment of the caller's practice.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `appointments` | array of [`ProviderPracticeAppointment`](./ProviderPracticeAppointment.md) | Yes | | | | No | Appointments in the window, in start order. Each carries a `patient` summary when the patient is readable. |
14
+ | `practice_id` | `string` | Yes | | | | No | The practice's Practitioner id (the caller's own). |
15
+ | `total` | `integer` | Yes | | | | No | Number of appointments returned. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -1612,6 +1612,8 @@
1612
1612
  - [ProviderPatientResponse](ProviderPatientResponse.md)
1613
1613
  - [ProviderPatientSummary](ProviderPatientSummary.md)
1614
1614
  - [ProviderPostgraduateTraining](ProviderPostgraduateTraining.md)
1615
+ - [ProviderPracticeAppointment](ProviderPracticeAppointment.md)
1616
+ - [ProviderPracticeAppointmentsResponse](ProviderPracticeAppointmentsResponse.md)
1615
1617
  - [ProviderProfessionalLiability](ProviderProfessionalLiability.md)
1616
1618
  - [ProviderQueueEncounter](ProviderQueueEncounter.md)
1617
1619
  - [ProviderQueuePatient](ProviderQueuePatient.md)
@@ -78,7 +78,7 @@ const result = await ams.getAgentsForTenant(tenantId);
78
78
 
79
79
  ```bash
80
80
  curl -X GET \
81
- 'https://dev-amsservices.health.cloud/api/ams/application/agents/%3CTENANT_ID%3E'
81
+ 'https://dev-ams-services.health.cloud/api/ams/application/agents/%3CTENANT_ID%3E'
82
82
  ```
83
83
 
84
84
  ## Notes
@@ -0,0 +1,166 @@
1
+ # List all appointments of the practice
2
+
3
+ Operation ID: `provider.listPracticeAppointments`
4
+
5
+ Every appointment patients booked through the practice scheduler (the practice's own telehealth slots), for the window `start_date`..`end_date` (YYYY-MM-DD; default today to 30 days ahead, at most 90 days). Appointments that exist only in an EHR such as Athena, and other practices' appointments, are never returned. `appointment_id` is accepted by the appointment by-ID routes. Optional `status` (FHIR Appointment status), `patient_id`, `limit` (default 100, at most 200). Practice owner only.
6
+
7
+ ## Public method
8
+
9
+ `listPracticeAppointments`
10
+
11
+ Signature: `provider.listPracticeAppointments(filters)`
12
+
13
+ Return type: `Promise<ProviderPracticeAppointmentsResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /practice/appointments`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
36
+ |---|---|---:|---|---|---|---:|---|
37
+ | `start_date` | `string|null` | No | | | | Yes | Window start, YYYY-MM-DD. Defaults to today |
38
+ | `end_date` | `string|null` | No | | | | Yes | Window end, YYYY-MM-DD. Defaults to start_date + 30 days |
39
+ | `status` | `string|null` | No | | | | Yes | Optional FHIR Appointment status |
40
+ | `limit` | `string|null` | No | | | | Yes | Maximum rows: 1 to 200 (default 100) |
41
+ | `patient_id` | `string|null` | No | | | | Yes | Optional FHIR Patient resource ID to restrict the list |
42
+
43
+ ## Body parameters
44
+
45
+ None.
46
+
47
+ Request model: None.
48
+
49
+ ## Request example
50
+
51
+ None declared in canonical OpenAPI.
52
+
53
+ ## Success responses
54
+
55
+ | Status | Shape | Content type | Description |
56
+ |---|---|---|---|
57
+ | `200` | [`ProviderPracticeAppointmentsResponse`](../models/ProviderPracticeAppointmentsResponse.md) | application/json | The practice's appointments |
58
+
59
+ ## Success response examples
60
+
61
+ ### 200
62
+
63
+ ```json
64
+ {
65
+ "appointments": [
66
+ {
67
+ "appointment_id": "string",
68
+ "end": "string",
69
+ "patient": {
70
+ "address": {
71
+ "city": "string",
72
+ "country": "string",
73
+ "state": "string",
74
+ "street1": "string",
75
+ "street2": "string",
76
+ "zip_code": "string"
77
+ },
78
+ "date_of_birth": "string",
79
+ "first_name": "string",
80
+ "gender": "string",
81
+ "last_name": "string",
82
+ "patient_id": "string",
83
+ "phone": {
84
+ "extension": "string",
85
+ "number": "string",
86
+ "type": "string"
87
+ }
88
+ },
89
+ "patient_id": "string",
90
+ "provider_id": "string",
91
+ "reason": "string",
92
+ "start": "string",
93
+ "status": "scheduled",
94
+ "telehealth_link": "string"
95
+ }
96
+ ],
97
+ "practice_id": "string",
98
+ "total": 0
99
+ }
100
+ ```
101
+
102
+ ## Common errors
103
+
104
+ | Status | Shape | Content type | Description |
105
+ |---|---|---|---|
106
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Invalid window, status or limit |
107
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider authorization required |
108
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Not a practice owner |
109
+
110
+ ## Error examples
111
+
112
+ ### 400
113
+
114
+ ```json
115
+ {
116
+ "error": "string"
117
+ }
118
+ ```
119
+
120
+ ### 401
121
+
122
+ ```json
123
+ {
124
+ "error": "string"
125
+ }
126
+ ```
127
+
128
+ ### 403
129
+
130
+ ```json
131
+ {
132
+ "error": "string"
133
+ }
134
+ ```
135
+
136
+ ## NodeJS / TypeScript implementation
137
+
138
+ ```ts
139
+ import { HCSDK } from "@healthcloudai/hc-sdk";
140
+ ```
141
+
142
+ ```ts
143
+ const filters = "<FILTERS>";
144
+
145
+ const result = await provider.listPracticeAppointments(filters);
146
+ ```
147
+
148
+ ## cURL
149
+
150
+ ```bash
151
+ curl -X GET \
152
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
153
+ 'https://dev-api-provider.health.cloud/practice/appointments?start_date=2026-08-15T09%3A00%3A00Z&end_date=2026-08-15T09%3A00%3A00Z&status=%3CSTATUS%3E&limit=%3CLIMIT%3E&patient_id=%3CPATIENT_ID%3E'
154
+ ```
155
+
156
+ ## Notes
157
+
158
+ None.
159
+
160
+ ## Prepared Test Console scenario
161
+
162
+ No canonical scenario is currently associated.
163
+
164
+ ## Real response
165
+
166
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "3.30.1",
3
+ "version": "3.31.1",
4
4
  "description": "All-in-one HealthCloud SDK with typed platform APIs and secure connector clients.",
5
5
  "author": "Healthcheck Systems Inc",
6
6
  "license": "MIT",