@healthcloudai/hc-sdk 2.0.2 → 2.1.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/README.md +3 -1
- package/dist/index.cjs +24 -10
- package/dist/index.d.cts +545 -471
- package/dist/index.d.ts +545 -471
- package/dist/index.js +24 -10
- package/docs/clients/FieldAgentClient.md +3 -0
- package/docs/clients/PatientClient.md +0 -1
- package/docs/clients/TelehealthClient.md +0 -1
- package/docs/docs-manifest.json +15 -10
- package/docs/examples/index.md +3 -2
- package/docs/index.md +3 -2
- package/docs/models/AddDependentRequest.md +10 -6
- package/docs/models/AddDependentResponse.md +17 -0
- package/docs/models/AddNotificationResponse.md +19 -0
- package/docs/models/DependentResponse.md +17 -0
- package/docs/models/GetPatientPhotoResponse.md +15 -0
- package/docs/models/ListDependentsResponse.md +2 -2
- package/docs/models/ListNotificationsResponse.md +2 -2
- package/docs/models/NotificationResponse.md +19 -0
- package/docs/models/NotificationUpsertRequest.md +23 -0
- package/docs/models/PatientPhotoUploadUrlResponse.md +14 -0
- package/docs/models/UploadPatientPhotoRequest.md +14 -0
- package/docs/models/{FetchRtcTokenResponse.md → UploadPatientPhotoResponse.md} +3 -4
- package/docs/models/index.md +9 -5
- package/docs/operations/fieldagent.confirmResetPassword.md +1 -1
- package/docs/operations/fieldagent.getPatientPhoto.md +85 -0
- package/docs/operations/{patient.commsRtcToken.md → fieldagent.patientPhotoUploadUrl.md} +19 -18
- package/docs/operations/fieldagent.uploadPatientPhoto.md +87 -0
- package/docs/operations/patient.addDependent.md +2 -2
- package/docs/operations/patient.addNotification.md +3 -3
- package/docs/operations/patient.checkEligibility.md +1 -1
- package/docs/operations/patient.confirmResetPassword.md +1 -1
- package/docs/operations/patient.listDependents.md +1 -1
- package/docs/operations/patient.listNotifications.md +1 -1
- package/docs/operations/person.confirmResetPassword.md +1 -1
- package/docs/operations/provider.confirmResetPassword.md +1 -1
- package/package.json +1 -2
- package/docs/models/AddNotificationRequest.md +0 -17
- package/docs/models/CommsRtcTokenRequest.md +0 -15
- package/docs/models/CommsRtcTokenResponse.md +0 -19
- package/docs/models/FetchRtcTokenRequest.md +0 -15
- package/docs/operations/telehealth.fetchRtcToken.md +0 -82
package/dist/index.js
CHANGED
|
@@ -517,6 +517,30 @@ var FieldAgentClient = class extends BaseServiceClient {
|
|
|
517
517
|
listPatients(query) {
|
|
518
518
|
return this.send("GET", "/patients", { query });
|
|
519
519
|
}
|
|
520
|
+
getPatientPhotoUploadUrl(patientId) {
|
|
521
|
+
return this.send("GET", "/patients/{patient_id}/photo/upload-url", {
|
|
522
|
+
pathParams: { patient_id: patientId }
|
|
523
|
+
});
|
|
524
|
+
}
|
|
525
|
+
uploadPatientPhoto(patientId, request) {
|
|
526
|
+
return this.send("POST", "/patients/{patient_id}/photo", {
|
|
527
|
+
pathParams: { patient_id: patientId },
|
|
528
|
+
body: request
|
|
529
|
+
});
|
|
530
|
+
}
|
|
531
|
+
/**
|
|
532
|
+
* Get a patient's photo by binary_id, or the stored photo if binary_id is omitted.
|
|
533
|
+
* GET /patients/{patient_id}/photo?binary_id=...
|
|
534
|
+
*
|
|
535
|
+
* @param patientId - The FHIR Patient ID
|
|
536
|
+
* @param query - Optional query parameters; if omitted, fetches the stored/default photo
|
|
537
|
+
*/
|
|
538
|
+
getPatientPhoto(patientId, query) {
|
|
539
|
+
return this.send("GET", "/patients/{patient_id}/photo", {
|
|
540
|
+
pathParams: { patient_id: patientId },
|
|
541
|
+
query
|
|
542
|
+
});
|
|
543
|
+
}
|
|
520
544
|
listEncounters(query) {
|
|
521
545
|
return this.send("GET", "/encounters", { query });
|
|
522
546
|
}
|
|
@@ -1211,12 +1235,6 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
1211
1235
|
body: request
|
|
1212
1236
|
});
|
|
1213
1237
|
}
|
|
1214
|
-
commsRtcToken(request) {
|
|
1215
|
-
return this.send("POST", "/communications/rtc-token", {
|
|
1216
|
-
body: request,
|
|
1217
|
-
auth: false
|
|
1218
|
-
});
|
|
1219
|
-
}
|
|
1220
1238
|
};
|
|
1221
1239
|
|
|
1222
1240
|
// src/models/openapi-generated/person/models/AddressType.ts
|
|
@@ -1513,9 +1531,6 @@ var TelehealthClient = class extends BaseServiceClient {
|
|
|
1513
1531
|
createProviderToken(request) {
|
|
1514
1532
|
return this.send("POST", "/telehealth/tokens/provider", { body: request });
|
|
1515
1533
|
}
|
|
1516
|
-
fetchRtcToken(request) {
|
|
1517
|
-
return this.send("POST", "/fetch_rtc_token", { body: request });
|
|
1518
|
-
}
|
|
1519
1534
|
};
|
|
1520
1535
|
|
|
1521
1536
|
// src/clients/VitalsClient.ts
|
|
@@ -4727,7 +4742,6 @@ var HCSDK_OPERATION_SUMMARY = [
|
|
|
4727
4742
|
{ service: "patient", method: "POST", path: "/communications/messages", sdkMethod: "patient.upsertMessage", summary: "Upsert message" },
|
|
4728
4743
|
{ service: "patient", method: "GET", path: "/communications/invites", sdkMethod: "patient.listInvites", summary: "List invites" },
|
|
4729
4744
|
{ service: "patient", method: "POST", path: "/communications/invites", sdkMethod: "patient.upsertInvite", summary: "Upsert invite" },
|
|
4730
|
-
{ service: "patient", method: "POST", path: "/communications/rtc-token", sdkMethod: "patient.commsRtcToken", summary: "Create communications RTC token" },
|
|
4731
4745
|
{ service: "vitals", method: "GET", path: "/connect", sdkMethod: "vitals.connect", summary: "Lambda warm-up / connectivity check" },
|
|
4732
4746
|
{ service: "vitals", method: "POST", path: "/patients/{patient_id}/vitals", sdkMethod: "vitals.record", summary: "Record patient vitals" },
|
|
4733
4747
|
{ service: "vitals", method: "GET", path: "/patients/{patient_id}/vitals", sdkMethod: "vitals.list", summary: "List patient vitals" },
|
|
@@ -6,13 +6,16 @@
|
|
|
6
6
|
- [`getAgent`](../operations/fieldagent.getAgent.md) — GET /agents/{agent_id}
|
|
7
7
|
- [`getDashboard`](../operations/fieldagent.getAgentDashboard.md) — GET /agents/{agent_id}/dashboard
|
|
8
8
|
- [`getPhoto`](../operations/fieldagent.getAgentPhoto.md) — GET /agents/{agent_id}/photo
|
|
9
|
+
- [`getPatientPhoto`](../operations/fieldagent.getPatientPhoto.md) — GET /patients/{patient_id}/photo
|
|
9
10
|
- [`listEncounters`](../operations/fieldagent.listEncounters.md) — GET /encounters
|
|
10
11
|
- [`listPatients`](../operations/fieldagent.listPatients.md) — GET /patients
|
|
11
12
|
- [`login`](../operations/fieldagent.login.md) — POST /auth/login
|
|
12
13
|
- [`onboardPatient`](../operations/fieldagent.onboardPatient.md) — Onboard a patient in one request
|
|
14
|
+
- [`getPatientPhotoUploadUrl`](../operations/fieldagent.patientPhotoUploadUrl.md) — GET /patients/{patient_id}/photo/upload-url
|
|
13
15
|
- [`register`](../operations/fieldagent.register.md) — POST /auth/register
|
|
14
16
|
- [`resetPassword`](../operations/fieldagent.resetPassword.md) — POST /auth/reset-password
|
|
15
17
|
- [`updateAgent`](../operations/fieldagent.updateAgent.md) — PATCH /agents/{agent_id}
|
|
16
18
|
- [`uploadPhoto`](../operations/fieldagent.uploadAgentPhoto.md) — POST /agents/{agent_id}/photo
|
|
19
|
+
- [`uploadPatientPhoto`](../operations/fieldagent.uploadPatientPhoto.md) — POST /patients/{patient_id}/photo
|
|
17
20
|
- [`verifyEmail`](../operations/fieldagent.verifyEmail.md) — POST /auth/verify-email
|
|
18
21
|
- [`verifySms`](../operations/fieldagent.verifySms.md) — POST /auth/verify-sms
|
|
@@ -17,7 +17,6 @@
|
|
|
17
17
|
- [`listInvites`](../operations/patient.commsListInvites.md) — GET /communications/invites
|
|
18
18
|
- [`listMessages`](../operations/patient.commsListMessages.md) — GET /communications/messages
|
|
19
19
|
- [`listPresence`](../operations/patient.commsListPresence.md) — GET /communications/presence
|
|
20
|
-
- [`commsRtcToken`](../operations/patient.commsRtcToken.md) — POST /communications/rtc-token
|
|
21
20
|
- [`upsertConversation`](../operations/patient.commsUpsertConversation.md) — POST /communications/conversations
|
|
22
21
|
- [`upsertGroup`](../operations/patient.commsUpsertGroup.md) — POST /communications/groups
|
|
23
22
|
- [`upsertInvite`](../operations/patient.commsUpsertInvite.md) — POST /communications/invites
|
|
@@ -4,4 +4,3 @@
|
|
|
4
4
|
- [`createChannel`](../operations/telehealth.createChannel.md) — POST /telehealth/channels
|
|
5
5
|
- [`createPatientToken`](../operations/telehealth.createPatientToken.md) — POST /telehealth/tokens/patient
|
|
6
6
|
- [`createProviderToken`](../operations/telehealth.createProviderToken.md) — POST /telehealth/tokens/provider
|
|
7
|
-
- [`fetchRtcToken`](../operations/telehealth.fetchRtcToken.md) — POST /fetch_rtc_token
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:ded600adfc30f8cf4c03541bb347f024ac714176972684c8836ffa1570e00359",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AnthropicClient.md",
|
|
@@ -55,9 +55,10 @@
|
|
|
55
55
|
"index.md",
|
|
56
56
|
"models/ActivitySummary.md",
|
|
57
57
|
"models/AddDependentRequest.md",
|
|
58
|
+
"models/AddDependentResponse.md",
|
|
58
59
|
"models/AddInsuranceRequest.md",
|
|
59
60
|
"models/AddInsuranceResponse.md",
|
|
60
|
-
"models/
|
|
61
|
+
"models/AddNotificationResponse.md",
|
|
61
62
|
"models/Address.md",
|
|
62
63
|
"models/AddressType.md",
|
|
63
64
|
"models/AgentDashboardPayload.md",
|
|
@@ -301,8 +302,6 @@
|
|
|
301
302
|
"models/CommsListInvitesResponse.md",
|
|
302
303
|
"models/CommsListMessagesResponse.md",
|
|
303
304
|
"models/CommsListPresenceResponse.md",
|
|
304
|
-
"models/CommsRtcTokenRequest.md",
|
|
305
|
-
"models/CommsRtcTokenResponse.md",
|
|
306
305
|
"models/CommsUpsertConversationRequest.md",
|
|
307
306
|
"models/CommsUpsertGroupRequest.md",
|
|
308
307
|
"models/CommsUpsertInviteRequest.md",
|
|
@@ -344,6 +343,7 @@
|
|
|
344
343
|
"models/DeleteDependentResponse.md",
|
|
345
344
|
"models/DeleteNotificationResponse.md",
|
|
346
345
|
"models/DemographicsMatch.md",
|
|
346
|
+
"models/DependentResponse.md",
|
|
347
347
|
"models/DiagnosticTest.md",
|
|
348
348
|
"models/DiagnosticTestRelationship.md",
|
|
349
349
|
"models/DischargeDisposition.md",
|
|
@@ -376,8 +376,6 @@
|
|
|
376
376
|
"models/FaceMatchResponse.md",
|
|
377
377
|
"models/FedexCreateShipmentRequest.md",
|
|
378
378
|
"models/FedexTrackShipmentRequest.md",
|
|
379
|
-
"models/FetchRtcTokenRequest.md",
|
|
380
|
-
"models/FetchRtcTokenResponse.md",
|
|
381
379
|
"models/FhirResource.md",
|
|
382
380
|
"models/FieldAgentProfileResponse.md",
|
|
383
381
|
"models/GS1LookupResponse.md",
|
|
@@ -404,6 +402,7 @@
|
|
|
404
402
|
"models/GetMedicationResponse.md",
|
|
405
403
|
"models/GetPatientDashboardResponse.md",
|
|
406
404
|
"models/GetPatientFlagsResponse.md",
|
|
405
|
+
"models/GetPatientPhotoResponse.md",
|
|
407
406
|
"models/GetPatientResponse.md",
|
|
408
407
|
"models/GetPatientSidebarPatientSidebarResponse.md",
|
|
409
408
|
"models/GetPersonResponse.md",
|
|
@@ -750,6 +749,8 @@
|
|
|
750
749
|
"models/MessageStatus.md",
|
|
751
750
|
"models/NameUse.md",
|
|
752
751
|
"models/NearestLocationsResponse.md",
|
|
752
|
+
"models/NotificationResponse.md",
|
|
753
|
+
"models/NotificationUpsertRequest.md",
|
|
753
754
|
"models/NppesGetProviderRequest.md",
|
|
754
755
|
"models/NppesSearchProvidersRequest.md",
|
|
755
756
|
"models/NppesVerifyProviderRequest.md",
|
|
@@ -801,6 +802,7 @@
|
|
|
801
802
|
"models/PatientLink.md",
|
|
802
803
|
"models/PatientLinkType.md",
|
|
803
804
|
"models/PatientName.md",
|
|
805
|
+
"models/PatientPhotoUploadUrlResponse.md",
|
|
804
806
|
"models/PatientSidebar.md",
|
|
805
807
|
"models/PeakFlowReading.md",
|
|
806
808
|
"models/Person.md",
|
|
@@ -1079,6 +1081,8 @@
|
|
|
1079
1081
|
"models/UpdateRaceResponse.md",
|
|
1080
1082
|
"models/UploadAgentPhotoRequest.md",
|
|
1081
1083
|
"models/UploadAgentPhotoResponse.md",
|
|
1084
|
+
"models/UploadPatientPhotoRequest.md",
|
|
1085
|
+
"models/UploadPatientPhotoResponse.md",
|
|
1082
1086
|
"models/VerifyEmailResponse.md",
|
|
1083
1087
|
"models/VerifySmsResponse.md",
|
|
1084
1088
|
"models/VisionFaceCompareRequest.md",
|
|
@@ -2038,14 +2042,17 @@
|
|
|
2038
2042
|
"operations/fieldagent.getAgent.md",
|
|
2039
2043
|
"operations/fieldagent.getAgentDashboard.md",
|
|
2040
2044
|
"operations/fieldagent.getAgentPhoto.md",
|
|
2045
|
+
"operations/fieldagent.getPatientPhoto.md",
|
|
2041
2046
|
"operations/fieldagent.listEncounters.md",
|
|
2042
2047
|
"operations/fieldagent.listPatients.md",
|
|
2043
2048
|
"operations/fieldagent.login.md",
|
|
2044
2049
|
"operations/fieldagent.onboardPatient.md",
|
|
2050
|
+
"operations/fieldagent.patientPhotoUploadUrl.md",
|
|
2045
2051
|
"operations/fieldagent.register.md",
|
|
2046
2052
|
"operations/fieldagent.resetPassword.md",
|
|
2047
2053
|
"operations/fieldagent.updateAgent.md",
|
|
2048
2054
|
"operations/fieldagent.uploadAgentPhoto.md",
|
|
2055
|
+
"operations/fieldagent.uploadPatientPhoto.md",
|
|
2049
2056
|
"operations/fieldagent.verifyEmail.md",
|
|
2050
2057
|
"operations/fieldagent.verifySms.md",
|
|
2051
2058
|
"operations/graph.connect.md",
|
|
@@ -2095,7 +2102,6 @@
|
|
|
2095
2102
|
"operations/patient.commsListInvites.md",
|
|
2096
2103
|
"operations/patient.commsListMessages.md",
|
|
2097
2104
|
"operations/patient.commsListPresence.md",
|
|
2098
|
-
"operations/patient.commsRtcToken.md",
|
|
2099
2105
|
"operations/patient.commsUpsertConversation.md",
|
|
2100
2106
|
"operations/patient.commsUpsertGroup.md",
|
|
2101
2107
|
"operations/patient.commsUpsertInvite.md",
|
|
@@ -2185,13 +2191,12 @@
|
|
|
2185
2191
|
"operations/telehealth.createChannel.md",
|
|
2186
2192
|
"operations/telehealth.createPatientToken.md",
|
|
2187
2193
|
"operations/telehealth.createProviderToken.md",
|
|
2188
|
-
"operations/telehealth.fetchRtcToken.md",
|
|
2189
2194
|
"operations/vitals.connect.md",
|
|
2190
2195
|
"operations/vitals.listVitals.md",
|
|
2191
2196
|
"operations/vitals.recordVitals.md"
|
|
2192
2197
|
],
|
|
2193
2198
|
"language": "nodejs",
|
|
2194
|
-
"modelCount":
|
|
2195
|
-
"operationCount":
|
|
2199
|
+
"modelCount": 1165,
|
|
2200
|
+
"operationCount": 975,
|
|
2196
2201
|
"schemaVersion": 1
|
|
2197
2202
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -825,14 +825,17 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
825
825
|
- [GET /agents/{agent_id}](../operations/fieldagent.getAgent.md)
|
|
826
826
|
- [GET /agents/{agent_id}/dashboard](../operations/fieldagent.getAgentDashboard.md)
|
|
827
827
|
- [GET /agents/{agent_id}/photo](../operations/fieldagent.getAgentPhoto.md)
|
|
828
|
+
- [GET /patients/{patient_id}/photo](../operations/fieldagent.getPatientPhoto.md)
|
|
828
829
|
- [GET /encounters](../operations/fieldagent.listEncounters.md)
|
|
829
830
|
- [GET /patients](../operations/fieldagent.listPatients.md)
|
|
830
831
|
- [POST /auth/login](../operations/fieldagent.login.md)
|
|
831
832
|
- [Onboard a patient in one request](../operations/fieldagent.onboardPatient.md)
|
|
833
|
+
- [GET /patients/{patient_id}/photo/upload-url](../operations/fieldagent.patientPhotoUploadUrl.md)
|
|
832
834
|
- [POST /auth/register](../operations/fieldagent.register.md)
|
|
833
835
|
- [POST /auth/reset-password](../operations/fieldagent.resetPassword.md)
|
|
834
836
|
- [PATCH /agents/{agent_id}](../operations/fieldagent.updateAgent.md)
|
|
835
837
|
- [POST /agents/{agent_id}/photo](../operations/fieldagent.uploadAgentPhoto.md)
|
|
838
|
+
- [POST /patients/{patient_id}/photo](../operations/fieldagent.uploadPatientPhoto.md)
|
|
836
839
|
- [POST /auth/verify-email](../operations/fieldagent.verifyEmail.md)
|
|
837
840
|
- [POST /auth/verify-sms](../operations/fieldagent.verifySms.md)
|
|
838
841
|
- [GET /connect](../operations/graph.connect.md)
|
|
@@ -882,7 +885,6 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
882
885
|
- [GET /communications/invites](../operations/patient.commsListInvites.md)
|
|
883
886
|
- [GET /communications/messages](../operations/patient.commsListMessages.md)
|
|
884
887
|
- [GET /communications/presence](../operations/patient.commsListPresence.md)
|
|
885
|
-
- [POST /communications/rtc-token](../operations/patient.commsRtcToken.md)
|
|
886
888
|
- [POST /communications/conversations](../operations/patient.commsUpsertConversation.md)
|
|
887
889
|
- [POST /communications/groups](../operations/patient.commsUpsertGroup.md)
|
|
888
890
|
- [POST /communications/invites](../operations/patient.commsUpsertInvite.md)
|
|
@@ -972,7 +974,6 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
972
974
|
- [POST /telehealth/channels](../operations/telehealth.createChannel.md)
|
|
973
975
|
- [POST /telehealth/tokens/patient](../operations/telehealth.createPatientToken.md)
|
|
974
976
|
- [POST /telehealth/tokens/provider](../operations/telehealth.createProviderToken.md)
|
|
975
|
-
- [POST /fetch_rtc_token](../operations/telehealth.fetchRtcToken.md)
|
|
976
977
|
- [GET /connect](../operations/vitals.connect.md)
|
|
977
978
|
- [GET /patients/{patient_id}/vitals](../operations/vitals.listVitals.md)
|
|
978
979
|
- [POST /patients/{patient_id}/vitals](../operations/vitals.recordVitals.md)
|
package/docs/index.md
CHANGED
|
@@ -833,14 +833,17 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
833
833
|
- [GET /agents/{agent_id}](operations/fieldagent.getAgent.md) (`fieldagent.getAgent`)
|
|
834
834
|
- [GET /agents/{agent_id}/dashboard](operations/fieldagent.getAgentDashboard.md) (`fieldagent.getAgentDashboard`)
|
|
835
835
|
- [GET /agents/{agent_id}/photo](operations/fieldagent.getAgentPhoto.md) (`fieldagent.getAgentPhoto`)
|
|
836
|
+
- [GET /patients/{patient_id}/photo](operations/fieldagent.getPatientPhoto.md) (`fieldagent.getPatientPhoto`)
|
|
836
837
|
- [GET /encounters](operations/fieldagent.listEncounters.md) (`fieldagent.listEncounters`)
|
|
837
838
|
- [GET /patients](operations/fieldagent.listPatients.md) (`fieldagent.listPatients`)
|
|
838
839
|
- [POST /auth/login](operations/fieldagent.login.md) (`fieldagent.login`)
|
|
839
840
|
- [Onboard a patient in one request](operations/fieldagent.onboardPatient.md) (`fieldagent.onboardPatient`)
|
|
841
|
+
- [GET /patients/{patient_id}/photo/upload-url](operations/fieldagent.patientPhotoUploadUrl.md) (`fieldagent.patientPhotoUploadUrl`)
|
|
840
842
|
- [POST /auth/register](operations/fieldagent.register.md) (`fieldagent.register`)
|
|
841
843
|
- [POST /auth/reset-password](operations/fieldagent.resetPassword.md) (`fieldagent.resetPassword`)
|
|
842
844
|
- [PATCH /agents/{agent_id}](operations/fieldagent.updateAgent.md) (`fieldagent.updateAgent`)
|
|
843
845
|
- [POST /agents/{agent_id}/photo](operations/fieldagent.uploadAgentPhoto.md) (`fieldagent.uploadAgentPhoto`)
|
|
846
|
+
- [POST /patients/{patient_id}/photo](operations/fieldagent.uploadPatientPhoto.md) (`fieldagent.uploadPatientPhoto`)
|
|
844
847
|
- [POST /auth/verify-email](operations/fieldagent.verifyEmail.md) (`fieldagent.verifyEmail`)
|
|
845
848
|
- [POST /auth/verify-sms](operations/fieldagent.verifySms.md) (`fieldagent.verifySms`)
|
|
846
849
|
- [GET /connect](operations/graph.connect.md) (`graph.connect`)
|
|
@@ -890,7 +893,6 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
890
893
|
- [GET /communications/invites](operations/patient.commsListInvites.md) (`patient.commsListInvites`)
|
|
891
894
|
- [GET /communications/messages](operations/patient.commsListMessages.md) (`patient.commsListMessages`)
|
|
892
895
|
- [GET /communications/presence](operations/patient.commsListPresence.md) (`patient.commsListPresence`)
|
|
893
|
-
- [POST /communications/rtc-token](operations/patient.commsRtcToken.md) (`patient.commsRtcToken`)
|
|
894
896
|
- [POST /communications/conversations](operations/patient.commsUpsertConversation.md) (`patient.commsUpsertConversation`)
|
|
895
897
|
- [POST /communications/groups](operations/patient.commsUpsertGroup.md) (`patient.commsUpsertGroup`)
|
|
896
898
|
- [POST /communications/invites](operations/patient.commsUpsertInvite.md) (`patient.commsUpsertInvite`)
|
|
@@ -980,7 +982,6 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
980
982
|
- [POST /telehealth/channels](operations/telehealth.createChannel.md) (`telehealth.createChannel`)
|
|
981
983
|
- [POST /telehealth/tokens/patient](operations/telehealth.createPatientToken.md) (`telehealth.createPatientToken`)
|
|
982
984
|
- [POST /telehealth/tokens/provider](operations/telehealth.createProviderToken.md) (`telehealth.createProviderToken`)
|
|
983
|
-
- [POST /fetch_rtc_token](operations/telehealth.fetchRtcToken.md) (`telehealth.fetchRtcToken`)
|
|
984
985
|
- [GET /connect](operations/vitals.connect.md) (`vitals.connect`)
|
|
985
986
|
- [GET /patients/{patient_id}/vitals](operations/vitals.listVitals.md) (`vitals.listVitals`)
|
|
986
987
|
- [POST /patients/{patient_id}/vitals](operations/vitals.recordVitals.md) (`vitals.recordVitals`)
|
|
@@ -2,7 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `AddDependentRequest`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
HC transport shape for creating/updating a FHIR RelatedPerson dependent.
|
|
6
|
+
|
|
7
|
+
``relationship`` is a free-form string on purpose: the app sends
|
|
8
|
+
title-case display labels ("Spouse", "Child", ...) while FHIR stores v3
|
|
9
|
+
RoleCode values ("SPS", "CHLD", ...); the service layer
|
|
10
|
+
(``Dependent.parse_relationship``) maps both case-insensitively.
|
|
6
11
|
|
|
7
12
|
Type: `object`
|
|
8
13
|
|
|
@@ -10,8 +15,7 @@ Type: `object`
|
|
|
10
15
|
|
|
11
16
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
17
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `relationship` | `array` | No | | | | No | |
|
|
18
|
+
| `dob` | `string|null` | No | | | | Yes | ISO-8601 date (YYYY-MM-DD). |
|
|
19
|
+
| `first_name` | `string` | Yes | | | | No | |
|
|
20
|
+
| `last_name` | `string` | Yes | | | | No | |
|
|
21
|
+
| `relationship` | `string|null` | No | | | | Yes | e.g. 'Spouse' \| 'spouse' \| 'SPS'; accepted case-insensitively. One of self/spouse/child/parent/other. |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# AddDependentResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `AddDependentResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `dob` | `string|null` | No | | | | Yes | ISO-8601 date (YYYY-MM-DD). |
|
|
14
|
+
| `first_name` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `id` | `string|null` | No | | | | Yes | |
|
|
16
|
+
| `last_name` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `relationship` | `string|null` | No | | | | Yes | |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# AddNotificationResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `AddNotificationResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `createdAt` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `description` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `icon` | `string|null` | No | | | | Yes | |
|
|
16
|
+
| `id` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `read` | `boolean` | No | | | `false` | No | |
|
|
18
|
+
| `severity` | `string|null` | No | | | | Yes | |
|
|
19
|
+
| `title` | `string|null` | No | | | | Yes | |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# DependentResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `DependentResponse`
|
|
4
|
+
|
|
5
|
+
HC-shaped dependent record returned by the Patient API.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `dob` | `string|null` | No | | | | Yes | ISO-8601 date (YYYY-MM-DD). |
|
|
14
|
+
| `first_name` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `id` | `string|null` | No | | | | Yes | |
|
|
16
|
+
| `last_name` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `relationship` | `string|null` | No | | | | Yes | |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# FieldAgentPatientPhotoResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `GetPatientPhotoResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `binary_id` | `string` | Yes | | | | No | |
|
|
14
|
+
| `content_type` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `data` | `string|null` | No | | | | Yes | Base64-encoded image bytes (FHIR Binary.data). |
|
|
@@ -10,5 +10,5 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `dependents` |
|
|
14
|
-
| `patient_id` | `string
|
|
13
|
+
| `dependents` | array of [`DependentResponse`](./DependentResponse.md) | Yes | | | | No | |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
@@ -10,5 +10,5 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `notifications` |
|
|
14
|
-
| `patient_id` | `string
|
|
13
|
+
| `notifications` | array of [`NotificationResponse`](./NotificationResponse.md) | Yes | | | | No | |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# NotificationResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `NotificationResponse`
|
|
4
|
+
|
|
5
|
+
HC-shaped notification record returned by the Patient API.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `createdAt` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `description` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `icon` | `string|null` | No | | | | Yes | |
|
|
16
|
+
| `id` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `read` | `boolean` | No | | | `false` | No | |
|
|
18
|
+
| `severity` | `string|null` | No | | | | Yes | |
|
|
19
|
+
| `title` | `string|null` | No | | | | Yes | |
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# NotificationUpsertRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `NotificationUpsertRequest`
|
|
4
|
+
|
|
5
|
+
HC transport shape for creating/updating a patient notification.
|
|
6
|
+
|
|
7
|
+
All fields are optional: a create may carry the full shape, while the
|
|
8
|
+
app's "mark read" sends only ``{read: true}`` via PUT. The service layer
|
|
9
|
+
merges partial updates over the existing FHIR Communication
|
|
10
|
+
(read-modify-write), so a partial body never wipes stored fields.
|
|
11
|
+
|
|
12
|
+
Type: `object`
|
|
13
|
+
|
|
14
|
+
## Fields
|
|
15
|
+
|
|
16
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
17
|
+
|---|---|---:|---|---|---|---:|---|
|
|
18
|
+
| `createdAt` | `string|null` | No | | | | Yes | ISO-8601 datetime; defaults to now on create. |
|
|
19
|
+
| `description` | `string|null` | No | | | | Yes | |
|
|
20
|
+
| `icon` | `string|null` | No | | | | Yes | |
|
|
21
|
+
| `read` | `boolean|null` | No | | | | Yes | |
|
|
22
|
+
| `severity` | `string|null` | No | | | | Yes | One of info/success/warning/urgent (case-insensitive). |
|
|
23
|
+
| `title` | `string|null` | No | | | | Yes | |
|
|
@@ -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,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
|
-
#
|
|
1
|
+
# FieldAgentPatientPhotoUploadResponse
|
|
2
2
|
|
|
3
|
-
Model ID: `
|
|
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
|
-
| `
|
|
14
|
-
| `token` | `string` | Yes | | | | No | |
|
|
13
|
+
| `binary_id` | `string` | Yes | | | | No | |
|
package/docs/models/index.md
CHANGED
|
@@ -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
|
-
- [
|
|
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,6 +717,8 @@
|
|
|
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)
|
|
@@ -791,6 +792,7 @@
|
|
|
791
792
|
- [PatientLink](PatientLink.md)
|
|
792
793
|
- [PatientLinkType](PatientLinkType.md)
|
|
793
794
|
- [PatientName](PatientName.md)
|
|
795
|
+
- [PatientPhotoUploadUrlResponse](PatientPhotoUploadUrlResponse.md)
|
|
794
796
|
- [PatientSidebar](PatientSidebar.md)
|
|
795
797
|
- [PeakFlowReading](PeakFlowReading.md)
|
|
796
798
|
- [Person](Person.md)
|
|
@@ -1094,6 +1096,8 @@
|
|
|
1094
1096
|
- [UpdateRaceResponse](UpdateRaceResponse.md)
|
|
1095
1097
|
- [UploadAgentPhotoRequest](UploadAgentPhotoRequest.md)
|
|
1096
1098
|
- [FieldAgentPhotoUploadResponse](UploadAgentPhotoResponse.md)
|
|
1099
|
+
- [UploadPatientPhotoRequest](UploadPatientPhotoRequest.md)
|
|
1100
|
+
- [FieldAgentPatientPhotoUploadResponse](UploadPatientPhotoResponse.md)
|
|
1097
1101
|
- [VerifyEmailResponse](VerifyEmailResponse.md)
|
|
1098
1102
|
- [VerifySmsResponse](VerifySmsResponse.md)
|
|
1099
1103
|
- [VisionFaceCompareRequest](VisionFaceCompareRequest.md)
|
|
@@ -8,7 +8,7 @@ POST /auth/confirm-reset-password
|
|
|
8
8
|
|
|
9
9
|
`confirmPassword`
|
|
10
10
|
|
|
11
|
-
Signature: `confirmPassword<TResponse =
|
|
11
|
+
Signature: `confirmPassword<TResponse = ConfirmFieldAgentPasswordResponse>(request: ConfirmFieldAgentPasswordRequest): Promise<TResponse>`
|
|
12
12
|
|
|
13
13
|
Return type: `Promise<TResponse>`
|
|
14
14
|
|