@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.
- package/dist/index.cjs +173 -0
- package/dist/index.d.cts +5950 -5764
- package/dist/index.d.ts +5950 -5764
- package/dist/index.js +173 -0
- package/docs/clients/EhrClient.md +15 -0
- package/docs/clients/PatientClient.md +3 -0
- package/docs/docs-manifest.json +62 -5
- package/docs/examples/index.md +18 -0
- package/docs/index.md +18 -0
- package/docs/models/AddInsuranceRequest.md +1 -0
- package/docs/models/AddInsuranceResponse.md +2 -0
- package/docs/models/Allergy.md +31 -0
- package/docs/models/AllergyCategory.md +15 -0
- package/docs/models/AllergyCriticality.md +15 -0
- package/docs/models/AllergyReaction.md +21 -0
- package/docs/models/AllergyStatus.md +15 -0
- package/docs/models/AllergyVerificationStatus.md +15 -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/CodedConcept.md +19 -0
- package/docs/models/FamilyCondition.md +21 -0
- package/docs/models/FamilyHistoryEntry.md +30 -0
- package/docs/models/FamilyHistoryStatus.md +15 -0
- package/docs/models/FamilyRelationship.md +15 -0
- package/docs/models/GS1LookupResponse.md +3 -2
- package/docs/models/GetEncounterResponse.md +3 -0
- package/docs/models/GetHealthRecordResponse.md +19 -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/IntoleranceType.md +15 -0
- package/docs/models/ListAllergiesResponse.md +19 -0
- package/docs/models/ListConditionsResponse.md +19 -0
- package/docs/models/ListDirectivesResponse.md +19 -0
- package/docs/models/ListFamilyHistoryResponse.md +19 -0
- package/docs/models/ListFunctionalStatusResponse.md +19 -0
- package/docs/models/ListImmunizationsResponse.md +19 -0
- package/docs/models/ListObservationsResponse.md +19 -0
- package/docs/models/ListProceduresResponse.md +19 -0
- package/docs/models/ListQuestionnaireResponsesResponse.md +19 -0
- package/docs/models/ListSocialHistoryResponse.md +19 -0
- package/docs/models/ListVitalsResponse.md +19 -0
- package/docs/models/PatientDemographics.md +2 -0
- package/docs/models/Problem.md +37 -0
- package/docs/models/ProblemCategory.md +15 -0
- package/docs/models/ProblemClinicalStatus.md +15 -0
- package/docs/models/ProblemSeverity.md +15 -0
- package/docs/models/ProblemVerificationStatus.md +15 -0
- package/docs/models/QuestionnaireResponse.md +27 -0
- package/docs/models/QuestionnaireResponseStatus.md +15 -0
- package/docs/models/ReactionSeverity.md +15 -0
- package/docs/models/ResponseAnswer.md +27 -0
- package/docs/models/ResponseItem.md +21 -0
- package/docs/models/ScanUploadResponse.md +4 -4
- package/docs/models/Slot.md +1 -0
- package/docs/models/ehr.ListDiagnosticsResponse.md +19 -0
- package/docs/models/ehr.ListEncountersResponse.md +19 -0
- package/docs/models/ehr.ListMedicationsResponse.md +19 -0
- package/docs/models/fieldagent.Encounter.md +3 -0
- package/docs/models/index.md +41 -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/ehr.getHealthRecord.md +122 -0
- package/docs/operations/ehr.listAllergies.md +156 -0
- package/docs/operations/ehr.listConditions.md +152 -0
- package/docs/operations/ehr.listDiagnostics.md +147 -0
- package/docs/operations/ehr.listDirectives.md +122 -0
- package/docs/operations/ehr.listEncounters.md +178 -0
- package/docs/operations/ehr.listFamilyHistory.md +147 -0
- package/docs/operations/ehr.listFunctionalStatus.md +122 -0
- package/docs/operations/ehr.listImmunizations.md +122 -0
- package/docs/operations/ehr.listMedications.md +163 -0
- package/docs/operations/ehr.listObservations.md +126 -0
- package/docs/operations/ehr.listProcedures.md +122 -0
- package/docs/operations/ehr.listQuestionnaireResponses.md +162 -0
- package/docs/operations/ehr.listSocialHistory.md +122 -0
- package/docs/operations/ehr.listVitals.md +132 -0
- 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
|
@@ -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
|
|
|
@@ -59,65 +59,68 @@ None declared in canonical OpenAPI.
|
|
|
59
59
|
"checked_in": true,
|
|
60
60
|
"encounters": [
|
|
61
61
|
{
|
|
62
|
-
"appointment_id": "
|
|
62
|
+
"appointment_id": "string",
|
|
63
|
+
"athena_appointment_id": "string",
|
|
64
|
+
"athena_encounter_id": "string",
|
|
63
65
|
"created_by": "self",
|
|
64
|
-
"created_date": "2026-
|
|
66
|
+
"created_date": "2026-01-01T09:00:00Z",
|
|
65
67
|
"diagnoses": [
|
|
66
68
|
{
|
|
67
|
-
"condition_display": "
|
|
68
|
-
"condition_id": "
|
|
69
|
+
"condition_display": "string",
|
|
70
|
+
"condition_id": "string",
|
|
69
71
|
"rank": 1,
|
|
70
|
-
"use_code": "
|
|
72
|
+
"use_code": "CC"
|
|
71
73
|
}
|
|
72
74
|
],
|
|
73
75
|
"encounter_class": "AMB",
|
|
74
|
-
"encounter_id": "
|
|
75
|
-
"fhir_id": "
|
|
76
|
+
"encounter_id": "00000000-0000-0000-0000-000000000000",
|
|
77
|
+
"fhir_id": "string",
|
|
76
78
|
"hospitalization": {
|
|
77
|
-
"admit_source_code": "
|
|
78
|
-
"destination_id": "
|
|
79
|
+
"admit_source_code": "string",
|
|
80
|
+
"destination_id": "string",
|
|
79
81
|
"discharge_disposition": "home",
|
|
80
|
-
"origin_id": "
|
|
81
|
-
"pre_admission_id": "
|
|
82
|
-
"re_admission_code": "
|
|
82
|
+
"origin_id": "string",
|
|
83
|
+
"pre_admission_id": "string",
|
|
84
|
+
"re_admission_code": "string"
|
|
83
85
|
},
|
|
84
|
-
"length_minutes":
|
|
86
|
+
"length_minutes": 0,
|
|
85
87
|
"locations": [
|
|
86
88
|
{
|
|
87
|
-
"location_display": "
|
|
88
|
-
"location_id": "
|
|
89
|
-
"period_end": "2026-
|
|
90
|
-
"period_start": "2026-
|
|
91
|
-
"status": "
|
|
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"
|
|
92
94
|
}
|
|
93
95
|
],
|
|
96
|
+
"notes": "string",
|
|
94
97
|
"participants": [
|
|
95
98
|
{
|
|
96
|
-
"participant_type": "
|
|
97
|
-
"period_end": "2026-
|
|
98
|
-
"period_start": "2026-
|
|
99
|
-
"practitioner_display": "
|
|
100
|
-
"practitioner_id": "
|
|
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"
|
|
101
104
|
}
|
|
102
105
|
],
|
|
103
|
-
"patient_id": "
|
|
104
|
-
"period_end": "2026-
|
|
105
|
-
"period_start": "2026-
|
|
106
|
-
"priority_code": "
|
|
107
|
-
"priority_display": "
|
|
108
|
-
"reason_code": "
|
|
109
|
-
"reason_display": "
|
|
110
|
-
"service_provider_display": "
|
|
111
|
-
"service_provider_id": "
|
|
112
|
-
"service_type_code": "
|
|
113
|
-
"service_type_display": "
|
|
114
|
-
"status": "
|
|
115
|
-
"type_code": "
|
|
116
|
-
"type_display": "
|
|
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"
|
|
117
120
|
}
|
|
118
121
|
],
|
|
119
122
|
"ok": true,
|
|
120
|
-
"patient_id": "
|
|
123
|
+
"patient_id": "string"
|
|
121
124
|
}
|
|
122
125
|
```
|
|
123
126
|
|
|
@@ -56,69 +56,72 @@ None declared in canonical OpenAPI.
|
|
|
56
56
|
|
|
57
57
|
```json
|
|
58
58
|
{
|
|
59
|
-
"asOf": "
|
|
59
|
+
"asOf": "string",
|
|
60
60
|
"careSession": {
|
|
61
61
|
"encounters": [
|
|
62
62
|
{
|
|
63
|
-
"appointment_id": "
|
|
63
|
+
"appointment_id": "string",
|
|
64
|
+
"athena_appointment_id": "string",
|
|
65
|
+
"athena_encounter_id": "string",
|
|
64
66
|
"created_by": "self",
|
|
65
|
-
"created_date": "2026-
|
|
67
|
+
"created_date": "2026-01-01T09:00:00Z",
|
|
66
68
|
"diagnoses": [
|
|
67
69
|
{
|
|
68
|
-
"condition_display": "
|
|
69
|
-
"condition_id": "
|
|
70
|
+
"condition_display": "string",
|
|
71
|
+
"condition_id": "string",
|
|
70
72
|
"rank": 1,
|
|
71
|
-
"use_code": "
|
|
73
|
+
"use_code": "CC"
|
|
72
74
|
}
|
|
73
75
|
],
|
|
74
76
|
"encounter_class": "AMB",
|
|
75
|
-
"encounter_id": "
|
|
76
|
-
"fhir_id": "
|
|
77
|
+
"encounter_id": "00000000-0000-0000-0000-000000000000",
|
|
78
|
+
"fhir_id": "string",
|
|
77
79
|
"hospitalization": {
|
|
78
|
-
"admit_source_code": "
|
|
79
|
-
"destination_id": "
|
|
80
|
+
"admit_source_code": "string",
|
|
81
|
+
"destination_id": "string",
|
|
80
82
|
"discharge_disposition": "home",
|
|
81
|
-
"origin_id": "
|
|
82
|
-
"pre_admission_id": "
|
|
83
|
-
"re_admission_code": "
|
|
83
|
+
"origin_id": "string",
|
|
84
|
+
"pre_admission_id": "string",
|
|
85
|
+
"re_admission_code": "string"
|
|
84
86
|
},
|
|
85
|
-
"length_minutes":
|
|
87
|
+
"length_minutes": 0,
|
|
86
88
|
"locations": [
|
|
87
89
|
{
|
|
88
|
-
"location_display": "
|
|
89
|
-
"location_id": "
|
|
90
|
-
"period_end": "2026-
|
|
91
|
-
"period_start": "2026-
|
|
92
|
-
"status": "
|
|
90
|
+
"location_display": "string",
|
|
91
|
+
"location_id": "string",
|
|
92
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
93
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
94
|
+
"status": "active"
|
|
93
95
|
}
|
|
94
96
|
],
|
|
97
|
+
"notes": "string",
|
|
95
98
|
"participants": [
|
|
96
99
|
{
|
|
97
|
-
"participant_type": "
|
|
98
|
-
"period_end": "2026-
|
|
99
|
-
"period_start": "2026-
|
|
100
|
-
"practitioner_display": "
|
|
101
|
-
"practitioner_id": "
|
|
100
|
+
"participant_type": "PPRF",
|
|
101
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
102
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
103
|
+
"practitioner_display": "string",
|
|
104
|
+
"practitioner_id": "string"
|
|
102
105
|
}
|
|
103
106
|
],
|
|
104
|
-
"patient_id": "
|
|
105
|
-
"period_end": "2026-
|
|
106
|
-
"period_start": "2026-
|
|
107
|
-
"priority_code": "
|
|
108
|
-
"priority_display": "
|
|
109
|
-
"reason_code": "
|
|
110
|
-
"reason_display": "
|
|
111
|
-
"service_provider_display": "
|
|
112
|
-
"service_provider_id": "
|
|
113
|
-
"service_type_code": "
|
|
114
|
-
"service_type_display": "
|
|
115
|
-
"status": "
|
|
116
|
-
"type_code": "
|
|
117
|
-
"type_display": "
|
|
107
|
+
"patient_id": "string",
|
|
108
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
109
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
110
|
+
"priority_code": "string",
|
|
111
|
+
"priority_display": "string",
|
|
112
|
+
"reason_code": "string",
|
|
113
|
+
"reason_display": "string",
|
|
114
|
+
"service_provider_display": "string",
|
|
115
|
+
"service_provider_id": "string",
|
|
116
|
+
"service_type_code": "string",
|
|
117
|
+
"service_type_display": "string",
|
|
118
|
+
"status": "planned",
|
|
119
|
+
"type_code": "string",
|
|
120
|
+
"type_display": "string"
|
|
118
121
|
}
|
|
119
122
|
],
|
|
120
|
-
"patientId": "
|
|
121
|
-
"visitorName": "
|
|
123
|
+
"patientId": "string",
|
|
124
|
+
"visitorName": "string"
|
|
122
125
|
},
|
|
123
126
|
"ok": true
|
|
124
127
|
}
|