@healthcloudai/hc-sdk 2.6.2 → 2.8.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 (112) hide show
  1. package/dist/index.cjs +173 -0
  2. package/dist/index.d.cts +5950 -5764
  3. package/dist/index.d.ts +5950 -5764
  4. package/dist/index.js +173 -0
  5. package/docs/clients/EhrClient.md +15 -0
  6. package/docs/clients/PatientClient.md +3 -0
  7. package/docs/docs-manifest.json +62 -5
  8. package/docs/examples/index.md +18 -0
  9. package/docs/index.md +18 -0
  10. package/docs/models/AddInsuranceRequest.md +1 -0
  11. package/docs/models/AddInsuranceResponse.md +2 -0
  12. package/docs/models/Allergy.md +31 -0
  13. package/docs/models/AllergyCategory.md +15 -0
  14. package/docs/models/AllergyCriticality.md +15 -0
  15. package/docs/models/AllergyReaction.md +21 -0
  16. package/docs/models/AllergyStatus.md +15 -0
  17. package/docs/models/AllergyVerificationStatus.md +15 -0
  18. package/docs/models/Appointment.md +1 -0
  19. package/docs/models/AthenaAppointment.md +1 -0
  20. package/docs/models/BookAppointmentRequest.md +1 -0
  21. package/docs/models/CheckEncounterRequest.md +17 -0
  22. package/docs/models/CheckInEncounterRequest.md +17 -0
  23. package/docs/models/CodedConcept.md +19 -0
  24. package/docs/models/FamilyCondition.md +21 -0
  25. package/docs/models/FamilyHistoryEntry.md +30 -0
  26. package/docs/models/FamilyHistoryStatus.md +15 -0
  27. package/docs/models/FamilyRelationship.md +15 -0
  28. package/docs/models/GS1LookupResponse.md +3 -2
  29. package/docs/models/GetEncounterResponse.md +3 -0
  30. package/docs/models/GetHealthRecordResponse.md +19 -0
  31. package/docs/models/GetLatestEncounterResponse.md +17 -0
  32. package/docs/models/GetPatientResponse.md +2 -0
  33. package/docs/models/GetScanUploadUrlRequest.md +3 -2
  34. package/docs/models/GetTestResultResponse.md +20 -0
  35. package/docs/models/IntoleranceType.md +15 -0
  36. package/docs/models/ListAllergiesResponse.md +19 -0
  37. package/docs/models/ListConditionsResponse.md +19 -0
  38. package/docs/models/ListDirectivesResponse.md +19 -0
  39. package/docs/models/ListFamilyHistoryResponse.md +19 -0
  40. package/docs/models/ListFunctionalStatusResponse.md +19 -0
  41. package/docs/models/ListImmunizationsResponse.md +19 -0
  42. package/docs/models/ListObservationsResponse.md +19 -0
  43. package/docs/models/ListProceduresResponse.md +19 -0
  44. package/docs/models/ListQuestionnaireResponsesResponse.md +19 -0
  45. package/docs/models/ListSocialHistoryResponse.md +19 -0
  46. package/docs/models/ListVitalsResponse.md +19 -0
  47. package/docs/models/PatientDemographics.md +2 -0
  48. package/docs/models/Problem.md +37 -0
  49. package/docs/models/ProblemCategory.md +15 -0
  50. package/docs/models/ProblemClinicalStatus.md +15 -0
  51. package/docs/models/ProblemSeverity.md +15 -0
  52. package/docs/models/ProblemVerificationStatus.md +15 -0
  53. package/docs/models/QuestionnaireResponse.md +27 -0
  54. package/docs/models/QuestionnaireResponseStatus.md +15 -0
  55. package/docs/models/ReactionSeverity.md +15 -0
  56. package/docs/models/ResponseAnswer.md +27 -0
  57. package/docs/models/ResponseItem.md +21 -0
  58. package/docs/models/ScanUploadResponse.md +4 -4
  59. package/docs/models/Slot.md +1 -0
  60. package/docs/models/ehr.ListDiagnosticsResponse.md +19 -0
  61. package/docs/models/ehr.ListEncountersResponse.md +19 -0
  62. package/docs/models/ehr.ListMedicationsResponse.md +19 -0
  63. package/docs/models/fieldagent.Encounter.md +3 -0
  64. package/docs/models/index.md +41 -2
  65. package/docs/models/patient.Encounter.md +3 -0
  66. package/docs/operations/appointments.book.md +18 -15
  67. package/docs/operations/appointments.cancel.md +12 -11
  68. package/docs/operations/appointments.createSlot.md +44 -9
  69. package/docs/operations/appointments.listPatientAppointments.md +13 -12
  70. package/docs/operations/appointments.listSlots.md +9 -8
  71. package/docs/operations/appointments.reschedule.md +11 -10
  72. package/docs/operations/connectors.athenaBookAppointment.md +1 -0
  73. package/docs/operations/connectors.athenaCreateInsurancePackage.md +1 -1
  74. package/docs/operations/connectors.athenaGetAppointmentDetails.md +1 -0
  75. package/docs/operations/connectors.athenaGetBookedAppointments.md +1 -0
  76. package/docs/operations/connectors.athenaGetEncounter.md +1 -0
  77. package/docs/operations/connectors.athenaListAppointments.md +1 -0
  78. package/docs/operations/connectors.athenaListPatientAppointments.md +1 -0
  79. package/docs/operations/diagnostics.getScanUploadUrl.md +7 -5
  80. package/docs/operations/diagnostics.getTestResult.md +5 -23
  81. package/docs/operations/diagnostics.lookupTestByGs1.md +12 -6
  82. package/docs/operations/ehr.getHealthRecord.md +122 -0
  83. package/docs/operations/ehr.listAllergies.md +156 -0
  84. package/docs/operations/ehr.listConditions.md +152 -0
  85. package/docs/operations/ehr.listDiagnostics.md +147 -0
  86. package/docs/operations/ehr.listDirectives.md +122 -0
  87. package/docs/operations/ehr.listEncounters.md +178 -0
  88. package/docs/operations/ehr.listFamilyHistory.md +147 -0
  89. package/docs/operations/ehr.listFunctionalStatus.md +122 -0
  90. package/docs/operations/ehr.listImmunizations.md +122 -0
  91. package/docs/operations/ehr.listMedications.md +163 -0
  92. package/docs/operations/ehr.listObservations.md +126 -0
  93. package/docs/operations/ehr.listProcedures.md +122 -0
  94. package/docs/operations/ehr.listQuestionnaireResponses.md +162 -0
  95. package/docs/operations/ehr.listSocialHistory.md +122 -0
  96. package/docs/operations/ehr.listVitals.md +132 -0
  97. package/docs/operations/fieldagent.listEncounters.md +42 -39
  98. package/docs/operations/fieldagent.listPatients.md +60 -95
  99. package/docs/operations/patient.addInsurance.md +14 -10
  100. package/docs/operations/patient.checkEncounter.md +110 -0
  101. package/docs/operations/patient.checkInEncounter.md +173 -0
  102. package/docs/operations/patient.createEncounter.md +40 -37
  103. package/docs/operations/patient.getCheckinCheckin.md +41 -38
  104. package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +43 -40
  105. package/docs/operations/patient.getEncounter.md +40 -37
  106. package/docs/operations/patient.getLatestEncounter.md +162 -0
  107. package/docs/operations/patient.getPatient.md +57 -92
  108. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +97 -129
  109. package/docs/operations/patient.listEncounters.md +41 -38
  110. package/package.json +1 -1
  111. package/docs/models/PanelResult.md +0 -24
  112. package/docs/models/SingleTestResultResponse.md +0 -28
@@ -58,61 +58,64 @@ None declared in canonical OpenAPI.
58
58
 
59
59
  ```json
60
60
  {
61
- "appointment_id": "appointment-example-001",
61
+ "appointment_id": "string",
62
+ "athena_appointment_id": "string",
63
+ "athena_encounter_id": "string",
62
64
  "created_by": "self",
63
- "created_date": "2026-08-10T23:36:57Z",
65
+ "created_date": "2026-01-01T09:00:00Z",
64
66
  "diagnoses": [
65
67
  {
66
- "condition_display": "Acute upper respiratory infection",
67
- "condition_id": "condition-example-001",
68
+ "condition_display": "string",
69
+ "condition_id": "string",
68
70
  "rank": 1,
69
- "use_code": "AD"
71
+ "use_code": "CC"
70
72
  }
71
73
  ],
72
74
  "encounter_class": "AMB",
73
- "encounter_id": "167dd34e-1833-4260-a8b1-ea0b38229a1b",
74
- "fhir_id": "6e0d484f-4f8b-4025-b6ef-abedf69f0f91",
75
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
76
+ "fhir_id": "string",
75
77
  "hospitalization": {
76
- "admit_source_code": "physician-referral",
77
- "destination_id": "location-example-002",
78
+ "admit_source_code": "string",
79
+ "destination_id": "string",
78
80
  "discharge_disposition": "home",
79
- "origin_id": "location-example-001",
80
- "pre_admission_id": "encounter-example-prior",
81
- "re_admission_code": "N"
81
+ "origin_id": "string",
82
+ "pre_admission_id": "string",
83
+ "re_admission_code": "string"
82
84
  },
83
- "length_minutes": 30,
85
+ "length_minutes": 0,
84
86
  "locations": [
85
87
  {
86
- "location_display": "Example Clinic, Room 101",
87
- "location_id": "location-example-001",
88
- "period_end": "2026-08-10T10:30:00Z",
89
- "period_start": "2026-08-10T10:00:00Z",
90
- "status": "completed"
88
+ "location_display": "string",
89
+ "location_id": "string",
90
+ "period_end": "2026-01-01T09:00:00Z",
91
+ "period_start": "2026-01-01T09:00:00Z",
92
+ "status": "active"
91
93
  }
92
94
  ],
95
+ "notes": "string",
93
96
  "participants": [
94
97
  {
95
- "participant_type": "ATND",
96
- "period_end": "2026-08-10T10:30:00Z",
97
- "period_start": "2026-08-10T10:00:00Z",
98
- "practitioner_display": "Dr. Alex Smith",
99
- "practitioner_id": "provider-example-001"
98
+ "participant_type": "PPRF",
99
+ "period_end": "2026-01-01T09:00:00Z",
100
+ "period_start": "2026-01-01T09:00:00Z",
101
+ "practitioner_display": "string",
102
+ "practitioner_id": "string"
100
103
  }
101
104
  ],
102
- "patient_id": "patient-example-001",
103
- "period_end": "2026-08-10T10:30:00Z",
104
- "period_start": "2026-08-10T10:00:00Z",
105
- "priority_code": "R",
106
- "priority_display": "Routine",
107
- "reason_code": "386661006",
108
- "reason_display": "Fever",
109
- "service_provider_display": "Example Health Clinic",
110
- "service_provider_id": "organization-example-001",
111
- "service_type_code": "124",
112
- "service_type_display": "General practice",
113
- "status": "finished",
114
- "type_code": "99213",
115
- "type_display": "Office outpatient visit"
105
+ "patient_id": "string",
106
+ "period_end": "2026-01-01T09:00:00Z",
107
+ "period_start": "2026-01-01T09:00:00Z",
108
+ "priority_code": "string",
109
+ "priority_display": "string",
110
+ "reason_code": "string",
111
+ "reason_display": "string",
112
+ "service_provider_display": "string",
113
+ "service_provider_id": "string",
114
+ "service_type_code": "string",
115
+ "service_type_display": "string",
116
+ "status": "planned",
117
+ "type_code": "string",
118
+ "type_display": "string"
116
119
  }
117
120
  ```
118
121
 
@@ -0,0 +1,162 @@
1
+ # Get the patient's latest open encounter
2
+
3
+ Operation ID: `patient.getLatestEncounter`
4
+
5
+ Get the patient's latest open encounter
6
+
7
+ ## Public method
8
+
9
+ `getLatestEncounter`
10
+
11
+ Signature: `patient.getLatestEncounter(patientId)`
12
+
13
+ Return type: `Promise<GetLatestEncounterResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /patients/{patient_id}/encounters/latest`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `patient_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` | [`GetLatestEncounterResponse`](../models/GetLatestEncounterResponse.md) | application/json | The patient's latest open encounter, or null if none |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
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
+ "participants": [
98
+ {
99
+ "participant_type": "PPRF",
100
+ "period_end": "2026-01-01T09:00:00Z",
101
+ "period_start": "2026-01-01T09:00:00Z",
102
+ "practitioner_display": "string",
103
+ "practitioner_id": "string"
104
+ }
105
+ ],
106
+ "patient_id": "string",
107
+ "period_end": "2026-01-01T09:00:00Z",
108
+ "period_start": "2026-01-01T09:00:00Z",
109
+ "priority_code": "string",
110
+ "priority_display": "string",
111
+ "reason_code": "string",
112
+ "reason_display": "string",
113
+ "service_provider_display": "string",
114
+ "service_provider_id": "string",
115
+ "service_type_code": "string",
116
+ "service_type_display": "string",
117
+ "status": "planned",
118
+ "type_code": "string",
119
+ "type_display": "string"
120
+ }
121
+ }
122
+ ```
123
+
124
+ ## Common errors
125
+
126
+ None declared in canonical OpenAPI.
127
+
128
+ ## Error examples
129
+
130
+ None declared in canonical OpenAPI.
131
+
132
+ ## NodeJS / TypeScript implementation
133
+
134
+ ```ts
135
+ import { HCSDK } from "@healthcloudai/hc-sdk";
136
+ ```
137
+
138
+ ```ts
139
+ const patientId = "<PATIENT_ID>";
140
+
141
+ const result = await patient.getLatestEncounter(patientId);
142
+ ```
143
+
144
+ ## cURL
145
+
146
+ ```bash
147
+ curl -X GET \
148
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
149
+ 'https://dev-api-patient.health.cloud/patients/%3CPATIENT_ID%3E/encounters/latest'
150
+ ```
151
+
152
+ ## Notes
153
+
154
+ None.
155
+
156
+ ## Prepared Test Console scenario
157
+
158
+ No canonical scenario is currently associated.
159
+
160
+ ## Real response
161
+
162
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -57,127 +57,92 @@ None declared in canonical OpenAPI.
57
57
  ```json
58
58
  {
59
59
  "active": true,
60
- "addresses": [
61
- {
62
- "city": "Testville",
63
- "country": "US",
64
- "is_primary": true,
65
- "state": "CA",
66
- "street1": "123 Example Street",
67
- "street2": "Apartment 4B",
68
- "type": "home",
69
- "zip_code": "94102"
70
- }
71
- ],
60
+ "addresses": [],
61
+ "athena_patient_id": "string",
62
+ "athena_practice_id": "string",
72
63
  "attributes": {},
73
64
  "communications": [
74
65
  {
75
- "language": "en",
76
- "preferred": true
66
+ "language": "string",
67
+ "preferred": false
77
68
  }
78
69
  ],
79
70
  "created_by": "self",
80
- "created_date": "2026-08-10T23:34:21Z",
81
- "date_of_birth": "1990-05-15",
71
+ "created_date": "2026-01-01T09:00:00Z",
72
+ "date_of_birth": "2026-01-01",
82
73
  "deceased": false,
83
- "deceased_cause": null,
84
- "deceased_date": null,
85
- "email": "test.user@example.com",
86
- "emergency_contacts": [
87
- {
88
- "email": "emergency.contact@example.com",
89
- "first_name": "Jamie",
90
- "is_primary": true,
91
- "last_name": "Smith",
92
- "phones": [
93
- {
94
- "extension": "101",
95
- "is_primary": true,
96
- "number": "+15550100003",
97
- "sms_enabled": true,
98
- "type": "mobile"
99
- }
100
- ],
101
- "relationship": "Spouse",
102
- "relationship_v2_code": "SPS"
103
- }
104
- ],
105
- "ethnicity": "not_hispanic_or_latino",
106
- "fhir_id": "patient-example-001",
74
+ "deceased_cause": "string",
75
+ "deceased_date": "2026-01-01",
76
+ "email": "user@example.com",
77
+ "emergency_contacts": [],
78
+ "ethnicity": "hispanic_or_latino",
79
+ "fhir_id": "string",
107
80
  "flags": {},
108
- "gender": "unknown",
81
+ "gender": "male",
109
82
  "gender_identity": "man",
110
83
  "insurance": [
111
84
  {
112
- "copay": 25,
113
- "deductible": 1000,
85
+ "copay": 0,
86
+ "deductible": 0,
114
87
  "effective_date": "2026-01-01",
115
- "group_number": "GRP-example-001",
116
- "member_id": "MEM-example-001",
117
- "payer_id": "60054",
118
- "payer_name": "Example Health Plan",
119
- "plan_name": "Example Gold Plan",
120
- "plan_type": "PPO",
88
+ "group_number": "string",
89
+ "member_id": "string",
90
+ "payer_id": "string",
91
+ "payer_name": "string",
92
+ "plan_name": "string",
93
+ "plan_type": "string",
121
94
  "priority": "primary",
122
- "subscriber_date_of_birth": "1990-05-15",
123
- "subscriber_first_name": "Test",
124
- "subscriber_id": "SUB-example-001",
125
- "subscriber_last_name": "User",
95
+ "subscriber_date_of_birth": "2026-01-01",
96
+ "subscriber_first_name": "string",
97
+ "subscriber_id": "string",
98
+ "subscriber_last_name": "string",
126
99
  "subscriber_relationship": "self",
127
- "termination_date": "2026-12-31"
100
+ "termination_date": "2026-01-01"
128
101
  }
129
102
  ],
130
103
  "links": [
131
104
  {
132
- "other_patient_fhir_id": "patient-example-previous",
133
- "type": "replaces"
105
+ "other_patient_fhir_id": "string",
106
+ "type": "seealso"
134
107
  }
135
108
  ],
136
- "managing_organization_id": "organization-example-001",
137
- "marital_status": "married",
138
- "mrn": "MRN-EXAMPLE-001",
109
+ "managing_organization_id": "string",
110
+ "marital_status": "single",
111
+ "mrn": "string",
139
112
  "name": {
140
- "first_name": "Test",
141
- "last_name": "User",
142
- "middle_name": "Alex",
143
- "preferred_name": "Test",
144
- "prefix": "Mr.",
145
- "suffix": "Jr.",
113
+ "first_name": "string",
114
+ "last_name": "string",
115
+ "middle_name": "string",
116
+ "preferred_name": "string",
117
+ "prefix": "string",
118
+ "suffix": "string",
146
119
  "use": "official"
147
120
  },
148
- "nationality": "US",
149
- "patient_id": "11111111-2222-4333-8444-555555555555",
150
- "phones": [
151
- {
152
- "extension": "101",
153
- "is_primary": true,
154
- "number": "+15550100000",
155
- "sms_enabled": true,
156
- "type": "mobile"
157
- }
158
- ],
159
- "photo_binary_id": "photo-example-001",
121
+ "nationality": "st",
122
+ "patient_id": "00000000-0000-0000-0000-000000000000",
123
+ "phones": [],
124
+ "photo_binary_id": "string",
160
125
  "preferred_language": "en",
161
126
  "preferred_pharmacy": {
162
- "address_city": "Testville",
163
- "address_state": "CA",
164
- "address_street1": "456 Pharmacy Avenue",
165
- "address_street2": "Suite 100",
166
- "address_zip": "94102",
167
- "fax": "+15550100005",
127
+ "address_city": "string",
128
+ "address_state": "string",
129
+ "address_street1": "string",
130
+ "address_street2": "string",
131
+ "address_zip": "string",
132
+ "fax": "string",
168
133
  "is_mail_order": false,
169
- "name": "Example Community Pharmacy",
170
- "ncpdp_id": "1234567",
171
- "notes": "Open daily from 08:00 to 20:00.",
172
- "npi": "1234567890",
173
- "pharmacy_id": "pharmacy-example-001",
174
- "phone": "+15550100004"
134
+ "name": "string",
135
+ "ncpdp_id": "string",
136
+ "notes": "string",
137
+ "npi": "string",
138
+ "pharmacy_id": "string",
139
+ "phone": "string"
175
140
  },
176
141
  "race": [
177
- "white"
142
+ "american_indian_or_alaska_native"
178
143
  ],
179
- "sex_at_birth": "unknown",
180
- "telehealth_id": 1700000000
144
+ "sex_at_birth": "male",
145
+ "telehealth_id": 0
181
146
  }
182
147
  ```
183
148