@healthcloudai/hc-sdk 2.7.0 → 2.9.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 +168 -2
- package/dist/index.d.ts +168 -2
- package/dist/index.js +70 -0
- package/docs/clients/PatientClient.md +3 -0
- package/docs/docs-manifest.json +11 -6
- 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/SetPreferredPharmacyResponse.md +20 -0
- package/docs/models/Slot.md +1 -0
- package/docs/models/fieldagent.Encounter.md +3 -0
- package/docs/models/index.md +5 -3
- package/docs/models/patient.Encounter.md +3 -0
- package/docs/models/patient.LoginResponse.md +1 -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 +114 -0
- package/docs/operations/patient.createEncounter.md +40 -37
- package/docs/operations/patient.createQuestionnaireResponse.md +1 -1
- 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/docs/operations/patient.login.md +8 -7
- package/docs/operations/patient.setPreferredPharmacy.md +3 -4
- package/docs/operations/patient.updatePhone.md +42 -1
- package/docs/operations/person.updatePhone.md +42 -1
- package/docs/operations/provider.updatePhone.md +42 -1
- package/package.json +1 -1
- package/docs/models/OrganizationResource.md +0 -19
- package/docs/models/PanelResult.md +0 -24
- package/docs/models/SingleTestResultResponse.md +0 -28
|
@@ -58,19 +58,20 @@ None declared in canonical OpenAPI.
|
|
|
58
58
|
|
|
59
59
|
```json
|
|
60
60
|
{
|
|
61
|
-
"appointment_id": "
|
|
62
|
-
"
|
|
63
|
-
"
|
|
64
|
-
"
|
|
65
|
-
"
|
|
66
|
-
"
|
|
61
|
+
"appointment_id": "string",
|
|
62
|
+
"athena_appointment_id": "string",
|
|
63
|
+
"created_at": "string",
|
|
64
|
+
"end": "string",
|
|
65
|
+
"patient_id": "string",
|
|
66
|
+
"provider_id": "string",
|
|
67
|
+
"slot_id": "string",
|
|
67
68
|
"slot_ids": [
|
|
68
|
-
"
|
|
69
|
+
"string"
|
|
69
70
|
],
|
|
70
|
-
"specialty_code": "
|
|
71
|
-
"start": "
|
|
72
|
-
"status": "
|
|
73
|
-
"updated_at": "
|
|
71
|
+
"specialty_code": "string",
|
|
72
|
+
"start": "string",
|
|
73
|
+
"status": "scheduled",
|
|
74
|
+
"updated_at": "string"
|
|
74
75
|
}
|
|
75
76
|
```
|
|
76
77
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `appointments.createSlot`
|
|
4
4
|
|
|
5
|
-
Create a provider-owned slot that can later be discovered with `appointments.listSlots` and booked. Times use ISO 8601 date-time values and `end` must be after `start`.
|
|
5
|
+
Create a provider-owned slot that can later be discovered with `appointments.listSlots` and booked via `appointments.book` (pass the returned `slot_id`, which is the real FHIR resource id). Times use ISO 8601 date-time values and `end` must be strictly after `start`. Restricted to a PROVIDER (their own provider_id only) or TENANTADMIN caller. Rejects a slot whose [start, end) range overlaps an existing slot on the *same schedule* (409) — back-to-back slots (one ending exactly when the next starts) are not an overlap, so a schedule holding many contiguous, non-overlapping slots is normal and expected; a slot being updated is excluded from its own overlap check. The overlap scope is per schedule (in practice per provider) — an identical time range on a different provider's schedule is never a conflict.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -71,13 +71,14 @@ Request model: [`CreateSlotRequest`](../models/CreateSlotRequest.md)
|
|
|
71
71
|
|
|
72
72
|
```json
|
|
73
73
|
{
|
|
74
|
-
"
|
|
75
|
-
"
|
|
76
|
-
"
|
|
77
|
-
"
|
|
78
|
-
"
|
|
79
|
-
"
|
|
80
|
-
"
|
|
74
|
+
"athena_appointment_id": "string",
|
|
75
|
+
"end": "2026-01-01T09:00:00Z",
|
|
76
|
+
"location": "string",
|
|
77
|
+
"provider_id": "string",
|
|
78
|
+
"provider_name": "string",
|
|
79
|
+
"slot_id": "string",
|
|
80
|
+
"specialty_code": "string",
|
|
81
|
+
"start": "2026-01-01T09:00:00Z",
|
|
81
82
|
"status": "free"
|
|
82
83
|
}
|
|
83
84
|
```
|
|
@@ -86,8 +87,10 @@ Request model: [`CreateSlotRequest`](../models/CreateSlotRequest.md)
|
|
|
86
87
|
|
|
87
88
|
| Status | Shape | Content type | Description |
|
|
88
89
|
|---|---|---|---|
|
|
89
|
-
| `400` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Required fields are missing, date-time values are invalid, or FHIR rejected the slot |
|
|
90
|
+
| `400` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Required fields are missing, date-time values are invalid, end is not after start, or FHIR rejected the slot |
|
|
90
91
|
| `401` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
92
|
+
| `403` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Caller is not a provider or tenant administrator, or a provider tried to create a slot for a different provider_id |
|
|
93
|
+
| `409` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | The requested time range overlaps an existing slot on the same schedule |
|
|
91
94
|
| `500` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Internal server error |
|
|
92
95
|
|
|
93
96
|
## Error examples
|
|
@@ -109,6 +112,14 @@ Request model: [`CreateSlotRequest`](../models/CreateSlotRequest.md)
|
|
|
109
112
|
}
|
|
110
113
|
```
|
|
111
114
|
|
|
115
|
+
### 400 — end is not after start
|
|
116
|
+
|
|
117
|
+
```json
|
|
118
|
+
{
|
|
119
|
+
"error": "end must be after start"
|
|
120
|
+
}
|
|
121
|
+
```
|
|
122
|
+
|
|
112
123
|
### 400 — Date-time values are invalid
|
|
113
124
|
|
|
114
125
|
```json
|
|
@@ -133,6 +144,30 @@ Request model: [`CreateSlotRequest`](../models/CreateSlotRequest.md)
|
|
|
133
144
|
}
|
|
134
145
|
```
|
|
135
146
|
|
|
147
|
+
### 403 — Caller pool type is not provider/tenant administrator
|
|
148
|
+
|
|
149
|
+
```json
|
|
150
|
+
{
|
|
151
|
+
"error": "Provider or tenant administrator authorization required"
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### 403 — Provider caller does not own this provider_id
|
|
156
|
+
|
|
157
|
+
```json
|
|
158
|
+
{
|
|
159
|
+
"error": "Providers may only create their own slots"
|
|
160
|
+
}
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### 409 — Conflicts with an existing slot
|
|
164
|
+
|
|
165
|
+
```json
|
|
166
|
+
{
|
|
167
|
+
"error": "Slot slot-existing on schedule schedule-pract-123 already occupies 2026-09-01T09:00:00Z–2026-09-01T09:30:00Z, which overlaps the requested 2026-09-01T09:15:00Z–2026-09-01T09:45:00Z"
|
|
168
|
+
}
|
|
169
|
+
```
|
|
170
|
+
|
|
136
171
|
### 500 — Unexpected service failure (sanitized example)
|
|
137
172
|
|
|
138
173
|
```json
|
|
@@ -62,23 +62,24 @@ None declared in canonical OpenAPI.
|
|
|
62
62
|
{
|
|
63
63
|
"appointments": [
|
|
64
64
|
{
|
|
65
|
-
"appointment_id": "
|
|
66
|
-
"
|
|
67
|
-
"
|
|
68
|
-
"
|
|
69
|
-
"
|
|
70
|
-
"
|
|
65
|
+
"appointment_id": "string",
|
|
66
|
+
"athena_appointment_id": "string",
|
|
67
|
+
"created_at": "string",
|
|
68
|
+
"end": "string",
|
|
69
|
+
"patient_id": "string",
|
|
70
|
+
"provider_id": "string",
|
|
71
|
+
"slot_id": "string",
|
|
71
72
|
"slot_ids": [
|
|
72
|
-
"
|
|
73
|
+
"string"
|
|
73
74
|
],
|
|
74
|
-
"specialty_code": "
|
|
75
|
-
"start": "
|
|
75
|
+
"specialty_code": "string",
|
|
76
|
+
"start": "string",
|
|
76
77
|
"status": "scheduled",
|
|
77
|
-
"updated_at": "
|
|
78
|
+
"updated_at": "string"
|
|
78
79
|
}
|
|
79
80
|
],
|
|
80
|
-
"patient_id": "
|
|
81
|
-
"total":
|
|
81
|
+
"patient_id": "string",
|
|
82
|
+
"total": 0
|
|
82
83
|
}
|
|
83
84
|
```
|
|
84
85
|
|
|
@@ -63,17 +63,18 @@ None declared in canonical OpenAPI.
|
|
|
63
63
|
{
|
|
64
64
|
"slots": [
|
|
65
65
|
{
|
|
66
|
-
"
|
|
67
|
-
"
|
|
68
|
-
"
|
|
69
|
-
"
|
|
70
|
-
"
|
|
71
|
-
"
|
|
72
|
-
"
|
|
66
|
+
"athena_appointment_id": "string",
|
|
67
|
+
"end": "2026-01-01T09:00:00Z",
|
|
68
|
+
"location": "string",
|
|
69
|
+
"provider_id": "string",
|
|
70
|
+
"provider_name": "string",
|
|
71
|
+
"slot_id": "string",
|
|
72
|
+
"specialty_code": "string",
|
|
73
|
+
"start": "2026-01-01T09:00:00Z",
|
|
73
74
|
"status": "free"
|
|
74
75
|
}
|
|
75
76
|
],
|
|
76
|
-
"total":
|
|
77
|
+
"total": 0
|
|
77
78
|
}
|
|
78
79
|
```
|
|
79
80
|
|
|
@@ -64,19 +64,20 @@ Request model: [`RescheduleAppointmentRequest`](../models/RescheduleAppointmentR
|
|
|
64
64
|
|
|
65
65
|
```json
|
|
66
66
|
{
|
|
67
|
-
"appointment_id": "
|
|
68
|
-
"
|
|
69
|
-
"
|
|
70
|
-
"
|
|
71
|
-
"
|
|
72
|
-
"
|
|
67
|
+
"appointment_id": "string",
|
|
68
|
+
"athena_appointment_id": "string",
|
|
69
|
+
"created_at": "string",
|
|
70
|
+
"end": "string",
|
|
71
|
+
"patient_id": "string",
|
|
72
|
+
"provider_id": "string",
|
|
73
|
+
"slot_id": "string",
|
|
73
74
|
"slot_ids": [
|
|
74
|
-
"
|
|
75
|
+
"string"
|
|
75
76
|
],
|
|
76
|
-
"specialty_code": "
|
|
77
|
-
"start": "
|
|
77
|
+
"specialty_code": "string",
|
|
78
|
+
"start": "string",
|
|
78
79
|
"status": "scheduled",
|
|
79
|
-
"updated_at": "
|
|
80
|
+
"updated_at": "string"
|
|
80
81
|
}
|
|
81
82
|
```
|
|
82
83
|
|
|
@@ -75,6 +75,7 @@ Request model: [`AthenaBookAppointmentRequest`](../models/AthenaBookAppointmentR
|
|
|
75
75
|
"appointment_type_id": "12345",
|
|
76
76
|
"date": "example-date",
|
|
77
77
|
"department_id": "12345",
|
|
78
|
+
"encounter_id": "12345",
|
|
78
79
|
"last_modified": "example-last-modified",
|
|
79
80
|
"patient_appointment_type_name": "Example Name",
|
|
80
81
|
"patient_id": "12345",
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.athenaCreateInsurancePackage`
|
|
4
4
|
|
|
5
|
-
Create an insurance record from an insurance package.
|
|
5
|
+
Create an insurance record from an insurance package. Tries sequence numbers 1 → 2 → 3 (Athena's primary/secondary/tertiary insurance slots) since an occupied slot rejects the write. Raises the last error (e.g. an invalid ``package_id``) if none of the three slots accept it, rather than swallowing it — silently returning None here left callers unable to tell "no free slot" apart from "Athena rejected this package outright", both by AthenaInsuranceSync and by direct API/MCP callers of this connector method.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -72,6 +72,7 @@ Request model: [`AthenaGetAppointmentDetailsRequest`](../models/AthenaGetAppoint
|
|
|
72
72
|
"appointment_type_id": "12345",
|
|
73
73
|
"date": "example-date",
|
|
74
74
|
"department_id": "12345",
|
|
75
|
+
"encounter_id": "12345",
|
|
75
76
|
"last_modified": "example-last-modified",
|
|
76
77
|
"patient_appointment_type_name": "Example Name",
|
|
77
78
|
"patient_id": "12345",
|
|
@@ -74,6 +74,7 @@ Request model: [`AthenaGetBookedAppointmentsRequest`](../models/AthenaGetBookedA
|
|
|
74
74
|
"appointment_type_id": "12345",
|
|
75
75
|
"date": "example-date",
|
|
76
76
|
"department_id": "12345",
|
|
77
|
+
"encounter_id": "12345",
|
|
77
78
|
"last_modified": "example-last-modified",
|
|
78
79
|
"patient_appointment_type_name": "Example Name",
|
|
79
80
|
"patient_id": "12345",
|
|
@@ -72,6 +72,7 @@ Request model: [`AthenaGetEncounterRequest`](../models/AthenaGetEncounterRequest
|
|
|
72
72
|
"appointment_type_id": "12345",
|
|
73
73
|
"date": "example-date",
|
|
74
74
|
"department_id": "12345",
|
|
75
|
+
"encounter_id": "12345",
|
|
75
76
|
"last_modified": "example-last-modified",
|
|
76
77
|
"patient_appointment_type_name": "Example Name",
|
|
77
78
|
"patient_id": "12345",
|
|
@@ -74,6 +74,7 @@ Request model: [`AthenaListAppointmentsRequest`](../models/AthenaListAppointment
|
|
|
74
74
|
"appointment_type_id": "12345",
|
|
75
75
|
"date": "example-date",
|
|
76
76
|
"department_id": "12345",
|
|
77
|
+
"encounter_id": "12345",
|
|
77
78
|
"last_modified": "example-last-modified",
|
|
78
79
|
"patient_appointment_type_name": "Example Name",
|
|
79
80
|
"patient_id": "12345",
|
|
@@ -73,6 +73,7 @@ Request model: [`AthenaListPatientAppointmentsRequest`](../models/AthenaListPati
|
|
|
73
73
|
"appointment_type_id": "12345",
|
|
74
74
|
"date": "example-date",
|
|
75
75
|
"department_id": "12345",
|
|
76
|
+
"encounter_id": "12345",
|
|
76
77
|
"last_modified": "example-last-modified",
|
|
77
78
|
"patient_appointment_type_name": "Example Name",
|
|
78
79
|
"patient_id": "12345",
|
|
@@ -49,8 +49,9 @@ Request model: [`GetScanUploadUrlRequest`](../models/GetScanUploadUrlRequest.md)
|
|
|
49
49
|
```json
|
|
50
50
|
{
|
|
51
51
|
"content_type": "image/jpeg",
|
|
52
|
-
"filename": "
|
|
53
|
-
"
|
|
52
|
+
"filename": "scan.jpg",
|
|
53
|
+
"gtin": "string",
|
|
54
|
+
"test_id": "00000000-0000-0000-0000-000000000000"
|
|
54
55
|
}
|
|
55
56
|
```
|
|
56
57
|
|
|
@@ -137,8 +138,9 @@ const patientId = "<PATIENT_ID>";
|
|
|
137
138
|
|
|
138
139
|
const request = {
|
|
139
140
|
"content_type": "image/jpeg",
|
|
140
|
-
"filename": "
|
|
141
|
-
"
|
|
141
|
+
"filename": "scan.jpg",
|
|
142
|
+
"gtin": "string",
|
|
143
|
+
"test_id": "00000000-0000-0000-0000-000000000000"
|
|
142
144
|
};
|
|
143
145
|
|
|
144
146
|
const result = await diagnostics.getScanUploadUrl(patientId, request);
|
|
@@ -150,7 +152,7 @@ const result = await diagnostics.getScanUploadUrl(patientId, request);
|
|
|
150
152
|
curl -X POST \
|
|
151
153
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
152
154
|
-H 'Content-Type: application/json' \
|
|
153
|
-
-d '{"content_type":"image/jpeg","filename":"
|
|
155
|
+
-d '{"content_type":"image/jpeg","filename":"scan.jpg","gtin":"string","test_id":"00000000-0000-0000-0000-000000000000"}' \
|
|
154
156
|
'https://dev-api-diagnostics.health.cloud/patients/%3CPATIENT_ID%3E/diagnostics/scan-upload-url'
|
|
155
157
|
```
|
|
156
158
|
|
|
@@ -51,7 +51,7 @@ None declared in canonical OpenAPI.
|
|
|
51
51
|
|
|
52
52
|
| Status | Shape | Content type | Description |
|
|
53
53
|
|---|---|---|---|
|
|
54
|
-
| `200` | [`
|
|
54
|
+
| `200` | [`GetTestResultResponse`](../models/GetTestResultResponse.md) | application/json | Single test result, supports 1-N panels |
|
|
55
55
|
|
|
56
56
|
## Success response examples
|
|
57
57
|
|
|
@@ -59,28 +59,10 @@ None declared in canonical OpenAPI.
|
|
|
59
59
|
|
|
60
60
|
```json
|
|
61
61
|
{
|
|
62
|
-
"
|
|
63
|
-
"
|
|
64
|
-
"
|
|
65
|
-
"
|
|
66
|
-
{
|
|
67
|
-
"interpretation": "NEG",
|
|
68
|
-
"loinc_code": "94500-6",
|
|
69
|
-
"loinc_display": "SARS-CoV-2 RNA",
|
|
70
|
-
"panel_name": "SARS-CoV-2",
|
|
71
|
-
"quantitative_unit": "index",
|
|
72
|
-
"quantitative_value": 0.12,
|
|
73
|
-
"result": "not_detected",
|
|
74
|
-
"result_type": "quantitative"
|
|
75
|
-
}
|
|
76
|
-
],
|
|
77
|
-
"patient_id": "patient-example-001",
|
|
78
|
-
"performed_by": "provider-example-001",
|
|
79
|
-
"performed_datetime": "2026-08-10T12:00:00Z",
|
|
80
|
-
"scan_url": "https://example.com/resource",
|
|
81
|
-
"status": "final",
|
|
82
|
-
"test_id": "00000000-0000-4000-8000-000000000001",
|
|
83
|
-
"test_type": "covid19"
|
|
62
|
+
"code": 0,
|
|
63
|
+
"data": {},
|
|
64
|
+
"message": "string",
|
|
65
|
+
"success": true
|
|
84
66
|
}
|
|
85
67
|
```
|
|
86
68
|
|
|
@@ -61,13 +61,19 @@ None declared in canonical OpenAPI.
|
|
|
61
61
|
```json
|
|
62
62
|
{
|
|
63
63
|
"gs1_parsed": {
|
|
64
|
-
"expiration_date": "
|
|
65
|
-
"gtin": "
|
|
66
|
-
"lot_number": "
|
|
67
|
-
"serial_number": "
|
|
64
|
+
"expiration_date": "2026-01-01",
|
|
65
|
+
"gtin": "string",
|
|
66
|
+
"lot_number": "string",
|
|
67
|
+
"serial_number": "string"
|
|
68
68
|
},
|
|
69
|
-
"product":
|
|
70
|
-
"raw_gs1": "
|
|
69
|
+
"product": {},
|
|
70
|
+
"raw_gs1": "string",
|
|
71
|
+
"scan_upload": {
|
|
72
|
+
"expires_in": 0,
|
|
73
|
+
"storage_key": "string",
|
|
74
|
+
"test_id": "00000000-0000-0000-0000-000000000000",
|
|
75
|
+
"upload_url": "string"
|
|
76
|
+
}
|
|
71
77
|
}
|
|
72
78
|
```
|
|
73
79
|
|
|
@@ -61,68 +61,71 @@ None declared in canonical OpenAPI.
|
|
|
61
61
|
|
|
62
62
|
```json
|
|
63
63
|
{
|
|
64
|
-
"created_by": "
|
|
64
|
+
"created_by": "string",
|
|
65
65
|
"encounters": [
|
|
66
66
|
{
|
|
67
|
-
"appointment_id": "
|
|
68
|
-
"
|
|
69
|
-
"
|
|
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",
|
|
70
72
|
"diagnoses": [
|
|
71
73
|
{
|
|
72
|
-
"condition_display": "
|
|
73
|
-
"condition_id": "
|
|
74
|
+
"condition_display": "string",
|
|
75
|
+
"condition_id": "string",
|
|
74
76
|
"rank": 1,
|
|
75
77
|
"use_code": "CC"
|
|
76
78
|
}
|
|
77
79
|
],
|
|
78
80
|
"encounter_class": "AMB",
|
|
79
|
-
"encounter_id": "00000000-0000-
|
|
80
|
-
"fhir_id": "
|
|
81
|
+
"encounter_id": "00000000-0000-0000-0000-000000000000",
|
|
82
|
+
"fhir_id": "string",
|
|
81
83
|
"hospitalization": {
|
|
82
|
-
"admit_source_code": "
|
|
83
|
-
"destination_id": "
|
|
84
|
+
"admit_source_code": "string",
|
|
85
|
+
"destination_id": "string",
|
|
84
86
|
"discharge_disposition": "home",
|
|
85
|
-
"origin_id": "
|
|
86
|
-
"pre_admission_id": "
|
|
87
|
-
"re_admission_code": "
|
|
87
|
+
"origin_id": "string",
|
|
88
|
+
"pre_admission_id": "string",
|
|
89
|
+
"re_admission_code": "string"
|
|
88
90
|
},
|
|
89
|
-
"length_minutes":
|
|
91
|
+
"length_minutes": 0,
|
|
90
92
|
"locations": [
|
|
91
93
|
{
|
|
92
|
-
"location_display": "
|
|
93
|
-
"location_id": "
|
|
94
|
-
"period_end": "2026-
|
|
95
|
-
"period_start": "2026-
|
|
96
|
-
"status": "
|
|
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"
|
|
97
99
|
}
|
|
98
100
|
],
|
|
101
|
+
"notes": "string",
|
|
99
102
|
"participants": [
|
|
100
103
|
{
|
|
101
104
|
"participant_type": "PPRF",
|
|
102
|
-
"period_end": "2026-
|
|
103
|
-
"period_start": "2026-
|
|
104
|
-
"practitioner_display": "
|
|
105
|
-
"practitioner_id": "
|
|
105
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
106
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
107
|
+
"practitioner_display": "string",
|
|
108
|
+
"practitioner_id": "string"
|
|
106
109
|
}
|
|
107
110
|
],
|
|
108
|
-
"patient_id": "
|
|
109
|
-
"period_end": "2026-
|
|
110
|
-
"period_start": "2026-
|
|
111
|
-
"priority_code": "
|
|
112
|
-
"priority_display": "
|
|
113
|
-
"reason_code": "
|
|
114
|
-
"reason_display": "
|
|
115
|
-
"service_provider_display": "
|
|
116
|
-
"service_provider_id": "
|
|
117
|
-
"service_type_code": "
|
|
118
|
-
"service_type_display": "
|
|
119
|
-
"status": "
|
|
120
|
-
"type_code": "
|
|
121
|
-
"type_display": "
|
|
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"
|
|
122
125
|
}
|
|
123
126
|
],
|
|
124
|
-
"patient_id": "
|
|
125
|
-
"total":
|
|
127
|
+
"patient_id": "string",
|
|
128
|
+
"total": 0
|
|
126
129
|
}
|
|
127
130
|
```
|
|
128
131
|
|