@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
@@ -0,0 +1,20 @@
1
+ # OnboardPatientStepResult
2
+
3
+ Model ID: `OnboardPatientStepResult`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `cognito_sub` | `string|null` | No | | | | Yes | |
14
+ | `email_otp_sent` | `boolean|null` | No | | | | Yes | |
15
+ | `email_verified` | `boolean|null` | No | | | | Yes | |
16
+ | `error` | `string|null` | No | | | | Yes | |
17
+ | `fhir_patient_id` | `string|null` | No | | | | Yes | |
18
+ | `status` | `string` | Yes | | | | No | 'success' or 'failed' |
19
+ | `telehealth_id` | `integer|null` | No | | | | Yes | |
20
+ | `temp_password_generated` | `boolean|null` | No | | | | Yes | |
@@ -0,0 +1,15 @@
1
+ # OnboardQuestionnaireAnswer
2
+
3
+ Model ID: `OnboardQuestionnaireAnswer`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `value_boolean` | `boolean|null` | No | | | | Yes | |
14
+ | `value_integer` | `integer|null` | No | | | | Yes | |
15
+ | `value_string` | `string|null` | No | | | | Yes | |
@@ -0,0 +1,19 @@
1
+ # OnboardQuestionnaireDefinition
2
+
3
+ Model ID: `OnboardQuestionnaireDefinition`
4
+
5
+ Inline Questionnaire definition — same shape CreateQuestionnaireRequest
6
+ accepts on POST /questionnaires (Patient API). Used when the caller has
7
+ no pre-existing questionnaire_id; the Questionnaire is created from this
8
+ before the response below is submitted against it.
9
+
10
+ Type: `object`
11
+
12
+ ## Fields
13
+
14
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
15
+ |---|---|---:|---|---|---|---:|---|
16
+ | `items` | array of [`QuestionnaireItemInput`](./QuestionnaireItemInput.md) | No | | | | No | |
17
+ | `name` | `string` | Yes | | | | No | |
18
+ | `status` | `string` | No | | | `"active"` | No | |
19
+ | `title` | `string|null` | No | | | | Yes | |
@@ -0,0 +1,19 @@
1
+ # OnboardQuestionnairePayload
2
+
3
+ Model ID: `OnboardQuestionnairePayload`
4
+
5
+ questionnaire section of POST /onboardpatients. Either questionnaire_id
6
+ (an existing Questionnaire) or definition (create one inline) is
7
+ required; items are the answers, submitted the same way regardless of
8
+ which one was supplied.
9
+
10
+ Type: `object`
11
+
12
+ ## Fields
13
+
14
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
15
+ |---|---|---:|---|---|---|---:|---|
16
+ | `definition` | [`OnboardQuestionnaireDefinition`](./OnboardQuestionnaireDefinition.md) | No | | | | Yes | |
17
+ | `items` | array of [`OnboardQuestionnaireResponseItem`](./OnboardQuestionnaireResponseItem.md) | No | | | | No | |
18
+ | `questionnaire_id` | `string|null` | No | | | | Yes | FHIR id of an existing Questionnaire. Omit to create one inline via definition. |
19
+ | `status` | `string` | No | | | `"completed"` | No | |
@@ -0,0 +1,14 @@
1
+ # OnboardQuestionnaireResponseItem
2
+
3
+ Model ID: `OnboardQuestionnaireResponseItem`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `answers` | array of [`OnboardQuestionnaireAnswer`](./OnboardQuestionnaireAnswer.md) | No | | | | No | |
14
+ | `link_id` | `string` | Yes | | | | No | |
@@ -0,0 +1,16 @@
1
+ # OnboardQuestionnaireStepResult
2
+
3
+ Model ID: `OnboardQuestionnaireStepResult`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `error` | `string|null` | No | | | | Yes | |
14
+ | `fhir_id` | `string|null` | No | | | | Yes | FHIR id of the created QuestionnaireResponse. |
15
+ | `questionnaire_fhir_id` | `string|null` | No | | | | Yes | FHIR id of the Questionnaire used — either the supplied questionnaire_id, or the one just created from definition. |
16
+ | `status` | `string` | Yes | | | | No | 'success', 'failed', or 'skipped' |
@@ -0,0 +1,19 @@
1
+ # OnboardVitalsPayload
2
+
3
+ Model ID: `OnboardVitalsPayload`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `diastolic` | `number|null` | No | | | | Yes | mmHg; requires systolic to be applied |
14
+ | `heart_rate` | `number|null` | No | | | | Yes | beats/min |
15
+ | `height_cm` | `number|null` | No | | | | Yes | |
16
+ | `oxygen_saturation` | `number|null` | No | | | | Yes | SpO2 percentage |
17
+ | `systolic` | `number|null` | No | | | | Yes | mmHg; requires diastolic to be applied |
18
+ | `temperature` | `number|null` | No | | | | Yes | Celsius |
19
+ | `weight_kg` | `number|null` | No | | | | Yes | |
@@ -0,0 +1,15 @@
1
+ # OnboardVitalsStepResult
2
+
3
+ Model ID: `OnboardVitalsStepResult`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `error` | `string|null` | No | | | | Yes | |
14
+ | `observation_count` | `integer|null` | No | | | | Yes | |
15
+ | `status` | `string` | Yes | | | | No | 'success', 'failed', or 'skipped' |
@@ -0,0 +1,14 @@
1
+ # PatientPhotoUploadUrlResponse
2
+
3
+ Model ID: `PatientPhotoUploadUrlResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `key` | `string` | Yes | | | | No | |
14
+ | `url` | `string` | Yes | | | | No | |
@@ -0,0 +1,11 @@
1
+ # QuestionItemType
2
+
3
+ Model ID: `QuestionItemType`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
@@ -0,0 +1,21 @@
1
+ # QuestionnaireItemInput
2
+
3
+ Model ID: `QuestionnaireItemInput`
4
+
5
+ The minimal item shape actually read by Questionnaire.from_request_dict()
6
+ — the exact fields accepted by POST /questionnaires on the Patient API and
7
+ the inline questionnaire.definition.items on POST /onboardpatients (Field
8
+ Agent API). Deliberately narrower than QuestionnaireItem: only link_id,
9
+ text and type are read from a request; the rest of that model's fields
10
+ (required, repeats, answer_options, ...) are not yet accepted here, so
11
+ they are not advertised as part of the request contract.
12
+
13
+ Type: `object`
14
+
15
+ ## Fields
16
+
17
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
18
+ |---|---|---:|---|---|---|---:|---|
19
+ | `link_id` | `string|null` | No | | | | Yes | |
20
+ | `text` | `string|null` | No | | | | Yes | |
21
+ | `type` | [`QuestionItemType`](./QuestionItemType.md) | No | | | `"string"` | No | |
@@ -0,0 +1,14 @@
1
+ # UploadPatientPhotoRequest
2
+
3
+ Model ID: `UploadPatientPhotoRequest`
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` | No | | | `"image/png"` | No | |
14
+ | `data` | `string` | No | | | | No | Base64-encoded image data |
@@ -1,6 +1,6 @@
1
- # FetchRtcTokenResponse
1
+ # FieldAgentPatientPhotoUploadResponse
2
2
 
3
- Model ID: `FetchRtcTokenResponse`
3
+ Model ID: `UploadPatientPhotoResponse`
4
4
 
5
5
  No description.
6
6
 
@@ -10,5 +10,4 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `code` | `string` | Yes | | | | No | |
14
- | `token` | `string` | Yes | | | | No | |
13
+ | `binary_id` | `string` | Yes | | | | No | |
@@ -2,9 +2,10 @@
2
2
 
3
3
  - [ActivitySummary](ActivitySummary.md)
4
4
  - [AddDependentRequest](AddDependentRequest.md)
5
+ - [AddDependentResponse](AddDependentResponse.md)
5
6
  - [AddInsuranceRequest](AddInsuranceRequest.md)
6
7
  - [AddInsuranceResponse](AddInsuranceResponse.md)
7
- - [AddNotificationRequest](AddNotificationRequest.md)
8
+ - [AddNotificationResponse](AddNotificationResponse.md)
8
9
  - [Address](Address.md)
9
10
  - [AddressType](AddressType.md)
10
11
  - [AgentDashboardPayload](AgentDashboardPayload.md)
@@ -249,8 +250,6 @@
249
250
  - [CommsListInvitesResponse](CommsListInvitesResponse.md)
250
251
  - [CommsListMessagesResponse](CommsListMessagesResponse.md)
251
252
  - [CommsListPresenceResponse](CommsListPresenceResponse.md)
252
- - [CommsRtcTokenRequest](CommsRtcTokenRequest.md)
253
- - [CommsRtcTokenResponse](CommsRtcTokenResponse.md)
254
253
  - [UpsertConversationRequest](CommsUpsertConversationRequest.md)
255
254
  - [UpsertGroupRequest](CommsUpsertGroupRequest.md)
256
255
  - [UpsertInviteRequest](CommsUpsertInviteRequest.md)
@@ -292,6 +291,7 @@
292
291
  - [DeleteDependentResponse](DeleteDependentResponse.md)
293
292
  - [DeleteNotificationResponse](DeleteNotificationResponse.md)
294
293
  - [DemographicsMatch](DemographicsMatch.md)
294
+ - [DependentResponse](DependentResponse.md)
295
295
  - [diagnostics.ConnectResponse](diagnostics.ConnectResponse.md)
296
296
  - [diagnostics.ListDiagnosticsResponse](diagnostics.ListDiagnosticsResponse.md)
297
297
  - [DiagnosticTest](DiagnosticTest.md)
@@ -327,8 +327,6 @@
327
327
  - [FaceMatchResponse](FaceMatchResponse.md)
328
328
  - [FedexCreateShipmentRequest](FedexCreateShipmentRequest.md)
329
329
  - [FedexTrackShipmentRequest](FedexTrackShipmentRequest.md)
330
- - [LegacyRtcTokenRequest](FetchRtcTokenRequest.md)
331
- - [FetchRtcTokenResponse](FetchRtcTokenResponse.md)
332
330
  - [FhirResource](FhirResource.md)
333
331
  - [fieldagent.ConnectResponse](fieldagent.ConnectResponse.md)
334
332
  - [Encounter](fieldagent.Encounter.md)
@@ -367,6 +365,7 @@
367
365
  - [Medication](GetMedicationResponse.md)
368
366
  - [GetPatientDashboardResponse](GetPatientDashboardResponse.md)
369
367
  - [PatientFlags](GetPatientFlagsResponse.md)
368
+ - [FieldAgentPatientPhotoResponse](GetPatientPhotoResponse.md)
370
369
  - [PatientDemographics](GetPatientResponse.md)
371
370
  - [GetPatientSidebarPatientSidebarResponse](GetPatientSidebarPatientSidebarResponse.md)
372
371
  - [Person](GetPersonResponse.md)
@@ -718,12 +717,25 @@
718
717
  - [MessageStatus](MessageStatus.md)
719
718
  - [NameUse](NameUse.md)
720
719
  - [NearestLocationsResponse](NearestLocationsResponse.md)
720
+ - [NotificationResponse](NotificationResponse.md)
721
+ - [NotificationUpsertRequest](NotificationUpsertRequest.md)
721
722
  - [NppesGetProviderRequest](NppesGetProviderRequest.md)
722
723
  - [NppesSearchProvidersRequest](NppesSearchProvidersRequest.md)
723
724
  - [NppesVerifyProviderRequest](NppesVerifyProviderRequest.md)
724
725
  - [ObservationStatus](ObservationStatus.md)
726
+ - [OnboardEncounterPayload](OnboardEncounterPayload.md)
727
+ - [OnboardEncounterStepResult](OnboardEncounterStepResult.md)
728
+ - [OnboardPatientPayload](OnboardPatientPayload.md)
725
729
  - [OnboardPatientRequest](OnboardPatientRequest.md)
726
730
  - [OnboardPatientResponse](OnboardPatientResponse.md)
731
+ - [OnboardPatientStepResult](OnboardPatientStepResult.md)
732
+ - [OnboardQuestionnaireAnswer](OnboardQuestionnaireAnswer.md)
733
+ - [OnboardQuestionnaireDefinition](OnboardQuestionnaireDefinition.md)
734
+ - [OnboardQuestionnairePayload](OnboardQuestionnairePayload.md)
735
+ - [OnboardQuestionnaireResponseItem](OnboardQuestionnaireResponseItem.md)
736
+ - [OnboardQuestionnaireStepResult](OnboardQuestionnaireStepResult.md)
737
+ - [OnboardVitalsPayload](OnboardVitalsPayload.md)
738
+ - [OnboardVitalsStepResult](OnboardVitalsStepResult.md)
727
739
  - [OpenaiBuildResponseCreatePayloadRequest](OpenaiBuildResponseCreatePayloadRequest.md)
728
740
  - [OpenaiChatJsonRequest](OpenaiChatJsonRequest.md)
729
741
  - [OpenaiChatRequest](OpenaiChatRequest.md)
@@ -791,6 +803,7 @@
791
803
  - [PatientLink](PatientLink.md)
792
804
  - [PatientLinkType](PatientLinkType.md)
793
805
  - [PatientName](PatientName.md)
806
+ - [PatientPhotoUploadUrlResponse](PatientPhotoUploadUrlResponse.md)
794
807
  - [PatientSidebar](PatientSidebar.md)
795
808
  - [PeakFlowReading](PeakFlowReading.md)
796
809
  - [Person](Person.md)
@@ -860,6 +873,8 @@
860
873
  - [QuestGetPrintableResultsRequest](QuestGetPrintableResultsRequest.md)
861
874
  - [QuestGetRequisitionRequest](QuestGetRequisitionRequest.md)
862
875
  - [QuestGetResultsRequest](QuestGetResultsRequest.md)
876
+ - [QuestionItemType](QuestionItemType.md)
877
+ - [QuestionnaireItemInput](QuestionnaireItemInput.md)
863
878
  - [QuestListTestsRequest](QuestListTestsRequest.md)
864
879
  - [QuestProcessPushedResultRequest](QuestProcessPushedResultRequest.md)
865
880
  - [QuestRequestCompendiumsOnDemandRequest](QuestRequestCompendiumsOnDemandRequest.md)
@@ -1094,6 +1109,8 @@
1094
1109
  - [UpdateRaceResponse](UpdateRaceResponse.md)
1095
1110
  - [UploadAgentPhotoRequest](UploadAgentPhotoRequest.md)
1096
1111
  - [FieldAgentPhotoUploadResponse](UploadAgentPhotoResponse.md)
1112
+ - [UploadPatientPhotoRequest](UploadPatientPhotoRequest.md)
1113
+ - [FieldAgentPatientPhotoUploadResponse](UploadPatientPhotoResponse.md)
1097
1114
  - [VerifyEmailResponse](VerifyEmailResponse.md)
1098
1115
  - [VerifySmsResponse](VerifySmsResponse.md)
1099
1116
  - [VisionFaceCompareRequest](VisionFaceCompareRequest.md)
@@ -8,7 +8,7 @@ POST /auth/confirm-reset-password
8
8
 
9
9
  `confirmPassword`
10
10
 
11
- Signature: `confirmPassword<TResponse = VerifiedResponse>(request: ConfirmFieldAgentPasswordRequest): Promise<TResponse>`
11
+ Signature: `confirmPassword<TResponse = ConfirmFieldAgentPasswordResponse>(request: ConfirmFieldAgentPasswordRequest): Promise<TResponse>`
12
12
 
13
13
  Return type: `Promise<TResponse>`
14
14
 
@@ -0,0 +1,85 @@
1
+ # GET /patients/{patient_id}/photo
2
+
3
+ Operation ID: `fieldagent.getPatientPhoto`
4
+
5
+ GET /patients/{patient_id}/photo
6
+
7
+ ## Public method
8
+
9
+ `getPatientPhoto`
10
+
11
+ Signature: `getPatientPhoto<TResponse = GetPhotoResponse>(patientId: string, query?: GetPhotoQuery): Promise<TResponse>`
12
+
13
+ Return type: `Promise<TResponse>`
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/{patient_id}/photo`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `patient_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
38
+ |---|---|---:|---|---|---|---:|---|
39
+ | `binary_id` | `string` | Yes | | | | No | Optional binary_id returned by upload_patient_photo. If omitted, the stored patient photo is used. |
40
+
41
+ ## Body parameters
42
+
43
+ None.
44
+
45
+ Request model: None.
46
+
47
+ ## Success responses
48
+
49
+ | Status | Shape | Content type | Description |
50
+ |---|---|---|---|
51
+ | `200` | [`GetPatientPhotoResponse`](../models/GetPatientPhotoResponse.md) | application/json | Patient photo |
52
+
53
+ ## Common errors
54
+
55
+ None declared in canonical OpenAPI.
56
+
57
+ ## NodeJS / TypeScript implementation
58
+
59
+ ```ts
60
+ import { HCSDK } from "@healthcloudai/hc-sdk";
61
+ ```
62
+
63
+ ```ts
64
+ const result = await fieldAgentClient.getPatientPhoto(patientId, query);
65
+ ```
66
+
67
+ ## cURL
68
+
69
+ ```bash
70
+ curl -X GET \
71
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
72
+ '<BASE_URL>/patients/{patient_id}/photo?binary_id=<BINARY_ID>'
73
+ ```
74
+
75
+ ## Notes
76
+
77
+ None.
78
+
79
+ ## Prepared Test Console scenario
80
+
81
+ No canonical scenario is currently associated.
82
+
83
+ ## Real response
84
+
85
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -1,20 +1,22 @@
1
- # POST /communications/rtc-token
1
+ # GET /patients/{patient_id}/photo/upload-url
2
2
 
3
- Operation ID: `patient.commsRtcToken`
3
+ Operation ID: `fieldagent.patientPhotoUploadUrl`
4
4
 
5
- POST /communications/rtc-token
5
+ GET /patients/{patient_id}/photo/upload-url
6
6
 
7
7
  ## Public method
8
8
 
9
- `commsRtcToken`
9
+ `getPatientPhotoUploadUrl`
10
10
 
11
- Signature: `commsRtcToken<TResponse = RtcTokenResponse>(request: RtcTokenRequest): Promise<TResponse>`
11
+ Signature: `getPatientPhotoUploadUrl<TResponse = PhotoUploadUrlResponse>(patientId: string): Promise<TResponse>`
12
12
 
13
13
  Return type: `Promise<TResponse>`
14
14
 
15
15
  ## Authentication
16
16
 
17
- Classification: **UNSPECIFIED**
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
18
20
 
19
21
  ## Prerequisites
20
22
 
@@ -22,11 +24,13 @@ None documented.
22
24
 
23
25
  ## HTTP
24
26
 
25
- `POST /communications/rtc-token`
27
+ `GET /patients/{patient_id}/photo/upload-url`
26
28
 
27
29
  ## Path parameters
28
30
 
29
- None.
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `patient_id` | `string` | Yes | | | | No | |
30
34
 
31
35
  ## Query parameters
32
36
 
@@ -34,17 +38,15 @@ None.
34
38
 
35
39
  ## Body parameters
36
40
 
37
- | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
38
- |---|---|---:|---|---|---|---:|---|
39
- | `body` | [`CommsRtcTokenRequest`](../models/CommsRtcTokenRequest.md) | No | | | | No | |
41
+ None.
40
42
 
41
- Request model: [`CommsRtcTokenRequest`](../models/CommsRtcTokenRequest.md)
43
+ Request model: None.
42
44
 
43
45
  ## Success responses
44
46
 
45
47
  | Status | Shape | Content type | Description |
46
48
  |---|---|---|---|
47
- | `200` | [`CommsRtcTokenResponse`](../models/CommsRtcTokenResponse.md) | application/json | Agora RTC token |
49
+ | `200` | [`PatientPhotoUploadUrlResponse`](../models/PatientPhotoUploadUrlResponse.md) | application/json | Successful Response |
48
50
 
49
51
  ## Common errors
50
52
 
@@ -57,16 +59,15 @@ import { HCSDK } from "@healthcloudai/hc-sdk";
57
59
  ```
58
60
 
59
61
  ```ts
60
- const result = await patientClient.commsRtcToken(request);
62
+ const result = await fieldAgentClient.getPatientPhotoUploadUrl(patientId);
61
63
  ```
62
64
 
63
65
  ## cURL
64
66
 
65
67
  ```bash
66
- curl -X POST \
67
- -H 'Content-Type: application/json' \
68
- -d '<REQUEST_BODY_JSON>' \
69
- '<BASE_URL>/communications/rtc-token'
68
+ curl -X GET \
69
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
70
+ '<BASE_URL>/patients/{patient_id}/photo/upload-url'
70
71
  ```
71
72
 
72
73
  ## Notes
@@ -0,0 +1,87 @@
1
+ # POST /patients/{patient_id}/photo
2
+
3
+ Operation ID: `fieldagent.uploadPatientPhoto`
4
+
5
+ POST /patients/{patient_id}/photo
6
+
7
+ ## Public method
8
+
9
+ `uploadPatientPhoto`
10
+
11
+ Signature: `uploadPatientPhoto<TResponse = PhotoUploadResponse>(patientId: string, request: PhotoUploadRequest): Promise<TResponse>`
12
+
13
+ Return type: `Promise<TResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `POST /patients/{patient_id}/photo`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `patient_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ None.
38
+
39
+ ## Body parameters
40
+
41
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
42
+ |---|---|---:|---|---|---|---:|---|
43
+ | `body` | [`UploadPatientPhotoRequest`](../models/UploadPatientPhotoRequest.md) | No | | | | No | |
44
+
45
+ Request model: [`UploadPatientPhotoRequest`](../models/UploadPatientPhotoRequest.md)
46
+
47
+ ## Success responses
48
+
49
+ | Status | Shape | Content type | Description |
50
+ |---|---|---|---|
51
+ | `201` | [`UploadPatientPhotoResponse`](../models/UploadPatientPhotoResponse.md) | application/json | Patient photo stored |
52
+
53
+ ## Common errors
54
+
55
+ None declared in canonical OpenAPI.
56
+
57
+ ## NodeJS / TypeScript implementation
58
+
59
+ ```ts
60
+ import { HCSDK } from "@healthcloudai/hc-sdk";
61
+ ```
62
+
63
+ ```ts
64
+ const result = await fieldAgentClient.uploadPatientPhoto(patientId, request);
65
+ ```
66
+
67
+ ## cURL
68
+
69
+ ```bash
70
+ curl -X POST \
71
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
72
+ -H 'Content-Type: application/json' \
73
+ -d '<REQUEST_BODY_JSON>' \
74
+ '<BASE_URL>/patients/{patient_id}/photo'
75
+ ```
76
+
77
+ ## Notes
78
+
79
+ None.
80
+
81
+ ## Prepared Test Console scenario
82
+
83
+ No canonical scenario is currently associated.
84
+
85
+ ## Real response
86
+
87
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -38,7 +38,7 @@ None.
38
38
 
39
39
  | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
40
40
  |---|---|---:|---|---|---|---:|---|
41
- | `body` | [`AddDependentRequest`](../models/AddDependentRequest.md) | No | | | | No | |
41
+ | `body` | [`AddDependentRequest`](../models/AddDependentRequest.md) | Yes | | | | No | |
42
42
 
43
43
  Request model: [`AddDependentRequest`](../models/AddDependentRequest.md)
44
44
 
@@ -46,7 +46,7 @@ Request model: [`AddDependentRequest`](../models/AddDependentRequest.md)
46
46
 
47
47
  | Status | Shape | Content type | Description |
48
48
  |---|---|---|---|
49
- | `200` | [`FhirResource`](../models/FhirResource.md) | application/json | Successful Response |
49
+ | `201` | [`AddDependentResponse`](../models/AddDependentResponse.md) | application/json | Dependent created |
50
50
 
51
51
  ## Common errors
52
52
 
@@ -38,15 +38,15 @@ None.
38
38
 
39
39
  | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
40
40
  |---|---|---:|---|---|---|---:|---|
41
- | `body` | [`AddNotificationRequest`](../models/AddNotificationRequest.md) | No | | | | No | |
41
+ | `body` | [`NotificationUpsertRequest`](../models/NotificationUpsertRequest.md) | Yes | | | | No | |
42
42
 
43
- Request model: [`AddNotificationRequest`](../models/AddNotificationRequest.md)
43
+ Request model: [`NotificationUpsertRequest`](../models/NotificationUpsertRequest.md)
44
44
 
45
45
  ## Success responses
46
46
 
47
47
  | Status | Shape | Content type | Description |
48
48
  |---|---|---|---|
49
- | `200` | [`FhirResource`](../models/FhirResource.md) | application/json | Successful Response |
49
+ | `201` | [`AddNotificationResponse`](../models/AddNotificationResponse.md) | application/json | Notification created |
50
50
 
51
51
  ## Common errors
52
52
 
@@ -8,7 +8,7 @@ POST /insurance/eligibility
8
8
 
9
9
  `checkInsuranceEligibility`
10
10
 
11
- Signature: `checkInsuranceEligibility<TResponse = JsonValue>(request: InsuranceEligibilityRequest): Promise<TResponse>`
11
+ Signature: `checkInsuranceEligibility<TResponse = JsonValue>(request: CheckEligibilityRequest): 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: ConfirmPatientPasswordRequest): Promise<TResponse>`
11
+ Signature: `confirmPassword<TResponse = ResetPatientPasswordResponse>(request: ConfirmPatientPasswordRequest): Promise<TResponse>`
12
12
 
13
13
  Return type: `Promise<TResponse>`
14
14