@healthcloudai/hc-sdk 2.7.0 → 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.
- package/dist/index.cjs +70 -0
- package/dist/index.d.cts +160 -2
- package/dist/index.d.ts +160 -2
- package/dist/index.js +70 -0
- package/docs/clients/PatientClient.md +3 -0
- package/docs/docs-manifest.json +10 -5
- package/docs/examples/index.md +3 -0
- package/docs/index.md +3 -0
- package/docs/models/AddInsuranceRequest.md +1 -0
- package/docs/models/AddInsuranceResponse.md +2 -0
- package/docs/models/Appointment.md +1 -0
- package/docs/models/AthenaAppointment.md +1 -0
- package/docs/models/BookAppointmentRequest.md +1 -0
- package/docs/models/CheckEncounterRequest.md +17 -0
- package/docs/models/CheckInEncounterRequest.md +17 -0
- package/docs/models/GS1LookupResponse.md +3 -2
- package/docs/models/GetEncounterResponse.md +3 -0
- package/docs/models/GetLatestEncounterResponse.md +17 -0
- package/docs/models/GetPatientResponse.md +2 -0
- package/docs/models/GetScanUploadUrlRequest.md +3 -2
- package/docs/models/GetTestResultResponse.md +20 -0
- package/docs/models/PatientDemographics.md +2 -0
- package/docs/models/ScanUploadResponse.md +4 -4
- package/docs/models/Slot.md +1 -0
- package/docs/models/fieldagent.Encounter.md +3 -0
- package/docs/models/index.md +4 -2
- package/docs/models/patient.Encounter.md +3 -0
- package/docs/operations/appointments.book.md +18 -15
- package/docs/operations/appointments.cancel.md +12 -11
- package/docs/operations/appointments.createSlot.md +44 -9
- package/docs/operations/appointments.listPatientAppointments.md +13 -12
- package/docs/operations/appointments.listSlots.md +9 -8
- package/docs/operations/appointments.reschedule.md +11 -10
- package/docs/operations/connectors.athenaBookAppointment.md +1 -0
- package/docs/operations/connectors.athenaCreateInsurancePackage.md +1 -1
- package/docs/operations/connectors.athenaGetAppointmentDetails.md +1 -0
- package/docs/operations/connectors.athenaGetBookedAppointments.md +1 -0
- package/docs/operations/connectors.athenaGetEncounter.md +1 -0
- package/docs/operations/connectors.athenaListAppointments.md +1 -0
- package/docs/operations/connectors.athenaListPatientAppointments.md +1 -0
- package/docs/operations/diagnostics.getScanUploadUrl.md +7 -5
- package/docs/operations/diagnostics.getTestResult.md +5 -23
- package/docs/operations/diagnostics.lookupTestByGs1.md +12 -6
- package/docs/operations/fieldagent.listEncounters.md +42 -39
- package/docs/operations/fieldagent.listPatients.md +60 -95
- package/docs/operations/patient.addInsurance.md +14 -10
- package/docs/operations/patient.checkEncounter.md +110 -0
- package/docs/operations/patient.checkInEncounter.md +173 -0
- package/docs/operations/patient.createEncounter.md +40 -37
- package/docs/operations/patient.getCheckinCheckin.md +41 -38
- package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +43 -40
- package/docs/operations/patient.getEncounter.md +40 -37
- package/docs/operations/patient.getLatestEncounter.md +162 -0
- package/docs/operations/patient.getPatient.md +57 -92
- package/docs/operations/patient.getPatientSidebarPatientSidebar.md +97 -129
- package/docs/operations/patient.listEncounters.md +41 -38
- package/package.json +1 -1
- package/docs/models/PanelResult.md +0 -24
- package/docs/models/SingleTestResultResponse.md +0 -28
|
@@ -62,134 +62,99 @@ None declared in canonical OpenAPI.
|
|
|
62
62
|
|
|
63
63
|
```json
|
|
64
64
|
{
|
|
65
|
-
"created_by": "
|
|
66
|
-
"next_page_token": "
|
|
65
|
+
"created_by": "string",
|
|
66
|
+
"next_page_token": "string",
|
|
67
67
|
"patients": [
|
|
68
68
|
{
|
|
69
69
|
"active": true,
|
|
70
|
-
"addresses": [
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
"country": "US",
|
|
74
|
-
"is_primary": true,
|
|
75
|
-
"state": "IL",
|
|
76
|
-
"street1": "100 Health Avenue",
|
|
77
|
-
"street2": "Apartment 4B",
|
|
78
|
-
"type": "home",
|
|
79
|
-
"zip_code": "62701"
|
|
80
|
-
}
|
|
81
|
-
],
|
|
70
|
+
"addresses": [],
|
|
71
|
+
"athena_patient_id": "string",
|
|
72
|
+
"athena_practice_id": "string",
|
|
82
73
|
"attributes": {},
|
|
83
74
|
"communications": [
|
|
84
75
|
{
|
|
85
|
-
"language": "
|
|
86
|
-
"preferred":
|
|
76
|
+
"language": "string",
|
|
77
|
+
"preferred": false
|
|
87
78
|
}
|
|
88
79
|
],
|
|
89
|
-
"created_by": "
|
|
90
|
-
"created_date": "2026-
|
|
91
|
-
"date_of_birth": "
|
|
80
|
+
"created_by": "self",
|
|
81
|
+
"created_date": "2026-01-01T09:00:00Z",
|
|
82
|
+
"date_of_birth": "2026-01-01",
|
|
92
83
|
"deceased": false,
|
|
93
|
-
"deceased_cause":
|
|
94
|
-
"deceased_date":
|
|
95
|
-
"email": "
|
|
96
|
-
"emergency_contacts": [
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
"first_name": "Jamie",
|
|
100
|
-
"is_primary": true,
|
|
101
|
-
"last_name": "Smith",
|
|
102
|
-
"phones": [
|
|
103
|
-
{
|
|
104
|
-
"extension": "101",
|
|
105
|
-
"is_primary": true,
|
|
106
|
-
"number": "+15550100003",
|
|
107
|
-
"sms_enabled": true,
|
|
108
|
-
"type": "mobile"
|
|
109
|
-
}
|
|
110
|
-
],
|
|
111
|
-
"relationship": "Spouse",
|
|
112
|
-
"relationship_v2_code": "SPS"
|
|
113
|
-
}
|
|
114
|
-
],
|
|
115
|
-
"ethnicity": "not_hispanic_or_latino",
|
|
116
|
-
"fhir_id": "patient-example-001",
|
|
84
|
+
"deceased_cause": "string",
|
|
85
|
+
"deceased_date": "2026-01-01",
|
|
86
|
+
"email": "user@example.com",
|
|
87
|
+
"emergency_contacts": [],
|
|
88
|
+
"ethnicity": "hispanic_or_latino",
|
|
89
|
+
"fhir_id": "string",
|
|
117
90
|
"flags": {},
|
|
118
|
-
"gender": "
|
|
119
|
-
"gender_identity": "
|
|
91
|
+
"gender": "male",
|
|
92
|
+
"gender_identity": "man",
|
|
120
93
|
"insurance": [
|
|
121
94
|
{
|
|
122
|
-
"copay":
|
|
123
|
-
"deductible":
|
|
95
|
+
"copay": 0,
|
|
96
|
+
"deductible": 0,
|
|
124
97
|
"effective_date": "2026-01-01",
|
|
125
|
-
"group_number": "
|
|
126
|
-
"member_id": "
|
|
127
|
-
"payer_id": "
|
|
128
|
-
"payer_name": "
|
|
129
|
-
"plan_name": "
|
|
130
|
-
"plan_type": "
|
|
98
|
+
"group_number": "string",
|
|
99
|
+
"member_id": "string",
|
|
100
|
+
"payer_id": "string",
|
|
101
|
+
"payer_name": "string",
|
|
102
|
+
"plan_name": "string",
|
|
103
|
+
"plan_type": "string",
|
|
131
104
|
"priority": "primary",
|
|
132
|
-
"subscriber_date_of_birth": "
|
|
133
|
-
"subscriber_first_name": "
|
|
134
|
-
"subscriber_id": "
|
|
135
|
-
"subscriber_last_name": "
|
|
105
|
+
"subscriber_date_of_birth": "2026-01-01",
|
|
106
|
+
"subscriber_first_name": "string",
|
|
107
|
+
"subscriber_id": "string",
|
|
108
|
+
"subscriber_last_name": "string",
|
|
136
109
|
"subscriber_relationship": "self",
|
|
137
|
-
"termination_date": "2026-
|
|
110
|
+
"termination_date": "2026-01-01"
|
|
138
111
|
}
|
|
139
112
|
],
|
|
140
113
|
"links": [
|
|
141
114
|
{
|
|
142
|
-
"other_patient_fhir_id": "
|
|
115
|
+
"other_patient_fhir_id": "string",
|
|
143
116
|
"type": "seealso"
|
|
144
117
|
}
|
|
145
118
|
],
|
|
146
|
-
"managing_organization_id": "
|
|
147
|
-
"marital_status": "
|
|
148
|
-
"mrn": "
|
|
119
|
+
"managing_organization_id": "string",
|
|
120
|
+
"marital_status": "single",
|
|
121
|
+
"mrn": "string",
|
|
149
122
|
"name": {
|
|
150
|
-
"first_name": "
|
|
151
|
-
"last_name": "
|
|
152
|
-
"middle_name": "
|
|
153
|
-
"preferred_name": "
|
|
154
|
-
"prefix": "
|
|
155
|
-
"suffix": "
|
|
123
|
+
"first_name": "string",
|
|
124
|
+
"last_name": "string",
|
|
125
|
+
"middle_name": "string",
|
|
126
|
+
"preferred_name": "string",
|
|
127
|
+
"prefix": "string",
|
|
128
|
+
"suffix": "string",
|
|
156
129
|
"use": "official"
|
|
157
130
|
},
|
|
158
|
-
"nationality": "
|
|
159
|
-
"patient_id": "00000000-0000-
|
|
160
|
-
"phones": [
|
|
161
|
-
|
|
162
|
-
"extension": "",
|
|
163
|
-
"is_primary": true,
|
|
164
|
-
"number": "+15550100000",
|
|
165
|
-
"sms_enabled": true,
|
|
166
|
-
"type": "mobile"
|
|
167
|
-
}
|
|
168
|
-
],
|
|
169
|
-
"photo_binary_id": "photo-example-002",
|
|
131
|
+
"nationality": "st",
|
|
132
|
+
"patient_id": "00000000-0000-0000-0000-000000000000",
|
|
133
|
+
"phones": [],
|
|
134
|
+
"photo_binary_id": "string",
|
|
170
135
|
"preferred_language": "en",
|
|
171
136
|
"preferred_pharmacy": {
|
|
172
|
-
"address_city": "
|
|
173
|
-
"address_state": "
|
|
174
|
-
"address_street1": "
|
|
175
|
-
"address_street2": "
|
|
176
|
-
"address_zip": "
|
|
177
|
-
"fax": "
|
|
137
|
+
"address_city": "string",
|
|
138
|
+
"address_state": "string",
|
|
139
|
+
"address_street1": "string",
|
|
140
|
+
"address_street2": "string",
|
|
141
|
+
"address_zip": "string",
|
|
142
|
+
"fax": "string",
|
|
178
143
|
"is_mail_order": false,
|
|
179
|
-
"name": "
|
|
180
|
-
"ncpdp_id": "
|
|
181
|
-
"notes": "
|
|
182
|
-
"npi": "
|
|
183
|
-
"pharmacy_id": "
|
|
184
|
-
"phone": "
|
|
144
|
+
"name": "string",
|
|
145
|
+
"ncpdp_id": "string",
|
|
146
|
+
"notes": "string",
|
|
147
|
+
"npi": "string",
|
|
148
|
+
"pharmacy_id": "string",
|
|
149
|
+
"phone": "string"
|
|
185
150
|
},
|
|
186
151
|
"race": [
|
|
187
|
-
"
|
|
152
|
+
"american_indian_or_alaska_native"
|
|
188
153
|
],
|
|
189
|
-
"sex_at_birth": "
|
|
154
|
+
"sex_at_birth": "male"
|
|
190
155
|
}
|
|
191
156
|
],
|
|
192
|
-
"total":
|
|
157
|
+
"total": 0
|
|
193
158
|
}
|
|
194
159
|
```
|
|
195
160
|
|
|
@@ -46,9 +46,10 @@ Request model: [`AddInsuranceRequest`](../models/AddInsuranceRequest.md)
|
|
|
46
46
|
|
|
47
47
|
```json
|
|
48
48
|
{
|
|
49
|
-
"
|
|
50
|
-
"
|
|
51
|
-
"
|
|
49
|
+
"insurance_package_id": "string",
|
|
50
|
+
"member_id": "string",
|
|
51
|
+
"payer_id": "string",
|
|
52
|
+
"payer_name": "string",
|
|
52
53
|
"priority": "primary",
|
|
53
54
|
"relationship": "self"
|
|
54
55
|
}
|
|
@@ -66,9 +67,11 @@ Request model: [`AddInsuranceRequest`](../models/AddInsuranceRequest.md)
|
|
|
66
67
|
|
|
67
68
|
```json
|
|
68
69
|
{
|
|
69
|
-
"
|
|
70
|
-
"
|
|
71
|
-
"
|
|
70
|
+
"athena_insurance_error": "string",
|
|
71
|
+
"athena_insurance_status": "string",
|
|
72
|
+
"coverages_created": 0,
|
|
73
|
+
"fhir_patient_id": "string",
|
|
74
|
+
"patient_id": "string"
|
|
72
75
|
}
|
|
73
76
|
```
|
|
74
77
|
|
|
@@ -115,9 +118,10 @@ import type { CreateInsuranceRequest } from "@healthcloudai/hc-sdk";
|
|
|
115
118
|
|
|
116
119
|
```ts
|
|
117
120
|
const request = {
|
|
118
|
-
"
|
|
119
|
-
"
|
|
120
|
-
"
|
|
121
|
+
"insurance_package_id": "string",
|
|
122
|
+
"member_id": "string",
|
|
123
|
+
"payer_id": "string",
|
|
124
|
+
"payer_name": "string",
|
|
121
125
|
"priority": "primary",
|
|
122
126
|
"relationship": "self"
|
|
123
127
|
};
|
|
@@ -131,7 +135,7 @@ const result = await patient.createInsurance(request);
|
|
|
131
135
|
curl -X POST \
|
|
132
136
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
133
137
|
-H 'Content-Type: application/json' \
|
|
134
|
-
-d '{"member_id":"
|
|
138
|
+
-d '{"insurance_package_id":"string","member_id":"string","payer_id":"string","payer_name":"string","priority":"primary","relationship":"self"}' \
|
|
135
139
|
'https://dev-api-patient.health.cloud/patients/insurance'
|
|
136
140
|
```
|
|
137
141
|
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# 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
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.checkEncounter`
|
|
4
|
+
|
|
5
|
+
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
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`checkEncounter`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.checkEncounter(request)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<CheckEncounterResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`POST /encounters/check`
|
|
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` | [`CheckEncounterRequest`](../models/CheckEncounterRequest.md) | Yes | | | | No | |
|
|
42
|
+
|
|
43
|
+
Request model: [`CheckEncounterRequest`](../models/CheckEncounterRequest.md)
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"patient_id": "string"
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Success responses
|
|
54
|
+
|
|
55
|
+
| Status | Shape | Content type | Description |
|
|
56
|
+
|---|---|---|---|
|
|
57
|
+
| `200` | `object` | application/json | Current or newly created encounter, with Athena walk-in status |
|
|
58
|
+
|
|
59
|
+
## Success response examples
|
|
60
|
+
|
|
61
|
+
### 200
|
|
62
|
+
|
|
63
|
+
```json
|
|
64
|
+
{}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Common errors
|
|
68
|
+
|
|
69
|
+
None declared in canonical OpenAPI.
|
|
70
|
+
|
|
71
|
+
## Error examples
|
|
72
|
+
|
|
73
|
+
None declared in canonical OpenAPI.
|
|
74
|
+
|
|
75
|
+
## NodeJS / TypeScript implementation
|
|
76
|
+
|
|
77
|
+
```ts
|
|
78
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
79
|
+
import type { CheckEncounterRequest } from "@healthcloudai/hc-sdk";
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
```ts
|
|
83
|
+
const request = {
|
|
84
|
+
"patient_id": "string"
|
|
85
|
+
};
|
|
86
|
+
|
|
87
|
+
const result = await patient.checkEncounter(request);
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## cURL
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
curl -X POST \
|
|
94
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
95
|
+
-H 'Content-Type: application/json' \
|
|
96
|
+
-d '{"patient_id":"string"}' \
|
|
97
|
+
'https://dev-api-patient.health.cloud/encounters/check'
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Notes
|
|
101
|
+
|
|
102
|
+
None.
|
|
103
|
+
|
|
104
|
+
## Prepared Test Console scenario
|
|
105
|
+
|
|
106
|
+
No canonical scenario is currently associated.
|
|
107
|
+
|
|
108
|
+
## Real response
|
|
109
|
+
|
|
110
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
# Check in an encounter via the tenant's connected EHR
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.checkInEncounter`
|
|
4
|
+
|
|
5
|
+
Check in an encounter via the tenant's connected EHR
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`checkInEncounter`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.checkInEncounter(encounterId, request)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<EncounterResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`POST /encounters/{encounter_id}/check-in`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `encounter_id` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
None.
|
|
38
|
+
|
|
39
|
+
## Body parameters
|
|
40
|
+
|
|
41
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
42
|
+
|---|---|---:|---|---|---|---:|---|
|
|
43
|
+
| `body` | [`CheckInEncounterRequest`](../models/CheckInEncounterRequest.md) | Yes | | | | No | |
|
|
44
|
+
|
|
45
|
+
Request model: [`CheckInEncounterRequest`](../models/CheckInEncounterRequest.md)
|
|
46
|
+
|
|
47
|
+
## Request example
|
|
48
|
+
|
|
49
|
+
```json
|
|
50
|
+
{
|
|
51
|
+
"appointment_id": "string"
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Success responses
|
|
56
|
+
|
|
57
|
+
| Status | Shape | Content type | Description |
|
|
58
|
+
|---|---|---|---|
|
|
59
|
+
| `200` | [`patient.Encounter`](../models/patient.Encounter.md) | application/json | Encounter checked in and linked to the EHR encounter |
|
|
60
|
+
|
|
61
|
+
## Success response examples
|
|
62
|
+
|
|
63
|
+
### 200
|
|
64
|
+
|
|
65
|
+
```json
|
|
66
|
+
{
|
|
67
|
+
"appointment_id": "string",
|
|
68
|
+
"athena_appointment_id": "string",
|
|
69
|
+
"athena_encounter_id": "string",
|
|
70
|
+
"created_by": "self",
|
|
71
|
+
"created_date": "2026-01-01T09:00:00Z",
|
|
72
|
+
"diagnoses": [
|
|
73
|
+
{
|
|
74
|
+
"condition_display": "string",
|
|
75
|
+
"condition_id": "string",
|
|
76
|
+
"rank": 1,
|
|
77
|
+
"use_code": "CC"
|
|
78
|
+
}
|
|
79
|
+
],
|
|
80
|
+
"encounter_class": "AMB",
|
|
81
|
+
"encounter_id": "00000000-0000-0000-0000-000000000000",
|
|
82
|
+
"fhir_id": "string",
|
|
83
|
+
"hospitalization": {
|
|
84
|
+
"admit_source_code": "string",
|
|
85
|
+
"destination_id": "string",
|
|
86
|
+
"discharge_disposition": "home",
|
|
87
|
+
"origin_id": "string",
|
|
88
|
+
"pre_admission_id": "string",
|
|
89
|
+
"re_admission_code": "string"
|
|
90
|
+
},
|
|
91
|
+
"length_minutes": 0,
|
|
92
|
+
"locations": [
|
|
93
|
+
{
|
|
94
|
+
"location_display": "string",
|
|
95
|
+
"location_id": "string",
|
|
96
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
97
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
98
|
+
"status": "active"
|
|
99
|
+
}
|
|
100
|
+
],
|
|
101
|
+
"notes": "string",
|
|
102
|
+
"participants": [
|
|
103
|
+
{
|
|
104
|
+
"participant_type": "PPRF",
|
|
105
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
106
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
107
|
+
"practitioner_display": "string",
|
|
108
|
+
"practitioner_id": "string"
|
|
109
|
+
}
|
|
110
|
+
],
|
|
111
|
+
"patient_id": "string",
|
|
112
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
113
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
114
|
+
"priority_code": "string",
|
|
115
|
+
"priority_display": "string",
|
|
116
|
+
"reason_code": "string",
|
|
117
|
+
"reason_display": "string",
|
|
118
|
+
"service_provider_display": "string",
|
|
119
|
+
"service_provider_id": "string",
|
|
120
|
+
"service_type_code": "string",
|
|
121
|
+
"service_type_display": "string",
|
|
122
|
+
"status": "planned",
|
|
123
|
+
"type_code": "string",
|
|
124
|
+
"type_display": "string"
|
|
125
|
+
}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## Common errors
|
|
129
|
+
|
|
130
|
+
None declared in canonical OpenAPI.
|
|
131
|
+
|
|
132
|
+
## Error examples
|
|
133
|
+
|
|
134
|
+
None declared in canonical OpenAPI.
|
|
135
|
+
|
|
136
|
+
## NodeJS / TypeScript implementation
|
|
137
|
+
|
|
138
|
+
```ts
|
|
139
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
140
|
+
import type { CheckInEncounterRequest } from "@healthcloudai/hc-sdk";
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
```ts
|
|
144
|
+
const encounterId = "<ENCOUNTER_ID>";
|
|
145
|
+
|
|
146
|
+
const request = {
|
|
147
|
+
"appointment_id": "string"
|
|
148
|
+
};
|
|
149
|
+
|
|
150
|
+
const result = await patient.checkInEncounter(encounterId, request);
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
## cURL
|
|
154
|
+
|
|
155
|
+
```bash
|
|
156
|
+
curl -X POST \
|
|
157
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
158
|
+
-H 'Content-Type: application/json' \
|
|
159
|
+
-d '{"appointment_id":"string"}' \
|
|
160
|
+
'https://dev-api-patient.health.cloud/encounters/%3CENCOUNTER_ID%3E/check-in'
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
## Notes
|
|
164
|
+
|
|
165
|
+
None.
|
|
166
|
+
|
|
167
|
+
## Prepared Test Console scenario
|
|
168
|
+
|
|
169
|
+
No canonical scenario is currently associated.
|
|
170
|
+
|
|
171
|
+
## Real response
|
|
172
|
+
|
|
173
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -86,61 +86,64 @@ Request model: [`CreateEncounterRequest`](../models/CreateEncounterRequest.md)
|
|
|
86
86
|
|
|
87
87
|
```json
|
|
88
88
|
{
|
|
89
|
-
"appointment_id": "
|
|
89
|
+
"appointment_id": "string",
|
|
90
|
+
"athena_appointment_id": "string",
|
|
91
|
+
"athena_encounter_id": "string",
|
|
90
92
|
"created_by": "self",
|
|
91
|
-
"created_date": "2026-
|
|
93
|
+
"created_date": "2026-01-01T09:00:00Z",
|
|
92
94
|
"diagnoses": [
|
|
93
95
|
{
|
|
94
|
-
"condition_display": "
|
|
95
|
-
"condition_id": "
|
|
96
|
+
"condition_display": "string",
|
|
97
|
+
"condition_id": "string",
|
|
96
98
|
"rank": 1,
|
|
97
|
-
"use_code": "
|
|
99
|
+
"use_code": "CC"
|
|
98
100
|
}
|
|
99
101
|
],
|
|
100
102
|
"encounter_class": "AMB",
|
|
101
|
-
"encounter_id": "
|
|
102
|
-
"fhir_id": "
|
|
103
|
+
"encounter_id": "00000000-0000-0000-0000-000000000000",
|
|
104
|
+
"fhir_id": "string",
|
|
103
105
|
"hospitalization": {
|
|
104
|
-
"admit_source_code": "
|
|
105
|
-
"destination_id": "
|
|
106
|
+
"admit_source_code": "string",
|
|
107
|
+
"destination_id": "string",
|
|
106
108
|
"discharge_disposition": "home",
|
|
107
|
-
"origin_id": "
|
|
108
|
-
"pre_admission_id": "
|
|
109
|
-
"re_admission_code": "
|
|
109
|
+
"origin_id": "string",
|
|
110
|
+
"pre_admission_id": "string",
|
|
111
|
+
"re_admission_code": "string"
|
|
110
112
|
},
|
|
111
|
-
"length_minutes":
|
|
113
|
+
"length_minutes": 0,
|
|
112
114
|
"locations": [
|
|
113
115
|
{
|
|
114
|
-
"location_display": "
|
|
115
|
-
"location_id": "
|
|
116
|
-
"period_end": "2026-
|
|
117
|
-
"period_start": "2026-
|
|
118
|
-
"status": "
|
|
116
|
+
"location_display": "string",
|
|
117
|
+
"location_id": "string",
|
|
118
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
119
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
120
|
+
"status": "active"
|
|
119
121
|
}
|
|
120
122
|
],
|
|
123
|
+
"notes": "string",
|
|
121
124
|
"participants": [
|
|
122
125
|
{
|
|
123
|
-
"participant_type": "
|
|
124
|
-
"period_end": "2026-
|
|
125
|
-
"period_start": "2026-
|
|
126
|
-
"practitioner_display": "
|
|
127
|
-
"practitioner_id": "
|
|
126
|
+
"participant_type": "PPRF",
|
|
127
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
128
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
129
|
+
"practitioner_display": "string",
|
|
130
|
+
"practitioner_id": "string"
|
|
128
131
|
}
|
|
129
132
|
],
|
|
130
|
-
"patient_id": "
|
|
131
|
-
"period_end": "2026-
|
|
132
|
-
"period_start": "2026-
|
|
133
|
-
"priority_code": "
|
|
134
|
-
"priority_display": "
|
|
135
|
-
"reason_code": "
|
|
136
|
-
"reason_display": "
|
|
137
|
-
"service_provider_display": "
|
|
138
|
-
"service_provider_id": "
|
|
139
|
-
"service_type_code": "
|
|
140
|
-
"service_type_display": "
|
|
141
|
-
"status": "
|
|
142
|
-
"type_code": "
|
|
143
|
-
"type_display": "
|
|
133
|
+
"patient_id": "string",
|
|
134
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
135
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
136
|
+
"priority_code": "string",
|
|
137
|
+
"priority_display": "string",
|
|
138
|
+
"reason_code": "string",
|
|
139
|
+
"reason_display": "string",
|
|
140
|
+
"service_provider_display": "string",
|
|
141
|
+
"service_provider_id": "string",
|
|
142
|
+
"service_type_code": "string",
|
|
143
|
+
"service_type_display": "string",
|
|
144
|
+
"status": "planned",
|
|
145
|
+
"type_code": "string",
|
|
146
|
+
"type_display": "string"
|
|
144
147
|
}
|
|
145
148
|
```
|
|
146
149
|
|