@healthcloudai/hc-sdk 2.7.0 → 2.9.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 (68) hide show
  1. package/dist/index.cjs +70 -0
  2. package/dist/index.d.cts +168 -2
  3. package/dist/index.d.ts +168 -2
  4. package/dist/index.js +70 -0
  5. package/docs/clients/PatientClient.md +3 -0
  6. package/docs/docs-manifest.json +11 -6
  7. package/docs/examples/index.md +3 -0
  8. package/docs/index.md +3 -0
  9. package/docs/models/AddInsuranceRequest.md +1 -0
  10. package/docs/models/AddInsuranceResponse.md +2 -0
  11. package/docs/models/Appointment.md +1 -0
  12. package/docs/models/AthenaAppointment.md +1 -0
  13. package/docs/models/BookAppointmentRequest.md +1 -0
  14. package/docs/models/CheckEncounterRequest.md +17 -0
  15. package/docs/models/CheckInEncounterRequest.md +17 -0
  16. package/docs/models/GS1LookupResponse.md +3 -2
  17. package/docs/models/GetEncounterResponse.md +3 -0
  18. package/docs/models/GetLatestEncounterResponse.md +17 -0
  19. package/docs/models/GetPatientResponse.md +2 -0
  20. package/docs/models/GetScanUploadUrlRequest.md +3 -2
  21. package/docs/models/GetTestResultResponse.md +20 -0
  22. package/docs/models/PatientDemographics.md +2 -0
  23. package/docs/models/ScanUploadResponse.md +4 -4
  24. package/docs/models/SetPreferredPharmacyResponse.md +20 -0
  25. package/docs/models/Slot.md +1 -0
  26. package/docs/models/fieldagent.Encounter.md +3 -0
  27. package/docs/models/index.md +5 -3
  28. package/docs/models/patient.Encounter.md +3 -0
  29. package/docs/models/patient.LoginResponse.md +1 -0
  30. package/docs/operations/appointments.book.md +18 -15
  31. package/docs/operations/appointments.cancel.md +12 -11
  32. package/docs/operations/appointments.createSlot.md +44 -9
  33. package/docs/operations/appointments.listPatientAppointments.md +13 -12
  34. package/docs/operations/appointments.listSlots.md +9 -8
  35. package/docs/operations/appointments.reschedule.md +11 -10
  36. package/docs/operations/connectors.athenaBookAppointment.md +1 -0
  37. package/docs/operations/connectors.athenaCreateInsurancePackage.md +1 -1
  38. package/docs/operations/connectors.athenaGetAppointmentDetails.md +1 -0
  39. package/docs/operations/connectors.athenaGetBookedAppointments.md +1 -0
  40. package/docs/operations/connectors.athenaGetEncounter.md +1 -0
  41. package/docs/operations/connectors.athenaListAppointments.md +1 -0
  42. package/docs/operations/connectors.athenaListPatientAppointments.md +1 -0
  43. package/docs/operations/diagnostics.getScanUploadUrl.md +7 -5
  44. package/docs/operations/diagnostics.getTestResult.md +5 -23
  45. package/docs/operations/diagnostics.lookupTestByGs1.md +12 -6
  46. package/docs/operations/fieldagent.listEncounters.md +42 -39
  47. package/docs/operations/fieldagent.listPatients.md +60 -95
  48. package/docs/operations/patient.addInsurance.md +14 -10
  49. package/docs/operations/patient.checkEncounter.md +110 -0
  50. package/docs/operations/patient.checkInEncounter.md +114 -0
  51. package/docs/operations/patient.createEncounter.md +40 -37
  52. package/docs/operations/patient.createQuestionnaireResponse.md +1 -1
  53. package/docs/operations/patient.getCheckinCheckin.md +41 -38
  54. package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +43 -40
  55. package/docs/operations/patient.getEncounter.md +40 -37
  56. package/docs/operations/patient.getLatestEncounter.md +162 -0
  57. package/docs/operations/patient.getPatient.md +57 -92
  58. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +97 -129
  59. package/docs/operations/patient.listEncounters.md +41 -38
  60. package/docs/operations/patient.login.md +8 -7
  61. package/docs/operations/patient.setPreferredPharmacy.md +3 -4
  62. package/docs/operations/patient.updatePhone.md +42 -1
  63. package/docs/operations/person.updatePhone.md +42 -1
  64. package/docs/operations/provider.updatePhone.md +42 -1
  65. package/package.json +1 -1
  66. package/docs/models/OrganizationResource.md +0 -19
  67. package/docs/models/PanelResult.md +0 -24
  68. package/docs/models/SingleTestResultResponse.md +0 -28
package/dist/index.js CHANGED
@@ -253,6 +253,14 @@ var AppointmentsClient = class extends BaseServiceClient {
253
253
  /**
254
254
  * Book an appointment for a specific slot.
255
255
  * POST /appointments/book
256
+ *
257
+ * On an Athena-integrated tenant the booking is made in Athena only — no
258
+ * local FHIR Appointment is written — and `athena_appointment_id` is
259
+ * **required**: take it from the `athena_appointment_id` of the chosen
260
+ * {@link listSlots} result, or the request is rejected. `slot_id` is still
261
+ * required by the generic pre-check; for Athena slots the same numeric id
262
+ * serves as both, since Athena reuses one id for a slot before and after
263
+ * booking.
256
264
  */
257
265
  book(request) {
258
266
  return this.send("POST", "/appointments/book", {
@@ -1272,11 +1280,73 @@ var PatientClient = class extends BaseServiceClient {
1272
1280
  pathParams: { id: encounterId }
1273
1281
  });
1274
1282
  }
1283
+ /**
1284
+ * Open (or resume) the patient's visit right now — "the patient is here."
1285
+ *
1286
+ * Finds or creates their current open FHIR Encounter. On an Athena-integrated
1287
+ * tenant this additionally books a walk-in appointment for the current
1288
+ * moment, attaches the tenant's default self-pay insurance package, and
1289
+ * checks the patient in — all server-side, so no appointment id is needed.
1290
+ * Use {@link checkInEncounter} instead when you already hold one.
1291
+ *
1292
+ * Resolves with HTTP 200 even when the Athena leg failed: inspect
1293
+ * `athena_encounter_status` (and `athena_insurance_status`) rather than
1294
+ * treating a resolved promise as success. The endpoint retries the
1295
+ * book+check-in pair once on its own, because Athena legitimately rejects a
1296
+ * walk-in whose minute falls outside the provider's schedule template.
1297
+ *
1298
+ * Idempotent: an encounter already linked to Athena is returned as-is and is
1299
+ * never re-booked or re-checked-in.
1300
+ */
1301
+ checkEncounter(request) {
1302
+ return this.send("POST", "/encounters/check", {
1303
+ body: request
1304
+ });
1305
+ }
1306
+ /**
1307
+ * Check the patient in against an appointment you already have (for example a
1308
+ * future slot booked earlier through `AppointmentsClient.bookAppointment`),
1309
+ * and link the resulting Athena encounter onto the FHIR Encounter.
1310
+ *
1311
+ * Does not create or book an appointment, and does not attach insurance —
1312
+ * use {@link checkEncounter} for the walk-in-now flow.
1313
+ */
1314
+ checkInEncounter(encounterId, request) {
1315
+ return this.send("POST", "/encounters/{id}/check-in", {
1316
+ pathParams: { id: encounterId },
1317
+ body: request
1318
+ });
1319
+ }
1320
+ /**
1321
+ * Get the patient's latest still-open encounter, or `{ encounter: null }`
1322
+ * when none is open.
1323
+ *
1324
+ * On an Athena-integrated tenant Athena is authoritative: its encounter list
1325
+ * is read directly and matched back onto the local FHIR Encounter by
1326
+ * `athena_encounter_id`. A tenant-level read failure is surfaced as an error
1327
+ * rather than an empty result, so `{ encounter: null }` genuinely means "no
1328
+ * open encounter".
1329
+ */
1330
+ getLatestEncounter(patientId) {
1331
+ return this.send("GET", "/patients/{patient_id}/encounters/latest", {
1332
+ pathParams: { patient_id: patientId }
1333
+ });
1334
+ }
1275
1335
  createQuestionnaire(request) {
1276
1336
  return this.send("POST", "/questionnaires", {
1277
1337
  body: request
1278
1338
  });
1279
1339
  }
1340
+ /**
1341
+ * Create a FHIR QuestionnaireResponse, and on an Athena-integrated tenant also
1342
+ * append it as a note on the patient's open Athena encounter.
1343
+ *
1344
+ * The FHIR write always happens; the Athena note is additive and non-fatal, so
1345
+ * its outcome is reported on `athena_questionnaire_status` rather than
1346
+ * rejecting the call. `skipped_no_athena_encounter` means no Athena encounter
1347
+ * is open yet — notes attach to one, which only exists after check-in
1348
+ * ({@link checkEncounter}).
1349
+ */
1280
1350
  createQuestionnaireResponse(questionnaireId, request) {
1281
1351
  return this.send("POST", "/questionnaires/{id}/responses", {
1282
1352
  pathParams: { id: questionnaireId },
@@ -9,6 +9,8 @@
9
9
  - [`ocrIdentityDocument`](../operations/patient.assistantOcr.md) — OCR an identity document via vision LLM
10
10
  - [`ocrInsuranceDocument`](../operations/patient.assistantOcrInsurance.md) — OCR an insurance card via vision LLM
11
11
  - [`checkInsuranceEligibility`](../operations/patient.checkEligibility.md) — Check insurance eligibility
12
+ - [`checkEncounter`](../operations/patient.checkEncounter.md) — Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in
13
+ - [`checkInEncounter`](../operations/patient.checkInEncounter.md) — Check in an encounter via the tenant's connected EHR
12
14
  - [`getCommunicationsState`](../operations/patient.commsGetState.md) — Get the full CareConnect snapshot
13
15
  - [`getUnreadCount`](../operations/patient.commsGetUnreadCount.md) — Get unread message count
14
16
  - [`listConversations`](../operations/patient.commsListConversations.md) — List conversations
@@ -37,6 +39,7 @@
37
39
  - [`getCurrentCareSession`](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md) — Get the current care session
38
40
  - [`getEncounter`](../operations/patient.getEncounter.md) — Get an encounter
39
41
  - [`listPatientInsurances`](../operations/patient.getInsurance.md) — List insurance coverage
42
+ - [`getLatestEncounter`](../operations/patient.getLatestEncounter.md) — Get the patient's latest open encounter
40
43
  - [`getMedication`](../operations/patient.getMedication.md) — Get a medication
41
44
  - [`getProfile`](../operations/patient.getPatient.md) — Get the authenticated patient
42
45
  - [`getPatientAlerts`](../operations/patient.getPatientAlerts.md) — Get patient dashboard alerts
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:66eaa85f930df6ea0e0a429b9842cc4d3bed53310e8725f9989df2bf1abb23ef",
2
+ "docsDataContentDigest": "sha256:8862eacd1c7e0798f51dbc7a398e2f12ea901c7a27b945b20a87b87749021a48",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AnthropicClient.md",
@@ -434,6 +434,8 @@
434
434
  "models/CarequalityRetrieveDocumentsResponse.md",
435
435
  "models/ChatMessageRecord.md",
436
436
  "models/CheckEligibilityRequest.md",
437
+ "models/CheckEncounterRequest.md",
438
+ "models/CheckInEncounterRequest.md",
437
439
  "models/CmsGetCountyFipsRequest.md",
438
440
  "models/CmsSearchHealthPlansRequest.md",
439
441
  "models/CmsSearchHealthPlansResponse.md",
@@ -581,6 +583,7 @@
581
583
  "models/GetEncounterResponse.md",
582
584
  "models/GetHealthRecordResponse.md",
583
585
  "models/GetInsuranceResponse.md",
586
+ "models/GetLatestEncounterResponse.md",
584
587
  "models/GetMedicalConceptAncestorsResponse.md",
585
588
  "models/GetMedicalConceptDescendantsResponse.md",
586
589
  "models/GetMedicalConceptRelationshipsResponse.md",
@@ -598,6 +601,7 @@
598
601
  "models/GetPolicyDocumentResponse.md",
599
602
  "models/GetPractitionerResponse.md",
600
603
  "models/GetScanUploadUrlRequest.md",
604
+ "models/GetTestResultResponse.md",
601
605
  "models/GetVitalsResponse.md",
602
606
  "models/GlucoseReading.md",
603
607
  "models/GoogleAICandidate.md",
@@ -1274,7 +1278,6 @@
1274
1278
  "models/OpenAIModerateRequest.md",
1275
1279
  "models/OpenAIUpdateAssistantRequest.md",
1276
1280
  "models/OpenAIUpdateAssistantResponse.md",
1277
- "models/OrganizationResource.md",
1278
1281
  "models/OuraBuildAuthorizationUrlRequest.md",
1279
1282
  "models/OuraBuildAuthorizationUrlResponse.md",
1280
1283
  "models/OuraDailyActivity.md",
@@ -1315,7 +1318,6 @@
1315
1318
  "models/OuraWorkout.md",
1316
1319
  "models/PainScale.md",
1317
1320
  "models/PainScore.md",
1318
- "models/PanelResult.md",
1319
1321
  "models/ParticipantType.md",
1320
1322
  "models/PatientAlertsResponse.md",
1321
1323
  "models/PatientDemographics.md",
@@ -1604,8 +1606,8 @@
1604
1606
  "models/SendGridSendResult.md",
1605
1607
  "models/SendGridTemplate.md",
1606
1608
  "models/SetPreferredPharmacyRequest.md",
1609
+ "models/SetPreferredPharmacyResponse.md",
1607
1610
  "models/SexAtBirth.md",
1608
- "models/SingleTestResultResponse.md",
1609
1611
  "models/Slot.md",
1610
1612
  "models/SlotStatus.md",
1611
1613
  "models/SpecimenType.md",
@@ -2910,6 +2912,8 @@
2910
2912
  "operations/patient.assistantOcr.md",
2911
2913
  "operations/patient.assistantOcrInsurance.md",
2912
2914
  "operations/patient.checkEligibility.md",
2915
+ "operations/patient.checkEncounter.md",
2916
+ "operations/patient.checkInEncounter.md",
2913
2917
  "operations/patient.commsGetState.md",
2914
2918
  "operations/patient.commsGetUnreadCount.md",
2915
2919
  "operations/patient.commsListConversations.md",
@@ -2939,6 +2943,7 @@
2939
2943
  "operations/patient.getCurrentCareSessionCareSessionsCurrent.md",
2940
2944
  "operations/patient.getEncounter.md",
2941
2945
  "operations/patient.getInsurance.md",
2946
+ "operations/patient.getLatestEncounter.md",
2942
2947
  "operations/patient.getMedication.md",
2943
2948
  "operations/patient.getPatient.md",
2944
2949
  "operations/patient.getPatientAlerts.md",
@@ -3019,7 +3024,7 @@
3019
3024
  "operations/vitals.recordVitals.md"
3020
3025
  ],
3021
3026
  "language": "nodejs",
3022
- "modelCount": 1965,
3023
- "operationCount": 998,
3027
+ "modelCount": 1967,
3028
+ "operationCount": 1001,
3024
3029
  "schemaVersion": 1
3025
3030
  }
@@ -893,6 +893,8 @@ Generated call examples use exact public surface signatures. Workflow examples r
893
893
  - [OCR an identity document via vision LLM](../operations/patient.assistantOcr.md)
894
894
  - [OCR an insurance card via vision LLM](../operations/patient.assistantOcrInsurance.md)
895
895
  - [Check insurance eligibility](../operations/patient.checkEligibility.md)
896
+ - [Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in](../operations/patient.checkEncounter.md)
897
+ - [Check in an encounter via the tenant's connected EHR](../operations/patient.checkInEncounter.md)
896
898
  - [Get the full CareConnect snapshot](../operations/patient.commsGetState.md)
897
899
  - [Get unread message count](../operations/patient.commsGetUnreadCount.md)
898
900
  - [List conversations](../operations/patient.commsListConversations.md)
@@ -922,6 +924,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
922
924
  - [Get the current care session](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md)
923
925
  - [Get an encounter](../operations/patient.getEncounter.md)
924
926
  - [List insurance coverage](../operations/patient.getInsurance.md)
927
+ - [Get the patient's latest open encounter](../operations/patient.getLatestEncounter.md)
925
928
  - [Get a medication](../operations/patient.getMedication.md)
926
929
  - [Get the authenticated patient](../operations/patient.getPatient.md)
927
930
  - [Get patient dashboard alerts](../operations/patient.getPatientAlerts.md)
package/docs/index.md CHANGED
@@ -901,6 +901,8 @@ This directory is generated from the shared structured docs data. Do not edit ge
901
901
  - [OCR an identity document via vision LLM](operations/patient.assistantOcr.md) (`patient.assistantOcr`)
902
902
  - [OCR an insurance card via vision LLM](operations/patient.assistantOcrInsurance.md) (`patient.assistantOcrInsurance`)
903
903
  - [Check insurance eligibility](operations/patient.checkEligibility.md) (`patient.checkEligibility`)
904
+ - [Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in](operations/patient.checkEncounter.md) (`patient.checkEncounter`)
905
+ - [Check in an encounter via the tenant's connected EHR](operations/patient.checkInEncounter.md) (`patient.checkInEncounter`)
904
906
  - [Get the full CareConnect snapshot](operations/patient.commsGetState.md) (`patient.commsGetState`)
905
907
  - [Get unread message count](operations/patient.commsGetUnreadCount.md) (`patient.commsGetUnreadCount`)
906
908
  - [List conversations](operations/patient.commsListConversations.md) (`patient.commsListConversations`)
@@ -930,6 +932,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
930
932
  - [Get the current care session](operations/patient.getCurrentCareSessionCareSessionsCurrent.md) (`patient.getCurrentCareSessionCareSessionsCurrent`)
931
933
  - [Get an encounter](operations/patient.getEncounter.md) (`patient.getEncounter`)
932
934
  - [List insurance coverage](operations/patient.getInsurance.md) (`patient.getInsurance`)
935
+ - [Get the patient's latest open encounter](operations/patient.getLatestEncounter.md) (`patient.getLatestEncounter`)
933
936
  - [Get a medication](operations/patient.getMedication.md) (`patient.getMedication`)
934
937
  - [Get the authenticated patient](operations/patient.getPatient.md) (`patient.getPatient`)
935
938
  - [Get patient dashboard alerts](operations/patient.getPatientAlerts.md) (`patient.getPatientAlerts`)
@@ -11,6 +11,7 @@ Type: `object`
11
11
 
12
12
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
13
13
  |---|---|---:|---|---|---|---:|---|
14
+ | `insurance_package_id` | `string|null` | No | | | | Yes | Athena Health insurance package id from Athena's own catalogue. Only used for tenants with the ATHENA integration enabled, where it identifies which Athena package to attach to the mirrored patient. When omitted, a best-effort lookup by payer_name/member_id is attempted. |
14
15
  | `member_id` | `string` | Yes | | | | No | Subscriber's member/policy ID with the payer. |
15
16
  | `payer_id` | `string|null` | No | | | | Yes | NAIC or payer identifier. |
16
17
  | `payer_name` | `string` | Yes | | | | No | Display name of the insurance payer/carrier. |
@@ -10,6 +10,8 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `athena_insurance_error` | `string|null` | No | | | | Yes | Human-readable reason the Athena mirror failed, when athena_insurance_status is 'failed'. |
14
+ | `athena_insurance_status` | `string|null` | No | | | | Yes | 'linked' if the insurance was also mirrored into Athena, 'failed' otherwise, null if this tenant has no Athena integration configured. |
13
15
  | `coverages_created` | `integer` | Yes | | | | No | Number of FHIR Coverage resources created by this request. |
14
16
  | `fhir_patient_id` | `string|null` | Yes | | | | Yes | Deprecated alias of `patient_id`, kept for one release as a compatibility grace window. |
15
17
  | `patient_id` | `string|null` | Yes | | | | Yes | FHIR Patient resource ID the coverage was added to. |
@@ -11,6 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `appointment_id` | `string` | Yes | | | | No | Stable appointment identifier used to cancel or reschedule. |
14
+ | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id this appointment is linked to, when booked via Athena. |
14
15
  | `created_at` | `string|null` | No | date-time | | | Yes | Creation timestamp in ISO 8601 date-time format, when available. |
15
16
  | `end` | `string|null` | No | date-time | | | Yes | Appointment end in ISO 8601 date-time format, when scheduled. |
16
17
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID associated with the appointment. |
@@ -17,6 +17,7 @@ Type: `object`
17
17
  | `date` | `string|null` | No | | | `null` | Yes | |
18
18
  | `department_id` | `string|null` | No | | | `null` | Yes | |
19
19
  | `duration` | `unknown|null` | No | | | `null` | Yes | |
20
+ | `encounter_id` | `string|null` | No | | | `null` | Yes | |
20
21
  | `last_modified` | `string|null` | No | | | `null` | Yes | |
21
22
  | `patient_appointment_type_name` | `string|null` | No | | | `null` | Yes | |
22
23
  | `patient_id` | `string|null` | No | | | `null` | Yes | |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id of the slot being booked, taken from the `athena_appointment_id` of the chosen `appointments.listSlots` result. Required on an Athena-integrated tenant, where the booking is made in Athena against this id (the request is rejected without it); ignored on a FHIR-only tenant, which books against `slot_id`. |
13
14
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID for whom the appointment is booked. |
14
15
  | `slot_id` | `string` | Yes | | | | No | FHIR Slot resource ID returned by `appointments.listSlots`. |
15
16
 
@@ -0,0 +1,17 @@
1
+ # CheckEncounterRequest
2
+
3
+ Model ID: `CheckEncounterRequest`
4
+
5
+ Request body for POST /encounters/check.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource id. |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.
@@ -0,0 +1,17 @@
1
+ # CheckInEncounterRequest
2
+
3
+ Model ID: `CheckInEncounterRequest`
4
+
5
+ Request body for POST /encounters/{encounter_id}/check-in.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `appointment_id` | `string` | Yes | | | | No | EHR (e.g. Athena) appointment id to check the patient in against. |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.
@@ -10,9 +10,10 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `gs1_parsed` | [`GS1ParsedData`](./GS1ParsedData.md) | Yes | | | | No | Structured components parsed from the raw_gs1 barcode string. |
14
- | `product` | `object|null` | No | | | | Yes | Opaque source-catalog product map returned verbatim when the parsed GTIN is recognized; null if no match was found. Its PascalCase/source-specific fields are not the TestProfile schema. |
13
+ | `gs1_parsed` | [`GS1ParsedData`](./GS1ParsedData.md) | Yes | | | | No | Structured components parsed from the raw GS1 barcode. |
14
+ | `product` | `object|null` | No | | | | Yes | Opaque source-catalog product map returned when the parsed GTIN is recognized. |
15
15
  | `raw_gs1` | `string` | Yes | | | | No | The raw GS1 barcode string that was looked up. |
16
+ | `scan_upload` | [`ScanUploadResponse`](./ScanUploadResponse.md) | No | | | | Yes | SAFE CDX upload information generated for this patient/test. Present when the product supports SAFE CDX image processing. |
16
17
 
17
18
  ## Example
18
19
 
@@ -11,6 +11,8 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `appointment_id` | `string|null` | No | | | | Yes | FHIR Appointment id this encounter fulfills, when linked. |
14
+ | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id this encounter was checked in from, when checked in via Athena. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
15
+ | `athena_encounter_id` | `string|null` | No | | | | Yes | Athena Health encounter id this encounter is linked to, when checked in via Athena. |
14
16
  | `created_by` | `string` | No | | | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
15
17
  | `created_date` | `string|null` | No | | | | Yes | UTC datetime when the encounter was created |
16
18
  | `diagnoses` | array of [`patient.EncounterDiagnosis`](./patient.EncounterDiagnosis.md) | No | | | | No | Diagnoses recorded for this encounter, ranked by rank. |
@@ -20,6 +22,7 @@ Type: `object`
20
22
  | `hospitalization` | [`patient.EncounterHospitalization`](./patient.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
21
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
22
24
  | `locations` | array of [`patient.EncounterLocation`](./patient.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
23
26
  | `participants` | array of [`patient.EncounterParticipant`](./patient.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
24
27
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient id who is the subject of the encounter. |
25
28
  | `period_end` | `string|null` | No | | | | Yes | When the encounter ended, when recorded. |
@@ -0,0 +1,17 @@
1
+ # GetLatestEncounterResponse
2
+
3
+ Model ID: `GetLatestEncounterResponse`
4
+
5
+ Response for GET /patients/{patient_id}/encounters/latest.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `encounter` | [`patient.Encounter`](./patient.Encounter.md) | No | | | | Yes | The patient's latest open encounter, or null if none is currently open. |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.
@@ -17,6 +17,8 @@ Type: `object`
17
17
  |---|---|---:|---|---|---|---:|---|
18
18
  | `active` | `boolean` | No | | | `true` | No | Whether the patient record is active. |
19
19
  | `addresses` | array of [`Address`](./Address.md) | No | | | | No | Patient's addresses (home, work, mailing, etc.). |
20
+ | `athena_patient_id` | `string|null` | No | | | | Yes | Athena Health patient identifier when this patient is linked to Athena |
21
+ | `athena_practice_id` | `string|null` | No | | | | Yes | Athena Health practice identifier that scopes athena_patient_id |
20
22
  | `attributes` | `object` | No | | | | No | Arbitrary JSON-compatible metadata for this patient |
21
23
  | `communications` | array of [`Communication`](./Communication.md) | No | | | | No | Languages the patient communicates in, with preferred flag. |
22
24
  | `created_by` | `string` | No | | | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
@@ -11,8 +11,9 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `content_type` | `string` | No | | | `"image/jpeg"` | No | MIME type of the scan image. Defaults to image/jpeg. |
14
- | `filename` | `string` | No | | | `"scan.jpg"` | No | Filename to use for the uploaded scan. Defaults to scan.jpg. |
15
- | `test_id` | `string` | Yes | uuid | | | No | Domain UUID of the rapid test this scan belongs to. |
14
+ | `filename` | `string` | No | | | `"scan.jpg"` | No | Filename of the uploaded scan. Defaults to scan.jpg. |
15
+ | `gtin` | `string|null` | No | | | | Yes | GTIN of the test kit. Optional for the compatibility upload endpoint; the combined GS1 lookup flow supplies it automatically. |
16
+ | `test_id` | `string` | Yes | uuid | | | No | Health Cloud correlation UUID for the diagnostic scan. |
16
17
 
17
18
  ## Example
18
19
 
@@ -0,0 +1,20 @@
1
+ # GetTestResultResponse
2
+
3
+ Model ID: `GetTestResultResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `code` | `integer` | Yes | | | | No | |
14
+ | `data` | `object` | Yes | | | | No | |
15
+ | `message` | `string` | Yes | | | | No | |
16
+ | `success` | `boolean` | Yes | | | | No | |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -12,6 +12,8 @@ Type: `object`
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `active` | `boolean` | No | | | `true` | No | Whether the patient record is active. |
14
14
  | `addresses` | array of [`Address`](./Address.md) | No | | | | No | Patient's addresses (home, work, mailing, etc.). |
15
+ | `athena_patient_id` | `string|null` | No | | | | Yes | Athena Health patient identifier when this patient is linked to Athena |
16
+ | `athena_practice_id` | `string|null` | No | | | | Yes | Athena Health practice identifier that scopes athena_patient_id |
15
17
  | `attributes` | `object` | No | | | | No | Arbitrary JSON-compatible metadata for this patient |
16
18
  | `communications` | array of [`Communication`](./Communication.md) | No | | | | No | Languages the patient communicates in, with preferred flag. |
17
19
  | `created_by` | `string` | No | | | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `ScanUploadResponse`
4
4
 
5
- Response for POST /patients/{patient_id}/diagnostics/scan-upload-url.
5
+ SAFE CDX presigned upload information.
6
6
 
7
7
  Type: `object`
8
8
 
@@ -11,9 +11,9 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `expires_in` | `integer` | Yes | | | | No | Seconds until the presigned URL expires. |
14
- | `storage_key` | `string` | Yes | | | | No | Object key the scan will be stored under. |
15
- | `test_id` | `string` | Yes | uuid | | | No | Echoes the test_id the upload URL was generated for. |
16
- | `upload_url` | `string` | Yes | | | | No | Presigned PUT URL. Upload the raw image bytes directly to this URL with an HTTP PUT. |
14
+ | `storage_key` | `string` | Yes | | | | No | SAFE CDX S3 object key associated with this scan. |
15
+ | `test_id` | `string` | Yes | uuid | | | No | Health Cloud correlation identifier for this diagnostic scan. Use this identifier when retrieving the processed result. |
16
+ | `upload_url` | `string` | Yes | | | | No | Presigned AWS S3 PUT URL. Upload the image bytes directly using the required Content-Type. |
17
17
 
18
18
  ## Example
19
19
 
@@ -0,0 +1,20 @@
1
+ # SetPreferredPharmacyResponse
2
+
3
+ Model ID: `SetPreferredPharmacyResponse`
4
+
5
+ Response for PUT /patients/preferred-pharmacy: the saved FHIR
6
+ Organization resource (passthrough, hence `extra="allow"` rather than
7
+ enumerating every FHIR field) plus the Athena mirror outcome.
8
+
9
+ Type: `object`
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
14
+ |---|---|---:|---|---|---|---:|---|
15
+ | `athena_pharmacy_error` | `string|null` | No | | | | Yes | Reason for a 'failed' athena_pharmacy_status, when present. |
16
+ | `athena_pharmacy_status` | `string|null` | No | | | | Yes | Outcome of mirroring this pharmacy into Athena: 'linked', 'failed', 'skipped_no_athena' (tenant not Athena-integrated), or 'skipped_not_linked' (patient has no athena_patient_id). |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id backing this slot. Always present for slots sourced from Athena, where it — not `slot_id` — is what `appointments.book` must be given as `athena_appointment_id`. |
13
14
  | `end` | `string` | Yes | date-time | | | No | Exclusive slot end in ISO 8601 date-time format. |
14
15
  | `location` | `string|null` | No | | | | Yes | Human-readable appointment location, when available. |
15
16
  | `provider_id` | `string` | Yes | | | | No | FHIR Practitioner resource ID assigned to the slot. |
@@ -11,6 +11,8 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `appointment_id` | `string|null` | No | | | | Yes | FHIR Appointment id this encounter fulfills, when linked. |
14
+ | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id this encounter was checked in from, when checked in via Athena. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
15
+ | `athena_encounter_id` | `string|null` | No | | | | Yes | Athena Health encounter id this encounter is linked to, when checked in via Athena. |
14
16
  | `created_by` | `string` | No | | | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
15
17
  | `created_date` | `string|null` | No | | | | Yes | UTC datetime when the encounter was created |
16
18
  | `diagnoses` | array of [`fieldagent.EncounterDiagnosis`](./fieldagent.EncounterDiagnosis.md) | No | | | | No | Diagnoses recorded for this encounter, ranked by rank. |
@@ -20,6 +22,7 @@ Type: `object`
20
22
  | `hospitalization` | [`fieldagent.EncounterHospitalization`](./fieldagent.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
21
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
22
24
  | `locations` | array of [`fieldagent.EncounterLocation`](./fieldagent.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
23
26
  | `participants` | array of [`fieldagent.EncounterParticipant`](./fieldagent.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
24
27
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient id who is the subject of the encounter. |
25
28
  | `period_end` | `string|null` | No | | | | Yes | When the encounter ended, when recorded. |
@@ -385,6 +385,8 @@
385
385
  - [CareSession](CareSession.md)
386
386
  - [ChatMessageRecord](ChatMessageRecord.md)
387
387
  - [CheckEligibilityRequest](CheckEligibilityRequest.md)
388
+ - [CheckEncounterRequest](CheckEncounterRequest.md)
389
+ - [CheckInEncounterRequest](CheckInEncounterRequest.md)
388
390
  - [CMSCounty](CMSCounty.md)
389
391
  - [CmsGetCountyFipsRequest](CmsGetCountyFipsRequest.md)
390
392
  - [CmsSearchHealthPlansRequest](CmsSearchHealthPlansRequest.md)
@@ -563,6 +565,7 @@
563
565
  - [GetEncounterResponse](GetEncounterResponse.md)
564
566
  - [HealthRecordResponse](GetHealthRecordResponse.md)
565
567
  - [GetInsuranceResponse](GetInsuranceResponse.md)
568
+ - [GetLatestEncounterResponse](GetLatestEncounterResponse.md)
566
569
  - [GetMedicalConceptAncestorsResponse](GetMedicalConceptAncestorsResponse.md)
567
570
  - [GetMedicalConceptDescendantsResponse](GetMedicalConceptDescendantsResponse.md)
568
571
  - [GetMedicalConceptRelationshipsResponse](GetMedicalConceptRelationshipsResponse.md)
@@ -580,6 +583,7 @@
580
583
  - [GetPolicyDocumentResponse](GetPolicyDocumentResponse.md)
581
584
  - [Practitioner](GetPractitionerResponse.md)
582
585
  - [ScanUploadUrlRequest](GetScanUploadUrlRequest.md)
586
+ - [GetTestResultResponse](GetTestResultResponse.md)
583
587
  - [GetVitalsResponse](GetVitalsResponse.md)
584
588
  - [GlucoseReading](GlucoseReading.md)
585
589
  - [GoogleAICandidate](GoogleAICandidate.md)
@@ -1262,7 +1266,6 @@
1262
1266
  - [OpenAIModerateRequest](OpenAIModerateRequest.md)
1263
1267
  - [OpenAIUpdateAssistantRequest](OpenAIUpdateAssistantRequest.md)
1264
1268
  - [OpenAIUpdateAssistantResponse](OpenAIUpdateAssistantResponse.md)
1265
- - [OrganizationResource](OrganizationResource.md)
1266
1269
  - [OuraBuildAuthorizationUrlRequest](OuraBuildAuthorizationUrlRequest.md)
1267
1270
  - [OuraBuildAuthorizationUrlResponse](OuraBuildAuthorizationUrlResponse.md)
1268
1271
  - [OuraDailyActivity](OuraDailyActivity.md)
@@ -1303,7 +1306,6 @@
1303
1306
  - [OuraWorkout](OuraWorkout.md)
1304
1307
  - [PainScale](PainScale.md)
1305
1308
  - [PainScore](PainScore.md)
1306
- - [PanelResult](PanelResult.md)
1307
1309
  - [ParticipantType](ParticipantType.md)
1308
1310
  - [ConfirmResetPasswordRequest](patient.ConfirmResetPasswordRequest.md)
1309
1311
  - [ConfirmResetPasswordResponse](patient.ConfirmResetPasswordResponse.md)
@@ -1669,8 +1671,8 @@
1669
1671
  - [SendGridTemplate](SendGridTemplate.md)
1670
1672
  - [session.ConnectResponse](session.ConnectResponse.md)
1671
1673
  - [SetPreferredPharmacyRequest](SetPreferredPharmacyRequest.md)
1674
+ - [SetPreferredPharmacyResponse](SetPreferredPharmacyResponse.md)
1672
1675
  - [SexAtBirth](SexAtBirth.md)
1673
- - [SingleTestResultResponse](SingleTestResultResponse.md)
1674
1676
  - [Slot](Slot.md)
1675
1677
  - [SlotStatus](SlotStatus.md)
1676
1678
  - [SpecimenType](SpecimenType.md)
@@ -11,6 +11,8 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `appointment_id` | `string|null` | No | | | | Yes | FHIR Appointment id this encounter fulfills, when linked. |
14
+ | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id this encounter was checked in from, when checked in via Athena. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
15
+ | `athena_encounter_id` | `string|null` | No | | | | Yes | Athena Health encounter id this encounter is linked to, when checked in via Athena. |
14
16
  | `created_by` | `string` | No | | | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
15
17
  | `created_date` | `string|null` | No | | | | Yes | UTC datetime when the encounter was created |
16
18
  | `diagnoses` | array of [`patient.EncounterDiagnosis`](./patient.EncounterDiagnosis.md) | No | | | | No | Diagnoses recorded for this encounter, ranked by rank. |
@@ -20,6 +22,7 @@ Type: `object`
20
22
  | `hospitalization` | [`patient.EncounterHospitalization`](./patient.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
21
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
22
24
  | `locations` | array of [`patient.EncounterLocation`](./patient.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
23
26
  | `participants` | array of [`patient.EncounterParticipant`](./patient.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
24
27
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient id who is the subject of the encounter. |
25
28
  | `period_end` | `string|null` | No | | | | Yes | When the encounter ended, when recorded. |
@@ -11,6 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `access_token` | `string` | Yes | | | | No | Cognito access token (JWT) for subsequent Bearer-authenticated requests. |
14
+ | `athena_patient_id` | `string|null` | No | | | | Yes | Athena Health patient ID, when this tenant is Athena-integrated and the patient was linked at registration. |
14
15
  | `cognito_sub` | `string|null` | No | | | | Yes | Cognito user's stable `sub` claim. |
15
16
  | `expires_in` | `integer` | Yes | | | | No | Access token lifetime in seconds. |
16
17
  | `fhir_patient_id` | `string|null` | No | | | | Yes | FHIR Patient resource ID resolved for this user, when found. |
@@ -46,8 +46,9 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
46
46
 
47
47
  ```json
48
48
  {
49
- "patient_id": "pat-456",
50
- "slot_id": "550e8400-e29b-41d4-a716-446655440000"
49
+ "athena_appointment_id": "string",
50
+ "patient_id": "string",
51
+ "slot_id": "string"
51
52
  }
52
53
  ```
53
54
 
@@ -63,19 +64,20 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
63
64
 
64
65
  ```json
65
66
  {
66
- "appointment_id": "770e8400-e29b-41d4-a716-446655440002",
67
- "created_at": "2026-08-10T14:30:00Z",
68
- "end": "2026-08-15T09:30:00Z",
69
- "patient_id": "pat-456",
70
- "provider_id": "pract-123",
71
- "slot_id": "550e8400-e29b-41d4-a716-446655440000",
67
+ "appointment_id": "string",
68
+ "athena_appointment_id": "string",
69
+ "created_at": "string",
70
+ "end": "string",
71
+ "patient_id": "string",
72
+ "provider_id": "string",
73
+ "slot_id": "string",
72
74
  "slot_ids": [
73
- "550e8400-e29b-41d4-a716-446655440000"
75
+ "string"
74
76
  ],
75
- "specialty_code": "394617004",
76
- "start": "2026-08-15T09:00:00Z",
77
+ "specialty_code": "string",
78
+ "start": "string",
77
79
  "status": "scheduled",
78
- "updated_at": "2026-08-10T14:30:00Z"
80
+ "updated_at": "string"
79
81
  }
80
82
  ```
81
83
 
@@ -140,8 +142,9 @@ import type { BookAppointmentRequest } from "@healthcloudai/hc-sdk";
140
142
 
141
143
  ```ts
142
144
  const request = {
143
- "patient_id": "pat-456",
144
- "slot_id": "550e8400-e29b-41d4-a716-446655440000"
145
+ "athena_appointment_id": "string",
146
+ "patient_id": "string",
147
+ "slot_id": "string"
145
148
  };
146
149
 
147
150
  const result = await appointments.book(request);
@@ -153,7 +156,7 @@ const result = await appointments.book(request);
153
156
  curl -X POST \
154
157
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
155
158
  -H 'Content-Type: application/json' \
156
- -d '{"patient_id":"pat-456","slot_id":"550e8400-e29b-41d4-a716-446655440000"}' \
159
+ -d '{"athena_appointment_id":"string","patient_id":"string","slot_id":"string"}' \
157
160
  'https://dev-api-appointments.health.cloud/appointments/book'
158
161
  ```
159
162