@healthcloudai/hc-sdk 3.11.0 → 3.12.0

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
@@ -2096,6 +2096,20 @@ function AddPatientIntakeResponseFromJSONTyped(json, ignoreDiscriminator) {
2096
2096
  };
2097
2097
  }
2098
2098
 
2099
+ // src/models/openapi-generated/patient/models/GetDefaultProviderResponse.ts
2100
+ function GetDefaultProviderResponseFromJSON(json) {
2101
+ return GetDefaultProviderResponseFromJSONTyped(json, false);
2102
+ }
2103
+ function GetDefaultProviderResponseFromJSONTyped(json, ignoreDiscriminator) {
2104
+ if (json == null) {
2105
+ return json;
2106
+ }
2107
+ return {
2108
+ "name": json["name"],
2109
+ "npi": json["npi"]
2110
+ };
2111
+ }
2112
+
2099
2113
  // src/clients/PatientClient.ts
2100
2114
  var PatientClient = class extends BaseServiceClient {
2101
2115
  /** Add one agent-collected intake section and return actionable validation errors. */
@@ -2188,6 +2202,11 @@ var PatientClient = class extends BaseServiceClient {
2188
2202
  getDashboard() {
2189
2203
  return this.send("GET", "/patients/dashboard", {});
2190
2204
  }
2205
+ /** GET /patients/defaultprovider — return the authenticated patient's tenant default provider. */
2206
+ async getDefaultProvider() {
2207
+ const response = await this.send("GET", "/patients/defaultprovider", {});
2208
+ return GetDefaultProviderResponseFromJSON(response);
2209
+ }
2191
2210
  getAgentConfiguration() {
2192
2211
  return this.send("GET", "/agentconfiguration", {});
2193
2212
  }
@@ -39,6 +39,7 @@
39
39
  - [`getCheckin`](../operations/patient.getCheckinCheckin.md) — Get current check-in state
40
40
  - [`getCommunicationConsent`](../operations/patient.getCommunicationConsent.md) — Get SMS/phone contact-preference consent
41
41
  - [`getCurrentCareSession`](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md) — Get the current care session
42
+ - [`getDefaultProvider`](../operations/patient.getDefaultProvider.md) — Get the tenant default provider
42
43
  - [`getEncounter`](../operations/patient.getEncounter.md) — Get an encounter
43
44
  - [`listPatientInsurances`](../operations/patient.getInsurance.md) — List insurance coverage
44
45
  - [`getLatestEncounter`](../operations/patient.getLatestEncounter.md) — Get the patient's latest open encounter
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:6e7792f233e63fa5217b47b397dab0b95e12f5f5bef8f4b9b2e62e2da274b0da",
2
+ "docsDataContentDigest": "sha256:5475deccae12d7b690d5249fdec94ca286cbc8482df0fd5224b5e3e8d21c252b",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AmsClient.md",
@@ -588,6 +588,7 @@
588
588
  "models/GetAppointmentTelehealthLinkResponse.md",
589
589
  "models/GetCheckinCheckinResponse.md",
590
590
  "models/GetCurrentCareSessionCareSessionsCurrentResponse.md",
591
+ "models/GetDefaultProviderResponse.md",
591
592
  "models/GetDiagnosticAnalyteResponse.md",
592
593
  "models/GetDiagnosticSpecialtiesResponse.md",
593
594
  "models/GetDiagnosticTestRelationshipsResponse.md",
@@ -3010,6 +3011,7 @@
3010
3011
  "operations/patient.getCheckinCheckin.md",
3011
3012
  "operations/patient.getCommunicationConsent.md",
3012
3013
  "operations/patient.getCurrentCareSessionCareSessionsCurrent.md",
3014
+ "operations/patient.getDefaultProvider.md",
3013
3015
  "operations/patient.getEncounter.md",
3014
3016
  "operations/patient.getInsurance.md",
3015
3017
  "operations/patient.getLatestEncounter.md",
@@ -3109,7 +3111,7 @@
3109
3111
  "operations/vitals.recordVitals.md"
3110
3112
  ],
3111
3113
  "language": "nodejs",
3112
- "modelCount": 2027,
3113
- "operationCount": 1025,
3114
+ "modelCount": 2028,
3115
+ "operationCount": 1026,
3114
3116
  "schemaVersion": 1
3115
3117
  }
@@ -930,6 +930,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
930
930
  - [Get current check-in state](../operations/patient.getCheckinCheckin.md)
931
931
  - [Get SMS/phone contact-preference consent](../operations/patient.getCommunicationConsent.md)
932
932
  - [Get the current care session](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md)
933
+ - [Get the tenant default provider](../operations/patient.getDefaultProvider.md)
933
934
  - [Get an encounter](../operations/patient.getEncounter.md)
934
935
  - [List insurance coverage](../operations/patient.getInsurance.md)
935
936
  - [Get the patient's latest open encounter](../operations/patient.getLatestEncounter.md)
package/docs/index.md CHANGED
@@ -938,6 +938,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
938
938
  - [Get current check-in state](operations/patient.getCheckinCheckin.md) (`patient.getCheckinCheckin`)
939
939
  - [Get SMS/phone contact-preference consent](operations/patient.getCommunicationConsent.md) (`patient.getCommunicationConsent`)
940
940
  - [Get the current care session](operations/patient.getCurrentCareSessionCareSessionsCurrent.md) (`patient.getCurrentCareSessionCareSessionsCurrent`)
941
+ - [Get the tenant default provider](operations/patient.getDefaultProvider.md) (`patient.getDefaultProvider`)
941
942
  - [Get an encounter](operations/patient.getEncounter.md) (`patient.getEncounter`)
942
943
  - [List insurance coverage](operations/patient.getInsurance.md) (`patient.getInsurance`)
943
944
  - [Get the patient's latest open encounter](operations/patient.getLatestEncounter.md) (`patient.getLatestEncounter`)
@@ -0,0 +1,18 @@
1
+ # GetDefaultProviderResponse
2
+
3
+ Model ID: `GetDefaultProviderResponse`
4
+
5
+ Default provider configured for the authenticated patient's tenant.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `name` | `string` | Yes | | | | No | Provider's full name. |
14
+ | `npi` | `string` | Yes | | | | No | Provider's 10-digit US National Provider Identifier. |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -573,6 +573,7 @@
573
573
  - [GetAppointmentTelehealthLinkResponse](GetAppointmentTelehealthLinkResponse.md)
574
574
  - [GetCheckinCheckinResponse](GetCheckinCheckinResponse.md)
575
575
  - [GetCurrentCareSessionCareSessionsCurrentResponse](GetCurrentCareSessionCareSessionsCurrentResponse.md)
576
+ - [GetDefaultProviderResponse](GetDefaultProviderResponse.md)
576
577
  - [GetDiagnosticAnalyteResponse](GetDiagnosticAnalyteResponse.md)
577
578
  - [GetDiagnosticSpecialtiesResponse](GetDiagnosticSpecialtiesResponse.md)
578
579
  - [GetDiagnosticTestRelationshipsResponse](GetDiagnosticTestRelationshipsResponse.md)
@@ -0,0 +1,117 @@
1
+ # Get the tenant default provider
2
+
3
+ Operation ID: `patient.getDefaultProvider`
4
+
5
+ Return the configured default provider's full name and 10-digit NPI for the authenticated patient's tenant. Requires a patient Bearer JWT; the tenant is derived from that token and cannot be supplied by the client. Returns 404 when the account has no default provider configured.
6
+
7
+ ## Public method
8
+
9
+ `getDefaultProvider`
10
+
11
+ Signature: `patient.getDefaultProvider()`
12
+
13
+ Return type: `Promise<GetDefaultProviderResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /patients/defaultprovider`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ None.
36
+
37
+ ## Body parameters
38
+
39
+ None.
40
+
41
+ Request model: None.
42
+
43
+ ## Request example
44
+
45
+ None declared in canonical OpenAPI.
46
+
47
+ ## Success responses
48
+
49
+ | Status | Shape | Content type | Description |
50
+ |---|---|---|---|
51
+ | `200` | [`GetDefaultProviderResponse`](../models/GetDefaultProviderResponse.md) | application/json | Default provider configured for the authenticated patient's tenant |
52
+
53
+ ## Success response examples
54
+
55
+ ### 200
56
+
57
+ ```json
58
+ {
59
+ "name": "Murdoc Khaleghi",
60
+ "npi": "1942427778"
61
+ }
62
+ ```
63
+
64
+ ## Common errors
65
+
66
+ | Status | Shape | Content type | Description |
67
+ |---|---|---|---|
68
+ | `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing, invalid, expired, or non-patient Bearer JWT |
69
+ | `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The authenticated patient has no FHIR Patient record |
70
+
71
+ ## Error examples
72
+
73
+ ### 401 — Missing or invalid access token
74
+
75
+ ```json
76
+ {
77
+ "error": "Authorization required"
78
+ }
79
+ ```
80
+
81
+ ### 404 — Patient not found
82
+
83
+ ```json
84
+ {
85
+ "error": "Patient not found"
86
+ }
87
+ ```
88
+
89
+ ## NodeJS / TypeScript implementation
90
+
91
+ ```ts
92
+ import { HCSDK } from "@healthcloudai/hc-sdk";
93
+ ```
94
+
95
+ ```ts
96
+ const result = await patient.getDefaultProvider();
97
+ ```
98
+
99
+ ## cURL
100
+
101
+ ```bash
102
+ curl -X GET \
103
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
104
+ 'https://dev-api-patient.health.cloud/patients/defaultprovider'
105
+ ```
106
+
107
+ ## Notes
108
+
109
+ None.
110
+
111
+ ## Prepared Test Console scenario
112
+
113
+ No canonical scenario is currently associated.
114
+
115
+ ## Real response
116
+
117
+ 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.11.0",
3
+ "version": "3.12.0",
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",