@healthcloudai/hc-sdk 3.17.0 → 3.18.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 (108) hide show
  1. package/dist/index.cjs +3 -0
  2. package/dist/index.d.cts +21 -0
  3. package/dist/index.d.ts +21 -0
  4. package/dist/index.js +3 -0
  5. package/docs/docs-manifest.json +71 -11
  6. package/docs/models/AlcoholFrequency.md +15 -0
  7. package/docs/models/AlcoholUse.md +20 -0
  8. package/docs/models/BodyHeight.md +17 -0
  9. package/docs/models/BodyTemperature.md +18 -0
  10. package/docs/models/BodyWeight.md +18 -0
  11. package/docs/models/BookAppointmentRequest.md +2 -0
  12. package/docs/models/DietCategory.md +19 -0
  13. package/docs/models/EducationLevel.md +15 -0
  14. package/docs/models/ExerciseFrequency.md +15 -0
  15. package/docs/models/FunctionalLevel.md +15 -0
  16. package/docs/models/FunctionalStatus.md +40 -0
  17. package/docs/models/GetPractitionerResponse.md +8 -2
  18. package/docs/models/LicenseVerification.md +19 -0
  19. package/docs/models/ListAllergiesResponse.md +1 -1
  20. package/docs/models/ListConditionsResponse.md +1 -1
  21. package/docs/models/ListDirectivesResponse.md +1 -1
  22. package/docs/models/ListFamilyHistoryResponse.md +1 -1
  23. package/docs/models/ListImmunizationsResponse.md +1 -1
  24. package/docs/models/ListProceduresResponse.md +1 -1
  25. package/docs/models/ListQuestionnaireResponsesResponse.md +1 -1
  26. package/docs/models/LivingSituation.md +15 -0
  27. package/docs/models/NpiVerification.md +21 -0
  28. package/docs/models/OnboardingProgressRequest.md +18 -0
  29. package/docs/models/PortalRole.md +18 -0
  30. package/docs/models/Practitioner.md +9 -2
  31. package/docs/models/ProviderCredential.md +19 -0
  32. package/docs/models/ProviderEducationCredential.md +6 -2
  33. package/docs/models/ProviderEncounterListResponse.md +1 -1
  34. package/docs/models/ProviderEncounterRecord.md +49 -0
  35. package/docs/models/ProviderEncounterResponse.md +1 -1
  36. package/docs/models/ProviderLanguage.md +3 -2
  37. package/docs/models/ProviderOnboardingStatus.md +19 -0
  38. package/docs/models/ProviderPatientRecordResources.md +32 -0
  39. package/docs/models/ProviderPatientRecordResponse.md +1 -1
  40. package/docs/models/ProviderPostgraduateTraining.md +22 -0
  41. package/docs/models/ProviderProfessionalLiability.md +19 -0
  42. package/docs/models/ProviderSpecialty.md +1 -1
  43. package/docs/models/ProviderStateLicense.md +9 -2
  44. package/docs/models/SexualOrientation.md +15 -0
  45. package/docs/models/SmokingStatus.md +15 -0
  46. package/docs/models/SocialHistory.md +35 -0
  47. package/docs/models/SubstanceStatus.md +15 -0
  48. package/docs/models/SubstanceUse.md +23 -0
  49. package/docs/models/TobaccoUse.md +22 -0
  50. package/docs/models/UpdateEncounterClinicalNoteResponse.md +1 -1
  51. package/docs/models/UpdateEncounterStatusResponse.md +1 -1
  52. package/docs/models/UpdatePractitionerRequest.md +5 -0
  53. package/docs/models/UpdatePractitionerResponse.md +8 -2
  54. package/docs/models/VitalsRecord.md +41 -0
  55. package/docs/models/appointments.ErrorResponse.md +1 -0
  56. package/docs/models/diagnostics.Coding.md +19 -0
  57. package/docs/models/diagnostics.LabObservation.md +1 -1
  58. package/docs/models/{AdvanceDirective.md → ehr.AdvanceDirective.md} +1 -1
  59. package/docs/models/{Allergy.md → ehr.Allergy.md} +1 -1
  60. package/docs/models/ehr.Coding.md +19 -0
  61. package/docs/models/{FamilyHistoryEntry.md → ehr.FamilyHistoryEntry.md} +1 -1
  62. package/docs/models/{Immunization.md → ehr.Immunization.md} +1 -1
  63. package/docs/models/{Problem.md → ehr.Problem.md} +1 -1
  64. package/docs/models/{Procedure.md → ehr.Procedure.md} +1 -1
  65. package/docs/models/ehr.Quantity.md +20 -0
  66. package/docs/models/{QuestionnaireResponse.md → ehr.QuestionnaireResponse.md} +2 -2
  67. package/docs/models/{ResponseAnswer.md → ehr.ResponseAnswer.md} +4 -4
  68. package/docs/models/{ResponseItem.md → ehr.ResponseItem.md} +3 -3
  69. package/docs/models/index.md +69 -9
  70. package/docs/models/provider.AdvanceDirective.md +31 -0
  71. package/docs/models/provider.Allergy.md +31 -0
  72. package/docs/models/provider.AllergyReaction.md +21 -0
  73. package/docs/models/provider.BloodPressure.md +20 -0
  74. package/docs/models/provider.CodedConcept.md +19 -0
  75. package/docs/models/provider.Coding.md +19 -0
  76. package/docs/models/provider.Dosage.md +24 -0
  77. package/docs/models/provider.Encounter.md +48 -0
  78. package/docs/models/provider.EncounterDiagnosis.md +20 -0
  79. package/docs/models/provider.EncounterHospitalization.md +22 -0
  80. package/docs/models/provider.EncounterLocation.md +21 -0
  81. package/docs/models/provider.EncounterParticipant.md +21 -0
  82. package/docs/models/provider.FamilyCondition.md +22 -0
  83. package/docs/models/provider.FamilyHistoryEntry.md +30 -0
  84. package/docs/models/provider.GynHistory.md +25 -0
  85. package/docs/models/provider.HeartRate.md +18 -0
  86. package/docs/models/provider.Immunization.md +40 -0
  87. package/docs/models/provider.ImmunizationReaction.md +20 -0
  88. package/docs/models/provider.LabObservation.md +29 -0
  89. package/docs/models/provider.Medication.md +41 -0
  90. package/docs/models/provider.PerinatalHistory.md +25 -0
  91. package/docs/models/provider.Problem.md +37 -0
  92. package/docs/models/provider.Procedure.md +37 -0
  93. package/docs/models/provider.PulseOximetry.md +20 -0
  94. package/docs/models/provider.Quantity.md +20 -0
  95. package/docs/models/provider.QuestionnaireResponse.md +27 -0
  96. package/docs/models/provider.ReferenceRange.md +20 -0
  97. package/docs/models/provider.ResponseAnswer.md +27 -0
  98. package/docs/models/provider.ResponseItem.md +21 -0
  99. package/docs/operations/appointments.book.md +34 -1
  100. package/docs/operations/provider.getEncounter.md +84 -1
  101. package/docs/operations/provider.getPatientRecord.md +516 -1
  102. package/docs/operations/provider.getPractitioner.md +92 -53
  103. package/docs/operations/provider.listEncounters.md +84 -1
  104. package/docs/operations/provider.register.md +25 -3
  105. package/docs/operations/provider.updateEncounterClinicalNote.md +84 -1
  106. package/docs/operations/provider.updateEncounterStatus.md +84 -1
  107. package/docs/operations/provider.updatePractitioner.md +256 -150
  108. package/package.json +1 -1
@@ -0,0 +1,20 @@
1
+ # ReferenceRange
2
+
3
+ Model ID: `provider.ReferenceRange`
4
+
5
+ The normal/expected range for a lab observation's value.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `high` | `number|null` | No | | | | Yes | Upper bound of the normal range, optional. |
14
+ | `low` | `number|null` | No | | | | Yes | Lower bound of the normal range, optional. |
15
+ | `text` | `string|null` | No | | | | Yes | Free-text range description, e.g. 'Negative', optional. |
16
+ | `unit` | `string|null` | No | | | | Yes | Unit of measure for low/high, optional. |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -0,0 +1,27 @@
1
+ # ResponseAnswer
2
+
3
+ Model ID: `provider.ResponseAnswer`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `sub_items` | array of [`provider.ResponseItem`](./provider.ResponseItem.md) | No | | | | No | Nested sub-items under this answer, for grouped questions. |
14
+ | `value_boolean` | `boolean|null` | No | | | | Yes | Boolean answer value, when the question type is boolean. |
15
+ | `value_coding` | [`provider.Coding`](./provider.Coding.md) | No | | | | Yes | Coded answer value (system/code/display), when the question type is choice or open-choice. |
16
+ | `value_date` | `string|null` | No | | | | Yes | Date answer value (ISO date), when the question type is date. |
17
+ | `value_date_time` | `string|null` | No | | | | Yes | DateTime answer value (ISO dateTime), when the question type is dateTime. |
18
+ | `value_decimal` | `number|null` | No | | | | Yes | Decimal answer value, when the question type is decimal. |
19
+ | `value_integer` | `integer|null` | No | | | | Yes | Integer answer value, when the question type is integer. |
20
+ | `value_quantity` | [`provider.Quantity`](./provider.Quantity.md) | No | | | | Yes | Quantity answer value (value/unit/system), when the question type is quantity. |
21
+ | `value_string` | `string|null` | No | | | | Yes | String answer value, when the question type is string. |
22
+ | `value_time` | `string|null` | No | | | | Yes | Time answer value, when the question type is time. |
23
+ | `value_uri` | `string|null` | No | | | | Yes | URI answer value, when the question type is uri. |
24
+
25
+ ## Example
26
+
27
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # ResponseItem
2
+
3
+ Model ID: `provider.ResponseItem`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `answers` | array of [`provider.ResponseAnswer`](./provider.ResponseAnswer.md) | No | | | | No | Answers given for this item. |
14
+ | `definition` | `string|null` | No | | | | Yes | Canonical URI of the element this item collects, when defined. |
15
+ | `link_id` | `string` | Yes | | | | No | Stable linkId matching the corresponding Questionnaire.item.linkId. |
16
+ | `sub_items` | array of [`provider.ResponseItem`](./provider.ResponseItem.md) | No | | | | No | Nested sub-items, for grouped questions. |
17
+ | `text` | `string|null` | No | | | | Yes | Display text of the question, when present. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -47,6 +47,7 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
47
47
  ```json
48
48
  {
49
49
  "athena_appointment_id": "string",
50
+ "note": "string",
50
51
  "patient_id": "string",
51
52
  "slot_id": "string",
52
53
  "start": "string",
@@ -94,7 +95,10 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
94
95
  | `401` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
95
96
  | `404` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | The requested slot was not found |
96
97
  | `409` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Conflict — slot not available |
98
+ | `410` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | |
97
99
  | `500` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Internal server error |
100
+ | `502` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | |
101
+ | `503` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Athena rate limited the upstream request; Retry-After is forwarded when valid |
98
102
 
99
103
  ## Error examples
100
104
 
@@ -130,6 +134,16 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
130
134
  }
131
135
  ```
132
136
 
137
+ ### 410
138
+
139
+ ```json
140
+ {
141
+ "code": "string",
142
+ "error": "string",
143
+ "outcome": {}
144
+ }
145
+ ```
146
+
133
147
  ### 500 — Unexpected service failure (sanitized example)
134
148
 
135
149
  ```json
@@ -138,6 +152,24 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
138
152
  }
139
153
  ```
140
154
 
155
+ ### 502
156
+
157
+ ```json
158
+ {
159
+ "code": "string",
160
+ "error": "string",
161
+ "outcome": {}
162
+ }
163
+ ```
164
+
165
+ ### 503 — Athena temporarily rate limited this read
166
+
167
+ ```json
168
+ {
169
+ "error": "Appointments are temporarily unavailable because the upstream service is rate limited"
170
+ }
171
+ ```
172
+
141
173
  ## NodeJS / TypeScript implementation
142
174
 
143
175
  ```ts
@@ -148,6 +180,7 @@ import type { BookAppointmentRequest } from "@healthcloudai/hc-sdk";
148
180
  ```ts
149
181
  const request = {
150
182
  "athena_appointment_id": "string",
183
+ "note": "string",
151
184
  "patient_id": "string",
152
185
  "slot_id": "string",
153
186
  "start": "string",
@@ -163,7 +196,7 @@ const result = await appointments.book(request);
163
196
  curl -X POST \
164
197
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
165
198
  -H 'Content-Type: application/json' \
166
- -d '{"athena_appointment_id":"string","patient_id":"string","slot_id":"string","start":"string","steadymd_clinician_guid":"string"}' \
199
+ -d '{"athena_appointment_id":"string","note":"string","patient_id":"string","slot_id":"string","start":"string","steadymd_clinician_guid":"string"}' \
167
200
  'https://dev-api-appointments.health.cloud/appointments/book'
168
201
  ```
169
202
 
@@ -58,7 +58,90 @@ None declared in canonical OpenAPI.
58
58
 
59
59
  ```json
60
60
  {
61
- "encounter": {}
61
+ "encounter": {
62
+ "appointment_id": "string",
63
+ "athena_appointment_id": "string",
64
+ "athena_encounter_id": "string",
65
+ "created_by": "self",
66
+ "created_date": "2026-01-01T09:00:00Z",
67
+ "diagnoses": [
68
+ {
69
+ "condition_display": "string",
70
+ "condition_id": "string",
71
+ "rank": 1,
72
+ "use_code": "CC"
73
+ }
74
+ ],
75
+ "encounter_class": "AMB",
76
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
77
+ "fhir_id": "string",
78
+ "hospitalization": {
79
+ "admit_source_code": "string",
80
+ "destination_id": "string",
81
+ "discharge_disposition": "home",
82
+ "origin_id": "string",
83
+ "pre_admission_id": "string",
84
+ "re_admission_code": "string"
85
+ },
86
+ "length_minutes": 0,
87
+ "locations": [
88
+ {
89
+ "location_display": "string",
90
+ "location_id": "string",
91
+ "period_end": "2026-01-01T09:00:00Z",
92
+ "period_start": "2026-01-01T09:00:00Z",
93
+ "status": "active"
94
+ }
95
+ ],
96
+ "notes": "string",
97
+ "openloop_appointment_id": "string",
98
+ "openloop_encounter_id": "string",
99
+ "participants": [
100
+ {
101
+ "participant_type": "PPRF",
102
+ "period_end": "2026-01-01T09:00:00Z",
103
+ "period_start": "2026-01-01T09:00:00Z",
104
+ "practitioner_display": "string",
105
+ "practitioner_id": "string"
106
+ }
107
+ ],
108
+ "patient": {
109
+ "address": {
110
+ "city": "string",
111
+ "country": "string",
112
+ "state": "string",
113
+ "street1": "string",
114
+ "street2": "string",
115
+ "zip_code": "string"
116
+ },
117
+ "date_of_birth": "string",
118
+ "first_name": "string",
119
+ "gender": "string",
120
+ "last_name": "string",
121
+ "patient_id": "string",
122
+ "phone": {
123
+ "extension": "string",
124
+ "number": "string",
125
+ "type": "string"
126
+ }
127
+ },
128
+ "patient_id": "string",
129
+ "period_end": "2026-01-01T09:00:00Z",
130
+ "period_start": "2026-01-01T09:00:00Z",
131
+ "priority_code": "string",
132
+ "priority_display": "string",
133
+ "reason_code": "string",
134
+ "reason_display": "string",
135
+ "service_provider_display": "string",
136
+ "service_provider_id": "string",
137
+ "service_type_code": "string",
138
+ "service_type_display": "string",
139
+ "status": "planned",
140
+ "steadymd_consult_guid": "string",
141
+ "steadymd_episode_guid": "string",
142
+ "type_code": "string",
143
+ "type_display": "string"
144
+ }
62
145
  }
63
146
  ```
64
147