@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
|
@@ -57,127 +57,92 @@ None declared in canonical OpenAPI.
|
|
|
57
57
|
```json
|
|
58
58
|
{
|
|
59
59
|
"active": true,
|
|
60
|
-
"addresses": [
|
|
61
|
-
|
|
62
|
-
|
|
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": "
|
|
76
|
-
"preferred":
|
|
66
|
+
"language": "string",
|
|
67
|
+
"preferred": false
|
|
77
68
|
}
|
|
78
69
|
],
|
|
79
70
|
"created_by": "self",
|
|
80
|
-
"created_date": "2026-
|
|
81
|
-
"date_of_birth": "
|
|
71
|
+
"created_date": "2026-01-01T09:00:00Z",
|
|
72
|
+
"date_of_birth": "2026-01-01",
|
|
82
73
|
"deceased": false,
|
|
83
|
-
"deceased_cause":
|
|
84
|
-
"deceased_date":
|
|
85
|
-
"email": "
|
|
86
|
-
"emergency_contacts": [
|
|
87
|
-
|
|
88
|
-
|
|
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": "
|
|
81
|
+
"gender": "male",
|
|
109
82
|
"gender_identity": "man",
|
|
110
83
|
"insurance": [
|
|
111
84
|
{
|
|
112
|
-
"copay":
|
|
113
|
-
"deductible":
|
|
85
|
+
"copay": 0,
|
|
86
|
+
"deductible": 0,
|
|
114
87
|
"effective_date": "2026-01-01",
|
|
115
|
-
"group_number": "
|
|
116
|
-
"member_id": "
|
|
117
|
-
"payer_id": "
|
|
118
|
-
"payer_name": "
|
|
119
|
-
"plan_name": "
|
|
120
|
-
"plan_type": "
|
|
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": "
|
|
123
|
-
"subscriber_first_name": "
|
|
124
|
-
"subscriber_id": "
|
|
125
|
-
"subscriber_last_name": "
|
|
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-
|
|
100
|
+
"termination_date": "2026-01-01"
|
|
128
101
|
}
|
|
129
102
|
],
|
|
130
103
|
"links": [
|
|
131
104
|
{
|
|
132
|
-
"other_patient_fhir_id": "
|
|
133
|
-
"type": "
|
|
105
|
+
"other_patient_fhir_id": "string",
|
|
106
|
+
"type": "seealso"
|
|
134
107
|
}
|
|
135
108
|
],
|
|
136
|
-
"managing_organization_id": "
|
|
137
|
-
"marital_status": "
|
|
138
|
-
"mrn": "
|
|
109
|
+
"managing_organization_id": "string",
|
|
110
|
+
"marital_status": "single",
|
|
111
|
+
"mrn": "string",
|
|
139
112
|
"name": {
|
|
140
|
-
"first_name": "
|
|
141
|
-
"last_name": "
|
|
142
|
-
"middle_name": "
|
|
143
|
-
"preferred_name": "
|
|
144
|
-
"prefix": "
|
|
145
|
-
"suffix": "
|
|
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": "
|
|
149
|
-
"patient_id": "
|
|
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": "
|
|
163
|
-
"address_state": "
|
|
164
|
-
"address_street1": "
|
|
165
|
-
"address_street2": "
|
|
166
|
-
"address_zip": "
|
|
167
|
-
"fax": "
|
|
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": "
|
|
170
|
-
"ncpdp_id": "
|
|
171
|
-
"notes": "
|
|
172
|
-
"npi": "
|
|
173
|
-
"pharmacy_id": "
|
|
174
|
-
"phone": "
|
|
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
|
-
"
|
|
142
|
+
"american_indian_or_alaska_native"
|
|
178
143
|
],
|
|
179
|
-
"sex_at_birth": "
|
|
180
|
-
"telehealth_id":
|
|
144
|
+
"sex_at_birth": "male",
|
|
145
|
+
"telehealth_id": 0
|
|
181
146
|
}
|
|
182
147
|
```
|
|
183
148
|
|
|
@@ -56,189 +56,157 @@ None declared in canonical OpenAPI.
|
|
|
56
56
|
|
|
57
57
|
```json
|
|
58
58
|
{
|
|
59
|
-
"asOf": "
|
|
59
|
+
"asOf": "string",
|
|
60
60
|
"ok": true,
|
|
61
61
|
"sidebar": {
|
|
62
62
|
"patient": {
|
|
63
63
|
"active": true,
|
|
64
|
-
"addresses": [
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
"country": "US",
|
|
68
|
-
"is_primary": true,
|
|
69
|
-
"state": "CA",
|
|
70
|
-
"street1": "123 Example Street",
|
|
71
|
-
"street2": "Apartment 4B",
|
|
72
|
-
"type": "home",
|
|
73
|
-
"zip_code": "94102"
|
|
74
|
-
}
|
|
75
|
-
],
|
|
64
|
+
"addresses": [],
|
|
65
|
+
"athena_patient_id": "string",
|
|
66
|
+
"athena_practice_id": "string",
|
|
76
67
|
"attributes": {},
|
|
77
68
|
"communications": [
|
|
78
69
|
{
|
|
79
|
-
"language": "
|
|
80
|
-
"preferred":
|
|
70
|
+
"language": "string",
|
|
71
|
+
"preferred": false
|
|
81
72
|
}
|
|
82
73
|
],
|
|
83
74
|
"created_by": "self",
|
|
84
|
-
"created_date": "2026-
|
|
85
|
-
"date_of_birth": "
|
|
75
|
+
"created_date": "2026-01-01T09:00:00Z",
|
|
76
|
+
"date_of_birth": "2026-01-01",
|
|
86
77
|
"deceased": false,
|
|
87
|
-
"deceased_cause":
|
|
88
|
-
"deceased_date":
|
|
89
|
-
"email": "
|
|
90
|
-
"emergency_contacts": [
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
"first_name": "Jamie",
|
|
94
|
-
"is_primary": true,
|
|
95
|
-
"last_name": "Smith",
|
|
96
|
-
"phones": [
|
|
97
|
-
{
|
|
98
|
-
"extension": "101",
|
|
99
|
-
"is_primary": true,
|
|
100
|
-
"number": "+15550100003",
|
|
101
|
-
"sms_enabled": true,
|
|
102
|
-
"type": "mobile"
|
|
103
|
-
}
|
|
104
|
-
],
|
|
105
|
-
"relationship": "Spouse",
|
|
106
|
-
"relationship_v2_code": "SPS"
|
|
107
|
-
}
|
|
108
|
-
],
|
|
109
|
-
"ethnicity": "not_hispanic_or_latino",
|
|
110
|
-
"fhir_id": "patient-example-001",
|
|
78
|
+
"deceased_cause": "string",
|
|
79
|
+
"deceased_date": "2026-01-01",
|
|
80
|
+
"email": "user@example.com",
|
|
81
|
+
"emergency_contacts": [],
|
|
82
|
+
"ethnicity": "hispanic_or_latino",
|
|
83
|
+
"fhir_id": "string",
|
|
111
84
|
"flags": {},
|
|
112
|
-
"gender": "
|
|
85
|
+
"gender": "male",
|
|
113
86
|
"gender_identity": "man",
|
|
114
87
|
"insurance": [
|
|
115
88
|
{
|
|
116
|
-
"copay":
|
|
117
|
-
"deductible":
|
|
89
|
+
"copay": 0,
|
|
90
|
+
"deductible": 0,
|
|
118
91
|
"effective_date": "2026-01-01",
|
|
119
|
-
"group_number": "
|
|
120
|
-
"member_id": "
|
|
121
|
-
"payer_id": "
|
|
122
|
-
"payer_name": "
|
|
123
|
-
"plan_name": "
|
|
124
|
-
"plan_type": "
|
|
92
|
+
"group_number": "string",
|
|
93
|
+
"member_id": "string",
|
|
94
|
+
"payer_id": "string",
|
|
95
|
+
"payer_name": "string",
|
|
96
|
+
"plan_name": "string",
|
|
97
|
+
"plan_type": "string",
|
|
125
98
|
"priority": "primary",
|
|
126
|
-
"subscriber_date_of_birth": "
|
|
127
|
-
"subscriber_first_name": "
|
|
128
|
-
"subscriber_id": "
|
|
129
|
-
"subscriber_last_name": "
|
|
99
|
+
"subscriber_date_of_birth": "2026-01-01",
|
|
100
|
+
"subscriber_first_name": "string",
|
|
101
|
+
"subscriber_id": "string",
|
|
102
|
+
"subscriber_last_name": "string",
|
|
130
103
|
"subscriber_relationship": "self",
|
|
131
|
-
"termination_date": "2026-
|
|
104
|
+
"termination_date": "2026-01-01"
|
|
132
105
|
}
|
|
133
106
|
],
|
|
134
107
|
"links": [
|
|
135
108
|
{
|
|
136
|
-
"other_patient_fhir_id": "
|
|
137
|
-
"type": "
|
|
109
|
+
"other_patient_fhir_id": "string",
|
|
110
|
+
"type": "seealso"
|
|
138
111
|
}
|
|
139
112
|
],
|
|
140
|
-
"managing_organization_id": "
|
|
141
|
-
"marital_status": "
|
|
142
|
-
"mrn": "
|
|
113
|
+
"managing_organization_id": "string",
|
|
114
|
+
"marital_status": "single",
|
|
115
|
+
"mrn": "string",
|
|
143
116
|
"name": {
|
|
144
|
-
"first_name": "
|
|
145
|
-
"last_name": "
|
|
146
|
-
"middle_name": "
|
|
147
|
-
"preferred_name": "
|
|
148
|
-
"prefix": "
|
|
149
|
-
"suffix": "
|
|
117
|
+
"first_name": "string",
|
|
118
|
+
"last_name": "string",
|
|
119
|
+
"middle_name": "string",
|
|
120
|
+
"preferred_name": "string",
|
|
121
|
+
"prefix": "string",
|
|
122
|
+
"suffix": "string",
|
|
150
123
|
"use": "official"
|
|
151
124
|
},
|
|
152
|
-
"nationality": "
|
|
153
|
-
"patient_id": "
|
|
154
|
-
"phones": [
|
|
155
|
-
|
|
156
|
-
"extension": "101",
|
|
157
|
-
"is_primary": true,
|
|
158
|
-
"number": "+15550100000",
|
|
159
|
-
"sms_enabled": true,
|
|
160
|
-
"type": "mobile"
|
|
161
|
-
}
|
|
162
|
-
],
|
|
163
|
-
"photo_binary_id": "photo-example-001",
|
|
125
|
+
"nationality": "st",
|
|
126
|
+
"patient_id": "00000000-0000-0000-0000-000000000000",
|
|
127
|
+
"phones": [],
|
|
128
|
+
"photo_binary_id": "string",
|
|
164
129
|
"preferred_language": "en",
|
|
165
130
|
"preferred_pharmacy": {
|
|
166
|
-
"address_city": "
|
|
167
|
-
"address_state": "
|
|
168
|
-
"address_street1": "
|
|
169
|
-
"address_street2": "
|
|
170
|
-
"address_zip": "
|
|
171
|
-
"fax": "
|
|
131
|
+
"address_city": "string",
|
|
132
|
+
"address_state": "string",
|
|
133
|
+
"address_street1": "string",
|
|
134
|
+
"address_street2": "string",
|
|
135
|
+
"address_zip": "string",
|
|
136
|
+
"fax": "string",
|
|
172
137
|
"is_mail_order": false,
|
|
173
|
-
"name": "
|
|
174
|
-
"ncpdp_id": "
|
|
175
|
-
"notes": "
|
|
176
|
-
"npi": "
|
|
177
|
-
"pharmacy_id": "
|
|
178
|
-
"phone": "
|
|
138
|
+
"name": "string",
|
|
139
|
+
"ncpdp_id": "string",
|
|
140
|
+
"notes": "string",
|
|
141
|
+
"npi": "string",
|
|
142
|
+
"pharmacy_id": "string",
|
|
143
|
+
"phone": "string"
|
|
179
144
|
},
|
|
180
145
|
"race": [
|
|
181
|
-
"
|
|
146
|
+
"american_indian_or_alaska_native"
|
|
182
147
|
],
|
|
183
|
-
"sex_at_birth": "
|
|
148
|
+
"sex_at_birth": "male"
|
|
184
149
|
},
|
|
185
150
|
"recent_encounters": [
|
|
186
151
|
{
|
|
187
|
-
"appointment_id": "
|
|
152
|
+
"appointment_id": "string",
|
|
153
|
+
"athena_appointment_id": "string",
|
|
154
|
+
"athena_encounter_id": "string",
|
|
188
155
|
"created_by": "self",
|
|
189
|
-
"created_date": "2026-
|
|
156
|
+
"created_date": "2026-01-01T09:00:00Z",
|
|
190
157
|
"diagnoses": [
|
|
191
158
|
{
|
|
192
|
-
"condition_display": "
|
|
193
|
-
"condition_id": "
|
|
159
|
+
"condition_display": "string",
|
|
160
|
+
"condition_id": "string",
|
|
194
161
|
"rank": 1,
|
|
195
|
-
"use_code": "
|
|
162
|
+
"use_code": "CC"
|
|
196
163
|
}
|
|
197
164
|
],
|
|
198
165
|
"encounter_class": "AMB",
|
|
199
|
-
"encounter_id": "
|
|
200
|
-
"fhir_id": "
|
|
166
|
+
"encounter_id": "00000000-0000-0000-0000-000000000000",
|
|
167
|
+
"fhir_id": "string",
|
|
201
168
|
"hospitalization": {
|
|
202
|
-
"admit_source_code": "
|
|
203
|
-
"destination_id": "
|
|
169
|
+
"admit_source_code": "string",
|
|
170
|
+
"destination_id": "string",
|
|
204
171
|
"discharge_disposition": "home",
|
|
205
|
-
"origin_id": "
|
|
206
|
-
"pre_admission_id": "
|
|
207
|
-
"re_admission_code": "
|
|
172
|
+
"origin_id": "string",
|
|
173
|
+
"pre_admission_id": "string",
|
|
174
|
+
"re_admission_code": "string"
|
|
208
175
|
},
|
|
209
|
-
"length_minutes":
|
|
176
|
+
"length_minutes": 0,
|
|
210
177
|
"locations": [
|
|
211
178
|
{
|
|
212
|
-
"location_display": "
|
|
213
|
-
"location_id": "
|
|
214
|
-
"period_end": "2026-
|
|
215
|
-
"period_start": "2026-
|
|
216
|
-
"status": "
|
|
179
|
+
"location_display": "string",
|
|
180
|
+
"location_id": "string",
|
|
181
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
182
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
183
|
+
"status": "active"
|
|
217
184
|
}
|
|
218
185
|
],
|
|
186
|
+
"notes": "string",
|
|
219
187
|
"participants": [
|
|
220
188
|
{
|
|
221
|
-
"participant_type": "
|
|
222
|
-
"period_end": "2026-
|
|
223
|
-
"period_start": "2026-
|
|
224
|
-
"practitioner_display": "
|
|
225
|
-
"practitioner_id": "
|
|
189
|
+
"participant_type": "PPRF",
|
|
190
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
191
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
192
|
+
"practitioner_display": "string",
|
|
193
|
+
"practitioner_id": "string"
|
|
226
194
|
}
|
|
227
195
|
],
|
|
228
|
-
"patient_id": "
|
|
229
|
-
"period_end": "2026-
|
|
230
|
-
"period_start": "2026-
|
|
231
|
-
"priority_code": "
|
|
232
|
-
"priority_display": "
|
|
233
|
-
"reason_code": "
|
|
234
|
-
"reason_display": "
|
|
235
|
-
"service_provider_display": "
|
|
236
|
-
"service_provider_id": "
|
|
237
|
-
"service_type_code": "
|
|
238
|
-
"service_type_display": "
|
|
239
|
-
"status": "
|
|
240
|
-
"type_code": "
|
|
241
|
-
"type_display": "
|
|
196
|
+
"patient_id": "string",
|
|
197
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
198
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
199
|
+
"priority_code": "string",
|
|
200
|
+
"priority_display": "string",
|
|
201
|
+
"reason_code": "string",
|
|
202
|
+
"reason_display": "string",
|
|
203
|
+
"service_provider_display": "string",
|
|
204
|
+
"service_provider_id": "string",
|
|
205
|
+
"service_type_code": "string",
|
|
206
|
+
"service_type_display": "string",
|
|
207
|
+
"status": "planned",
|
|
208
|
+
"type_code": "string",
|
|
209
|
+
"type_display": "string"
|
|
242
210
|
}
|
|
243
211
|
]
|
|
244
212
|
}
|
|
@@ -62,64 +62,67 @@ None declared in canonical OpenAPI.
|
|
|
62
62
|
{
|
|
63
63
|
"encounters": [
|
|
64
64
|
{
|
|
65
|
-
"appointment_id": "
|
|
65
|
+
"appointment_id": "string",
|
|
66
|
+
"athena_appointment_id": "string",
|
|
67
|
+
"athena_encounter_id": "string",
|
|
66
68
|
"created_by": "self",
|
|
67
|
-
"created_date": "2026-
|
|
69
|
+
"created_date": "2026-01-01T09:00:00Z",
|
|
68
70
|
"diagnoses": [
|
|
69
71
|
{
|
|
70
|
-
"condition_display": "
|
|
71
|
-
"condition_id": "
|
|
72
|
+
"condition_display": "string",
|
|
73
|
+
"condition_id": "string",
|
|
72
74
|
"rank": 1,
|
|
73
|
-
"use_code": "
|
|
75
|
+
"use_code": "CC"
|
|
74
76
|
}
|
|
75
77
|
],
|
|
76
78
|
"encounter_class": "AMB",
|
|
77
|
-
"encounter_id": "
|
|
78
|
-
"fhir_id": "
|
|
79
|
+
"encounter_id": "00000000-0000-0000-0000-000000000000",
|
|
80
|
+
"fhir_id": "string",
|
|
79
81
|
"hospitalization": {
|
|
80
|
-
"admit_source_code": "
|
|
81
|
-
"destination_id": "
|
|
82
|
+
"admit_source_code": "string",
|
|
83
|
+
"destination_id": "string",
|
|
82
84
|
"discharge_disposition": "home",
|
|
83
|
-
"origin_id": "
|
|
84
|
-
"pre_admission_id": "
|
|
85
|
-
"re_admission_code": "
|
|
85
|
+
"origin_id": "string",
|
|
86
|
+
"pre_admission_id": "string",
|
|
87
|
+
"re_admission_code": "string"
|
|
86
88
|
},
|
|
87
|
-
"length_minutes":
|
|
89
|
+
"length_minutes": 0,
|
|
88
90
|
"locations": [
|
|
89
91
|
{
|
|
90
|
-
"location_display": "
|
|
91
|
-
"location_id": "
|
|
92
|
-
"period_end": "2026-
|
|
93
|
-
"period_start": "2026-
|
|
94
|
-
"status": "
|
|
92
|
+
"location_display": "string",
|
|
93
|
+
"location_id": "string",
|
|
94
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
95
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
96
|
+
"status": "active"
|
|
95
97
|
}
|
|
96
98
|
],
|
|
99
|
+
"notes": "string",
|
|
97
100
|
"participants": [
|
|
98
101
|
{
|
|
99
|
-
"participant_type": "
|
|
100
|
-
"period_end": "2026-
|
|
101
|
-
"period_start": "2026-
|
|
102
|
-
"practitioner_display": "
|
|
103
|
-
"practitioner_id": "
|
|
102
|
+
"participant_type": "PPRF",
|
|
103
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
104
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
105
|
+
"practitioner_display": "string",
|
|
106
|
+
"practitioner_id": "string"
|
|
104
107
|
}
|
|
105
108
|
],
|
|
106
|
-
"patient_id": "
|
|
107
|
-
"period_end": "2026-
|
|
108
|
-
"period_start": "2026-
|
|
109
|
-
"priority_code": "
|
|
110
|
-
"priority_display": "
|
|
111
|
-
"reason_code": "
|
|
112
|
-
"reason_display": "
|
|
113
|
-
"service_provider_display": "
|
|
114
|
-
"service_provider_id": "
|
|
115
|
-
"service_type_code": "
|
|
116
|
-
"service_type_display": "
|
|
117
|
-
"status": "
|
|
118
|
-
"type_code": "
|
|
119
|
-
"type_display": "
|
|
109
|
+
"patient_id": "string",
|
|
110
|
+
"period_end": "2026-01-01T09:00:00Z",
|
|
111
|
+
"period_start": "2026-01-01T09:00:00Z",
|
|
112
|
+
"priority_code": "string",
|
|
113
|
+
"priority_display": "string",
|
|
114
|
+
"reason_code": "string",
|
|
115
|
+
"reason_display": "string",
|
|
116
|
+
"service_provider_display": "string",
|
|
117
|
+
"service_provider_id": "string",
|
|
118
|
+
"service_type_code": "string",
|
|
119
|
+
"service_type_display": "string",
|
|
120
|
+
"status": "planned",
|
|
121
|
+
"type_code": "string",
|
|
122
|
+
"type_display": "string"
|
|
120
123
|
}
|
|
121
124
|
],
|
|
122
|
-
"total":
|
|
125
|
+
"total": 0
|
|
123
126
|
}
|
|
124
127
|
```
|
|
125
128
|
|
package/package.json
CHANGED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# PanelResult
|
|
2
|
-
|
|
3
|
-
Model ID: `PanelResult`
|
|
4
|
-
|
|
5
|
-
A single panel/analyte result within a (possibly multi-panel) test.
|
|
6
|
-
|
|
7
|
-
Type: `object`
|
|
8
|
-
|
|
9
|
-
## Fields
|
|
10
|
-
|
|
11
|
-
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
-
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `interpretation` | `string|null` | No | | | | Yes | Clinical interpretation flag, optional. |
|
|
14
|
-
| `loinc_code` | `string` | Yes | | | | No | LOINC code for this panel/analyte. |
|
|
15
|
-
| `loinc_display` | `string` | Yes | | | | No | Display text for loinc_code. |
|
|
16
|
-
| `panel_name` | `string` | Yes | | | | No | Name of this panel/analyte. |
|
|
17
|
-
| `quantitative_unit` | `string|null` | No | | | | Yes | Unit of measure for quantitative_value, optional. |
|
|
18
|
-
| `quantitative_value` | `number|null` | No | | | | Yes | Numeric result value, for quantitative panels. Requires quantitative_unit. |
|
|
19
|
-
| `result` | `string` | Yes | | | | No | The result value for this panel. |
|
|
20
|
-
| `result_type` | `string` | No | | | `"qualitative"` | No | 'qualitative' or 'quantitative'. Defaults to qualitative. |
|
|
21
|
-
|
|
22
|
-
## Example
|
|
23
|
-
|
|
24
|
-
None declared in canonical OpenAPI.
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# SingleTestResultResponse
|
|
2
|
-
|
|
3
|
-
Model ID: `SingleTestResultResponse`
|
|
4
|
-
|
|
5
|
-
Response for GET /patients/{patient_id}/diagnostics/{test_id}. Supports
|
|
6
|
-
both single-panel and multi-panel tests via the panels list.
|
|
7
|
-
|
|
8
|
-
Type: `object`
|
|
9
|
-
|
|
10
|
-
## Fields
|
|
11
|
-
|
|
12
|
-
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
13
|
-
|---|---|---:|---|---|---|---:|---|
|
|
14
|
-
| `device_name` | `string|null` | No | | | | Yes | CLIA-waived device make/model, optional. |
|
|
15
|
-
| `is_multi_panel` | `boolean` | Yes | | | | No | True if this test reports more than one panel/analyte result. |
|
|
16
|
-
| `lot_number` | `string|null` | No | | | | Yes | Test kit lot number, optional. |
|
|
17
|
-
| `panels` | array of [`PanelResult`](./PanelResult.md) | Yes | | | | No | One or more panel/analyte results for this test. |
|
|
18
|
-
| `patient_id` | `string` | Yes | | | | No | FHIR Patient ID this test result belongs to. |
|
|
19
|
-
| `performed_by` | `string|null` | No | | | | Yes | Name of the person who performed the test, optional. |
|
|
20
|
-
| `performed_datetime` | `string|null` | No | | | | Yes | ISO 8601 datetime the test was performed, optional. |
|
|
21
|
-
| `scan_url` | `string|null` | No | | | | Yes | URL of an uploaded scan image, when one was captured via the scan-upload-url flow. |
|
|
22
|
-
| `status` | `string` | Yes | | | | No | Observation lifecycle status. |
|
|
23
|
-
| `test_id` | `string` | Yes | uuid | | | No | Domain UUID of the test. |
|
|
24
|
-
| `test_type` | `string` | Yes | | | | No | Which test kit was used. |
|
|
25
|
-
|
|
26
|
-
## Example
|
|
27
|
-
|
|
28
|
-
None declared in canonical OpenAPI.
|