@healthcloudai/hc-sdk 2.0.2 → 2.2.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.
Files changed (60) hide show
  1. package/README.md +3 -1
  2. package/dist/index.cjs +24 -10
  3. package/dist/index.d.cts +1602 -550
  4. package/dist/index.d.ts +1602 -550
  5. package/dist/index.js +24 -10
  6. package/docs/clients/FieldAgentClient.md +3 -0
  7. package/docs/clients/PatientClient.md +1 -2
  8. package/docs/clients/TelehealthClient.md +0 -1
  9. package/docs/docs-manifest.json +28 -10
  10. package/docs/examples/index.md +4 -3
  11. package/docs/index.md +4 -3
  12. package/docs/models/AddDependentRequest.md +10 -6
  13. package/docs/models/AddDependentResponse.md +17 -0
  14. package/docs/models/AddNotificationResponse.md +19 -0
  15. package/docs/models/CreateQuestionnaireRequest.md +3 -3
  16. package/docs/models/CreateQuestionnaireResponse.md +1 -1
  17. package/docs/models/DependentResponse.md +17 -0
  18. package/docs/models/GetPatientPhotoResponse.md +15 -0
  19. package/docs/models/ListDependentsResponse.md +2 -2
  20. package/docs/models/ListNotificationsResponse.md +2 -2
  21. package/docs/models/NotificationResponse.md +19 -0
  22. package/docs/models/NotificationUpsertRequest.md +23 -0
  23. package/docs/models/OnboardEncounterPayload.md +35 -0
  24. package/docs/models/OnboardEncounterStepResult.md +15 -0
  25. package/docs/models/OnboardPatientPayload.md +22 -0
  26. package/docs/models/OnboardPatientRequest.md +4 -4
  27. package/docs/models/OnboardPatientResponse.md +4 -4
  28. package/docs/models/OnboardPatientStepResult.md +20 -0
  29. package/docs/models/OnboardQuestionnaireAnswer.md +15 -0
  30. package/docs/models/OnboardQuestionnaireDefinition.md +19 -0
  31. package/docs/models/OnboardQuestionnairePayload.md +19 -0
  32. package/docs/models/OnboardQuestionnaireResponseItem.md +14 -0
  33. package/docs/models/OnboardQuestionnaireStepResult.md +16 -0
  34. package/docs/models/OnboardVitalsPayload.md +19 -0
  35. package/docs/models/OnboardVitalsStepResult.md +15 -0
  36. package/docs/models/PatientPhotoUploadUrlResponse.md +14 -0
  37. package/docs/models/QuestionItemType.md +11 -0
  38. package/docs/models/QuestionnaireItemInput.md +21 -0
  39. package/docs/models/UploadPatientPhotoRequest.md +14 -0
  40. package/docs/models/{FetchRtcTokenResponse.md → UploadPatientPhotoResponse.md} +3 -4
  41. package/docs/models/index.md +22 -5
  42. package/docs/operations/fieldagent.confirmResetPassword.md +1 -1
  43. package/docs/operations/fieldagent.getPatientPhoto.md +85 -0
  44. package/docs/operations/{patient.commsRtcToken.md → fieldagent.patientPhotoUploadUrl.md} +19 -18
  45. package/docs/operations/fieldagent.uploadPatientPhoto.md +87 -0
  46. package/docs/operations/patient.addDependent.md +2 -2
  47. package/docs/operations/patient.addNotification.md +3 -3
  48. package/docs/operations/patient.checkEligibility.md +1 -1
  49. package/docs/operations/patient.confirmResetPassword.md +1 -1
  50. package/docs/operations/patient.createQuestionnaire.md +4 -4
  51. package/docs/operations/patient.listDependents.md +1 -1
  52. package/docs/operations/patient.listNotifications.md +1 -1
  53. package/docs/operations/person.confirmResetPassword.md +1 -1
  54. package/docs/operations/provider.confirmResetPassword.md +1 -1
  55. package/package.json +1 -2
  56. package/docs/models/AddNotificationRequest.md +0 -17
  57. package/docs/models/CommsRtcTokenRequest.md +0 -15
  58. package/docs/models/CommsRtcTokenResponse.md +0 -19
  59. package/docs/models/FetchRtcTokenRequest.md +0 -15
  60. package/docs/operations/telehealth.fetchRtcToken.md +0 -82
@@ -1,8 +1,8 @@
1
- # POST /questionnaires
1
+ # Create a FHIR Questionnaire
2
2
 
3
3
  Operation ID: `patient.createQuestionnaire`
4
4
 
5
- POST /questionnaires
5
+ Create a FHIR Questionnaire.
6
6
 
7
7
  ## Public method
8
8
 
@@ -38,7 +38,7 @@ None.
38
38
 
39
39
  | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
40
40
  |---|---|---:|---|---|---|---:|---|
41
- | `body` | [`CreateQuestionnaireRequest`](../models/CreateQuestionnaireRequest.md) | Yes | | | | No | |
41
+ | `body` | [`CreateQuestionnaireRequest`](../models/CreateQuestionnaireRequest.md) | No | | | | Yes | |
42
42
 
43
43
  Request model: [`CreateQuestionnaireRequest`](../models/CreateQuestionnaireRequest.md)
44
44
 
@@ -46,7 +46,7 @@ Request model: [`CreateQuestionnaireRequest`](../models/CreateQuestionnaireReque
46
46
 
47
47
  | Status | Shape | Content type | Description |
48
48
  |---|---|---|---|
49
- | `201` | [`CreateQuestionnaireResponse`](../models/CreateQuestionnaireResponse.md) | application/json | Successful Response |
49
+ | `201` | [`CreateQuestionnaireResponse`](../models/CreateQuestionnaireResponse.md) | application/json | Questionnaire created |
50
50
 
51
51
  ## Common errors
52
52
 
@@ -44,7 +44,7 @@ Request model: None.
44
44
 
45
45
  | Status | Shape | Content type | Description |
46
46
  |---|---|---|---|
47
- | `200` | [`ListDependentsResponse`](../models/ListDependentsResponse.md) | application/json | Successful Response |
47
+ | `200` | [`ListDependentsResponse`](../models/ListDependentsResponse.md) | application/json | List the authenticated patient's dependents |
48
48
 
49
49
  ## Common errors
50
50
 
@@ -44,7 +44,7 @@ Request model: None.
44
44
 
45
45
  | Status | Shape | Content type | Description |
46
46
  |---|---|---|---|
47
- | `200` | [`ListNotificationsResponse`](../models/ListNotificationsResponse.md) | application/json | Successful Response |
47
+ | `200` | [`ListNotificationsResponse`](../models/ListNotificationsResponse.md) | application/json | List the authenticated patient's notifications |
48
48
 
49
49
  ## Common errors
50
50
 
@@ -8,7 +8,7 @@ POST /auth/confirm-reset-password
8
8
 
9
9
  `confirmPassword`
10
10
 
11
- Signature: `confirmPassword<TResponse = VerifiedResponse>(request: ConfirmPersonPasswordRequest): Promise<TResponse>`
11
+ Signature: `confirmPassword<TResponse = ResetPersonPasswordResponse>(request: ConfirmPersonPasswordRequest): Promise<TResponse>`
12
12
 
13
13
  Return type: `Promise<TResponse>`
14
14
 
@@ -8,7 +8,7 @@ POST /auth/confirm-reset-password
8
8
 
9
9
  `confirmPassword`
10
10
 
11
- Signature: `confirmPassword<TResponse = VerifiedResponse>(request: ConfirmPractitionerPasswordRequest): Promise<TResponse>`
11
+ Signature: `confirmPassword<TResponse = ResetPractitionerPasswordResponse>(request: ConfirmPractitionerPasswordRequest): Promise<TResponse>`
12
12
 
13
13
  Return type: `Promise<TResponse>`
14
14
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "2.0.2",
3
+ "version": "2.2.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",
@@ -41,7 +41,6 @@
41
41
  "prepublishOnly": "npm run build",
42
42
  "test:live:connectors": "vitest run --config vitest.live.config.ts tests/live/connectors",
43
43
  "test:live:connector": "vitest run --config vitest.live.config.ts",
44
- "test:scenarios:validate": "tsx tests/integration/validateScenarios.ts",
45
44
  "export:la28": "tsx scripts/export-la28.ts",
46
45
  "export:patient-insurance-appointments": "tsx scripts/export-patient-insurance-appointments.ts"
47
46
  },
@@ -1,17 +0,0 @@
1
- # AddNotificationRequest
2
-
3
- Model ID: `AddNotificationRequest`
4
-
5
- No description.
6
-
7
- Type: `object`
8
-
9
- ## Fields
10
-
11
- | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
- |---|---|---:|---|---|---|---:|---|
13
- | `payload` | `array` | No | | | | No | |
14
- | `priority` | `string` | No | | | | No | |
15
- | `sent` | `string` | No | date-time | | | No | |
16
- | `status` | `string` | No | | | | No | |
17
- | `topic` | `object` | No | | | | No | |
@@ -1,15 +0,0 @@
1
- # CommsRtcTokenRequest
2
-
3
- Model ID: `CommsRtcTokenRequest`
4
-
5
- No description.
6
-
7
- Type: `object`
8
-
9
- ## Fields
10
-
11
- | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
- |---|---|---:|---|---|---|---:|---|
13
- | `channelName` | `string` | No | | | | No | |
14
- | `role` | `string` | No | | publisher, subscriber | `"publisher"` | No | |
15
- | `uid` | `string|integer` | No | | | | No | |
@@ -1,19 +0,0 @@
1
- # CommsRtcTokenResponse
2
-
3
- Model ID: `CommsRtcTokenResponse`
4
-
5
- No description.
6
-
7
- Type: `object`
8
-
9
- ## Fields
10
-
11
- | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
- |---|---|---:|---|---|---|---:|---|
13
- | `appId` | `string` | Yes | | | | No | |
14
- | `channelName` | `string` | Yes | | | | No | |
15
- | `expiresAt` | `string` | Yes | date-time | | | No | |
16
- | `role` | `string` | Yes | | | `"publisher"` | No | |
17
- | `rtcToken` | `string` | Yes | | | | No | |
18
- | `ttlSeconds` | `integer` | Yes | | | | No | |
19
- | `uid` | `string` | Yes | | | | No | Echoes the caller-supplied contact id. |
@@ -1,15 +0,0 @@
1
- # LegacyRtcTokenRequest
2
-
3
- Model ID: `FetchRtcTokenRequest`
4
-
5
- No description.
6
-
7
- Type: `object`
8
-
9
- ## Fields
10
-
11
- | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
- |---|---|---:|---|---|---|---:|---|
13
- | `channel_name` | `string` | Yes | | | | No | |
14
- | `role` | `integer` | Yes | | | | No | |
15
- | `uid` | `integer|string` | Yes | | | | No | |
@@ -1,82 +0,0 @@
1
- # POST /fetch_rtc_token
2
-
3
- Operation ID: `telehealth.fetchRtcToken`
4
-
5
- POST /fetch_rtc_token
6
-
7
- ## Public method
8
-
9
- `fetchRtcToken`
10
-
11
- Signature: `fetchRtcToken<TResponse = LegacyRtcTokenResponse>(request: LegacyRtcTokenRequest): Promise<TResponse>`
12
-
13
- Return type: `Promise<TResponse>`
14
-
15
- ## Authentication
16
-
17
- Classification: **UNSPECIFIED**
18
-
19
- ## Prerequisites
20
-
21
- None documented.
22
-
23
- ## HTTP
24
-
25
- `POST /fetch_rtc_token`
26
-
27
- ## Path parameters
28
-
29
- None.
30
-
31
- ## Query parameters
32
-
33
- None.
34
-
35
- ## Body parameters
36
-
37
- | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
38
- |---|---|---:|---|---|---|---:|---|
39
- | `body` | [`FetchRtcTokenRequest`](../models/FetchRtcTokenRequest.md) | Yes | | | | No | |
40
-
41
- Request model: [`FetchRtcTokenRequest`](../models/FetchRtcTokenRequest.md)
42
-
43
- ## Success responses
44
-
45
- | Status | Shape | Content type | Description |
46
- |---|---|---|---|
47
- | `200` | [`FetchRtcTokenResponse`](../models/FetchRtcTokenResponse.md) | application/json | Successful Response |
48
-
49
- ## Common errors
50
-
51
- None declared in canonical OpenAPI.
52
-
53
- ## NodeJS / TypeScript implementation
54
-
55
- ```ts
56
- import { HCSDK } from "@healthcloudai/hc-sdk";
57
- ```
58
-
59
- ```ts
60
- const result = await telehealthClient.fetchRtcToken(request);
61
- ```
62
-
63
- ## cURL
64
-
65
- ```bash
66
- curl -X POST \
67
- -H 'Content-Type: application/json' \
68
- -d '<REQUEST_BODY_JSON>' \
69
- '<BASE_URL>/fetch_rtc_token'
70
- ```
71
-
72
- ## Notes
73
-
74
- None.
75
-
76
- ## Prepared Test Console scenario
77
-
78
- No canonical scenario is currently associated.
79
-
80
- ## Real response
81
-
82
- No approved real integration response is currently published. Unapproved candidates are never rendered as examples.