@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
package/dist/index.js
CHANGED
|
@@ -253,6 +253,14 @@ var AppointmentsClient = class extends BaseServiceClient {
|
|
|
253
253
|
/**
|
|
254
254
|
* Book an appointment for a specific slot.
|
|
255
255
|
* POST /appointments/book
|
|
256
|
+
*
|
|
257
|
+
* On an Athena-integrated tenant the booking is made in Athena only — no
|
|
258
|
+
* local FHIR Appointment is written — and `athena_appointment_id` is
|
|
259
|
+
* **required**: take it from the `athena_appointment_id` of the chosen
|
|
260
|
+
* {@link listSlots} result, or the request is rejected. `slot_id` is still
|
|
261
|
+
* required by the generic pre-check; for Athena slots the same numeric id
|
|
262
|
+
* serves as both, since Athena reuses one id for a slot before and after
|
|
263
|
+
* booking.
|
|
256
264
|
*/
|
|
257
265
|
book(request) {
|
|
258
266
|
return this.send("POST", "/appointments/book", {
|
|
@@ -430,6 +438,109 @@ var EhrClient = class extends BaseServiceClient {
|
|
|
430
438
|
connect() {
|
|
431
439
|
return this.connectService();
|
|
432
440
|
}
|
|
441
|
+
// ─── Clinical Record ─────────────────────────────────────────────────
|
|
442
|
+
/** List a patient's allergies. */
|
|
443
|
+
listAllergies(patientId) {
|
|
444
|
+
return this.send("GET", "/patients/{patient_id}/allergies", {
|
|
445
|
+
pathParams: { patient_id: patientId }
|
|
446
|
+
});
|
|
447
|
+
}
|
|
448
|
+
/** List a patient's conditions. */
|
|
449
|
+
listConditions(patientId, clinicalStatus) {
|
|
450
|
+
return this.send("GET", "/patients/{patient_id}/conditions", {
|
|
451
|
+
pathParams: { patient_id: patientId },
|
|
452
|
+
query: clinicalStatus ? { clinical_status: clinicalStatus } : void 0
|
|
453
|
+
});
|
|
454
|
+
}
|
|
455
|
+
/** List a patient's diagnostic/lab observations. */
|
|
456
|
+
listDiagnostics(patientId, code) {
|
|
457
|
+
return this.send("GET", "/patients/{patient_id}/diagnostics", {
|
|
458
|
+
pathParams: { patient_id: patientId },
|
|
459
|
+
query: code ? { code } : void 0
|
|
460
|
+
});
|
|
461
|
+
}
|
|
462
|
+
/** List a patient's advance directives. */
|
|
463
|
+
listDirectives(patientId) {
|
|
464
|
+
return this.send("GET", "/patients/{patient_id}/directives", {
|
|
465
|
+
pathParams: { patient_id: patientId }
|
|
466
|
+
});
|
|
467
|
+
}
|
|
468
|
+
/** List a patient's encounters. */
|
|
469
|
+
listEncounters(patientId, status) {
|
|
470
|
+
return this.send("GET", "/patients/{patient_id}/encounters", {
|
|
471
|
+
pathParams: { patient_id: patientId },
|
|
472
|
+
query: status ? { status } : void 0
|
|
473
|
+
});
|
|
474
|
+
}
|
|
475
|
+
/** List a patient's family history. */
|
|
476
|
+
listFamilyHistory(patientId) {
|
|
477
|
+
return this.send("GET", "/patients/{patient_id}/family-history", {
|
|
478
|
+
pathParams: { patient_id: patientId }
|
|
479
|
+
});
|
|
480
|
+
}
|
|
481
|
+
/** List a patient's functional-status observations. */
|
|
482
|
+
listFunctionalStatus(patientId) {
|
|
483
|
+
return this.send("GET", "/patients/{patient_id}/functional-status", {
|
|
484
|
+
pathParams: { patient_id: patientId }
|
|
485
|
+
});
|
|
486
|
+
}
|
|
487
|
+
/** List a patient's immunizations. */
|
|
488
|
+
listImmunizations(patientId) {
|
|
489
|
+
return this.send("GET", "/patients/{patient_id}/immunizations", {
|
|
490
|
+
pathParams: { patient_id: patientId }
|
|
491
|
+
});
|
|
492
|
+
}
|
|
493
|
+
/** List a patient's medications. */
|
|
494
|
+
listMedications(patientId, resourceType) {
|
|
495
|
+
return this.send("GET", "/patients/{patient_id}/medications", {
|
|
496
|
+
pathParams: { patient_id: patientId },
|
|
497
|
+
query: resourceType ? { resource_type: resourceType } : void 0
|
|
498
|
+
});
|
|
499
|
+
}
|
|
500
|
+
/** List a patient's observations. */
|
|
501
|
+
listObservations(patientId, category) {
|
|
502
|
+
return this.send("GET", "/patients/{patient_id}/observations", {
|
|
503
|
+
pathParams: { patient_id: patientId },
|
|
504
|
+
query: category ? { category } : void 0
|
|
505
|
+
});
|
|
506
|
+
}
|
|
507
|
+
/** List a patient's procedures. */
|
|
508
|
+
listProcedures(patientId) {
|
|
509
|
+
return this.send("GET", "/patients/{patient_id}/procedures", {
|
|
510
|
+
pathParams: { patient_id: patientId }
|
|
511
|
+
});
|
|
512
|
+
}
|
|
513
|
+
/** List a patient's questionnaire responses. */
|
|
514
|
+
listQuestionnaireResponses(patientId, questionnaireUrl) {
|
|
515
|
+
return this.send("GET", "/patients/{patient_id}/questionnaire-responses", {
|
|
516
|
+
pathParams: { patient_id: patientId },
|
|
517
|
+
query: questionnaireUrl ? { questionnaire_url: questionnaireUrl } : void 0
|
|
518
|
+
});
|
|
519
|
+
}
|
|
520
|
+
/** Get a patient's consolidated health record. */
|
|
521
|
+
getHealthRecord(patientId) {
|
|
522
|
+
return this.send("GET", "/patients/{patient_id}/record", {
|
|
523
|
+
pathParams: { patient_id: patientId }
|
|
524
|
+
});
|
|
525
|
+
}
|
|
526
|
+
/** List a patient's social history. */
|
|
527
|
+
listSocialHistory(patientId) {
|
|
528
|
+
return this.send("GET", "/patients/{patient_id}/social-history", {
|
|
529
|
+
pathParams: { patient_id: patientId }
|
|
530
|
+
});
|
|
531
|
+
}
|
|
532
|
+
/** List a patient's vitals. */
|
|
533
|
+
listVitals(patientId, dateFrom, dateTo, type) {
|
|
534
|
+
const query = dateFrom || dateTo || type ? {
|
|
535
|
+
...dateFrom ? { date_from: dateFrom } : {},
|
|
536
|
+
...dateTo ? { date_to: dateTo } : {},
|
|
537
|
+
...type ? { type } : {}
|
|
538
|
+
} : void 0;
|
|
539
|
+
return this.send("GET", "/patients/{patient_id}/vitals", {
|
|
540
|
+
pathParams: { patient_id: patientId },
|
|
541
|
+
query
|
|
542
|
+
});
|
|
543
|
+
}
|
|
433
544
|
};
|
|
434
545
|
|
|
435
546
|
// src/clients/FieldAgentClient.ts
|
|
@@ -1169,11 +1280,73 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
1169
1280
|
pathParams: { id: encounterId }
|
|
1170
1281
|
});
|
|
1171
1282
|
}
|
|
1283
|
+
/**
|
|
1284
|
+
* Open (or resume) the patient's visit right now — "the patient is here."
|
|
1285
|
+
*
|
|
1286
|
+
* Finds or creates their current open FHIR Encounter. On an Athena-integrated
|
|
1287
|
+
* tenant this additionally books a walk-in appointment for the current
|
|
1288
|
+
* moment, attaches the tenant's default self-pay insurance package, and
|
|
1289
|
+
* checks the patient in — all server-side, so no appointment id is needed.
|
|
1290
|
+
* Use {@link checkInEncounter} instead when you already hold one.
|
|
1291
|
+
*
|
|
1292
|
+
* Resolves with HTTP 200 even when the Athena leg failed: inspect
|
|
1293
|
+
* `athena_encounter_status` (and `athena_insurance_status`) rather than
|
|
1294
|
+
* treating a resolved promise as success. The endpoint retries the
|
|
1295
|
+
* book+check-in pair once on its own, because Athena legitimately rejects a
|
|
1296
|
+
* walk-in whose minute falls outside the provider's schedule template.
|
|
1297
|
+
*
|
|
1298
|
+
* Idempotent: an encounter already linked to Athena is returned as-is and is
|
|
1299
|
+
* never re-booked or re-checked-in.
|
|
1300
|
+
*/
|
|
1301
|
+
checkEncounter(request) {
|
|
1302
|
+
return this.send("POST", "/encounters/check", {
|
|
1303
|
+
body: request
|
|
1304
|
+
});
|
|
1305
|
+
}
|
|
1306
|
+
/**
|
|
1307
|
+
* Check the patient in against an appointment you already have (for example a
|
|
1308
|
+
* future slot booked earlier through `AppointmentsClient.bookAppointment`),
|
|
1309
|
+
* and link the resulting Athena encounter onto the FHIR Encounter.
|
|
1310
|
+
*
|
|
1311
|
+
* Does not create or book an appointment, and does not attach insurance —
|
|
1312
|
+
* use {@link checkEncounter} for the walk-in-now flow.
|
|
1313
|
+
*/
|
|
1314
|
+
checkInEncounter(encounterId, request) {
|
|
1315
|
+
return this.send("POST", "/encounters/{id}/check-in", {
|
|
1316
|
+
pathParams: { id: encounterId },
|
|
1317
|
+
body: request
|
|
1318
|
+
});
|
|
1319
|
+
}
|
|
1320
|
+
/**
|
|
1321
|
+
* Get the patient's latest still-open encounter, or `{ encounter: null }`
|
|
1322
|
+
* when none is open.
|
|
1323
|
+
*
|
|
1324
|
+
* On an Athena-integrated tenant Athena is authoritative: its encounter list
|
|
1325
|
+
* is read directly and matched back onto the local FHIR Encounter by
|
|
1326
|
+
* `athena_encounter_id`. A tenant-level read failure is surfaced as an error
|
|
1327
|
+
* rather than an empty result, so `{ encounter: null }` genuinely means "no
|
|
1328
|
+
* open encounter".
|
|
1329
|
+
*/
|
|
1330
|
+
getLatestEncounter(patientId) {
|
|
1331
|
+
return this.send("GET", "/patients/{patient_id}/encounters/latest", {
|
|
1332
|
+
pathParams: { patient_id: patientId }
|
|
1333
|
+
});
|
|
1334
|
+
}
|
|
1172
1335
|
createQuestionnaire(request) {
|
|
1173
1336
|
return this.send("POST", "/questionnaires", {
|
|
1174
1337
|
body: request
|
|
1175
1338
|
});
|
|
1176
1339
|
}
|
|
1340
|
+
/**
|
|
1341
|
+
* Create a FHIR QuestionnaireResponse, and on an Athena-integrated tenant also
|
|
1342
|
+
* append it as a note on the patient's open Athena encounter.
|
|
1343
|
+
*
|
|
1344
|
+
* The FHIR write always happens; the Athena note is additive and non-fatal, so
|
|
1345
|
+
* its outcome is reported on `athena_questionnaire_status` rather than
|
|
1346
|
+
* rejecting the call. `skipped_no_athena_encounter` means no Athena encounter
|
|
1347
|
+
* is open yet — notes attach to one, which only exists after check-in
|
|
1348
|
+
* ({@link checkEncounter}).
|
|
1349
|
+
*/
|
|
1177
1350
|
createQuestionnaireResponse(questionnaireId, request) {
|
|
1178
1351
|
return this.send("POST", "/questionnaires/{id}/responses", {
|
|
1179
1352
|
pathParams: { id: questionnaireId },
|
|
@@ -1,3 +1,18 @@
|
|
|
1
1
|
# EhrClient
|
|
2
2
|
|
|
3
3
|
- [`connect`](../operations/ehr.connect.md) — Health check
|
|
4
|
+
- [`getHealthRecord`](../operations/ehr.getHealthRecord.md) — Get a patient's consolidated health record
|
|
5
|
+
- [`listAllergies`](../operations/ehr.listAllergies.md) — List a patient's allergies
|
|
6
|
+
- [`listConditions`](../operations/ehr.listConditions.md) — List a patient's conditions
|
|
7
|
+
- [`listDiagnostics`](../operations/ehr.listDiagnostics.md) — List a patient's diagnostic/lab observations
|
|
8
|
+
- [`listDirectives`](../operations/ehr.listDirectives.md) — List a patient's advance directives
|
|
9
|
+
- [`listEncounters`](../operations/ehr.listEncounters.md) — List a patient's encounters
|
|
10
|
+
- [`listFamilyHistory`](../operations/ehr.listFamilyHistory.md) — List a patient's family history
|
|
11
|
+
- [`listFunctionalStatus`](../operations/ehr.listFunctionalStatus.md) — List a patient's functional-status observations
|
|
12
|
+
- [`listImmunizations`](../operations/ehr.listImmunizations.md) — List a patient's immunizations
|
|
13
|
+
- [`listMedications`](../operations/ehr.listMedications.md) — List a patient's medications
|
|
14
|
+
- [`listObservations`](../operations/ehr.listObservations.md) — List a patient's observations
|
|
15
|
+
- [`listProcedures`](../operations/ehr.listProcedures.md) — List a patient's procedures
|
|
16
|
+
- [`listQuestionnaireResponses`](../operations/ehr.listQuestionnaireResponses.md) — List a patient's questionnaire responses
|
|
17
|
+
- [`listSocialHistory`](../operations/ehr.listSocialHistory.md) — List a patient's social history
|
|
18
|
+
- [`listVitals`](../operations/ehr.listVitals.md) — List a patient's vitals
|
|
@@ -9,6 +9,8 @@
|
|
|
9
9
|
- [`ocrIdentityDocument`](../operations/patient.assistantOcr.md) — OCR an identity document via vision LLM
|
|
10
10
|
- [`ocrInsuranceDocument`](../operations/patient.assistantOcrInsurance.md) — OCR an insurance card via vision LLM
|
|
11
11
|
- [`checkInsuranceEligibility`](../operations/patient.checkEligibility.md) — Check insurance eligibility
|
|
12
|
+
- [`checkEncounter`](../operations/patient.checkEncounter.md) — 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
|
|
13
|
+
- [`checkInEncounter`](../operations/patient.checkInEncounter.md) — Check in an encounter via the tenant's connected EHR
|
|
12
14
|
- [`getCommunicationsState`](../operations/patient.commsGetState.md) — Get the full CareConnect snapshot
|
|
13
15
|
- [`getUnreadCount`](../operations/patient.commsGetUnreadCount.md) — Get unread message count
|
|
14
16
|
- [`listConversations`](../operations/patient.commsListConversations.md) — List conversations
|
|
@@ -37,6 +39,7 @@
|
|
|
37
39
|
- [`getCurrentCareSession`](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md) — Get the current care session
|
|
38
40
|
- [`getEncounter`](../operations/patient.getEncounter.md) — Get an encounter
|
|
39
41
|
- [`listPatientInsurances`](../operations/patient.getInsurance.md) — List insurance coverage
|
|
42
|
+
- [`getLatestEncounter`](../operations/patient.getLatestEncounter.md) — Get the patient's latest open encounter
|
|
40
43
|
- [`getMedication`](../operations/patient.getMedication.md) — Get a medication
|
|
41
44
|
- [`getProfile`](../operations/patient.getPatient.md) — Get the authenticated patient
|
|
42
45
|
- [`getPatientAlerts`](../operations/patient.getPatientAlerts.md) — Get patient dashboard alerts
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:b772c7c5bd9d1be5a63cc8c5eb916027da1e012b56ee858728c88b3ffb6f31b0",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AnthropicClient.md",
|
|
@@ -62,6 +62,12 @@
|
|
|
62
62
|
"models/Address.md",
|
|
63
63
|
"models/AddressType.md",
|
|
64
64
|
"models/AgentDashboardResponse.md",
|
|
65
|
+
"models/Allergy.md",
|
|
66
|
+
"models/AllergyCategory.md",
|
|
67
|
+
"models/AllergyCriticality.md",
|
|
68
|
+
"models/AllergyReaction.md",
|
|
69
|
+
"models/AllergyStatus.md",
|
|
70
|
+
"models/AllergyVerificationStatus.md",
|
|
65
71
|
"models/AnalyzeIdentityDocumentRequest.md",
|
|
66
72
|
"models/AnalyzeIdentityDocumentResponse.md",
|
|
67
73
|
"models/AnthropicContentBlock.md",
|
|
@@ -428,9 +434,12 @@
|
|
|
428
434
|
"models/CarequalityRetrieveDocumentsResponse.md",
|
|
429
435
|
"models/ChatMessageRecord.md",
|
|
430
436
|
"models/CheckEligibilityRequest.md",
|
|
437
|
+
"models/CheckEncounterRequest.md",
|
|
438
|
+
"models/CheckInEncounterRequest.md",
|
|
431
439
|
"models/CmsGetCountyFipsRequest.md",
|
|
432
440
|
"models/CmsSearchHealthPlansRequest.md",
|
|
433
441
|
"models/CmsSearchHealthPlansResponse.md",
|
|
442
|
+
"models/CodedConcept.md",
|
|
434
443
|
"models/CommGroupRecord.md",
|
|
435
444
|
"models/CommsGetStateResponse.md",
|
|
436
445
|
"models/CommsGetUnreadCountResponse.md",
|
|
@@ -543,6 +552,10 @@
|
|
|
543
552
|
"models/Ethnicity.md",
|
|
544
553
|
"models/FaceMatchRequest.md",
|
|
545
554
|
"models/FaceMatchResponse.md",
|
|
555
|
+
"models/FamilyCondition.md",
|
|
556
|
+
"models/FamilyHistoryEntry.md",
|
|
557
|
+
"models/FamilyHistoryStatus.md",
|
|
558
|
+
"models/FamilyRelationship.md",
|
|
546
559
|
"models/FedexCreateShipmentRequest.md",
|
|
547
560
|
"models/FedexDeliveryDetails.md",
|
|
548
561
|
"models/FedexLatestStatusDetail.md",
|
|
@@ -568,7 +581,9 @@
|
|
|
568
581
|
"models/GetDiagnosticTestResponse.md",
|
|
569
582
|
"models/GetDiagnosticTestSystemResponse.md",
|
|
570
583
|
"models/GetEncounterResponse.md",
|
|
584
|
+
"models/GetHealthRecordResponse.md",
|
|
571
585
|
"models/GetInsuranceResponse.md",
|
|
586
|
+
"models/GetLatestEncounterResponse.md",
|
|
572
587
|
"models/GetMedicalConceptAncestorsResponse.md",
|
|
573
588
|
"models/GetMedicalConceptDescendantsResponse.md",
|
|
574
589
|
"models/GetMedicalConceptRelationshipsResponse.md",
|
|
@@ -586,6 +601,7 @@
|
|
|
586
601
|
"models/GetPolicyDocumentResponse.md",
|
|
587
602
|
"models/GetPractitionerResponse.md",
|
|
588
603
|
"models/GetScanUploadUrlRequest.md",
|
|
604
|
+
"models/GetTestResultResponse.md",
|
|
589
605
|
"models/GetVitalsResponse.md",
|
|
590
606
|
"models/GlucoseReading.md",
|
|
591
607
|
"models/GoogleAICandidate.md",
|
|
@@ -1159,6 +1175,7 @@
|
|
|
1159
1175
|
"models/Insurance.md",
|
|
1160
1176
|
"models/InsurancePriority.md",
|
|
1161
1177
|
"models/InterpretationCode.md",
|
|
1178
|
+
"models/IntoleranceType.md",
|
|
1162
1179
|
"models/IntraocularPressure.md",
|
|
1163
1180
|
"models/InviteChannel.md",
|
|
1164
1181
|
"models/InviteRecord.md",
|
|
@@ -1177,15 +1194,26 @@
|
|
|
1177
1194
|
"models/KnowledgeSearchResult.md",
|
|
1178
1195
|
"models/ListActionsResponse.md",
|
|
1179
1196
|
"models/ListActivityResponse.md",
|
|
1197
|
+
"models/ListAllergiesResponse.md",
|
|
1198
|
+
"models/ListConditionsResponse.md",
|
|
1180
1199
|
"models/ListDependentsResponse.md",
|
|
1181
1200
|
"models/ListDiagnosticTestsResponse.md",
|
|
1201
|
+
"models/ListDirectivesResponse.md",
|
|
1202
|
+
"models/ListFamilyHistoryResponse.md",
|
|
1203
|
+
"models/ListFunctionalStatusResponse.md",
|
|
1204
|
+
"models/ListImmunizationsResponse.md",
|
|
1182
1205
|
"models/ListKnowledgeResponse.md",
|
|
1183
1206
|
"models/ListMedicalConceptsGetResponse.md",
|
|
1184
1207
|
"models/ListNotificationsResponse.md",
|
|
1208
|
+
"models/ListObservationsResponse.md",
|
|
1185
1209
|
"models/ListPatientAppointmentsResponse.md",
|
|
1186
1210
|
"models/ListPatientsResponse.md",
|
|
1187
1211
|
"models/ListPolicyDocumentsResponse.md",
|
|
1212
|
+
"models/ListProceduresResponse.md",
|
|
1213
|
+
"models/ListQuestionnaireResponsesResponse.md",
|
|
1188
1214
|
"models/ListSlotsResponse.md",
|
|
1215
|
+
"models/ListSocialHistoryResponse.md",
|
|
1216
|
+
"models/ListVitalsResponse.md",
|
|
1189
1217
|
"models/LocationStatus.md",
|
|
1190
1218
|
"models/MaritalStatus.md",
|
|
1191
1219
|
"models/McpFieldagentRequest.md",
|
|
@@ -1291,7 +1319,6 @@
|
|
|
1291
1319
|
"models/OuraWorkout.md",
|
|
1292
1320
|
"models/PainScale.md",
|
|
1293
1321
|
"models/PainScore.md",
|
|
1294
|
-
"models/PanelResult.md",
|
|
1295
1322
|
"models/ParticipantType.md",
|
|
1296
1323
|
"models/PatientAlertsResponse.md",
|
|
1297
1324
|
"models/PatientDemographics.md",
|
|
@@ -1317,6 +1344,11 @@
|
|
|
1317
1344
|
"models/PreferredPharmacy.md",
|
|
1318
1345
|
"models/PresenceRecord.md",
|
|
1319
1346
|
"models/PresenceStatus.md",
|
|
1347
|
+
"models/Problem.md",
|
|
1348
|
+
"models/ProblemCategory.md",
|
|
1349
|
+
"models/ProblemClinicalStatus.md",
|
|
1350
|
+
"models/ProblemSeverity.md",
|
|
1351
|
+
"models/ProblemVerificationStatus.md",
|
|
1320
1352
|
"models/ProviderAcceptedInsurance.md",
|
|
1321
1353
|
"models/ProviderContactPoint.md",
|
|
1322
1354
|
"models/ProviderEducationCredential.md",
|
|
@@ -1376,13 +1408,18 @@
|
|
|
1376
1408
|
"models/QuestSyncCompendiumsRequest.md",
|
|
1377
1409
|
"models/QuestionItemType.md",
|
|
1378
1410
|
"models/QuestionnaireItemInput.md",
|
|
1411
|
+
"models/QuestionnaireResponse.md",
|
|
1412
|
+
"models/QuestionnaireResponseStatus.md",
|
|
1379
1413
|
"models/Race.md",
|
|
1380
1414
|
"models/RapidTest.md",
|
|
1381
1415
|
"models/RapidTestResult.md",
|
|
1382
1416
|
"models/RapidTestType.md",
|
|
1417
|
+
"models/ReactionSeverity.md",
|
|
1383
1418
|
"models/RecordVitalsResponse.md",
|
|
1384
1419
|
"models/RescheduleAppointmentRequest.md",
|
|
1385
1420
|
"models/RespiratoryRate.md",
|
|
1421
|
+
"models/ResponseAnswer.md",
|
|
1422
|
+
"models/ResponseItem.md",
|
|
1386
1423
|
"models/SalesforceAccount.md",
|
|
1387
1424
|
"models/SalesforceAccountAssets.md",
|
|
1388
1425
|
"models/SalesforceAddress.md",
|
|
@@ -1571,7 +1608,6 @@
|
|
|
1571
1608
|
"models/SendGridTemplate.md",
|
|
1572
1609
|
"models/SetPreferredPharmacyRequest.md",
|
|
1573
1610
|
"models/SexAtBirth.md",
|
|
1574
|
-
"models/SingleTestResultResponse.md",
|
|
1575
1611
|
"models/Slot.md",
|
|
1576
1612
|
"models/SlotStatus.md",
|
|
1577
1613
|
"models/SpecimenType.md",
|
|
@@ -1876,6 +1912,9 @@
|
|
|
1876
1912
|
"models/diagnostics.ListDiagnosticsResponse.md",
|
|
1877
1913
|
"models/diagnostics.ReferenceRange.md",
|
|
1878
1914
|
"models/ehr.ConnectResponse.md",
|
|
1915
|
+
"models/ehr.ListDiagnosticsResponse.md",
|
|
1916
|
+
"models/ehr.ListEncountersResponse.md",
|
|
1917
|
+
"models/ehr.ListMedicationsResponse.md",
|
|
1879
1918
|
"models/fieldagent.ConfirmResetPasswordRequest.md",
|
|
1880
1919
|
"models/fieldagent.ConfirmResetPasswordResponse.md",
|
|
1881
1920
|
"models/fieldagent.ConnectResponse.md",
|
|
@@ -2799,6 +2838,21 @@
|
|
|
2799
2838
|
"operations/diagnostics.listDiagnostics.md",
|
|
2800
2839
|
"operations/diagnostics.lookupTestByGs1.md",
|
|
2801
2840
|
"operations/ehr.connect.md",
|
|
2841
|
+
"operations/ehr.getHealthRecord.md",
|
|
2842
|
+
"operations/ehr.listAllergies.md",
|
|
2843
|
+
"operations/ehr.listConditions.md",
|
|
2844
|
+
"operations/ehr.listDiagnostics.md",
|
|
2845
|
+
"operations/ehr.listDirectives.md",
|
|
2846
|
+
"operations/ehr.listEncounters.md",
|
|
2847
|
+
"operations/ehr.listFamilyHistory.md",
|
|
2848
|
+
"operations/ehr.listFunctionalStatus.md",
|
|
2849
|
+
"operations/ehr.listImmunizations.md",
|
|
2850
|
+
"operations/ehr.listMedications.md",
|
|
2851
|
+
"operations/ehr.listObservations.md",
|
|
2852
|
+
"operations/ehr.listProcedures.md",
|
|
2853
|
+
"operations/ehr.listQuestionnaireResponses.md",
|
|
2854
|
+
"operations/ehr.listSocialHistory.md",
|
|
2855
|
+
"operations/ehr.listVitals.md",
|
|
2802
2856
|
"operations/fieldagent.agentPhotoUploadUrl.md",
|
|
2803
2857
|
"operations/fieldagent.confirmResetPassword.md",
|
|
2804
2858
|
"operations/fieldagent.connect.md",
|
|
@@ -2858,6 +2912,8 @@
|
|
|
2858
2912
|
"operations/patient.assistantOcr.md",
|
|
2859
2913
|
"operations/patient.assistantOcrInsurance.md",
|
|
2860
2914
|
"operations/patient.checkEligibility.md",
|
|
2915
|
+
"operations/patient.checkEncounter.md",
|
|
2916
|
+
"operations/patient.checkInEncounter.md",
|
|
2861
2917
|
"operations/patient.commsGetState.md",
|
|
2862
2918
|
"operations/patient.commsGetUnreadCount.md",
|
|
2863
2919
|
"operations/patient.commsListConversations.md",
|
|
@@ -2887,6 +2943,7 @@
|
|
|
2887
2943
|
"operations/patient.getCurrentCareSessionCareSessionsCurrent.md",
|
|
2888
2944
|
"operations/patient.getEncounter.md",
|
|
2889
2945
|
"operations/patient.getInsurance.md",
|
|
2946
|
+
"operations/patient.getLatestEncounter.md",
|
|
2890
2947
|
"operations/patient.getMedication.md",
|
|
2891
2948
|
"operations/patient.getPatient.md",
|
|
2892
2949
|
"operations/patient.getPatientAlerts.md",
|
|
@@ -2967,7 +3024,7 @@
|
|
|
2967
3024
|
"operations/vitals.recordVitals.md"
|
|
2968
3025
|
],
|
|
2969
3026
|
"language": "nodejs",
|
|
2970
|
-
"modelCount":
|
|
2971
|
-
"operationCount":
|
|
3027
|
+
"modelCount": 1967,
|
|
3028
|
+
"operationCount": 1001,
|
|
2972
3029
|
"schemaVersion": 1
|
|
2973
3030
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -819,6 +819,21 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
819
819
|
- [List lab observations](../operations/diagnostics.listDiagnostics.md)
|
|
820
820
|
- [Look up a test kit from a GS1 barcode](../operations/diagnostics.lookupTestByGs1.md)
|
|
821
821
|
- [Health check](../operations/ehr.connect.md)
|
|
822
|
+
- [Get a patient's consolidated health record](../operations/ehr.getHealthRecord.md)
|
|
823
|
+
- [List a patient's allergies](../operations/ehr.listAllergies.md)
|
|
824
|
+
- [List a patient's conditions](../operations/ehr.listConditions.md)
|
|
825
|
+
- [List a patient's diagnostic/lab observations](../operations/ehr.listDiagnostics.md)
|
|
826
|
+
- [List a patient's advance directives](../operations/ehr.listDirectives.md)
|
|
827
|
+
- [List a patient's encounters](../operations/ehr.listEncounters.md)
|
|
828
|
+
- [List a patient's family history](../operations/ehr.listFamilyHistory.md)
|
|
829
|
+
- [List a patient's functional-status observations](../operations/ehr.listFunctionalStatus.md)
|
|
830
|
+
- [List a patient's immunizations](../operations/ehr.listImmunizations.md)
|
|
831
|
+
- [List a patient's medications](../operations/ehr.listMedications.md)
|
|
832
|
+
- [List a patient's observations](../operations/ehr.listObservations.md)
|
|
833
|
+
- [List a patient's procedures](../operations/ehr.listProcedures.md)
|
|
834
|
+
- [List a patient's questionnaire responses](../operations/ehr.listQuestionnaireResponses.md)
|
|
835
|
+
- [List a patient's social history](../operations/ehr.listSocialHistory.md)
|
|
836
|
+
- [List a patient's vitals](../operations/ehr.listVitals.md)
|
|
822
837
|
- [Get a presigned agent photo upload URL](../operations/fieldagent.agentPhotoUploadUrl.md)
|
|
823
838
|
- [Complete a password reset](../operations/fieldagent.confirmResetPassword.md)
|
|
824
839
|
- [Health check](../operations/fieldagent.connect.md)
|
|
@@ -878,6 +893,8 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
878
893
|
- [OCR an identity document via vision LLM](../operations/patient.assistantOcr.md)
|
|
879
894
|
- [OCR an insurance card via vision LLM](../operations/patient.assistantOcrInsurance.md)
|
|
880
895
|
- [Check insurance eligibility](../operations/patient.checkEligibility.md)
|
|
896
|
+
- [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](../operations/patient.checkEncounter.md)
|
|
897
|
+
- [Check in an encounter via the tenant's connected EHR](../operations/patient.checkInEncounter.md)
|
|
881
898
|
- [Get the full CareConnect snapshot](../operations/patient.commsGetState.md)
|
|
882
899
|
- [Get unread message count](../operations/patient.commsGetUnreadCount.md)
|
|
883
900
|
- [List conversations](../operations/patient.commsListConversations.md)
|
|
@@ -907,6 +924,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
907
924
|
- [Get the current care session](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md)
|
|
908
925
|
- [Get an encounter](../operations/patient.getEncounter.md)
|
|
909
926
|
- [List insurance coverage](../operations/patient.getInsurance.md)
|
|
927
|
+
- [Get the patient's latest open encounter](../operations/patient.getLatestEncounter.md)
|
|
910
928
|
- [Get a medication](../operations/patient.getMedication.md)
|
|
911
929
|
- [Get the authenticated patient](../operations/patient.getPatient.md)
|
|
912
930
|
- [Get patient dashboard alerts](../operations/patient.getPatientAlerts.md)
|
package/docs/index.md
CHANGED
|
@@ -827,6 +827,21 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
827
827
|
- [List lab observations](operations/diagnostics.listDiagnostics.md) (`diagnostics.listDiagnostics`)
|
|
828
828
|
- [Look up a test kit from a GS1 barcode](operations/diagnostics.lookupTestByGs1.md) (`diagnostics.lookupTestByGs1`)
|
|
829
829
|
- [Health check](operations/ehr.connect.md) (`ehr.connect`)
|
|
830
|
+
- [Get a patient's consolidated health record](operations/ehr.getHealthRecord.md) (`ehr.getHealthRecord`)
|
|
831
|
+
- [List a patient's allergies](operations/ehr.listAllergies.md) (`ehr.listAllergies`)
|
|
832
|
+
- [List a patient's conditions](operations/ehr.listConditions.md) (`ehr.listConditions`)
|
|
833
|
+
- [List a patient's diagnostic/lab observations](operations/ehr.listDiagnostics.md) (`ehr.listDiagnostics`)
|
|
834
|
+
- [List a patient's advance directives](operations/ehr.listDirectives.md) (`ehr.listDirectives`)
|
|
835
|
+
- [List a patient's encounters](operations/ehr.listEncounters.md) (`ehr.listEncounters`)
|
|
836
|
+
- [List a patient's family history](operations/ehr.listFamilyHistory.md) (`ehr.listFamilyHistory`)
|
|
837
|
+
- [List a patient's functional-status observations](operations/ehr.listFunctionalStatus.md) (`ehr.listFunctionalStatus`)
|
|
838
|
+
- [List a patient's immunizations](operations/ehr.listImmunizations.md) (`ehr.listImmunizations`)
|
|
839
|
+
- [List a patient's medications](operations/ehr.listMedications.md) (`ehr.listMedications`)
|
|
840
|
+
- [List a patient's observations](operations/ehr.listObservations.md) (`ehr.listObservations`)
|
|
841
|
+
- [List a patient's procedures](operations/ehr.listProcedures.md) (`ehr.listProcedures`)
|
|
842
|
+
- [List a patient's questionnaire responses](operations/ehr.listQuestionnaireResponses.md) (`ehr.listQuestionnaireResponses`)
|
|
843
|
+
- [List a patient's social history](operations/ehr.listSocialHistory.md) (`ehr.listSocialHistory`)
|
|
844
|
+
- [List a patient's vitals](operations/ehr.listVitals.md) (`ehr.listVitals`)
|
|
830
845
|
- [Get a presigned agent photo upload URL](operations/fieldagent.agentPhotoUploadUrl.md) (`fieldagent.agentPhotoUploadUrl`)
|
|
831
846
|
- [Complete a password reset](operations/fieldagent.confirmResetPassword.md) (`fieldagent.confirmResetPassword`)
|
|
832
847
|
- [Health check](operations/fieldagent.connect.md) (`fieldagent.connect`)
|
|
@@ -886,6 +901,8 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
886
901
|
- [OCR an identity document via vision LLM](operations/patient.assistantOcr.md) (`patient.assistantOcr`)
|
|
887
902
|
- [OCR an insurance card via vision LLM](operations/patient.assistantOcrInsurance.md) (`patient.assistantOcrInsurance`)
|
|
888
903
|
- [Check insurance eligibility](operations/patient.checkEligibility.md) (`patient.checkEligibility`)
|
|
904
|
+
- [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](operations/patient.checkEncounter.md) (`patient.checkEncounter`)
|
|
905
|
+
- [Check in an encounter via the tenant's connected EHR](operations/patient.checkInEncounter.md) (`patient.checkInEncounter`)
|
|
889
906
|
- [Get the full CareConnect snapshot](operations/patient.commsGetState.md) (`patient.commsGetState`)
|
|
890
907
|
- [Get unread message count](operations/patient.commsGetUnreadCount.md) (`patient.commsGetUnreadCount`)
|
|
891
908
|
- [List conversations](operations/patient.commsListConversations.md) (`patient.commsListConversations`)
|
|
@@ -915,6 +932,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
915
932
|
- [Get the current care session](operations/patient.getCurrentCareSessionCareSessionsCurrent.md) (`patient.getCurrentCareSessionCareSessionsCurrent`)
|
|
916
933
|
- [Get an encounter](operations/patient.getEncounter.md) (`patient.getEncounter`)
|
|
917
934
|
- [List insurance coverage](operations/patient.getInsurance.md) (`patient.getInsurance`)
|
|
935
|
+
- [Get the patient's latest open encounter](operations/patient.getLatestEncounter.md) (`patient.getLatestEncounter`)
|
|
918
936
|
- [Get a medication](operations/patient.getMedication.md) (`patient.getMedication`)
|
|
919
937
|
- [Get the authenticated patient](operations/patient.getPatient.md) (`patient.getPatient`)
|
|
920
938
|
- [Get patient dashboard alerts](operations/patient.getPatientAlerts.md) (`patient.getPatientAlerts`)
|
|
@@ -11,6 +11,7 @@ Type: `object`
|
|
|
11
11
|
|
|
12
12
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
13
13
|
|---|---|---:|---|---|---|---:|---|
|
|
14
|
+
| `insurance_package_id` | `string|null` | No | | | | Yes | Athena Health insurance package id from Athena's own catalogue. Only used for tenants with the ATHENA integration enabled, where it identifies which Athena package to attach to the mirrored patient. When omitted, a best-effort lookup by payer_name/member_id is attempted. |
|
|
14
15
|
| `member_id` | `string` | Yes | | | | No | Subscriber's member/policy ID with the payer. |
|
|
15
16
|
| `payer_id` | `string|null` | No | | | | Yes | NAIC or payer identifier. |
|
|
16
17
|
| `payer_name` | `string` | Yes | | | | No | Display name of the insurance payer/carrier. |
|
|
@@ -10,6 +10,8 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `athena_insurance_error` | `string|null` | No | | | | Yes | Human-readable reason the Athena mirror failed, when athena_insurance_status is 'failed'. |
|
|
14
|
+
| `athena_insurance_status` | `string|null` | No | | | | Yes | 'linked' if the insurance was also mirrored into Athena, 'failed' otherwise, null if this tenant has no Athena integration configured. |
|
|
13
15
|
| `coverages_created` | `integer` | Yes | | | | No | Number of FHIR Coverage resources created by this request. |
|
|
14
16
|
| `fhir_patient_id` | `string|null` | Yes | | | | Yes | Deprecated alias of `patient_id`, kept for one release as a compatibility grace window. |
|
|
15
17
|
| `patient_id` | `string|null` | Yes | | | | Yes | FHIR Patient resource ID the coverage was added to. |
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Allergy
|
|
2
|
+
|
|
3
|
+
Model ID: `Allergy`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `allergen` | `string` | Yes | | | | No | Substance name (e.g. Penicillin, Peanut, Latex) |
|
|
14
|
+
| `allergen_code` | [`CodedConcept`](./CodedConcept.md) | No | | | `null` | Yes | Coded allergen concept (SNOMED CT), when available. |
|
|
15
|
+
| `allergy_id` | `string` | No | uuid | | | No | HealthCloud allergy identifier (UUID). |
|
|
16
|
+
| `asserted_by` | `string|null` | No | | | `null` | Yes | Patient self-reported or provider name |
|
|
17
|
+
| `asserted_date` | `string|null` | No | | | `null` | Yes | Date the allergy was asserted/recorded, when known. |
|
|
18
|
+
| `category` | [`AllergyCategory`](./AllergyCategory.md) | Yes | | | | No | Allergy category: food, medication, environment, biologic, other, or unknown. |
|
|
19
|
+
| `criticality` | [`AllergyCriticality`](./AllergyCriticality.md) | No | | | `"unable-to-assess"` | No | Clinical criticality: low, high, or unable-to-assess. |
|
|
20
|
+
| `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR AllergyIntolerance resource id, when stored. |
|
|
21
|
+
| `intolerance_type` | [`IntoleranceType`](./IntoleranceType.md) | No | | | `"allergy"` | No | Whether this is an allergy or an intolerance. |
|
|
22
|
+
| `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the allergy, when present. |
|
|
23
|
+
| `onset_date` | `string|null` | No | | | `null` | Yes | Date the allergy first onset, when known. |
|
|
24
|
+
| `reactions` | array of [`AllergyReaction`](./AllergyReaction.md) | No | | | | No | Adverse reactions associated with the allergy. |
|
|
25
|
+
| `resolved_date` | `string|null` | No | | | `null` | Yes | Date the allergy was resolved, when applicable. |
|
|
26
|
+
| `status` | [`AllergyStatus`](./AllergyStatus.md) | No | | | `"active"` | No | Clinical status: active, inactive, resolved, or entered-in-error. |
|
|
27
|
+
| `verification_status` | [`AllergyVerificationStatus`](./AllergyVerificationStatus.md) | No | | | `"confirmed"` | No | Verification status: unconfirmed, presumed, confirmed, refuted, or entered-in-error. |
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# AllergyReaction
|
|
2
|
+
|
|
3
|
+
Model ID: `AllergyReaction`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `manifestation` | `string` | Yes | | | | No | e.g. Hives, Anaphylaxis, Nausea |
|
|
14
|
+
| `manifestation_code` | [`CodedConcept`](./CodedConcept.md) | No | | | `null` | Yes | SNOMED-CT coded manifestation for FHIR |
|
|
15
|
+
| `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the reaction, when present. |
|
|
16
|
+
| `onset` | `string|null` | No | | | `null` | Yes | Date the reaction first occurred, when known. |
|
|
17
|
+
| `severity` | [`ReactionSeverity`](./ReactionSeverity.md) | No | | | `null` | Yes | Severity of the reaction: mild, moderate, severe, or life_threatening. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|