@healthcloudai/hc-sdk 3.27.0 → 3.29.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 (61) hide show
  1. package/dist/index.cjs +75 -3
  2. package/dist/index.d.cts +1234 -341
  3. package/dist/index.d.ts +1234 -341
  4. package/dist/index.js +75 -3
  5. package/docs/clients/PatientClient.md +5 -0
  6. package/docs/clients/ProviderClient.md +3 -0
  7. package/docs/docs-manifest.json +25 -3
  8. package/docs/examples/index.md +8 -0
  9. package/docs/index.md +8 -0
  10. package/docs/models/AvailabilityWindow.md +19 -0
  11. package/docs/models/BookPracticeAppointmentRequest.md +18 -0
  12. package/docs/models/CheckInEncounterResponse.md +1 -1
  13. package/docs/models/CreatePracticeInviteRequest.md +17 -0
  14. package/docs/models/GetEncounterResponse.md +1 -1
  15. package/docs/models/GetPatientResponse.md +1 -0
  16. package/docs/models/PatientDemographics.md +1 -0
  17. package/docs/models/PracticeAppointment.md +26 -0
  18. package/docs/models/PracticeAppointmentResponse.md +17 -0
  19. package/docs/models/PracticeAppointmentsResponse.md +19 -0
  20. package/docs/models/PracticeAvailability.md +22 -0
  21. package/docs/models/PracticeAvailabilityResponse.md +18 -0
  22. package/docs/models/PracticeInviteResponse.md +20 -0
  23. package/docs/models/PracticeSlot.md +19 -0
  24. package/docs/models/PracticeSlotsResponse.md +21 -0
  25. package/docs/models/ProviderEncounterRecord.md +3 -1
  26. package/docs/models/ProviderIntakeContent.md +25 -0
  27. package/docs/models/ProviderIntakeSubmission.md +29 -0
  28. package/docs/models/ProviderPatientProfile.md +1 -0
  29. package/docs/models/ProviderPatientRecordResources.md +1 -1
  30. package/docs/models/ProviderQueueEncounter.md +1 -0
  31. package/docs/models/ReschedulePracticeAppointmentRequest.md +17 -0
  32. package/docs/models/UpdateEncounterClinicalNoteRequest.md +2 -1
  33. package/docs/models/fieldagent.Encounter.md +1 -1
  34. package/docs/models/index.md +14 -0
  35. package/docs/models/patient.Encounter.md +1 -1
  36. package/docs/models/patient.RegisterRequest.md +1 -0
  37. package/docs/models/patient.RegisterResponse.md +1 -0
  38. package/docs/models/provider.Encounter.md +1 -1
  39. package/docs/operations/fieldagent.listPatients.md +1 -0
  40. package/docs/operations/patient.bookPracticeAppointment.md +180 -0
  41. package/docs/operations/patient.cancelPracticeAppointment.md +158 -0
  42. package/docs/operations/patient.getPatient.md +1 -0
  43. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
  44. package/docs/operations/patient.listPracticeAppointmentSlots.md +149 -0
  45. package/docs/operations/patient.listPracticeAppointments.md +156 -0
  46. package/docs/operations/patient.register.md +4 -1
  47. package/docs/operations/patient.reschedulePracticeAppointment.md +182 -0
  48. package/docs/operations/provider.claimEncounter.md +2 -0
  49. package/docs/operations/provider.createPracticeInvite.md +140 -0
  50. package/docs/operations/provider.getEncounter.md +2 -0
  51. package/docs/operations/provider.getEncounterQueue.md +1 -0
  52. package/docs/operations/provider.getPatientProfile.md +1 -0
  53. package/docs/operations/provider.getPatientRecord.md +54 -0
  54. package/docs/operations/provider.getPracticeAvailability.md +136 -0
  55. package/docs/operations/provider.listEncounters.md +2 -0
  56. package/docs/operations/provider.setPracticeAvailability.md +168 -0
  57. package/docs/operations/provider.signEncounter.md +2 -0
  58. package/docs/operations/provider.updateEncounterClinicalNote.md +2 -0
  59. package/docs/operations/provider.updateEncounterDiagnoses.md +2 -0
  60. package/docs/operations/provider.updateEncounterStatus.md +2 -0
  61. package/package.json +1 -1
@@ -0,0 +1,21 @@
1
+ # PracticeSlotsResponse
2
+
3
+ Model ID: `PracticeSlotsResponse`
4
+
5
+ GET /practice-appointment-slots.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `practice_display` | `string|null` | No | | | | Yes | |
14
+ | `practice_id` | `string|null` | No | | | | Yes | The patient's practice, or null when the patient has none. |
15
+ | `slot_minutes` | `integer|null` | No | | | | Yes | |
16
+ | `slots` | array of [`PracticeSlot`](./PracticeSlot.md) | No | | | | No | |
17
+ | `timezone` | `string|null` | No | | | | Yes | |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -22,7 +22,7 @@ Type: `object`
22
22
  | `hospitalization` | [`provider.EncounterHospitalization`](./provider.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
23
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
24
24
  | `locations` | array of [`provider.EncounterLocation`](./provider.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. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
26
26
  | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
27
27
  | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
28
28
  | `participants` | array of [`provider.EncounterParticipant`](./provider.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
@@ -32,8 +32,10 @@ Type: `object`
32
32
  | `period_start` | `string|null` | No | | | | Yes | When the encounter started, when recorded. |
33
33
  | `priority_code` | `string|null` | No | | | | Yes | Code for the encounter priority (e.g. routine, urgent, emergent), when coded. |
34
34
  | `priority_display` | `string|null` | No | | | | Yes | Display text for the encounter priority, when available. |
35
+ | `provider_notes` | `string|null` | No | | | | Yes | The provider's own clinical note, written with PATCH /encounters/{id}/clinical-note. Kept apart from the patient-reported text and not shown by the patient, EHR or field-agent APIs. Notes a provider wrote before this field existed are in `notes`, not here. |
35
36
  | `reason_code` | `string|null` | No | | | | Yes | SNOMED CT code for the reason for the encounter, when coded. |
36
37
  | `reason_display` | `string|null` | No | | | | Yes | Display text for the reason for the encounter, when available. |
38
+ | `reported_symptoms` | `string|null` | No | | | | Yes | What the patient reported for this visit: the symptom report and intake summaries collected in the patient app. Same text as `notes`, named for what it is. Null when the patient reported nothing. Never changed by a provider's clinical note. |
37
39
  | `service_provider_display` | `string|null` | No | | | | Yes | Display name of the service provider organization, when available. |
38
40
  | `service_provider_id` | `string|null` | No | | | | Yes | FHIR Organization id of the service provider, when linked. |
39
41
  | `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
@@ -0,0 +1,25 @@
1
+ # ProviderIntakeContent
2
+
3
+ Model ID: `ProviderIntakeContent`
4
+
5
+ The records an intake submission created, grouped like the health record's own sections.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `allergies` | array of [`provider.Allergy`](./provider.Allergy.md) | No | | | | No | |
14
+ | `conditions` | array of [`provider.Problem`](./provider.Problem.md) | No | | | | No | |
15
+ | `family_history` | array of [`provider.FamilyHistoryEntry`](./provider.FamilyHistoryEntry.md) | No | | | | No | |
16
+ | `gyn_history` | array of [`provider.GynHistory`](./provider.GynHistory.md) | No | | | | No | |
17
+ | `immunizations` | array of [`provider.Immunization`](./provider.Immunization.md) | No | | | | No | |
18
+ | `medications` | array of [`provider.Medication`](./provider.Medication.md) | No | | | | No | |
19
+ | `perinatal_history` | array of [`provider.PerinatalHistory`](./provider.PerinatalHistory.md) | No | | | | No | |
20
+ | `procedures` | array of [`provider.Procedure`](./provider.Procedure.md) | No | | | | No | |
21
+ | `social_history` | array of [`SocialHistory`](./SocialHistory.md) | No | | | | No | |
22
+
23
+ ## Example
24
+
25
+ None declared in canonical OpenAPI.
@@ -0,0 +1,29 @@
1
+ # ProviderIntakeSubmission
2
+
3
+ Model ID: `ProviderIntakeSubmission`
4
+
5
+ An intake the patient submitted, with what they submitted.
6
+
7
+ The delivery metadata is the patient intake response. `content` holds the submitted answers as the health record's own
8
+ sections (allergies, conditions, medications, immunizations, family_history, social_history, procedures, ...), because
9
+ intake answers are stored as FHIR records and the submissions table keeps metadata only.
10
+
11
+ Type: `object`
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
16
+ |---|---|---:|---|---|---|---:|---|
17
+ | `content` | [`ProviderIntakeContent`](./ProviderIntakeContent.md) | No | | | | No | The records this submission created, grouped by health-record section, in the record's domain shape. |
18
+ | `content_complete` | `boolean` | No | | | `true` | No | False when some records this submission created could not be found in the record (for example a partial save), so `content` is not everything submitted. |
19
+ | `created_at` | `string` | Yes | date-time | | | No | |
20
+ | `invalid_entries` | `object|null` | No | | | | Yes | |
21
+ | `sections` | `array` | No | | | | No | The intake sections this submission carried, for example allergies or problems. |
22
+ | `storage_status` | `string` | Yes | | pending, saved, partial, failed | | No | |
23
+ | `submission_id` | `string` | Yes | uuid | | | No | |
24
+ | `unknown_fields` | `array|null` | No | | | | Yes | |
25
+ | `vendors` | `object` | Yes | | | | No | |
26
+
27
+ ## Example
28
+
29
+ None declared in canonical OpenAPI.
@@ -32,6 +32,7 @@ Type: `object`
32
32
  | `openloop_patient_id` | `string|null` | No | | | | Yes | OpenLoop patient id, when linked. |
33
33
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource id. |
34
34
  | `phones` | array of [`Phone`](./Phone.md) | No | | | | No | |
35
+ | `practice_id` | `string|null` | No | | | | Yes | The patient's practice (a Practitioner id), or null when the patient has none. |
35
36
  | `preferred_language` | `string|null` | No | | | | Yes | |
36
37
  | `race` | array of [`Race`](./Race.md) | No | | | | No | |
37
38
  | `sex_at_birth` | [`SexAtBirth`](./SexAtBirth.md) | No | | | | Yes | |
@@ -19,7 +19,7 @@ Type: `object`
19
19
  | `functional_status` | array of [`FunctionalStatus`](./FunctionalStatus.md) | No | | | | No | |
20
20
  | `gyn_history` | array of [`provider.GynHistory`](./provider.GynHistory.md) | No | | | | No | |
21
21
  | `immunizations` | array of [`provider.Immunization`](./provider.Immunization.md) | No | | | | No | |
22
- | `intake_submissions` | array of [`PatientIntakeResponse`](./PatientIntakeResponse.md) | No | | | | No | |
22
+ | `intake_submissions` | array of [`ProviderIntakeSubmission`](./ProviderIntakeSubmission.md) | No | | | | No | |
23
23
  | `medications` | array of [`provider.Medication`](./provider.Medication.md) | No | | | | No | |
24
24
  | `perinatal_history` | array of [`provider.PerinatalHistory`](./provider.PerinatalHistory.md) | No | | | | No | |
25
25
  | `procedures` | array of [`provider.Procedure`](./provider.Procedure.md) | No | | | | No | |
@@ -19,6 +19,7 @@ Type: `object`
19
19
  | `priority_display` | `string|null` | No | | | | Yes | Priority text, when available. |
20
20
  | `reason_code` | `string|null` | No | | | | Yes | Reason-for-visit code, when coded. |
21
21
  | `reason_display` | `string|null` | No | | | | Yes | Reason-for-visit text, when available. |
22
+ | `reported_symptoms` | `string|null` | No | | | | Yes | What the patient reported for this visit, cut to at most 300 characters and ending in an ellipsis when longer. Null when the patient reported nothing. The full text comes with the encounter once taken. |
22
23
  | `status` | `string` | Yes | | | | No | Encounter status, for example planned, arrived or triaged. |
23
24
  | `type_code` | `string|null` | No | | | | Yes | SNOMED CT encounter type code, when coded. |
24
25
  | `type_display` | `string|null` | No | | | | Yes | Encounter type text, when available. |
@@ -0,0 +1,17 @@
1
+ # ReschedulePracticeAppointmentRequest
2
+
3
+ Model ID: `ReschedulePracticeAppointmentRequest`
4
+
5
+ POST /practice-appointments/{appointment_id}/reschedule.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `slot_id` | `string` | Yes | | | | No | The slot to move the appointment to, from GET /practice-appointment-slots. |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.
@@ -4,7 +4,8 @@ Model ID: `UpdateEncounterClinicalNoteRequest`
4
4
 
5
5
  FHIR notes and/or clinical assessment for one encounter.
6
6
 
7
- The FHIR Encounter stores the submitted content in its notes extension.
7
+ The FHIR Encounter stores the submitted content in its own provider-notes extension (`provider_notes`); the
8
+ patient-reported `notes` are never changed.
8
9
  When the encounter is linked to the configured EHR, ``notes`` is written
9
10
  to the EHR SOAP subjective field and ``assessment`` to its SOAP assessment
10
11
  field. At least one field must be supplied; the handler enforces that
@@ -22,7 +22,7 @@ Type: `object`
22
22
  | `hospitalization` | [`fieldagent.EncounterHospitalization`](./fieldagent.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
23
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
24
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. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
26
26
  | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
27
27
  | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
28
28
  | `participants` | array of [`fieldagent.EncounterParticipant`](./fieldagent.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
@@ -351,6 +351,7 @@
351
351
  - [AthenaUploadPrescriptionCardImageResponse](AthenaUploadPrescriptionCardImageResponse.md)
352
352
  - [AthenaVitalFailedReading](AthenaVitalFailedReading.md)
353
353
  - [AthenaVitalsMirrorResult](AthenaVitalsMirrorResult.md)
354
+ - [PracticeAvailabilityWindow](AvailabilityWindow.md)
354
355
  - [BloodPressureVital](BloodPressureVital.md)
355
356
  - [BodyHeight](BodyHeight.md)
356
357
  - [BodyHeightVital](BodyHeightVital.md)
@@ -359,6 +360,7 @@
359
360
  - [BodyWeight](BodyWeight.md)
360
361
  - [BodyWeightVital](BodyWeightVital.md)
361
362
  - [BookAppointmentRequest](BookAppointmentRequest.md)
363
+ - [BookPracticeAppointmentRequest](BookPracticeAppointmentRequest.md)
362
364
  - [CalAssignScheduleToEventTypeRequest](CalAssignScheduleToEventTypeRequest.md)
363
365
  - [CalAssignScheduleToEventTypeResponse](CalAssignScheduleToEventTypeResponse.md)
364
366
  - [CalAvailableSlotsResponse](CalAvailableSlotsResponse.md)
@@ -465,6 +467,7 @@
465
467
  - [CreateMedicationRequest](CreateMedicationRequest.md)
466
468
  - [CreateMedicationResponse](CreateMedicationResponse.md)
467
469
  - [CreateTelehealthTokenRequest](CreatePatientTokenRequest.md)
470
+ - [CreatePracticeInviteRequest](CreatePracticeInviteRequest.md)
468
471
  - [CreateProviderPatientRequest](CreateProviderPatientRequest.md)
469
472
  - [CreateTelehealthTokenRequest](CreateProviderTokenRequest.md)
470
473
  - [CreateQuestionnaireRequest](CreateQuestionnaireRequest.md)
@@ -1497,6 +1500,14 @@
1497
1500
  - [PolicyDocument](PolicyDocument.md)
1498
1501
  - [PortalRole](PortalRole.md)
1499
1502
  - [PositionCode](PositionCode.md)
1503
+ - [PracticeAppointment](PracticeAppointment.md)
1504
+ - [PracticeAppointmentResponse](PracticeAppointmentResponse.md)
1505
+ - [PracticeAppointmentsResponse](PracticeAppointmentsResponse.md)
1506
+ - [PracticeAvailability](PracticeAvailability.md)
1507
+ - [PracticeAvailabilityResponse](PracticeAvailabilityResponse.md)
1508
+ - [PracticeInviteResponse](PracticeInviteResponse.md)
1509
+ - [PracticeSlot](PracticeSlot.md)
1510
+ - [PracticeSlotsResponse](PracticeSlotsResponse.md)
1500
1511
  - [Practitioner](Practitioner.md)
1501
1512
  - [PreferredPharmacy](PreferredPharmacy.md)
1502
1513
  - [PresenceRecord](PresenceRecord.md)
@@ -1577,6 +1588,8 @@
1577
1588
  - [ProviderHomeSummaryResponse](ProviderHomeSummaryResponse.md)
1578
1589
  - [ProviderIdentifier](ProviderIdentifier.md)
1579
1590
  - [ProviderIdentifierType](ProviderIdentifierType.md)
1591
+ - [ProviderIntakeContent](ProviderIntakeContent.md)
1592
+ - [ProviderIntakeSubmission](ProviderIntakeSubmission.md)
1580
1593
  - [ProviderLanguage](ProviderLanguage.md)
1581
1594
  - [ProviderLocation](ProviderLocation.md)
1582
1595
  - [ProviderLocationAddressRequest](ProviderLocationAddressRequest.md)
@@ -1661,6 +1674,7 @@
1661
1674
  - [ReplaceInsuranceRequest](ReplaceInsuranceRequest.md)
1662
1675
  - [ReplaceInsuranceResponse](ReplaceInsuranceResponse.md)
1663
1676
  - [RescheduleAppointmentRequest](RescheduleAppointmentRequest.md)
1677
+ - [ReschedulePracticeAppointmentRequest](ReschedulePracticeAppointmentRequest.md)
1664
1678
  - [RespiratoryRate](RespiratoryRate.md)
1665
1679
  - [RetireInsuranceRequest](RetireInsuranceRequest.md)
1666
1680
  - [RetireInsuranceResponse](RetireInsuranceResponse.md)
@@ -22,7 +22,7 @@ Type: `object`
22
22
  | `hospitalization` | [`patient.EncounterHospitalization`](./patient.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
23
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
24
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. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
26
26
  | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
27
27
  | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
28
28
  | `participants` | array of [`patient.EncounterParticipant`](./patient.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
@@ -28,6 +28,7 @@ Type: `object`
28
28
  | `ethnicity` | [`Ethnicity`](./Ethnicity.md) | No | | | `null` | Yes | Hispanic or Latino ethnicity status, optional. Mirrored to Athena `ethnicitycode`. |
29
29
  | `first_name` | `string` | Yes | | | | No | Patient's given (first) name. |
30
30
  | `flags` | `object|null` | No | | | `null` | Yes | Boolean feature/state flags keyed by flag name. Recognized key: AUTO_VERIFY_EMAIL — if true, skips email OTP verification and auto-logs the patient in. |
31
+ | `invite_code` | `string|null` | No | | | `null` | Yes | A practice's invite code. A valid, unused, unexpired code makes the new patient that practice's patient (see `practice_id` on the patient). An invalid, expired or used code rejects the registration with 400 and a `code` of invalid_invite, invite_expired or invite_used; the patient is never registered without the practice they were invited to. |
31
32
  | `last_name` | `string` | Yes | | | | No | Patient's family (last) name. |
32
33
  | `marital_status` | [`MaritalStatus`](./MaritalStatus.md) | No | | | `null` | Yes | Marital status, optional. Mirrored to Athena `maritalstatus`. |
33
34
  | `password` | `string` | Yes | | | | No | Initial password, minimum 8 characters. |
@@ -20,6 +20,7 @@ Type: `object`
20
20
  | `fhir_patient_id` | `string` | Yes | | | | No | Newly created FHIR Patient resource ID. |
21
21
  | `id_token` | `string|null` | No | | | | Yes | Cognito ID token, present only when the tenant's flow auto-signs the user in after registration. |
22
22
  | `openloop_drivers_license_status` | `string|null` | No | | | | Yes | Outcome of mirroring the driver's license image to the patient's Healthie (OpenLoop) account, present only when a driver's license image was submitted with registration. |
23
+ | `practice_id` | `string|null` | No | | | | Yes | The practice the new patient now belongs to, present only when the registration used a valid `invite_code`. |
23
24
  | `steadymd_drivers_license_status` | `string|null` | No | | | | Yes | Outcome of mirroring the driver's license image to the patient's SteadyMD intake, present only when a driver's license image was submitted with registration. |
24
25
  | `telehealth_id` | `integer|null` | Yes | | | | Yes | Telehealth platform numeric user ID assigned at registration. |
25
26
 
@@ -22,7 +22,7 @@ Type: `object`
22
22
  | `hospitalization` | [`provider.EncounterHospitalization`](./provider.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
23
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
24
24
  | `locations` | array of [`provider.EncounterLocation`](./provider.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. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
26
26
  | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
27
27
  | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
28
28
  | `participants` | array of [`provider.EncounterParticipant`](./provider.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
@@ -142,6 +142,7 @@ None declared in canonical OpenAPI.
142
142
  "patient_id": "00000000-0000-0000-0000-000000000000",
143
143
  "phones": [],
144
144
  "photo_binary_id": "string",
145
+ "practice_id": "string",
145
146
  "preferred_language": "en",
146
147
  "preferred_pharmacy": {
147
148
  "address_city": "string",
@@ -0,0 +1,180 @@
1
+ # Book a telehealth appointment with the patient's practice
2
+
3
+ Operation ID: `patient.bookPracticeAppointment`
4
+
5
+ Books the slot (`slot_id` from GET /practice-appointment-slots). Two patients cannot take one slot: the loser gets 409 `slot_taken`. 409 `no_practice` when the patient has no practice, 409 `slot_unavailable` when the time is no longer a bookable slot, 502 `mirror_failed` when an Athena-integrated tenant's Athena booking failed (nothing is booked). The patient and the practice are notified. The response carries the video link.
6
+
7
+ ## Public method
8
+
9
+ `bookPracticeAppointment`
10
+
11
+ Signature: `patient.bookPracticeAppointment(request)`
12
+
13
+ Return type: `Promise<PracticeAppointmentResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `POST /practice-appointments`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ None.
36
+
37
+ ## Body parameters
38
+
39
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
40
+ |---|---|---:|---|---|---|---:|---|
41
+ | `body` | [`BookPracticeAppointmentRequest`](../models/BookPracticeAppointmentRequest.md) | Yes | | | | No | |
42
+
43
+ Request model: [`BookPracticeAppointmentRequest`](../models/BookPracticeAppointmentRequest.md)
44
+
45
+ ## Request example
46
+
47
+ ```json
48
+ {
49
+ "reason": "string",
50
+ "slot_id": "string"
51
+ }
52
+ ```
53
+
54
+ ## Success responses
55
+
56
+ | Status | Shape | Content type | Description |
57
+ |---|---|---|---|
58
+ | `201` | [`PracticeAppointmentResponse`](../models/PracticeAppointmentResponse.md) | application/json | The booked appointment |
59
+
60
+ ## Success response examples
61
+
62
+ ### 201
63
+
64
+ ```json
65
+ {
66
+ "appointment": {
67
+ "appointment_id": "string",
68
+ "end": "2026-01-01T09:00:00Z",
69
+ "practice_display": "string",
70
+ "practice_id": "string",
71
+ "previous_appointment_id": "string",
72
+ "reason": "string",
73
+ "slot_id": "string",
74
+ "start": "2026-01-01T09:00:00Z",
75
+ "status": "string",
76
+ "telehealth_link": "string"
77
+ }
78
+ }
79
+ ```
80
+
81
+ ## Common errors
82
+
83
+ | Status | Shape | Content type | Description |
84
+ |---|---|---|---|
85
+ | `400` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
86
+ | `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
87
+ | `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
88
+ | `409` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
89
+ | `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
90
+
91
+ ## Error examples
92
+
93
+ ### 400
94
+
95
+ ```json
96
+ {
97
+ "details": [
98
+ {}
99
+ ],
100
+ "error": "string"
101
+ }
102
+ ```
103
+
104
+ ### 401 — Missing or invalid access token
105
+
106
+ ```json
107
+ {
108
+ "error": "Authorization required"
109
+ }
110
+ ```
111
+
112
+ ### 404
113
+
114
+ ```json
115
+ {
116
+ "details": [
117
+ {}
118
+ ],
119
+ "error": "string"
120
+ }
121
+ ```
122
+
123
+ ### 409
124
+
125
+ ```json
126
+ {
127
+ "details": [
128
+ {}
129
+ ],
130
+ "error": "string"
131
+ }
132
+ ```
133
+
134
+ ### 502
135
+
136
+ ```json
137
+ {
138
+ "details": [
139
+ {}
140
+ ],
141
+ "error": "string"
142
+ }
143
+ ```
144
+
145
+ ## NodeJS / TypeScript implementation
146
+
147
+ ```ts
148
+ import { HCSDK } from "@healthcloudai/hc-sdk";
149
+ ```
150
+
151
+ ```ts
152
+ const request = {
153
+ "reason": "string",
154
+ "slot_id": "string"
155
+ };
156
+
157
+ const result = await patient.bookPracticeAppointment(request);
158
+ ```
159
+
160
+ ## cURL
161
+
162
+ ```bash
163
+ curl -X POST \
164
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
165
+ -H 'Content-Type: application/json' \
166
+ -d '{"reason":"string","slot_id":"string"}' \
167
+ 'https://dev-api-patient.health.cloud/practice-appointments'
168
+ ```
169
+
170
+ ## Notes
171
+
172
+ None.
173
+
174
+ ## Prepared Test Console scenario
175
+
176
+ No canonical scenario is currently associated.
177
+
178
+ ## Real response
179
+
180
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,158 @@
1
+ # Cancel a telehealth appointment with the patient's practice
2
+
3
+ Operation ID: `patient.cancelPracticeAppointment`
4
+
5
+ Cancels one of the caller's own practice appointments at any time before it starts (there is no cancellation window). Repeating a cancellation changes nothing. 404 for anyone else's appointment, 409 `already_started` once it has begun. The slot is free again. The patient and the practice are notified.
6
+
7
+ ## Public method
8
+
9
+ `cancelPracticeAppointment`
10
+
11
+ Signature: `patient.cancelPracticeAppointment(appointmentId)`
12
+
13
+ Return type: `Promise<PracticeAppointmentResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `POST /practice-appointments/{appointment_id}/cancel`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `appointment_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ None.
38
+
39
+ ## Body parameters
40
+
41
+ None.
42
+
43
+ Request model: None.
44
+
45
+ ## Request example
46
+
47
+ None declared in canonical OpenAPI.
48
+
49
+ ## Success responses
50
+
51
+ | Status | Shape | Content type | Description |
52
+ |---|---|---|---|
53
+ | `200` | [`PracticeAppointmentResponse`](../models/PracticeAppointmentResponse.md) | application/json | The cancelled appointment |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "appointment": {
62
+ "appointment_id": "string",
63
+ "end": "2026-01-01T09:00:00Z",
64
+ "practice_display": "string",
65
+ "practice_id": "string",
66
+ "previous_appointment_id": "string",
67
+ "reason": "string",
68
+ "slot_id": "string",
69
+ "start": "2026-01-01T09:00:00Z",
70
+ "status": "string",
71
+ "telehealth_link": "string"
72
+ }
73
+ }
74
+ ```
75
+
76
+ ## Common errors
77
+
78
+ | Status | Shape | Content type | Description |
79
+ |---|---|---|---|
80
+ | `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
81
+ | `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
82
+ | `409` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
83
+ | `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
84
+
85
+ ## Error examples
86
+
87
+ ### 401 — Missing or invalid access token
88
+
89
+ ```json
90
+ {
91
+ "error": "Authorization required"
92
+ }
93
+ ```
94
+
95
+ ### 404
96
+
97
+ ```json
98
+ {
99
+ "details": [
100
+ {}
101
+ ],
102
+ "error": "string"
103
+ }
104
+ ```
105
+
106
+ ### 409
107
+
108
+ ```json
109
+ {
110
+ "details": [
111
+ {}
112
+ ],
113
+ "error": "string"
114
+ }
115
+ ```
116
+
117
+ ### 502
118
+
119
+ ```json
120
+ {
121
+ "details": [
122
+ {}
123
+ ],
124
+ "error": "string"
125
+ }
126
+ ```
127
+
128
+ ## NodeJS / TypeScript implementation
129
+
130
+ ```ts
131
+ import { HCSDK } from "@healthcloudai/hc-sdk";
132
+ ```
133
+
134
+ ```ts
135
+ const appointmentId = "<APPOINTMENT_ID>";
136
+
137
+ const result = await patient.cancelPracticeAppointment(appointmentId);
138
+ ```
139
+
140
+ ## cURL
141
+
142
+ ```bash
143
+ curl -X POST \
144
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
145
+ 'https://dev-api-patient.health.cloud/practice-appointments/%3CAPPOINTMENT_ID%3E/cancel'
146
+ ```
147
+
148
+ ## Notes
149
+
150
+ None.
151
+
152
+ ## Prepared Test Console scenario
153
+
154
+ No canonical scenario is currently associated.
155
+
156
+ ## Real response
157
+
158
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -132,6 +132,7 @@ None declared in canonical OpenAPI.
132
132
  "patient_id": "00000000-0000-0000-0000-000000000000",
133
133
  "phones": [],
134
134
  "photo_binary_id": "string",
135
+ "practice_id": "string",
135
136
  "preferred_language": "en",
136
137
  "preferred_pharmacy": {
137
138
  "address_city": "string",
@@ -136,6 +136,7 @@ None declared in canonical OpenAPI.
136
136
  "patient_id": "00000000-0000-0000-0000-000000000000",
137
137
  "phones": [],
138
138
  "photo_binary_id": "string",
139
+ "practice_id": "string",
139
140
  "preferred_language": "en",
140
141
  "preferred_pharmacy": {
141
142
  "address_city": "string",