@healthcloudai/hc-sdk 3.19.0 → 3.19.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -1936,7 +1936,7 @@ interface BookAppointmentRequest {
1936
1936
  */
1937
1937
  patient_id: string;
1938
1938
  /**
1939
- * FHIR Slot resource ID returned by `appointments.listSlots`.
1939
+ * Required slot reference. On a FHIR-only tenant use the chosen listSlots result's fhir_id, or the resource ID returned by createSlot.slot_id. On a vendor-integrated tenant echo the chosen slot_id and supply the required vendor fields below.
1940
1940
  * @type {string}
1941
1941
  * @memberof BookAppointmentRequest
1942
1942
  */
@@ -1998,7 +1998,7 @@ interface RescheduleAppointmentRequest {
1998
1998
  */
1999
1999
  reason?: string | null;
2000
2000
  /**
2001
- * FHIR Slot resource ID of the new free slot returned by `appointments.listSlots`. Always send the chosen slot's `slot_id`, matching `appointments.book`'s contract. It is only acted upon on a FHIR-only tenant; vendor-integrated tenants read the vendor fields below instead.
2001
+ * Required reference for the new free slot. On a FHIR-only tenant use the chosen listSlots result's fhir_id, or createSlot.slot_id. On a vendor-integrated tenant echo the chosen slot_id and supply the required vendor fields below, as for booking.
2002
2002
  * @type {string}
2003
2003
  * @memberof RescheduleAppointmentRequest
2004
2004
  */
@@ -52584,6 +52584,12 @@ interface Slot {
52584
52584
  * @memberof Slot
52585
52585
  */
52586
52586
  end: Date;
52587
+ /**
52588
+ * FHIR Slot resource ID returned by FHIR-only appointments.listSlots. Send this value as slot_id to appointments.book or appointments.reschedule. It is not populated on vendor calendars (null or omitted), and may be omitted by appointments.createSlot, which returns the resource ID in slot_id.
52589
+ * @type {string}
52590
+ * @memberof Slot
52591
+ */
52592
+ fhir_id?: string | null;
52587
52593
  /**
52588
52594
  * Human-readable appointment location, when available.
52589
52595
  * @type {string}
@@ -52609,7 +52615,7 @@ interface Slot {
52609
52615
  */
52610
52616
  provider_name?: string | null;
52611
52617
  /**
52612
- * FHIR Slot resource ID used for booking.
52618
+ * Slot identifier. appointments.createSlot returns the FHIR resource ID here. On a FHIR-only appointments.listSlots response this is an internal identifier; use fhir_id for booking or rescheduling instead. Vendor-integrated callers echo slot_id together with the required vendor fields.
52613
52619
  * @type {string}
52614
52620
  * @memberof Slot
52615
52621
  */
package/dist/index.d.ts CHANGED
@@ -1936,7 +1936,7 @@ interface BookAppointmentRequest {
1936
1936
  */
1937
1937
  patient_id: string;
1938
1938
  /**
1939
- * FHIR Slot resource ID returned by `appointments.listSlots`.
1939
+ * Required slot reference. On a FHIR-only tenant use the chosen listSlots result's fhir_id, or the resource ID returned by createSlot.slot_id. On a vendor-integrated tenant echo the chosen slot_id and supply the required vendor fields below.
1940
1940
  * @type {string}
1941
1941
  * @memberof BookAppointmentRequest
1942
1942
  */
@@ -1998,7 +1998,7 @@ interface RescheduleAppointmentRequest {
1998
1998
  */
1999
1999
  reason?: string | null;
2000
2000
  /**
2001
- * FHIR Slot resource ID of the new free slot returned by `appointments.listSlots`. Always send the chosen slot's `slot_id`, matching `appointments.book`'s contract. It is only acted upon on a FHIR-only tenant; vendor-integrated tenants read the vendor fields below instead.
2001
+ * Required reference for the new free slot. On a FHIR-only tenant use the chosen listSlots result's fhir_id, or createSlot.slot_id. On a vendor-integrated tenant echo the chosen slot_id and supply the required vendor fields below, as for booking.
2002
2002
  * @type {string}
2003
2003
  * @memberof RescheduleAppointmentRequest
2004
2004
  */
@@ -52584,6 +52584,12 @@ interface Slot {
52584
52584
  * @memberof Slot
52585
52585
  */
52586
52586
  end: Date;
52587
+ /**
52588
+ * FHIR Slot resource ID returned by FHIR-only appointments.listSlots. Send this value as slot_id to appointments.book or appointments.reschedule. It is not populated on vendor calendars (null or omitted), and may be omitted by appointments.createSlot, which returns the resource ID in slot_id.
52589
+ * @type {string}
52590
+ * @memberof Slot
52591
+ */
52592
+ fhir_id?: string | null;
52587
52593
  /**
52588
52594
  * Human-readable appointment location, when available.
52589
52595
  * @type {string}
@@ -52609,7 +52615,7 @@ interface Slot {
52609
52615
  */
52610
52616
  provider_name?: string | null;
52611
52617
  /**
52612
- * FHIR Slot resource ID used for booking.
52618
+ * Slot identifier. appointments.createSlot returns the FHIR resource ID here. On a FHIR-only appointments.listSlots response this is an internal identifier; use fhir_id for booking or rescheduling instead. Vendor-integrated callers echo slot_id together with the required vendor fields.
52613
52619
  * @type {string}
52614
52620
  * @memberof Slot
52615
52621
  */
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:38987b7e37278cf36ee18ff68c57c3010b9fa846db5c6cca4eabe774b79b8780",
2
+ "docsDataContentDigest": "sha256:fca49659fb1bef13a9514270a34c5078b44a30938c424413511a2a7d2294176e",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AmsClient.md",
@@ -14,7 +14,7 @@ Type: `object`
14
14
  | `idempotency_key` | `string|null` | No | | | | Yes | Caller-created UUID v4 for one confirmed booking attempt. Reuse it with identical data on retries. Terminal results are remembered for at least 24 hours; a changed intent needs a new key. Omitting this field preserves legacy behavior without a replay guarantee. |
15
15
  | `note` | `string|null` | No | | | | Yes | Optional booking note; part of the idempotent intent. |
16
16
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID for whom the appointment is booked. |
17
- | `slot_id` | `string` | Yes | | | | No | FHIR Slot resource ID returned by `appointments.listSlots`. |
17
+ | `slot_id` | `string` | Yes | | | | No | Required slot reference. On a FHIR-only tenant use the chosen listSlots result's fhir_id, or the resource ID returned by createSlot.slot_id. On a vendor-integrated tenant echo the chosen slot_id and supply the required vendor fields below. |
18
18
  | `start` | `string|null` | No | | | | Yes | ISO 8601 start of the chosen slot, taken from the `start` of the chosen `appointments.listSlots` result. Required on an OpenLoop- or SteadyMD-integrated tenant, neither of which books by a pre-existing slot id; ignored on an Athena-integrated or FHIR-only tenant, which book by `athena_appointment_id`/`slot_id` respectively. |
19
19
  | `steadymd_clinician_guid` | `string|null` | No | | | | Yes | SteadyMD clinician guid of the slot being booked, taken from the `steadymd_clinician_guid` of the chosen `appointments.listSlots` result. Required on a SteadyMD-integrated tenant, where SteadyMD's own availability has no per-slot id, only a clinician + timestamp. |
20
20
 
@@ -17,7 +17,7 @@ Type: `object`
17
17
  |---|---|---:|---|---|---|---:|---|
18
18
  | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id of the NEW open slot being moved to, taken from the `athena_appointment_id` of the chosen `appointments.listSlots` result. Required when rescheduling on an Athena-integrated tenant; ignored otherwise. |
19
19
  | `reason` | `string|null` | No | | | | Yes | Optional free-text reason for the reschedule, recorded in logs and vendor notes where supported. |
20
- | `slot_id` | `string` | Yes | | | | No | FHIR Slot resource ID of the new free slot returned by `appointments.listSlots`. Always send the chosen slot's `slot_id`, matching `appointments.book`'s contract. It is only acted upon on a FHIR-only tenant; vendor-integrated tenants read the vendor fields below instead. |
20
+ | `slot_id` | `string` | Yes | | | | No | Required reference for the new free slot. On a FHIR-only tenant use the chosen listSlots result's fhir_id, or createSlot.slot_id. On a vendor-integrated tenant echo the chosen slot_id and supply the required vendor fields below, as for booking. |
21
21
  | `start` | `string|null` | No | date-time | | | Yes | ISO 8601 start of the new slot, taken from the `start` of the chosen `appointments.listSlots` result. Required when rescheduling on an OpenLoop- or SteadyMD-integrated tenant; ignored otherwise. |
22
22
  | `steadymd_clinician_guid` | `string|null` | No | | | | Yes | SteadyMD clinician guid of the new slot, taken from the `steadymd_clinician_guid` of the chosen `appointments.listSlots` result. Required when rescheduling on a SteadyMD-integrated tenant; ignored otherwise. |
23
23
 
@@ -12,11 +12,12 @@ Type: `object`
12
12
  |---|---|---:|---|---|---|---:|---|
13
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`. |
14
14
  | `end` | `string` | Yes | date-time | | | No | Exclusive slot end in ISO 8601 date-time format. |
15
+ | `fhir_id` | `string|null` | No | | | | Yes | FHIR Slot resource ID returned by FHIR-only appointments.listSlots. Send this value as slot_id to appointments.book or appointments.reschedule. It is not populated on vendor calendars (null or omitted), and may be omitted by appointments.createSlot, which returns the resource ID in slot_id. |
15
16
  | `location` | `string|null` | No | | | | Yes | Human-readable appointment location, when available. |
16
17
  | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id backing this slot. Always present for slots sourced from OpenLoop, where it — not `slot_id` — is what `appointments.book` must be given as `openloop_appointment_id`. |
17
18
  | `provider_id` | `string` | Yes | | | | No | FHIR Practitioner resource ID assigned to the slot. |
18
19
  | `provider_name` | `string|null` | No | | | | Yes | Provider display name, when available. |
19
- | `slot_id` | `string` | Yes | | | | No | FHIR Slot resource ID used for booking. |
20
+ | `slot_id` | `string` | Yes | | | | No | Slot identifier. appointments.createSlot returns the FHIR resource ID here. On a FHIR-only appointments.listSlots response this is an internal identifier; use fhir_id for booking or rescheduling instead. Vendor-integrated callers echo slot_id together with the required vendor fields. |
20
21
  | `specialty_code` | `string|null` | No | | | | Yes | SNOMED CT specialty code, when supplied by the schedule. |
21
22
  | `start` | `string` | Yes | date-time | | | No | Inclusive slot start in ISO 8601 date-time format. |
22
23
  | `status` | [`SlotStatus`](./SlotStatus.md) | Yes | | | | No | Current availability state of the slot. |
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `appointments.book`
4
4
 
5
- Book a patient into a free slot returned by `appointments.listSlots`. The operation creates the appointment and changes the selected slot from free to booked.
5
+ Book a patient into a free slot returned by `appointments.listSlots`. On a FHIR-only tenant send the selected slot's `fhir_id` as request `slot_id`; a resource ID returned by `appointments.createSlot` in `slot_id` is also accepted. Vendor-integrated callers echo the listed `slot_id` and required vendor metadata. The operation creates the appointment and changes the selected slot from free to booked.
6
6
 
7
7
  ## Public method
8
8
 
@@ -73,6 +73,7 @@ Request model: [`CreateSlotRequest`](../models/CreateSlotRequest.md)
73
73
  {
74
74
  "athena_appointment_id": "string",
75
75
  "end": "2026-01-01T09:00:00Z",
76
+ "fhir_id": "string",
76
77
  "location": "string",
77
78
  "openloop_appointment_id": "string",
78
79
  "provider_id": "string",
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `appointments.listSlots`
4
4
 
5
- Return bookable slots, optionally restricted to a provider, specialty, or inclusive date range. Use a returned `slot_id` as input to `appointments.book` or `appointments.reschedule`. On Athena-integrated tenants, an upstream rate limit returns a sanitized 503; respect the optional Retry-After header (seconds). There is no fallback to a different calendar.
5
+ Return bookable slots, optionally restricted to a provider, specialty, or inclusive date range. On a FHIR-only tenant, pass the chosen result's `fhir_id` as `slot_id` to `appointments.book` or `appointments.reschedule`; the listed `slot_id` is internal. Vendor-integrated callers echo the listed `slot_id` plus the required vendor fields. On Athena-integrated tenants, an upstream rate limit returns a sanitized 503; respect the optional Retry-After header (seconds). There is no fallback to a different calendar.
6
6
 
7
7
  ## Public method
8
8
 
@@ -65,6 +65,7 @@ None declared in canonical OpenAPI.
65
65
  {
66
66
  "athena_appointment_id": "string",
67
67
  "end": "2026-01-01T09:00:00Z",
68
+ "fhir_id": "string",
68
69
  "location": "string",
69
70
  "openloop_appointment_id": "string",
70
71
  "provider_id": "string",
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `appointments.reschedule`
4
4
 
5
- Move the identified appointment to another slot returned by `appointments.listSlots`. On a FHIR-only tenant the previous slot is released after the target slot is reserved. On a vendor-integrated tenant (Athena, OpenLoop, SteadyMD) the move is executed in the vendor — and fails there — with no FHIR fallback: pass the chosen new slot's per-vendor fields exactly as `appointments.book` does (`athena_appointment_id` on Athena; `start` on OpenLoop; `start` + `steadymd_clinician_guid` on SteadyMD).
5
+ Move the identified appointment to another slot returned by `appointments.listSlots`. On a FHIR-only tenant send the selected result's `fhir_id` as request `slot_id`. The previous slot is released after the target slot is reserved. On a vendor-integrated tenant (Athena, OpenLoop, SteadyMD) the move is executed in the vendor — and fails there — with no FHIR fallback: pass the chosen new slot's per-vendor fields exactly as `appointments.book` does (`athena_appointment_id` on Athena; `start` on OpenLoop; `start` + `steadymd_clinician_guid` on SteadyMD).
6
6
 
7
7
  ## Public method
8
8
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "3.19.0",
3
+ "version": "3.19.1",
4
4
  "description": "All-in-one HealthCloud SDK with typed platform APIs and secure connector clients.",
5
5
  "author": "Healthcheck Systems Inc",
6
6
  "license": "MIT",