@healthcloudai/hc-sdk 3.13.4 → 3.15.1
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 +495 -72
- package/dist/index.d.cts +2342 -1390
- package/dist/index.d.ts +2342 -1390
- package/dist/index.js +495 -72
- package/docs/clients/AthenaHealthClient.md +1 -1
- package/docs/clients/PatientClient.md +11 -0
- package/docs/docs-manifest.json +35 -3
- package/docs/examples/index.md +12 -1
- package/docs/index.md +12 -1
- package/docs/models/AssignImpiloDeviceRequest.md +17 -0
- package/docs/models/AssignImpiloDeviceResponse.md +20 -0
- package/docs/models/AthenaLabResult.md +2 -0
- package/docs/models/CancelTestOrderResponse.md +19 -0
- package/docs/models/CreateDeliveryOrderRequest.md +21 -0
- package/docs/models/DeliveryContact.md +24 -0
- package/docs/models/DeliveryOrder.md +30 -0
- package/docs/models/DeliveryPharmacy.md +25 -0
- package/docs/models/GetDefaultProviderResponse.md +2 -0
- package/docs/models/GetPatientResponse.md +1 -0
- package/docs/models/GetTestOrderResponse.md +44 -0
- package/docs/models/ImpiloDeviceItem.md +23 -0
- package/docs/models/ListDeliveryOrdersResponse.md +19 -0
- package/docs/models/ListImpiloDevicesResponse.md +18 -0
- package/docs/models/ListOrderItemsResponse.md +18 -0
- package/docs/models/ListTestOrdersResponse.md +18 -0
- package/docs/models/OrderItem.md +19 -0
- package/docs/models/OrderPriority.md +15 -0
- package/docs/models/OrderStatus.md +15 -0
- package/docs/models/PatientDemographics.md +1 -0
- package/docs/models/PlaceTestOrderRequest.md +43 -0
- package/docs/models/PlaceTestOrderResponse.md +44 -0
- package/docs/models/Specimen.md +30 -0
- package/docs/models/SpecimenStatus.md +15 -0
- package/docs/models/TestOrder.md +44 -0
- package/docs/models/_InsuranceOcrResult.md +1 -0
- package/docs/models/index.md +21 -0
- package/docs/operations/connectors.athenaAddLabResultDocument.md +2 -2
- package/docs/operations/connectors.athenaGetInsurancePackages.md +1 -1
- package/docs/operations/connectors.athenaGetLabResult.md +2 -0
- package/docs/operations/connectors.athenaListLabResults.md +2 -0
- package/docs/operations/fieldagent.listPatients.md +1 -0
- package/docs/operations/patient.addInsurance.md +48 -16
- package/docs/operations/patient.addPatientIntake.md +12 -1
- package/docs/operations/patient.assignImpiloDevice.md +112 -0
- package/docs/operations/patient.assistantOcrInsurance.md +64 -13
- package/docs/operations/patient.cancelTestOrder.md +152 -0
- package/docs/operations/patient.checkPatientInsuranceEligibility.md +133 -38
- package/docs/operations/patient.createDeliveryOrder.md +171 -0
- package/docs/operations/patient.getDefaultProvider.md +2 -0
- package/docs/operations/patient.getDeliveryOrder.md +156 -0
- package/docs/operations/patient.getPatient.md +1 -0
- package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
- package/docs/operations/patient.getTestOrder.md +194 -0
- package/docs/operations/patient.importImpiloVitals.md +129 -0
- package/docs/operations/patient.listDeliveryOrders.md +156 -0
- package/docs/operations/patient.listImpiloDevices.md +100 -0
- package/docs/operations/patient.listOrderItems.md +129 -0
- package/docs/operations/patient.listTestOrders.md +201 -0
- package/docs/operations/patient.placeTestOrder.md +309 -0
- package/docs/operations/patient.submitPatientIntake.md +17 -3
- package/package.json +1 -1
|
@@ -5,10 +5,12 @@
|
|
|
5
5
|
- [`saveNotification`](../operations/patient.addNotification.md) — Add a notification
|
|
6
6
|
- [`addToIntake`](../operations/patient.addPatientIntake.md) — Add one structured patient intake section
|
|
7
7
|
- [`scanIdentityDocument`](../operations/patient.analyzeIdentityDocument.md) — OCR an identity document
|
|
8
|
+
- [`assignImpiloDevice`](../operations/patient.assignImpiloDevice.md) — Assign Impilo device to patient
|
|
8
9
|
- [`askAssistant`](../operations/patient.assistantChat.md) — Grounded assistant chat
|
|
9
10
|
- [`classifyVoiceCommand`](../operations/patient.assistantClassify.md) — Classify a voice command into an action code
|
|
10
11
|
- [`ocrIdentityDocument`](../operations/patient.assistantOcr.md) — OCR an identity document via vision LLM
|
|
11
12
|
- [`ocrInsuranceDocument`](../operations/patient.assistantOcrInsurance.md) — OCR an insurance card via vision LLM
|
|
13
|
+
- [`cancelTestOrder`](../operations/patient.cancelTestOrder.md) — Cancel a diagnostic test order
|
|
12
14
|
- [`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
15
|
- [`checkInEncounter`](../operations/patient.checkInEncounter.md) — Check in an encounter via the tenant's connected EHR
|
|
14
16
|
- [`checkInsuranceEligibility`](../operations/patient.checkPatientInsuranceEligibility.md) — Check insurance eligibility and benefits
|
|
@@ -26,6 +28,7 @@
|
|
|
26
28
|
- [`upsertMessage`](../operations/patient.commsUpsertMessage.md) — Upsert a message
|
|
27
29
|
- [`upsertPresence`](../operations/patient.commsUpsertPresence.md) — Upsert presence
|
|
28
30
|
- [`connect`](../operations/patient.connect.md) — Health check
|
|
31
|
+
- [`createDeliveryOrder`](../operations/patient.createDeliveryOrder.md) — Order a catalog item for delivery
|
|
29
32
|
- [`createEncounter`](../operations/patient.createEncounter.md) — Create an encounter
|
|
30
33
|
- [`createMedication`](../operations/patient.createMedication.md) — Create a medication order
|
|
31
34
|
- [`createQuestionnaire`](../operations/patient.createQuestionnaire.md) — Create a FHIR Questionnaire
|
|
@@ -40,6 +43,7 @@
|
|
|
40
43
|
- [`getCommunicationConsent`](../operations/patient.getCommunicationConsent.md) — Get SMS/phone contact-preference consent
|
|
41
44
|
- [`getCurrentCareSession`](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md) — Get the current care session
|
|
42
45
|
- [`getDefaultProvider`](../operations/patient.getDefaultProvider.md) — Get the tenant default provider
|
|
46
|
+
- [`getDeliveryOrder`](../operations/patient.getDeliveryOrder.md) — Get delivery order and refresh vendor status
|
|
43
47
|
- [`getEncounter`](../operations/patient.getEncounter.md) — Get an encounter
|
|
44
48
|
- [`listPatientInsurances`](../operations/patient.getInsurance.md) — List insurance coverage
|
|
45
49
|
- [`getLatestEncounter`](../operations/patient.getLatestEncounter.md) — Get the patient's latest open encounter
|
|
@@ -53,20 +57,27 @@
|
|
|
53
57
|
- [`getPatientSidebar`](../operations/patient.getPatientSidebarPatientSidebar.md) — Get the patient sidebar summary
|
|
54
58
|
- [`getPhoto`](../operations/patient.getPhoto.md) — Get a patient photo
|
|
55
59
|
- [`getPreferredPharmacy`](../operations/patient.getPreferredPharmacy.md) — Get preferred pharmacy
|
|
60
|
+
- [`getTestOrder`](../operations/patient.getTestOrder.md) — Get a diagnostic test order
|
|
56
61
|
- [`importActivity`](../operations/patient.importActivity.md) — Import activity
|
|
57
62
|
- [`importCCDA`](../operations/patient.importHealthRecord.md) — Import a health record
|
|
63
|
+
- [`importImpiloVitals`](../operations/patient.importImpiloVitals.md) — Import Impilo RPM vitals
|
|
58
64
|
- [`importVitals`](../operations/patient.importVitals.md) — Import vitals
|
|
59
65
|
- [`initHealthRecordImport`](../operations/patient.initHealthRecordImport.md) — Check health-record import status
|
|
60
66
|
- [`listAssistantActions`](../operations/patient.listActions.md) — List assistant actions
|
|
61
67
|
- [`listActivity`](../operations/patient.listActivity.md) — List activity
|
|
68
|
+
- [`listDeliveryOrders`](../operations/patient.listDeliveryOrders.md) — List the patient's delivery orders
|
|
62
69
|
- [`listDependents`](../operations/patient.listDependents.md) — List dependents
|
|
63
70
|
- [`listEncounters`](../operations/patient.listEncounters.md) — List encounters
|
|
71
|
+
- [`listImpiloDevices`](../operations/patient.listImpiloDevices.md) — List Impilo device types
|
|
64
72
|
- [`listKnowledge`](../operations/patient.listKnowledge.md) — List knowledge-base collections and entries
|
|
65
73
|
- [`listMedications`](../operations/patient.listMedications.md) — List medications
|
|
66
74
|
- [`listNotifications`](../operations/patient.listNotifications.md) — List notifications
|
|
75
|
+
- [`listOrderItems`](../operations/patient.listOrderItems.md) — List order items
|
|
67
76
|
- [`listInsuranceClaims`](../operations/patient.listPatientInsuranceClaims.md) — List claims for the authenticated patient
|
|
77
|
+
- [`listTestOrders`](../operations/patient.listTestOrders.md) — List diagnostic test orders
|
|
68
78
|
- [`nearestLocations`](../operations/patient.nearestLocations.md) — Find nearby healthcare locations
|
|
69
79
|
- [`getPhotoUploadUrl`](../operations/patient.photoUploadUrl.md) — Get a photo upload URL
|
|
80
|
+
- [`placeTestOrder`](../operations/patient.placeTestOrder.md) — Place a diagnostic test order
|
|
70
81
|
- [`searchKnowledge`](../operations/patient.searchKnowledge.md) — Search the knowledge base
|
|
71
82
|
- [`setPreferredPharmacy`](../operations/patient.setPreferredPharmacy.md) — Set preferred pharmacy
|
|
72
83
|
- [`createCurrentScreeningSymptoms`](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) — Submit current symptoms
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:57be1634e8f62479ff0bdf4d75acb90286e23c24965f14d7a9bf8c1ccba52d60",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -85,6 +85,8 @@
|
|
|
85
85
|
"models/AppleIdTokenClaims.md",
|
|
86
86
|
"models/Appointment.md",
|
|
87
87
|
"models/AppointmentStatus.md",
|
|
88
|
+
"models/AssignImpiloDeviceRequest.md",
|
|
89
|
+
"models/AssignImpiloDeviceResponse.md",
|
|
88
90
|
"models/AssistantAction.md",
|
|
89
91
|
"models/AssistantChatRequest.md",
|
|
90
92
|
"models/AssistantChatResponse.md",
|
|
@@ -429,6 +431,7 @@
|
|
|
429
431
|
"models/CalUpdateScheduleRequest.md",
|
|
430
432
|
"models/CalUpdateScheduleResponse.md",
|
|
431
433
|
"models/CancelAppointmentRequest.md",
|
|
434
|
+
"models/CancelTestOrderResponse.md",
|
|
432
435
|
"models/CapturedTestImageResponse.md",
|
|
433
436
|
"models/CareSession.md",
|
|
434
437
|
"models/CarequalityDiscoverPatientRequest.md",
|
|
@@ -493,6 +496,7 @@
|
|
|
493
496
|
"models/ConversationKind.md",
|
|
494
497
|
"models/ConversationRecord.md",
|
|
495
498
|
"models/CreateChannelResponse.md",
|
|
499
|
+
"models/CreateDeliveryOrderRequest.md",
|
|
496
500
|
"models/CreateEncounterRequest.md",
|
|
497
501
|
"models/CreateMedicationRequest.md",
|
|
498
502
|
"models/CreateMedicationResponse.md",
|
|
@@ -511,6 +515,9 @@
|
|
|
511
515
|
"models/DeleteActivityResponse.md",
|
|
512
516
|
"models/DeleteDependentResponse.md",
|
|
513
517
|
"models/DeleteNotificationResponse.md",
|
|
518
|
+
"models/DeliveryContact.md",
|
|
519
|
+
"models/DeliveryOrder.md",
|
|
520
|
+
"models/DeliveryPharmacy.md",
|
|
514
521
|
"models/DemographicsMatch.md",
|
|
515
522
|
"models/DependentResponse.md",
|
|
516
523
|
"models/DiagnosticTest.md",
|
|
@@ -619,6 +626,7 @@
|
|
|
619
626
|
"models/GetPractitionerResponse.md",
|
|
620
627
|
"models/GetPreferredPharmacyResponse.md",
|
|
621
628
|
"models/GetScanUploadUrlRequest.md",
|
|
629
|
+
"models/GetTestOrderResponse.md",
|
|
622
630
|
"models/GetTestResultResponse.md",
|
|
623
631
|
"models/GetVectorDocumentChunksResponse.md",
|
|
624
632
|
"models/GetVitalsResponse.md",
|
|
@@ -1102,6 +1110,7 @@
|
|
|
1102
1110
|
"models/ImpiloCreatePatientRequest.md",
|
|
1103
1111
|
"models/ImpiloCreateProcurementRequest.md",
|
|
1104
1112
|
"models/ImpiloDevice.md",
|
|
1113
|
+
"models/ImpiloDeviceItem.md",
|
|
1105
1114
|
"models/ImpiloDeviceListResponse.md",
|
|
1106
1115
|
"models/ImpiloDeviceValidationResponse.md",
|
|
1107
1116
|
"models/ImpiloDisableReadingsRequest.md",
|
|
@@ -1218,16 +1227,19 @@
|
|
|
1218
1227
|
"models/ListActivityResponse.md",
|
|
1219
1228
|
"models/ListAllergiesResponse.md",
|
|
1220
1229
|
"models/ListConditionsResponse.md",
|
|
1230
|
+
"models/ListDeliveryOrdersResponse.md",
|
|
1221
1231
|
"models/ListDependentsResponse.md",
|
|
1222
1232
|
"models/ListDiagnosticTestsResponse.md",
|
|
1223
1233
|
"models/ListDirectivesResponse.md",
|
|
1224
1234
|
"models/ListFamilyHistoryResponse.md",
|
|
1225
1235
|
"models/ListFunctionalStatusResponse.md",
|
|
1226
1236
|
"models/ListImmunizationsResponse.md",
|
|
1237
|
+
"models/ListImpiloDevicesResponse.md",
|
|
1227
1238
|
"models/ListKnowledgeResponse.md",
|
|
1228
1239
|
"models/ListMedicalConceptsGetResponse.md",
|
|
1229
1240
|
"models/ListNotificationsResponse.md",
|
|
1230
1241
|
"models/ListObservationsResponse.md",
|
|
1242
|
+
"models/ListOrderItemsResponse.md",
|
|
1231
1243
|
"models/ListPatientAppointmentsResponse.md",
|
|
1232
1244
|
"models/ListPatientsResponse.md",
|
|
1233
1245
|
"models/ListPolicyDocumentsResponse.md",
|
|
@@ -1235,6 +1247,7 @@
|
|
|
1235
1247
|
"models/ListQuestionnaireResponsesResponse.md",
|
|
1236
1248
|
"models/ListSlotsResponse.md",
|
|
1237
1249
|
"models/ListSocialHistoryResponse.md",
|
|
1250
|
+
"models/ListTestOrdersResponse.md",
|
|
1238
1251
|
"models/ListVectorCollectionsResponse.md",
|
|
1239
1252
|
"models/ListVitalsResponse.md",
|
|
1240
1253
|
"models/LocationStatus.md",
|
|
@@ -1303,6 +1316,9 @@
|
|
|
1303
1316
|
"models/OpenAIUpdateAssistantRequest.md",
|
|
1304
1317
|
"models/OpenAIUpdateAssistantResponse.md",
|
|
1305
1318
|
"models/OpenLoopVitalsMirrorResult.md",
|
|
1319
|
+
"models/OrderItem.md",
|
|
1320
|
+
"models/OrderPriority.md",
|
|
1321
|
+
"models/OrderStatus.md",
|
|
1306
1322
|
"models/OuraBuildAuthorizationUrlRequest.md",
|
|
1307
1323
|
"models/OuraBuildAuthorizationUrlResponse.md",
|
|
1308
1324
|
"models/OuraDailyActivity.md",
|
|
@@ -1359,6 +1375,8 @@
|
|
|
1359
1375
|
"models/PersonRelationship.md",
|
|
1360
1376
|
"models/Phone.md",
|
|
1361
1377
|
"models/PhoneType.md",
|
|
1378
|
+
"models/PlaceTestOrderRequest.md",
|
|
1379
|
+
"models/PlaceTestOrderResponse.md",
|
|
1362
1380
|
"models/PlaidCreateIdentityVerificationRequest.md",
|
|
1363
1381
|
"models/PlaidGetIdentityVerificationRequest.md",
|
|
1364
1382
|
"models/PlaidIdentityVerification.md",
|
|
@@ -1648,6 +1666,8 @@
|
|
|
1648
1666
|
"models/SexAtBirth.md",
|
|
1649
1667
|
"models/Slot.md",
|
|
1650
1668
|
"models/SlotStatus.md",
|
|
1669
|
+
"models/Specimen.md",
|
|
1670
|
+
"models/SpecimenStatus.md",
|
|
1651
1671
|
"models/SpecimenType.md",
|
|
1652
1672
|
"models/StandardErrorResponse.md",
|
|
1653
1673
|
"models/SteadyMDAddAllergyIntoleranceRequest.md",
|
|
@@ -1759,6 +1779,7 @@
|
|
|
1759
1779
|
"models/SubscriberRelationship.md",
|
|
1760
1780
|
"models/TelehealthToken.md",
|
|
1761
1781
|
"models/TemperatureRoute.md",
|
|
1782
|
+
"models/TestOrder.md",
|
|
1762
1783
|
"models/TwilioGetMessageRequest.md",
|
|
1763
1784
|
"models/TwilioListMessagesRequest.md",
|
|
1764
1785
|
"models/TwilioListMessagesResponse.md",
|
|
@@ -2974,10 +2995,12 @@
|
|
|
2974
2995
|
"operations/patient.addNotification.md",
|
|
2975
2996
|
"operations/patient.addPatientIntake.md",
|
|
2976
2997
|
"operations/patient.analyzeIdentityDocument.md",
|
|
2998
|
+
"operations/patient.assignImpiloDevice.md",
|
|
2977
2999
|
"operations/patient.assistantChat.md",
|
|
2978
3000
|
"operations/patient.assistantClassify.md",
|
|
2979
3001
|
"operations/patient.assistantOcr.md",
|
|
2980
3002
|
"operations/patient.assistantOcrInsurance.md",
|
|
3003
|
+
"operations/patient.cancelTestOrder.md",
|
|
2981
3004
|
"operations/patient.checkEncounter.md",
|
|
2982
3005
|
"operations/patient.checkInEncounter.md",
|
|
2983
3006
|
"operations/patient.checkPatientInsuranceEligibility.md",
|
|
@@ -2996,6 +3019,7 @@
|
|
|
2996
3019
|
"operations/patient.commsUpsertPresence.md",
|
|
2997
3020
|
"operations/patient.confirmResetPassword.md",
|
|
2998
3021
|
"operations/patient.connect.md",
|
|
3022
|
+
"operations/patient.createDeliveryOrder.md",
|
|
2999
3023
|
"operations/patient.createEncounter.md",
|
|
3000
3024
|
"operations/patient.createMedication.md",
|
|
3001
3025
|
"operations/patient.createQuestionnaire.md",
|
|
@@ -3010,6 +3034,7 @@
|
|
|
3010
3034
|
"operations/patient.getCommunicationConsent.md",
|
|
3011
3035
|
"operations/patient.getCurrentCareSessionCareSessionsCurrent.md",
|
|
3012
3036
|
"operations/patient.getDefaultProvider.md",
|
|
3037
|
+
"operations/patient.getDeliveryOrder.md",
|
|
3013
3038
|
"operations/patient.getEncounter.md",
|
|
3014
3039
|
"operations/patient.getInsurance.md",
|
|
3015
3040
|
"operations/patient.getLatestEncounter.md",
|
|
@@ -3023,21 +3048,28 @@
|
|
|
3023
3048
|
"operations/patient.getPatientSidebarPatientSidebar.md",
|
|
3024
3049
|
"operations/patient.getPhoto.md",
|
|
3025
3050
|
"operations/patient.getPreferredPharmacy.md",
|
|
3051
|
+
"operations/patient.getTestOrder.md",
|
|
3026
3052
|
"operations/patient.importActivity.md",
|
|
3027
3053
|
"operations/patient.importHealthRecord.md",
|
|
3054
|
+
"operations/patient.importImpiloVitals.md",
|
|
3028
3055
|
"operations/patient.importVitals.md",
|
|
3029
3056
|
"operations/patient.initHealthRecordImport.md",
|
|
3030
3057
|
"operations/patient.listActions.md",
|
|
3031
3058
|
"operations/patient.listActivity.md",
|
|
3059
|
+
"operations/patient.listDeliveryOrders.md",
|
|
3032
3060
|
"operations/patient.listDependents.md",
|
|
3033
3061
|
"operations/patient.listEncounters.md",
|
|
3062
|
+
"operations/patient.listImpiloDevices.md",
|
|
3034
3063
|
"operations/patient.listKnowledge.md",
|
|
3035
3064
|
"operations/patient.listMedications.md",
|
|
3036
3065
|
"operations/patient.listNotifications.md",
|
|
3066
|
+
"operations/patient.listOrderItems.md",
|
|
3037
3067
|
"operations/patient.listPatientInsuranceClaims.md",
|
|
3068
|
+
"operations/patient.listTestOrders.md",
|
|
3038
3069
|
"operations/patient.login.md",
|
|
3039
3070
|
"operations/patient.nearestLocations.md",
|
|
3040
3071
|
"operations/patient.photoUploadUrl.md",
|
|
3072
|
+
"operations/patient.placeTestOrder.md",
|
|
3041
3073
|
"operations/patient.refreshToken.md",
|
|
3042
3074
|
"operations/patient.register.md",
|
|
3043
3075
|
"operations/patient.resendVerificationCode.md",
|
|
@@ -3108,7 +3140,7 @@
|
|
|
3108
3140
|
"operations/vitals.recordVitals.md"
|
|
3109
3141
|
],
|
|
3110
3142
|
"language": "nodejs",
|
|
3111
|
-
"modelCount":
|
|
3112
|
-
"operationCount":
|
|
3143
|
+
"modelCount": 2047,
|
|
3144
|
+
"operationCount": 1036,
|
|
3113
3145
|
"schemaVersion": 1
|
|
3114
3146
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -15,7 +15,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
15
15
|
- [Exchange code (Apple)](../operations/connectors.appleAuthExchangeCode.md)
|
|
16
16
|
- [Generate client secret (Apple)](../operations/connectors.appleAuthGenerateClientSecret.md)
|
|
17
17
|
- [Add a configured encounter reason](../operations/connectors.athenaAddEncounterReason.md)
|
|
18
|
-
- [
|
|
18
|
+
- [Create a result document, defaulting routing to the tenant provider](../operations/connectors.athenaAddLabResultDocument.md)
|
|
19
19
|
- [Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one](../operations/connectors.athenaAddPreferredPharmacy.md)
|
|
20
20
|
- [Answer health question (athenahealth)](../operations/connectors.athenaAnswerHealthQuestion.md)
|
|
21
21
|
- [Book an open appointment slot (without the telehealth deep link step)](../operations/connectors.athenaBookAppointment.md)
|
|
@@ -895,10 +895,12 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
895
895
|
- [Add a notification](../operations/patient.addNotification.md)
|
|
896
896
|
- [Add one structured patient intake section](../operations/patient.addPatientIntake.md)
|
|
897
897
|
- [OCR an identity document](../operations/patient.analyzeIdentityDocument.md)
|
|
898
|
+
- [Assign Impilo device to patient](../operations/patient.assignImpiloDevice.md)
|
|
898
899
|
- [Grounded assistant chat](../operations/patient.assistantChat.md)
|
|
899
900
|
- [Classify a voice command into an action code](../operations/patient.assistantClassify.md)
|
|
900
901
|
- [OCR an identity document via vision LLM](../operations/patient.assistantOcr.md)
|
|
901
902
|
- [OCR an insurance card via vision LLM](../operations/patient.assistantOcrInsurance.md)
|
|
903
|
+
- [Cancel a diagnostic test order](../operations/patient.cancelTestOrder.md)
|
|
902
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)
|
|
903
905
|
- [Check in an encounter via the tenant's connected EHR](../operations/patient.checkInEncounter.md)
|
|
904
906
|
- [Check insurance eligibility and benefits](../operations/patient.checkPatientInsuranceEligibility.md)
|
|
@@ -917,6 +919,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
917
919
|
- [Upsert presence](../operations/patient.commsUpsertPresence.md)
|
|
918
920
|
- [Confirm a password reset](../operations/patient.confirmResetPassword.md)
|
|
919
921
|
- [Health check](../operations/patient.connect.md)
|
|
922
|
+
- [Order a catalog item for delivery](../operations/patient.createDeliveryOrder.md)
|
|
920
923
|
- [Create an encounter](../operations/patient.createEncounter.md)
|
|
921
924
|
- [Create a medication order](../operations/patient.createMedication.md)
|
|
922
925
|
- [Create a FHIR Questionnaire](../operations/patient.createQuestionnaire.md)
|
|
@@ -931,6 +934,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
931
934
|
- [Get SMS/phone contact-preference consent](../operations/patient.getCommunicationConsent.md)
|
|
932
935
|
- [Get the current care session](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md)
|
|
933
936
|
- [Get the tenant default provider](../operations/patient.getDefaultProvider.md)
|
|
937
|
+
- [Get delivery order and refresh vendor status](../operations/patient.getDeliveryOrder.md)
|
|
934
938
|
- [Get an encounter](../operations/patient.getEncounter.md)
|
|
935
939
|
- [List insurance coverage](../operations/patient.getInsurance.md)
|
|
936
940
|
- [Get the patient's latest open encounter](../operations/patient.getLatestEncounter.md)
|
|
@@ -944,21 +948,28 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
944
948
|
- [Get the patient sidebar summary](../operations/patient.getPatientSidebarPatientSidebar.md)
|
|
945
949
|
- [Get a patient photo](../operations/patient.getPhoto.md)
|
|
946
950
|
- [Get preferred pharmacy](../operations/patient.getPreferredPharmacy.md)
|
|
951
|
+
- [Get a diagnostic test order](../operations/patient.getTestOrder.md)
|
|
947
952
|
- [Import activity](../operations/patient.importActivity.md)
|
|
948
953
|
- [Import a health record](../operations/patient.importHealthRecord.md)
|
|
954
|
+
- [Import Impilo RPM vitals](../operations/patient.importImpiloVitals.md)
|
|
949
955
|
- [Import vitals](../operations/patient.importVitals.md)
|
|
950
956
|
- [Check health-record import status](../operations/patient.initHealthRecordImport.md)
|
|
951
957
|
- [List assistant actions](../operations/patient.listActions.md)
|
|
952
958
|
- [List activity](../operations/patient.listActivity.md)
|
|
959
|
+
- [List the patient's delivery orders](../operations/patient.listDeliveryOrders.md)
|
|
953
960
|
- [List dependents](../operations/patient.listDependents.md)
|
|
954
961
|
- [List encounters](../operations/patient.listEncounters.md)
|
|
962
|
+
- [List Impilo device types](../operations/patient.listImpiloDevices.md)
|
|
955
963
|
- [List knowledge-base collections and entries](../operations/patient.listKnowledge.md)
|
|
956
964
|
- [List medications](../operations/patient.listMedications.md)
|
|
957
965
|
- [List notifications](../operations/patient.listNotifications.md)
|
|
966
|
+
- [List order items](../operations/patient.listOrderItems.md)
|
|
958
967
|
- [List claims for the authenticated patient](../operations/patient.listPatientInsuranceClaims.md)
|
|
968
|
+
- [List diagnostic test orders](../operations/patient.listTestOrders.md)
|
|
959
969
|
- [Log in a patient](../operations/patient.login.md)
|
|
960
970
|
- [Find nearby healthcare locations](../operations/patient.nearestLocations.md)
|
|
961
971
|
- [Get a photo upload URL](../operations/patient.photoUploadUrl.md)
|
|
972
|
+
- [Place a diagnostic test order](../operations/patient.placeTestOrder.md)
|
|
962
973
|
- [Refresh patient access tokens](../operations/patient.refreshToken.md)
|
|
963
974
|
- [Register a new patient](../operations/patient.register.md)
|
|
964
975
|
- [Resend the email verification OTP](../operations/patient.resendVerificationCode.md)
|
package/docs/index.md
CHANGED
|
@@ -23,7 +23,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
23
23
|
- [Exchange code (Apple)](operations/connectors.appleAuthExchangeCode.md) (`connectors.appleAuthExchangeCode`)
|
|
24
24
|
- [Generate client secret (Apple)](operations/connectors.appleAuthGenerateClientSecret.md) (`connectors.appleAuthGenerateClientSecret`)
|
|
25
25
|
- [Add a configured encounter reason](operations/connectors.athenaAddEncounterReason.md) (`connectors.athenaAddEncounterReason`)
|
|
26
|
-
- [
|
|
26
|
+
- [Create a result document, defaulting routing to the tenant provider](operations/connectors.athenaAddLabResultDocument.md) (`connectors.athenaAddLabResultDocument`)
|
|
27
27
|
- [Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one](operations/connectors.athenaAddPreferredPharmacy.md) (`connectors.athenaAddPreferredPharmacy`)
|
|
28
28
|
- [Answer health question (athenahealth)](operations/connectors.athenaAnswerHealthQuestion.md) (`connectors.athenaAnswerHealthQuestion`)
|
|
29
29
|
- [Book an open appointment slot (without the telehealth deep link step)](operations/connectors.athenaBookAppointment.md) (`connectors.athenaBookAppointment`)
|
|
@@ -903,10 +903,12 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
903
903
|
- [Add a notification](operations/patient.addNotification.md) (`patient.addNotification`)
|
|
904
904
|
- [Add one structured patient intake section](operations/patient.addPatientIntake.md) (`patient.addPatientIntake`)
|
|
905
905
|
- [OCR an identity document](operations/patient.analyzeIdentityDocument.md) (`patient.analyzeIdentityDocument`)
|
|
906
|
+
- [Assign Impilo device to patient](operations/patient.assignImpiloDevice.md) (`patient.assignImpiloDevice`)
|
|
906
907
|
- [Grounded assistant chat](operations/patient.assistantChat.md) (`patient.assistantChat`)
|
|
907
908
|
- [Classify a voice command into an action code](operations/patient.assistantClassify.md) (`patient.assistantClassify`)
|
|
908
909
|
- [OCR an identity document via vision LLM](operations/patient.assistantOcr.md) (`patient.assistantOcr`)
|
|
909
910
|
- [OCR an insurance card via vision LLM](operations/patient.assistantOcrInsurance.md) (`patient.assistantOcrInsurance`)
|
|
911
|
+
- [Cancel a diagnostic test order](operations/patient.cancelTestOrder.md) (`patient.cancelTestOrder`)
|
|
910
912
|
- [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`)
|
|
911
913
|
- [Check in an encounter via the tenant's connected EHR](operations/patient.checkInEncounter.md) (`patient.checkInEncounter`)
|
|
912
914
|
- [Check insurance eligibility and benefits](operations/patient.checkPatientInsuranceEligibility.md) (`patient.checkPatientInsuranceEligibility`)
|
|
@@ -925,6 +927,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
925
927
|
- [Upsert presence](operations/patient.commsUpsertPresence.md) (`patient.commsUpsertPresence`)
|
|
926
928
|
- [Confirm a password reset](operations/patient.confirmResetPassword.md) (`patient.confirmResetPassword`)
|
|
927
929
|
- [Health check](operations/patient.connect.md) (`patient.connect`)
|
|
930
|
+
- [Order a catalog item for delivery](operations/patient.createDeliveryOrder.md) (`patient.createDeliveryOrder`)
|
|
928
931
|
- [Create an encounter](operations/patient.createEncounter.md) (`patient.createEncounter`)
|
|
929
932
|
- [Create a medication order](operations/patient.createMedication.md) (`patient.createMedication`)
|
|
930
933
|
- [Create a FHIR Questionnaire](operations/patient.createQuestionnaire.md) (`patient.createQuestionnaire`)
|
|
@@ -939,6 +942,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
939
942
|
- [Get SMS/phone contact-preference consent](operations/patient.getCommunicationConsent.md) (`patient.getCommunicationConsent`)
|
|
940
943
|
- [Get the current care session](operations/patient.getCurrentCareSessionCareSessionsCurrent.md) (`patient.getCurrentCareSessionCareSessionsCurrent`)
|
|
941
944
|
- [Get the tenant default provider](operations/patient.getDefaultProvider.md) (`patient.getDefaultProvider`)
|
|
945
|
+
- [Get delivery order and refresh vendor status](operations/patient.getDeliveryOrder.md) (`patient.getDeliveryOrder`)
|
|
942
946
|
- [Get an encounter](operations/patient.getEncounter.md) (`patient.getEncounter`)
|
|
943
947
|
- [List insurance coverage](operations/patient.getInsurance.md) (`patient.getInsurance`)
|
|
944
948
|
- [Get the patient's latest open encounter](operations/patient.getLatestEncounter.md) (`patient.getLatestEncounter`)
|
|
@@ -952,21 +956,28 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
952
956
|
- [Get the patient sidebar summary](operations/patient.getPatientSidebarPatientSidebar.md) (`patient.getPatientSidebarPatientSidebar`)
|
|
953
957
|
- [Get a patient photo](operations/patient.getPhoto.md) (`patient.getPhoto`)
|
|
954
958
|
- [Get preferred pharmacy](operations/patient.getPreferredPharmacy.md) (`patient.getPreferredPharmacy`)
|
|
959
|
+
- [Get a diagnostic test order](operations/patient.getTestOrder.md) (`patient.getTestOrder`)
|
|
955
960
|
- [Import activity](operations/patient.importActivity.md) (`patient.importActivity`)
|
|
956
961
|
- [Import a health record](operations/patient.importHealthRecord.md) (`patient.importHealthRecord`)
|
|
962
|
+
- [Import Impilo RPM vitals](operations/patient.importImpiloVitals.md) (`patient.importImpiloVitals`)
|
|
957
963
|
- [Import vitals](operations/patient.importVitals.md) (`patient.importVitals`)
|
|
958
964
|
- [Check health-record import status](operations/patient.initHealthRecordImport.md) (`patient.initHealthRecordImport`)
|
|
959
965
|
- [List assistant actions](operations/patient.listActions.md) (`patient.listActions`)
|
|
960
966
|
- [List activity](operations/patient.listActivity.md) (`patient.listActivity`)
|
|
967
|
+
- [List the patient's delivery orders](operations/patient.listDeliveryOrders.md) (`patient.listDeliveryOrders`)
|
|
961
968
|
- [List dependents](operations/patient.listDependents.md) (`patient.listDependents`)
|
|
962
969
|
- [List encounters](operations/patient.listEncounters.md) (`patient.listEncounters`)
|
|
970
|
+
- [List Impilo device types](operations/patient.listImpiloDevices.md) (`patient.listImpiloDevices`)
|
|
963
971
|
- [List knowledge-base collections and entries](operations/patient.listKnowledge.md) (`patient.listKnowledge`)
|
|
964
972
|
- [List medications](operations/patient.listMedications.md) (`patient.listMedications`)
|
|
965
973
|
- [List notifications](operations/patient.listNotifications.md) (`patient.listNotifications`)
|
|
974
|
+
- [List order items](operations/patient.listOrderItems.md) (`patient.listOrderItems`)
|
|
966
975
|
- [List claims for the authenticated patient](operations/patient.listPatientInsuranceClaims.md) (`patient.listPatientInsuranceClaims`)
|
|
976
|
+
- [List diagnostic test orders](operations/patient.listTestOrders.md) (`patient.listTestOrders`)
|
|
967
977
|
- [Log in a patient](operations/patient.login.md) (`patient.login`)
|
|
968
978
|
- [Find nearby healthcare locations](operations/patient.nearestLocations.md) (`patient.nearestLocations`)
|
|
969
979
|
- [Get a photo upload URL](operations/patient.photoUploadUrl.md) (`patient.photoUploadUrl`)
|
|
980
|
+
- [Place a diagnostic test order](operations/patient.placeTestOrder.md) (`patient.placeTestOrder`)
|
|
970
981
|
- [Refresh patient access tokens](operations/patient.refreshToken.md) (`patient.refreshToken`)
|
|
971
982
|
- [Register a new patient](operations/patient.register.md) (`patient.register`)
|
|
972
983
|
- [Resend the email verification OTP](operations/patient.resendVerificationCode.md) (`patient.resendVerificationCode`)
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# AssignImpiloDeviceRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `AssignImpiloDeviceRequest`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `item_id` | `integer` | Yes | | | | No | Impilo item ID of the device type to assign. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AssignImpiloDeviceResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `AssignImpiloDeviceResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `device_id` | `integer|null` | No | | | | Yes | Impilo order ID when the order is placed. |
|
|
14
|
+
| `item_name` | `string|null` | No | | | | Yes | Name of the ordered device type. |
|
|
15
|
+
| `message` | `string|null` | No | | | | Yes | Human-readable detail. |
|
|
16
|
+
| `status` | `string` | Yes | | | | No | Result status: ok or error. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -21,6 +21,8 @@ Type: `object`
|
|
|
21
21
|
| `observations` | `array|null` | No | | | `null` | Yes | |
|
|
22
22
|
| `order_type` | `string|null` | No | | | `null` | Yes | |
|
|
23
23
|
| `priority` | `unknown|null` | No | | | `null` | Yes | |
|
|
24
|
+
| `provider_id` | `string|null` | No | | | `null` | Yes | |
|
|
25
|
+
| `provider_username` | `string|null` | No | | | `null` | Yes | |
|
|
24
26
|
| `result_category` | `string|null` | No | | | `null` | Yes | |
|
|
25
27
|
| `status` | `string|null` | No | | | `null` | Yes | |
|
|
26
28
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CancelTestOrderResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `CancelTestOrderResponse`
|
|
4
|
+
|
|
5
|
+
Response for DELETE /patients/orders/{order_id}.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `cancelled` | `boolean` | Yes | | | | No | Always `true` when the order was cancelled. |
|
|
14
|
+
| `fhir_id` | `string` | Yes | | | | No | FHIR ServiceRequest ID of the cancelled order. |
|
|
15
|
+
| `status` | `string` | Yes | | | | No | Resulting order status; `revoked` once cancelled. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# CreateDeliveryOrderRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `CreateDeliveryOrderRequest`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `dropoff` | [`DeliveryContact`](./DeliveryContact.md) | Yes | | | | No | |
|
|
14
|
+
| `idempotency_key` | `string` | Yes | uuid | | | No | Reuse this UUID when retrying the same purchase. |
|
|
15
|
+
| `order_item_id` | `string` | Yes | uuid | | | No | |
|
|
16
|
+
| `pickup_pharmacy` | [`DeliveryPharmacy`](./DeliveryPharmacy.md) | Yes | | | | No | |
|
|
17
|
+
| `vendor` | `string` | No | | | `"uber"` | No | |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# DeliveryContact
|
|
2
|
+
|
|
3
|
+
Model ID: `DeliveryContact`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `city` | `string` | Yes | | | | No | |
|
|
14
|
+
| `country` | `string` | No | | | `"US"` | No | |
|
|
15
|
+
| `name` | `string` | Yes | | | | No | |
|
|
16
|
+
| `notes` | `string` | No | | | `""` | No | |
|
|
17
|
+
| `phone_number` | `string` | Yes | | | | No | |
|
|
18
|
+
| `state` | `string` | Yes | | | | No | |
|
|
19
|
+
| `street_address` | `string` | Yes | | | | No | |
|
|
20
|
+
| `zip_code` | `string` | Yes | | | | No | |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# DeliveryOrder
|
|
2
|
+
|
|
3
|
+
Model ID: `DeliveryOrder`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `created_at` | `string` | Yes | date-time | | | No | |
|
|
14
|
+
| `delivery_order_id` | `string` | Yes | uuid | | | No | |
|
|
15
|
+
| `fhir_status` | `string` | No | | draft, active, suspended, cancelled, completed, entered-in-error | `"draft"` | No | |
|
|
16
|
+
| `notification_status` | `string` | No | | pending, sending, sent, failed, unknown | `"pending"` | No | |
|
|
17
|
+
| `order_item_id` | `string` | Yes | uuid | | | No | |
|
|
18
|
+
| `order_reference` | `string` | Yes | | | | No | |
|
|
19
|
+
| `pickup_pharmacy` | [`DeliveryPharmacy`](./DeliveryPharmacy.md) | Yes | | | | No | |
|
|
20
|
+
| `resource_type` | `string` | No | | | `"SupplyRequest"` | No | |
|
|
21
|
+
| `status` | `string` | Yes | | processing, dispatching, submitted, failed, submission_unknown | | No | |
|
|
22
|
+
| `tracking_url` | `string|null` | No | | | | Yes | |
|
|
23
|
+
| `updated_at` | `string` | Yes | date-time | | | No | |
|
|
24
|
+
| `vendor` | `string` | Yes | | | | No | |
|
|
25
|
+
| `vendor_order_id` | `string|null` | No | | | | Yes | |
|
|
26
|
+
| `vendor_status` | `string|null` | No | | | | Yes | |
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# DeliveryPharmacy
|
|
2
|
+
|
|
3
|
+
Model ID: `DeliveryPharmacy`
|
|
4
|
+
|
|
5
|
+
Caller-selected pharmacy pickup location and notification recipient.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `city` | `string` | Yes | | | | No | |
|
|
14
|
+
| `country` | `string` | No | | | `"US"` | No | |
|
|
15
|
+
| `email` | `string` | Yes | email | | | No | |
|
|
16
|
+
| `name` | `string` | Yes | | | | No | |
|
|
17
|
+
| `notes` | `string` | No | | | `""` | No | |
|
|
18
|
+
| `phone_number` | `string` | Yes | | | | No | |
|
|
19
|
+
| `state` | `string` | Yes | | | | No | |
|
|
20
|
+
| `street_address` | `string` | Yes | | | | No | |
|
|
21
|
+
| `zip_code` | `string` | Yes | | | | No | |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
None declared in canonical OpenAPI.
|
|
@@ -10,6 +10,8 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `first_name` | `string|null` | No | | | | Yes | Explicit given name, when configured. |
|
|
14
|
+
| `last_name` | `string|null` | No | | | | Yes | Explicit family name, when configured. |
|
|
13
15
|
| `name` | `string` | Yes | | | | No | Provider's full name. |
|
|
14
16
|
| `npi` | `string` | Yes | | | | No | Provider's 10-digit US National Provider Identifier. |
|
|
15
17
|
|
|
@@ -35,6 +35,7 @@ Type: `object`
|
|
|
35
35
|
| `flags` | `object` | No | | | | No | Boolean feature/state flags for this patient |
|
|
36
36
|
| `gender` | [`Gender`](./Gender.md) | Yes | | | | No | Administrative gender: male, female, other, or unknown. |
|
|
37
37
|
| `gender_identity` | [`GenderIdentity`](./GenderIdentity.md) | No | | | | Yes | Gender identity (US Core Patient extension). |
|
|
38
|
+
| `impilo_patient_id` | `string|null` | No | | | | Yes | Impilo patient identifier when this patient is linked to Impilo RPM |
|
|
38
39
|
| `insurance` | array of [`Insurance`](./Insurance.md) | No | | | | No | Patient's insurance coverages, in coordination-of-benefits order. |
|
|
39
40
|
| `links` | array of [`PatientLink`](./PatientLink.md) | No | | | | No | Links to related or duplicate patient records. |
|
|
40
41
|
| `managing_organization_id` | `string|null` | No | | | | Yes | FHIR Organization resource id |
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# GetTestOrderResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `GetTestOrderResponse`
|
|
4
|
+
|
|
5
|
+
Response for GET /patients/orders/{order_id}. Same shape as `TestOrder`.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `athena_encounter_id` | `string|null` | No | | | | Yes | Athena encounter used to create the lab order. |
|
|
14
|
+
| `athena_order_id` | `string|null` | No | | | | Yes | Confirmed Athena lab order identifier, separate from the FHIR ServiceRequest ID. |
|
|
15
|
+
| `athena_order_status` | `string|null` | No | | | | Yes | Athena order state returned on refresh, or created before the first refresh. Creation does not imply submission to an external laboratory. |
|
|
16
|
+
| `authored_on` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `cpt_code` | `string|null` | No | | | | Yes | |
|
|
18
|
+
| `diagnosis_codes` | `array` | No | | | | No | ICD-10 codes |
|
|
19
|
+
| `display` | `string` | Yes | | | | No | Test name, e.g. CBC with Differential |
|
|
20
|
+
| `encounter_id` | `string|null` | No | | | | Yes | |
|
|
21
|
+
| `fasting_required` | `boolean` | No | | | `false` | No | |
|
|
22
|
+
| `fhir_id` | `string|null` | No | | | | Yes | |
|
|
23
|
+
| `intent` | `string` | No | | | `"order"` | No | |
|
|
24
|
+
| `lab_name` | `string|null` | No | | | | Yes | |
|
|
25
|
+
| `loinc_code` | `string|null` | No | | | | Yes | |
|
|
26
|
+
| `notes` | `string|null` | No | | | | Yes | |
|
|
27
|
+
| `occurrence_date` | `string|null` | No | | | | Yes | |
|
|
28
|
+
| `occurrence_datetime` | `string|null` | No | | | | Yes | |
|
|
29
|
+
| `order_id` | `string` | No | | | | No | |
|
|
30
|
+
| `patient_fhir_id` | `string|null` | No | | | | Yes | |
|
|
31
|
+
| `performer_name` | `string|null` | No | | | | Yes | |
|
|
32
|
+
| `priority` | [`OrderPriority`](./OrderPriority.md) | No | | | `"routine"` | No | |
|
|
33
|
+
| `reason` | `string|null` | No | | | | Yes | |
|
|
34
|
+
| `requester_name` | `string|null` | No | | | | Yes | |
|
|
35
|
+
| `requester_npi` | `string|null` | No | | | | Yes | |
|
|
36
|
+
| `requisition_number` | `string|null` | No | | | | Yes | |
|
|
37
|
+
| `snomed_code` | `string|null` | No | | | | Yes | |
|
|
38
|
+
| `specimen` | [`Specimen`](./Specimen.md) | No | | | | Yes | |
|
|
39
|
+
| `standing_order` | `boolean` | No | | | `false` | No | |
|
|
40
|
+
| `status` | [`OrderStatus`](./OrderStatus.md) | No | | | `"active"` | No | |
|
|
41
|
+
|
|
42
|
+
## Example
|
|
43
|
+
|
|
44
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ImpiloDeviceItem
|
|
2
|
+
|
|
3
|
+
Model ID: `ImpiloDeviceItem`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `id` | `integer|null` | No | | | | Yes | Impilo item ID. |
|
|
14
|
+
| `item_class` | `string|null` | No | | | | Yes | Device class (e.g. CELLULAR, BLUETOOTH). |
|
|
15
|
+
| `manufacturer` | `string|null` | No | | | | Yes | Manufacturer name. |
|
|
16
|
+
| `model` | `string|null` | No | | | | Yes | Device model. |
|
|
17
|
+
| `name` | `string|null` | No | | | | Yes | Device name. |
|
|
18
|
+
| `reading_type` | `string|null` | No | | | | Yes | Type of reading the device captures. |
|
|
19
|
+
| `sku` | `string|null` | No | | | | Yes | Stock-keeping unit. |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
None declared in canonical OpenAPI.
|