@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
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
@@ -26,7 +25,7 @@
26
25
  - [`connect`](../operations/patient.connect.md) — GET /connect
27
26
  - [`createEncounter`](../operations/patient.createEncounter.md) — POST /encounters
28
27
  - [`createMedication`](../operations/patient.createMedication.md) — POST /patients/medications
29
- - [`createQuestionnaire`](../operations/patient.createQuestionnaire.md) — POST /questionnaires
28
+ - [`createQuestionnaire`](../operations/patient.createQuestionnaire.md) — Create a FHIR Questionnaire
30
29
  - [`createQuestionnaireResponse`](../operations/patient.createQuestionnaireResponse.md) — POST /questionnaires/{questionnaire_id}/responses
31
30
  - [`deleteActivity`](../operations/patient.deleteActivity.md) — DELETE /patients/activity/{activity_id}
32
31
  - [`deleteDependent`](../operations/patient.deleteDependent.md) — DELETE /patients/dependents/{dependent_id}
@@ -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
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:5eea09e1c8976cf97ca1d0c25428dec83d0bbf2c4a15e188a143f8a869196aaf",
2
+ "docsDataContentDigest": "sha256:7745a760438ffbb75039fdcb95bb94ec408f579dddbc7b82dfa0d9fdef10ba3d",
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/AddNotificationRequest.md",
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,12 +749,25 @@
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",
756
757
  "models/ObservationStatus.md",
758
+ "models/OnboardEncounterPayload.md",
759
+ "models/OnboardEncounterStepResult.md",
760
+ "models/OnboardPatientPayload.md",
757
761
  "models/OnboardPatientRequest.md",
758
762
  "models/OnboardPatientResponse.md",
763
+ "models/OnboardPatientStepResult.md",
764
+ "models/OnboardQuestionnaireAnswer.md",
765
+ "models/OnboardQuestionnaireDefinition.md",
766
+ "models/OnboardQuestionnairePayload.md",
767
+ "models/OnboardQuestionnaireResponseItem.md",
768
+ "models/OnboardQuestionnaireStepResult.md",
769
+ "models/OnboardVitalsPayload.md",
770
+ "models/OnboardVitalsStepResult.md",
759
771
  "models/OpenaiBuildResponseCreatePayloadRequest.md",
760
772
  "models/OpenaiChatJsonRequest.md",
761
773
  "models/OpenaiChatRequest.md",
@@ -801,6 +813,7 @@
801
813
  "models/PatientLink.md",
802
814
  "models/PatientLinkType.md",
803
815
  "models/PatientName.md",
816
+ "models/PatientPhotoUploadUrlResponse.md",
804
817
  "models/PatientSidebar.md",
805
818
  "models/PeakFlowReading.md",
806
819
  "models/Person.md",
@@ -857,6 +870,8 @@
857
870
  "models/QuestSubmitFullOrderRequest.md",
858
871
  "models/QuestSubmitOrderRequest.md",
859
872
  "models/QuestSyncCompendiumsRequest.md",
873
+ "models/QuestionItemType.md",
874
+ "models/QuestionnaireItemInput.md",
860
875
  "models/Race.md",
861
876
  "models/RapidTest.md",
862
877
  "models/RapidTestResult.md",
@@ -1079,6 +1094,8 @@
1079
1094
  "models/UpdateRaceResponse.md",
1080
1095
  "models/UploadAgentPhotoRequest.md",
1081
1096
  "models/UploadAgentPhotoResponse.md",
1097
+ "models/UploadPatientPhotoRequest.md",
1098
+ "models/UploadPatientPhotoResponse.md",
1082
1099
  "models/VerifyEmailResponse.md",
1083
1100
  "models/VerifySmsResponse.md",
1084
1101
  "models/VisionFaceCompareRequest.md",
@@ -2038,14 +2055,17 @@
2038
2055
  "operations/fieldagent.getAgent.md",
2039
2056
  "operations/fieldagent.getAgentDashboard.md",
2040
2057
  "operations/fieldagent.getAgentPhoto.md",
2058
+ "operations/fieldagent.getPatientPhoto.md",
2041
2059
  "operations/fieldagent.listEncounters.md",
2042
2060
  "operations/fieldagent.listPatients.md",
2043
2061
  "operations/fieldagent.login.md",
2044
2062
  "operations/fieldagent.onboardPatient.md",
2063
+ "operations/fieldagent.patientPhotoUploadUrl.md",
2045
2064
  "operations/fieldagent.register.md",
2046
2065
  "operations/fieldagent.resetPassword.md",
2047
2066
  "operations/fieldagent.updateAgent.md",
2048
2067
  "operations/fieldagent.uploadAgentPhoto.md",
2068
+ "operations/fieldagent.uploadPatientPhoto.md",
2049
2069
  "operations/fieldagent.verifyEmail.md",
2050
2070
  "operations/fieldagent.verifySms.md",
2051
2071
  "operations/graph.connect.md",
@@ -2095,7 +2115,6 @@
2095
2115
  "operations/patient.commsListInvites.md",
2096
2116
  "operations/patient.commsListMessages.md",
2097
2117
  "operations/patient.commsListPresence.md",
2098
- "operations/patient.commsRtcToken.md",
2099
2118
  "operations/patient.commsUpsertConversation.md",
2100
2119
  "operations/patient.commsUpsertGroup.md",
2101
2120
  "operations/patient.commsUpsertInvite.md",
@@ -2185,13 +2204,12 @@
2185
2204
  "operations/telehealth.createChannel.md",
2186
2205
  "operations/telehealth.createPatientToken.md",
2187
2206
  "operations/telehealth.createProviderToken.md",
2188
- "operations/telehealth.fetchRtcToken.md",
2189
2207
  "operations/vitals.connect.md",
2190
2208
  "operations/vitals.listVitals.md",
2191
2209
  "operations/vitals.recordVitals.md"
2192
2210
  ],
2193
2211
  "language": "nodejs",
2194
- "modelCount": 1161,
2195
- "operationCount": 974,
2212
+ "modelCount": 1178,
2213
+ "operationCount": 975,
2196
2214
  "schemaVersion": 1
2197
2215
  }
@@ -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)
@@ -892,7 +894,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
892
894
  - [GET /connect](../operations/patient.connect.md)
893
895
  - [POST /encounters](../operations/patient.createEncounter.md)
894
896
  - [POST /patients/medications](../operations/patient.createMedication.md)
895
- - [POST /questionnaires](../operations/patient.createQuestionnaire.md)
897
+ - [Create a FHIR Questionnaire](../operations/patient.createQuestionnaire.md)
896
898
  - [POST /questionnaires/{questionnaire_id}/responses](../operations/patient.createQuestionnaireResponse.md)
897
899
  - [DELETE /patients/activity/{activity_id}](../operations/patient.deleteActivity.md)
898
900
  - [DELETE /patients/dependents/{dependent_id}](../operations/patient.deleteDependent.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`)
@@ -900,7 +902,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
900
902
  - [GET /connect](operations/patient.connect.md) (`patient.connect`)
901
903
  - [POST /encounters](operations/patient.createEncounter.md) (`patient.createEncounter`)
902
904
  - [POST /patients/medications](operations/patient.createMedication.md) (`patient.createMedication`)
903
- - [POST /questionnaires](operations/patient.createQuestionnaire.md) (`patient.createQuestionnaire`)
905
+ - [Create a FHIR Questionnaire](operations/patient.createQuestionnaire.md) (`patient.createQuestionnaire`)
904
906
  - [POST /questionnaires/{questionnaire_id}/responses](operations/patient.createQuestionnaireResponse.md) (`patient.createQuestionnaireResponse`)
905
907
  - [DELETE /patients/activity/{activity_id}](operations/patient.deleteActivity.md) (`patient.deleteActivity`)
906
908
  - [DELETE /patients/dependents/{dependent_id}](operations/patient.deleteDependent.md) (`patient.deleteDependent`)
@@ -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
- No description.
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
- | `active` | `boolean` | No | | | | No | |
14
- | `birthDate` | `string` | No | date | | | No | |
15
- | `gender` | `string` | No | | | | No | |
16
- | `name` | `array` | No | | | | No | |
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 | |
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `CreateQuestionnaireRequest`
4
4
 
5
- No description.
5
+ Request body for POST /questionnaires — see Questionnaire.from_request_dict().
6
6
 
7
7
  Type: `object`
8
8
 
@@ -10,7 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `items` | `array` | No | | | | No | |
13
+ | `items` | array of [`QuestionnaireItemInput`](./QuestionnaireItemInput.md) | No | | | | No | |
14
14
  | `name` | `string` | Yes | | | | No | |
15
15
  | `status` | `string` | No | | | `"active"` | No | |
16
- | `title` | `string` | No | | | | No | |
16
+ | `title` | `string|null` | No | | | | Yes | |
@@ -10,4 +10,4 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `fhir_id` | `string|null` | Yes | | | | Yes | |
13
+ | `fhir_id` | `string` | Yes | | | | No | |
@@ -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` | `array` | Yes | | | | No | |
14
- | `patient_id` | `string|null` | Yes | | | | Yes | |
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` | `array` | Yes | | | | No | |
14
- | `patient_id` | `string|null` | Yes | | | | Yes | |
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,35 @@
1
+ # OnboardEncounterPayload
2
+
3
+ Model ID: `OnboardEncounterPayload`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `appointment_id` | `string|null` | No | | | | Yes | |
14
+ | `created_date` | `string|null` | No | | | | Yes | ISO 8601 datetime |
15
+ | `diagnoses` | array of [`fieldagent.EncounterDiagnosis`](./fieldagent.EncounterDiagnosis.md) | No | | | | No | |
16
+ | `encounter_class` | [`EncounterClass`](./EncounterClass.md) | No | | | `"AMB"` | No | |
17
+ | `encounter_id` | `string|null` | No | | | | Yes | UUID; server-generated if omitted. |
18
+ | `fhir_id` | `string|null` | No | | | | Yes | |
19
+ | `hospitalization` | [`fieldagent.EncounterHospitalization`](./fieldagent.EncounterHospitalization.md) | No | | | | Yes | |
20
+ | `length_minutes` | `integer|null` | No | | | | Yes | |
21
+ | `locations` | array of [`fieldagent.EncounterLocation`](./fieldagent.EncounterLocation.md) | No | | | | No | |
22
+ | `participants` | array of [`fieldagent.EncounterParticipant`](./fieldagent.EncounterParticipant.md) | No | | | | No | |
23
+ | `period_end` | `string|null` | No | | | | Yes | ISO 8601 datetime |
24
+ | `period_start` | `string|null` | No | | | | Yes | ISO 8601 datetime |
25
+ | `priority_code` | `string|null` | No | | | | Yes | |
26
+ | `priority_display` | `string|null` | No | | | | Yes | |
27
+ | `reason_code` | `string|null` | No | | | | Yes | |
28
+ | `reason_display` | `string|null` | No | | | | Yes | |
29
+ | `service_provider_display` | `string|null` | No | | | | Yes | |
30
+ | `service_provider_id` | `string|null` | No | | | | Yes | |
31
+ | `service_type_code` | `string|null` | No | | | | Yes | |
32
+ | `service_type_display` | `string|null` | No | | | | Yes | |
33
+ | `status` | [`EncounterStatus`](./EncounterStatus.md) | No | | | `"planned"` | No | |
34
+ | `type_code` | `string|null` | No | | | | Yes | |
35
+ | `type_display` | `string|null` | No | | | | Yes | |
@@ -0,0 +1,15 @@
1
+ # OnboardEncounterStepResult
2
+
3
+ Model ID: `OnboardEncounterStepResult`
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 | |
15
+ | `status` | `string` | Yes | | | | No | 'success', 'failed', or 'skipped' |
@@ -0,0 +1,22 @@
1
+ # OnboardPatientPayload
2
+
3
+ Model ID: `OnboardPatientPayload`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `address` | [`Address`](./Address.md) | No | | | | Yes | Mutually exclusive with addresses. |
14
+ | `addresses` | `array|null` | No | | | | Yes | Mutually exclusive with address. |
15
+ | `date_of_birth` | `string` | Yes | | | | No | ISO 8601 date (YYYY-MM-DD) |
16
+ | `email` | `string` | Yes | | | | No | |
17
+ | `first_name` | `string` | Yes | | | | No | |
18
+ | `last_name` | `string` | Yes | | | | No | |
19
+ | `password` | `string|null` | No | | | | Yes | Auto-generated server-side and not returned if omitted. |
20
+ | `phone` | `string|null` | No | | | | Yes | |
21
+ | `race` | [`Race`](./Race.md) | No | | | | Yes | |
22
+ | `sex_at_birth` | [`SexAtBirth`](./SexAtBirth.md) | No | | | | Yes | |
@@ -14,8 +14,8 @@ Type: `object`
14
14
 
15
15
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
16
16
  |---|---|---:|---|---|---|---:|---|
17
- | `encounter` | `object|null` | No | | | | Yes | Encounter fields accepted by POST /encounters on the Patient API (status, encounter_class, type_code, reason_code, period_start, ...). patient_id and created_by are populated automatically from the newly-registered patient and the calling field agent. |
18
- | `patient` | `object` | Yes | | | | No | first_name, last_name, email, date_of_birth required; password (auto-generated and not returned if omitted), phone, sex_at_birth optional. Same fields as POST /auth/register on the Patient API. |
19
- | `questionnaire` | `object|null` | No | | | | Yes | questionnaire_id (required), status, items[] — same shape as the body of POST /questionnaires/{questionnaire_id}/responses on the Patient API. |
17
+ | `encounter` | [`OnboardEncounterPayload`](./OnboardEncounterPayload.md) | No | | | | Yes | Encounter fields accepted by POST /encounters on the Patient API. patient_id and created_by are populated automatically from the newly-registered patient and the calling field agent. |
18
+ | `patient` | [`OnboardPatientPayload`](./OnboardPatientPayload.md) | Yes | | | | No | first_name, last_name, email, date_of_birth required; password (auto-generated and not returned if omitted), phone, sex_at_birth, address/addresses, race optional. Same fields as POST /auth/register on the Patient API. |
19
+ | `questionnaire` | [`OnboardQuestionnairePayload`](./OnboardQuestionnairePayload.md) | No | | | | Yes | Either questionnaire_id (FHIR id of an existing Questionnaire) or definition (create one inline — see OnboardQuestionnaireDefinition) is required. When definition is given instead of questionnaire_id, the Questionnaire is created first and its fhir_id is used for the response — the caller never needs to call POST /questionnaires separately. items are the answers, submitted the same way regardless of which one was supplied. |
20
20
  | `tenant_id` | `string|null` | No | | | | Yes | Defaults to the calling field agent's own tenant |
21
- | `vitals` | `object|null` | No | | | | Yes | temperature, weight_kg, height_cm, heart_rate, systolic, diastolic, oxygen_saturation — same fields as POST /patients/{patient_id}/vitals on the Vitals API. |
21
+ | `vitals` | [`OnboardVitalsPayload`](./OnboardVitalsPayload.md) | No | | | | Yes | Same fields as POST /patients/{patient_id}/vitals on the Vitals API. |
@@ -12,8 +12,8 @@ Type: `object`
12
12
 
13
13
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
14
14
  |---|---|---:|---|---|---|---:|---|
15
- | `encounter` | `object` | Yes | | | | No | status, fhir_id, error |
15
+ | `encounter` | [`OnboardEncounterStepResult`](./OnboardEncounterStepResult.md) | Yes | | | | No | |
16
16
  | `overall_status` | `string` | Yes | | | | No | 'completed', 'partial', or 'failed' |
17
- | `patient` | `object` | Yes | | | | No | status, fhir_patient_id, cognito_sub, ... |
18
- | `questionnaire_response` | `object` | Yes | | | | No | status, fhir_id, error |
19
- | `vitals` | `object` | Yes | | | | No | status, observation_count, error |
17
+ | `patient` | [`OnboardPatientStepResult`](./OnboardPatientStepResult.md) | Yes | | | | No | |
18
+ | `questionnaire_response` | [`OnboardQuestionnaireStepResult`](./OnboardQuestionnaireStepResult.md) | Yes | | | | No | |
19
+ | `vitals` | [`OnboardVitalsStepResult`](./OnboardVitalsStepResult.md) | Yes | | | | No | |