@healthcloudai/hc-sdk 3.25.0 → 3.26.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.
Files changed (35) hide show
  1. package/dist/index.cjs +49 -1
  2. package/dist/index.d.cts +2113 -307
  3. package/dist/index.d.ts +2113 -307
  4. package/dist/index.js +49 -1
  5. package/docs/clients/ProviderClient.md +6 -0
  6. package/docs/docs-manifest.json +24 -3
  7. package/docs/examples/index.md +6 -0
  8. package/docs/index.md +6 -0
  9. package/docs/models/CommunicationConsent.md +24 -0
  10. package/docs/models/Dependent.md +21 -0
  11. package/docs/models/DependentRelationship.md +15 -0
  12. package/docs/models/EncounterMedicationInput.md +29 -0
  13. package/docs/models/EncounterMedicationsResponse.md +19 -0
  14. package/docs/models/LabCatalogItem.md +24 -0
  15. package/docs/models/LabCatalogResponse.md +18 -0
  16. package/docs/models/LabOrder.md +1 -0
  17. package/docs/models/ProviderDriversLicenseSummary.md +19 -0
  18. package/docs/models/ProviderPatientInsuranceResponse.md +19 -0
  19. package/docs/models/ProviderPatientProfile.md +42 -0
  20. package/docs/models/ProviderPatientProfileResponse.md +21 -0
  21. package/docs/models/TelehealthRequest.md +22 -0
  22. package/docs/models/TelehealthRequestInput.md +17 -0
  23. package/docs/models/TelehealthRequestResponse.md +19 -0
  24. package/docs/models/UpdateEncounterMedicationsRequest.md +17 -0
  25. package/docs/models/index.md +15 -0
  26. package/docs/operations/provider.getLabOrder.md +21 -25
  27. package/docs/operations/provider.getPatientInsurance.md +134 -0
  28. package/docs/operations/provider.getPatientProfile.md +188 -0
  29. package/docs/operations/provider.listEncounterMedications.md +142 -0
  30. package/docs/operations/provider.listLabCatalog.md +215 -0
  31. package/docs/operations/provider.listLabOrders.md +24 -27
  32. package/docs/operations/provider.placeLabOrder.md +26 -28
  33. package/docs/operations/provider.requestTelehealthVisit.md +124 -0
  34. package/docs/operations/provider.updateEncounterMedications.md +186 -0
  35. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -3838,7 +3838,10 @@ var ProviderClient = class extends BaseServiceClient {
3838
3838
  placeLabOrder(patientId, request) {
3839
3839
  return this.send("POST", "/patients/{patient_id}/lab-orders", { pathParams: { patient_id: patientId }, body: request });
3840
3840
  }
3841
- /** List a patient's lab orders (GET /patients/{patient_id}/lab-orders), optionally by `status` (submitting, accepted or rejected). */
3841
+ /**
3842
+ * List a patient's lab orders (GET /patients/{patient_id}/lab-orders), optionally by `status` (submitting, accepted or
3843
+ * rejected) and by `encounter_id` (only the orders placed from that encounter).
3844
+ */
3842
3845
  listLabOrders(patientId, filters) {
3843
3846
  return this.send("GET", "/patients/{patient_id}/lab-orders", { pathParams: { patient_id: patientId }, query: filters });
3844
3847
  }
@@ -3850,6 +3853,51 @@ var ProviderClient = class extends BaseServiceClient {
3850
3853
  getLabOrderRequisition(patientId, orderId) {
3851
3854
  return this.send("GET", "/patients/{patient_id}/lab-orders/{order_id}/requisition", { pathParams: { patient_id: patientId, order_id: orderId } });
3852
3855
  }
3856
+ /**
3857
+ * A patient's full profile (GET /patients/{patient_id}/profile): demographics, identifiers, contact details, addresses,
3858
+ * emergency contacts, preferred pharmacy, communication consent, dependents and flags. A driver's license number comes
3859
+ * back as its last four characters. 404 for a patient who is not on the caller's care team and has no encounter with them.
3860
+ */
3861
+ getPatientProfile(patientId) {
3862
+ return this.send("GET", "/patients/{patient_id}/profile", { pathParams: { patient_id: patientId } });
3863
+ }
3864
+ /** A patient's insurance coverages, primary first (GET /patients/{patient_id}/insurance). Same scope as getPatientProfile. */
3865
+ getPatientInsurance(patientId) {
3866
+ return this.send("GET", "/patients/{patient_id}/insurance", { pathParams: { patient_id: patientId } });
3867
+ }
3868
+ /** The medications recorded on an encounter the caller holds (GET /encounters/{id}/medications). */
3869
+ listEncounterMedications(encounterId) {
3870
+ return this.send("GET", "/encounters/{encounter_id}/medications", { pathParams: { encounter_id: encounterId } });
3871
+ }
3872
+ /**
3873
+ * Replace an encounter's medications (PUT /encounters/{id}/medications): add, change or remove up to 25 at once.
3874
+ * Medications left out are removed (kept for audit). Records the plan in the chart; it does not e-prescribe. Only the
3875
+ * assigned provider (403 otherwise), and not once the encounter is signed (409).
3876
+ */
3877
+ updateEncounterMedications(encounterId, request) {
3878
+ return this.send("PUT", "/encounters/{encounter_id}/medications", {
3879
+ pathParams: { encounter_id: encounterId },
3880
+ body: request
3881
+ });
3882
+ }
3883
+ /**
3884
+ * The tests and panels a provider can order (GET /lab-orders/catalog), optionally filtered by `kind` (test or panel)
3885
+ * and `q` (name contains). Use an item's `catalog_item_id` in placeLabOrder.
3886
+ */
3887
+ listLabCatalog(filters) {
3888
+ return this.send("GET", "/lab-orders/catalog", { query: filters });
3889
+ }
3890
+ /**
3891
+ * Ask the patient to schedule a telehealth appointment (POST /encounters/{id}/telehealth-request). Records a proposed
3892
+ * telehealth appointment and sends the patient a generic notice. At most one request per encounter per hour: a repeat
3893
+ * returns the existing request with `created: false`. Only the assigned provider (403), and not once signed (409).
3894
+ */
3895
+ requestTelehealthVisit(encounterId, request) {
3896
+ return this.send("POST", "/encounters/{encounter_id}/telehealth-request", {
3897
+ pathParams: { encounter_id: encounterId },
3898
+ body: request != null ? request : {}
3899
+ });
3900
+ }
3853
3901
  /** Get a patient's consolidated health record (provider tenant scope). */
3854
3902
  getPatientRecord(patientId) {
3855
3903
  return this.send("GET", "/patients/{patient_id}/record", { pathParams: { patient_id: patientId } });
@@ -13,13 +13,17 @@
13
13
  - [`getHomeSummary`](../operations/provider.getHomeSummary.md) — Counts for the provider's home screen
14
14
  - [`getLabOrder`](../operations/provider.getLabOrder.md) — Get one Quest lab order requisition
15
15
  - [`getLabOrderRequisition`](../operations/provider.getLabOrderRequisition.md) — Get the Quest requisition PDF of a lab order
16
+ - [`getPatientInsurance`](../operations/provider.getPatientInsurance.md) — Get a patient's insurance coverage
17
+ - [`getPatientProfile`](../operations/provider.getPatientProfile.md) — Get a patient's full profile
16
18
  - [`getPatientRecord`](../operations/provider.getPatientRecord.md) — Get a patient's consolidated health record (provider tenant scope)
17
19
  - [`getPhoto`](../operations/provider.getPhoto.md) — Get a practitioner photo
18
20
  - [`getPhotoUploadUrl`](../operations/provider.getPhotoUploadUrl.md) — Get a presigned photo upload URL
19
21
  - [`get`](../operations/provider.getPractitioner.md) — Get a practitioner profile
20
22
  - [`getPractitionerLocation`](../operations/provider.getPractitionerLocation.md) — Get one practice location
21
23
  - [`listAppointments`](../operations/provider.listAppointments.md) — List tenant appointments
24
+ - [`listEncounterMedications`](../operations/provider.listEncounterMedications.md) — List the medications recorded on an encounter
22
25
  - [`listEncounters`](../operations/provider.listEncounters.md) — List the caller's own encounters
26
+ - [`listLabCatalog`](../operations/provider.listLabCatalog.md) — List the tests and panels a provider can order
23
27
  - [`listLabOrders`](../operations/provider.listLabOrders.md) — List a tenant patient's Quest lab orders
24
28
  - [`listPatients`](../operations/provider.listPatients.md) — List or search the calling practitioner's patients
25
29
  - [`listPractitionerLocations`](../operations/provider.listPractitionerLocations.md) — List the practitioner's practice locations
@@ -28,6 +32,7 @@
28
32
  - [`placeLabOrder`](../operations/provider.placeLabOrder.md) — Place a Quest lab order for a tenant patient
29
33
  - [`refreshToken`](../operations/provider.refreshToken.md) — Refresh practitioner access tokens
30
34
  - [`register`](../operations/provider.register.md) — Register a practitioner
35
+ - [`requestTelehealthVisit`](../operations/provider.requestTelehealthVisit.md) — Ask the patient to schedule a telehealth appointment
31
36
  - [`resendEmailVerification`](../operations/provider.resendVerificationCode.md) — Resend the email verification OTP
32
37
  - [`resetPassword`](../operations/provider.resetPassword.md) — Start a password reset
33
38
  - [`searchIcd10`](../operations/provider.searchIcd10.md) — Search ICD-10-CM diagnosis codes
@@ -35,6 +40,7 @@
35
40
  - [`signEncounter`](../operations/provider.signEncounter.md) — Sign and complete an encounter
36
41
  - [`updateEncounterClinicalNote`](../operations/provider.updateEncounterClinicalNote.md) — Update encounter notes and assessment
37
42
  - [`updateEncounterDiagnoses`](../operations/provider.updateEncounterDiagnoses.md) — Add, change or remove an encounter's diagnoses
43
+ - [`updateEncounterMedications`](../operations/provider.updateEncounterMedications.md) — Add, change or remove an encounter's medications
38
44
  - [`updateEncounterStatus`](../operations/provider.updateEncounterStatus.md) — Update encounter status
39
45
  - [`updatePhone`](../operations/provider.updatePhone.md) — Update a practitioner's phone number
40
46
  - [`update`](../operations/provider.updatePractitioner.md) — Update a practitioner profile
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:cddd1cb1d808fd8a4c7cb3ec30bbbb6f4bde28c473596110754cb047d49b8914",
2
+ "docsDataContentDigest": "sha256:e95a173c50b6a889818e2a0f518338dd91a28023a4daa1c4d0a9b1b50f223490",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AmsClient.md",
@@ -471,6 +471,7 @@
471
471
  "models/CommsListMessagesResponse.md",
472
472
  "models/CommsListPresenceResponse.md",
473
473
  "models/Communication.md",
474
+ "models/CommunicationConsent.md",
474
475
  "models/CommunicationConsentResponse.md",
475
476
  "models/CompendiumSyncResult.md",
476
477
  "models/ConnectivityResponse.md",
@@ -528,6 +529,8 @@
528
529
  "models/DeliveryOrder.md",
529
530
  "models/DeliveryPharmacy.md",
530
531
  "models/DemographicsMatch.md",
532
+ "models/Dependent.md",
533
+ "models/DependentRelationship.md",
531
534
  "models/DependentResponse.md",
532
535
  "models/DiagnosisInput.md",
533
536
  "models/DiagnosticTest.md",
@@ -586,6 +589,8 @@
586
589
  "models/EncounterClass.md",
587
590
  "models/EncounterClinicalState.md",
588
591
  "models/EncounterEffect.md",
592
+ "models/EncounterMedicationInput.md",
593
+ "models/EncounterMedicationsResponse.md",
589
594
  "models/EncounterOperationError.md",
590
595
  "models/EncounterOperationResponse.md",
591
596
  "models/EncounterSections.md",
@@ -1247,6 +1252,8 @@
1247
1252
  "models/KnowledgeCollection.md",
1248
1253
  "models/KnowledgeEntrySummary.md",
1249
1254
  "models/KnowledgeSearchResult.md",
1255
+ "models/LabCatalogItem.md",
1256
+ "models/LabCatalogResponse.md",
1250
1257
  "models/LabOrder.md",
1251
1258
  "models/LabOrderDiagnosis.md",
1252
1259
  "models/LabOrderErrorResponse.md",
@@ -1445,6 +1452,7 @@
1445
1452
  "models/ProviderAppointmentsResponse.md",
1446
1453
  "models/ProviderContactPoint.md",
1447
1454
  "models/ProviderCredential.md",
1455
+ "models/ProviderDriversLicenseSummary.md",
1448
1456
  "models/ProviderEducationCredential.md",
1449
1457
  "models/ProviderEncounterListResponse.md",
1450
1458
  "models/ProviderEncounterQueueResponse.md",
@@ -1465,8 +1473,11 @@
1465
1473
  "models/ProviderLocationRequest.md",
1466
1474
  "models/ProviderOnboardingStatus.md",
1467
1475
  "models/ProviderPatientAddress.md",
1476
+ "models/ProviderPatientInsuranceResponse.md",
1468
1477
  "models/ProviderPatientListResponse.md",
1469
1478
  "models/ProviderPatientPhone.md",
1479
+ "models/ProviderPatientProfile.md",
1480
+ "models/ProviderPatientProfileResponse.md",
1470
1481
  "models/ProviderPatientRecordResources.md",
1471
1482
  "models/ProviderPatientRecordResponse.md",
1472
1483
  "models/ProviderPatientResponse.md",
@@ -1850,6 +1861,9 @@
1850
1861
  "models/SubscriberRelationship.md",
1851
1862
  "models/SubstanceStatus.md",
1852
1863
  "models/SubstanceUse.md",
1864
+ "models/TelehealthRequest.md",
1865
+ "models/TelehealthRequestInput.md",
1866
+ "models/TelehealthRequestResponse.md",
1853
1867
  "models/TelehealthToken.md",
1854
1868
  "models/TemperatureRoute.md",
1855
1869
  "models/TestOrder.md",
@@ -1888,6 +1902,7 @@
1888
1902
  "models/UpdateEncounterClinicalNoteResponse.md",
1889
1903
  "models/UpdateEncounterDiagnosesRequest.md",
1890
1904
  "models/UpdateEncounterDiagnosesResponse.md",
1905
+ "models/UpdateEncounterMedicationsRequest.md",
1891
1906
  "models/UpdateEncounterStatusRequest.md",
1892
1907
  "models/UpdateEncounterStatusResponse.md",
1893
1908
  "models/UpdateMedicationRequest.md",
@@ -3253,13 +3268,17 @@
3253
3268
  "operations/provider.getHomeSummary.md",
3254
3269
  "operations/provider.getLabOrder.md",
3255
3270
  "operations/provider.getLabOrderRequisition.md",
3271
+ "operations/provider.getPatientInsurance.md",
3272
+ "operations/provider.getPatientProfile.md",
3256
3273
  "operations/provider.getPatientRecord.md",
3257
3274
  "operations/provider.getPhoto.md",
3258
3275
  "operations/provider.getPhotoUploadUrl.md",
3259
3276
  "operations/provider.getPractitioner.md",
3260
3277
  "operations/provider.getPractitionerLocation.md",
3261
3278
  "operations/provider.listAppointments.md",
3279
+ "operations/provider.listEncounterMedications.md",
3262
3280
  "operations/provider.listEncounters.md",
3281
+ "operations/provider.listLabCatalog.md",
3263
3282
  "operations/provider.listLabOrders.md",
3264
3283
  "operations/provider.listPatients.md",
3265
3284
  "operations/provider.listPractitionerLocations.md",
@@ -3268,6 +3287,7 @@
3268
3287
  "operations/provider.placeLabOrder.md",
3269
3288
  "operations/provider.refreshToken.md",
3270
3289
  "operations/provider.register.md",
3290
+ "operations/provider.requestTelehealthVisit.md",
3271
3291
  "operations/provider.resendVerificationCode.md",
3272
3292
  "operations/provider.resetPassword.md",
3273
3293
  "operations/provider.searchIcd10.md",
@@ -3275,6 +3295,7 @@
3275
3295
  "operations/provider.signEncounter.md",
3276
3296
  "operations/provider.updateEncounterClinicalNote.md",
3277
3297
  "operations/provider.updateEncounterDiagnoses.md",
3298
+ "operations/provider.updateEncounterMedications.md",
3278
3299
  "operations/provider.updateEncounterStatus.md",
3279
3300
  "operations/provider.updatePhone.md",
3280
3301
  "operations/provider.updatePractitioner.md",
@@ -3294,7 +3315,7 @@
3294
3315
  "operations/vitals.recordVitals.md"
3295
3316
  ],
3296
3317
  "language": "nodejs",
3297
- "modelCount": 2170,
3298
- "operationCount": 1067,
3318
+ "modelCount": 2185,
3319
+ "operationCount": 1073,
3299
3320
  "schemaVersion": 1
3300
3321
  }
@@ -1030,13 +1030,17 @@ Generated call examples use exact public surface signatures. Workflow examples r
1030
1030
  - [Counts for the provider's home screen](../operations/provider.getHomeSummary.md)
1031
1031
  - [Get one Quest lab order requisition](../operations/provider.getLabOrder.md)
1032
1032
  - [Get the Quest requisition PDF of a lab order](../operations/provider.getLabOrderRequisition.md)
1033
+ - [Get a patient's insurance coverage](../operations/provider.getPatientInsurance.md)
1034
+ - [Get a patient's full profile](../operations/provider.getPatientProfile.md)
1033
1035
  - [Get a patient's consolidated health record (provider tenant scope)](../operations/provider.getPatientRecord.md)
1034
1036
  - [Get a practitioner photo](../operations/provider.getPhoto.md)
1035
1037
  - [Get a presigned photo upload URL](../operations/provider.getPhotoUploadUrl.md)
1036
1038
  - [Get a practitioner profile](../operations/provider.getPractitioner.md)
1037
1039
  - [Get one practice location](../operations/provider.getPractitionerLocation.md)
1038
1040
  - [List tenant appointments](../operations/provider.listAppointments.md)
1041
+ - [List the medications recorded on an encounter](../operations/provider.listEncounterMedications.md)
1039
1042
  - [List the caller's own encounters](../operations/provider.listEncounters.md)
1043
+ - [List the tests and panels a provider can order](../operations/provider.listLabCatalog.md)
1040
1044
  - [List a tenant patient's Quest lab orders](../operations/provider.listLabOrders.md)
1041
1045
  - [List or search the calling practitioner's patients](../operations/provider.listPatients.md)
1042
1046
  - [List the practitioner's practice locations](../operations/provider.listPractitionerLocations.md)
@@ -1045,6 +1049,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
1045
1049
  - [Place a Quest lab order for a tenant patient](../operations/provider.placeLabOrder.md)
1046
1050
  - [Refresh practitioner access tokens](../operations/provider.refreshToken.md)
1047
1051
  - [Register a practitioner](../operations/provider.register.md)
1052
+ - [Ask the patient to schedule a telehealth appointment](../operations/provider.requestTelehealthVisit.md)
1048
1053
  - [Resend the email verification OTP](../operations/provider.resendVerificationCode.md)
1049
1054
  - [Start a password reset](../operations/provider.resetPassword.md)
1050
1055
  - [Search ICD-10-CM diagnosis codes](../operations/provider.searchIcd10.md)
@@ -1052,6 +1057,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
1052
1057
  - [Sign and complete an encounter](../operations/provider.signEncounter.md)
1053
1058
  - [Update encounter notes and assessment](../operations/provider.updateEncounterClinicalNote.md)
1054
1059
  - [Add, change or remove an encounter's diagnoses](../operations/provider.updateEncounterDiagnoses.md)
1060
+ - [Add, change or remove an encounter's medications](../operations/provider.updateEncounterMedications.md)
1055
1061
  - [Update encounter status](../operations/provider.updateEncounterStatus.md)
1056
1062
  - [Update a practitioner's phone number](../operations/provider.updatePhone.md)
1057
1063
  - [Update a practitioner profile](../operations/provider.updatePractitioner.md)
package/docs/index.md CHANGED
@@ -1038,13 +1038,17 @@ This directory is generated from the shared structured docs data. Do not edit ge
1038
1038
  - [Counts for the provider's home screen](operations/provider.getHomeSummary.md) (`provider.getHomeSummary`)
1039
1039
  - [Get one Quest lab order requisition](operations/provider.getLabOrder.md) (`provider.getLabOrder`)
1040
1040
  - [Get the Quest requisition PDF of a lab order](operations/provider.getLabOrderRequisition.md) (`provider.getLabOrderRequisition`)
1041
+ - [Get a patient's insurance coverage](operations/provider.getPatientInsurance.md) (`provider.getPatientInsurance`)
1042
+ - [Get a patient's full profile](operations/provider.getPatientProfile.md) (`provider.getPatientProfile`)
1041
1043
  - [Get a patient's consolidated health record (provider tenant scope)](operations/provider.getPatientRecord.md) (`provider.getPatientRecord`)
1042
1044
  - [Get a practitioner photo](operations/provider.getPhoto.md) (`provider.getPhoto`)
1043
1045
  - [Get a presigned photo upload URL](operations/provider.getPhotoUploadUrl.md) (`provider.getPhotoUploadUrl`)
1044
1046
  - [Get a practitioner profile](operations/provider.getPractitioner.md) (`provider.getPractitioner`)
1045
1047
  - [Get one practice location](operations/provider.getPractitionerLocation.md) (`provider.getPractitionerLocation`)
1046
1048
  - [List tenant appointments](operations/provider.listAppointments.md) (`provider.listAppointments`)
1049
+ - [List the medications recorded on an encounter](operations/provider.listEncounterMedications.md) (`provider.listEncounterMedications`)
1047
1050
  - [List the caller's own encounters](operations/provider.listEncounters.md) (`provider.listEncounters`)
1051
+ - [List the tests and panels a provider can order](operations/provider.listLabCatalog.md) (`provider.listLabCatalog`)
1048
1052
  - [List a tenant patient's Quest lab orders](operations/provider.listLabOrders.md) (`provider.listLabOrders`)
1049
1053
  - [List or search the calling practitioner's patients](operations/provider.listPatients.md) (`provider.listPatients`)
1050
1054
  - [List the practitioner's practice locations](operations/provider.listPractitionerLocations.md) (`provider.listPractitionerLocations`)
@@ -1053,6 +1057,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
1053
1057
  - [Place a Quest lab order for a tenant patient](operations/provider.placeLabOrder.md) (`provider.placeLabOrder`)
1054
1058
  - [Refresh practitioner access tokens](operations/provider.refreshToken.md) (`provider.refreshToken`)
1055
1059
  - [Register a practitioner](operations/provider.register.md) (`provider.register`)
1060
+ - [Ask the patient to schedule a telehealth appointment](operations/provider.requestTelehealthVisit.md) (`provider.requestTelehealthVisit`)
1056
1061
  - [Resend the email verification OTP](operations/provider.resendVerificationCode.md) (`provider.resendVerificationCode`)
1057
1062
  - [Start a password reset](operations/provider.resetPassword.md) (`provider.resetPassword`)
1058
1063
  - [Search ICD-10-CM diagnosis codes](operations/provider.searchIcd10.md) (`provider.searchIcd10`)
@@ -1060,6 +1065,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
1060
1065
  - [Sign and complete an encounter](operations/provider.signEncounter.md) (`provider.signEncounter`)
1061
1066
  - [Update encounter notes and assessment](operations/provider.updateEncounterClinicalNote.md) (`provider.updateEncounterClinicalNote`)
1062
1067
  - [Add, change or remove an encounter's diagnoses](operations/provider.updateEncounterDiagnoses.md) (`provider.updateEncounterDiagnoses`)
1068
+ - [Add, change or remove an encounter's medications](operations/provider.updateEncounterMedications.md) (`provider.updateEncounterMedications`)
1063
1069
  - [Update encounter status](operations/provider.updateEncounterStatus.md) (`provider.updateEncounterStatus`)
1064
1070
  - [Update a practitioner's phone number](operations/provider.updatePhone.md) (`provider.updatePhone`)
1065
1071
  - [Update a practitioner profile](operations/provider.updatePractitioner.md) (`provider.updatePractitioner`)
@@ -0,0 +1,24 @@
1
+ # CommunicationConsent
2
+
3
+ Model ID: `CommunicationConsent`
4
+
5
+ HC transport shape for the patient's SMS/phone contact-preference Consent.
6
+
7
+ ``sms_permitted``/``phone_permitted`` are independent: either may be
8
+ ``None`` ("not yet recorded"), and recording one never implies a value
9
+ for the other.
10
+
11
+ Type: `object`
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
16
+ |---|---|---:|---|---|---|---:|---|
17
+ | `effective_date` | `string|null` | No | | | | Yes | Date the consent was last recorded. |
18
+ | `id` | `string|null` | No | | | | Yes | Consent identifier (FHIR Consent id), when stored. |
19
+ | `phone_permitted` | `boolean|null` | No | | | | Yes | Patient's phone-call contact consent, when recorded. |
20
+ | `sms_permitted` | `boolean|null` | No | | | | Yes | Patient's SMS contact consent, when recorded. |
21
+
22
+ ## Example
23
+
24
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # Dependent
2
+
3
+ Model ID: `Dependent`
4
+
5
+ HC transport shape for a FHIR RelatedPerson dependent.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `dob` | `string|null` | No | | | | Yes | |
14
+ | `first_name` | `string` | Yes | | | | No | |
15
+ | `id` | `string|null` | No | | | | Yes | |
16
+ | `last_name` | `string` | Yes | | | | No | |
17
+ | `relationship` | [`DependentRelationship`](./DependentRelationship.md) | No | | | | Yes | |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # DependentRelationship
2
+
3
+ Model ID: `DependentRelationship`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,29 @@
1
+ # EncounterMedicationInput
2
+
3
+ Model ID: `EncounterMedicationInput`
4
+
5
+ One medication to record on an encounter.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `dose_unit` | `string` | Yes | | | | No | mg, mcg, mL, units, puffs, drops... |
14
+ | `dose_value` | `number` | Yes | | | | No | Dose per administration. |
15
+ | `end_date` | `string|null` | No | | | | Yes | |
16
+ | `frequency` | `string` | Yes | | once, once_daily, twice_daily, three_times_daily, four_times_daily, every_4_hours, every_6_hours, every_8_hours, every_12_hours, every_48_hours, weekly, biweekly, monthly, as_needed, other | | No | |
17
+ | `frequency_details` | `string|null` | No | | | | Yes | |
18
+ | `indication` | `string|null` | No | | | | Yes | |
19
+ | `instructions` | `string|null` | No | | | | Yes | |
20
+ | `name` | `string` | Yes | | | | No | Medication name (free text is allowed). |
21
+ | `notes` | `string|null` | No | | | | Yes | |
22
+ | `route` | `string|null` | No | | | | Yes | oral (default), intravenous, intramuscular, topical, inhaled, ... |
23
+ | `rxnorm_code` | `string|null` | No | | | | Yes | RxNorm code (digits), when known. |
24
+ | `start_date` | `string|null` | No | | | | Yes | |
25
+ | `status` | `string|null` | No | | | | Yes | Defaults to active. |
26
+
27
+ ## Example
28
+
29
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # EncounterMedicationsResponse
2
+
3
+ Model ID: `EncounterMedicationsResponse`
4
+
5
+ The medications recorded on an encounter.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `encounter_id` | `string` | Yes | | | | No | |
14
+ | `medications` | array of [`provider.Medication`](./provider.Medication.md) | Yes | | | | No | |
15
+ | `total` | `integer` | Yes | | | | No | |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,24 @@
1
+ # LabCatalogItem
2
+
3
+ Model ID: `LabCatalogItem`
4
+
5
+ A test or panel a provider can order.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `catalog_item_id` | `string` | Yes | | | | No | Use this as items[].catalog_item_id when placing a lab order. |
14
+ | `collection_modality` | `string|null` | No | | | | Yes | psc, home_kit, clinician_collected, ... |
15
+ | `description` | `string|null` | No | | | | Yes | |
16
+ | `kind` | `string` | Yes | | test, panel | | No | |
17
+ | `loinc_codes` | `array` | No | | | | No | |
18
+ | `name` | `string` | Yes | | | | No | |
19
+ | `short_name` | `string|null` | No | | | | Yes | |
20
+ | `vendor` | `string|null` | No | | | | Yes | |
21
+
22
+ ## Example
23
+
24
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # LabCatalogResponse
2
+
3
+ Model ID: `LabCatalogResponse`
4
+
5
+ GET /lab-orders/catalog.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `items` | array of [`LabCatalogItem`](./LabCatalogItem.md) | Yes | | | | No | |
14
+ | `total` | `integer` | Yes | | | | No | |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -15,6 +15,7 @@ Type: `object`
15
15
  | `authored_at` | `string|null` | No | | | | Yes | When the order was placed, ISO 8601 with offset. |
16
16
  | `collection_modality` | `string` | Yes | | psc, home_kit | | No | |
17
17
  | `diagnoses` | array of [`LabOrderDiagnosis`](./LabOrderDiagnosis.md) | Yes | | | | No | |
18
+ | `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter the order was placed from, when linked. |
18
19
  | `expected_collection_at` | `string|null` | No | | | | Yes | OBR-7: expected PSC visit or kit collection. |
19
20
  | `fhir_status` | `string` | Yes | | | | No | ServiceRequest.status: draft, active, completed (Quest reported every test final) or revoked. |
20
21
  | `lab` | `string` | Yes | | | | No | Quest performing lab, MET. |
@@ -0,0 +1,19 @@
1
+ # ProviderDriversLicenseSummary
2
+
3
+ Model ID: `ProviderDriversLicenseSummary`
4
+
5
+ A driver's license without its number: only the last four characters are returned.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `expiration_date` | `string|null` | No | | | | Yes | License expiration date, when known. |
14
+ | `number_last4` | `string|null` | No | | | | Yes | Last four characters of the license number, when on file. |
15
+ | `state` | `string|null` | No | | | | Yes | 2-letter US state code. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # ProviderPatientInsuranceResponse
2
+
3
+ Model ID: `ProviderPatientInsuranceResponse`
4
+
5
+ GET /patients/{patient_id}/insurance.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `insurances` | array of [`Insurance`](./Insurance.md) | Yes | | | | No | The patient's coverages, primary first. |
14
+ | `patient_id` | `string` | Yes | | | | No | |
15
+ | `total` | `integer` | Yes | | | | No | |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,42 @@
1
+ # ProviderPatientProfile
2
+
3
+ Model ID: `ProviderPatientProfile`
4
+
5
+ Everything the patient's own profile holds that a clinician needs.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `active` | `boolean` | No | | | `true` | No | |
14
+ | `addresses` | array of [`Address`](./Address.md) | No | | | | No | |
15
+ | `athena_patient_id` | `string|null` | No | | | | Yes | Athena patient id, when linked. |
16
+ | `communications` | array of [`Communication`](./Communication.md) | No | | | | No | Languages the patient speaks. |
17
+ | `date_of_birth` | `string` | Yes | date | | | No | |
18
+ | `deceased` | `boolean` | No | | | `false` | No | |
19
+ | `deceased_date` | `string|null` | No | | | | Yes | |
20
+ | `drivers_license` | [`ProviderDriversLicenseSummary`](./ProviderDriversLicenseSummary.md) | No | | | | Yes | |
21
+ | `email` | `string|null` | No | | | | Yes | |
22
+ | `emergency_contacts` | array of [`EmergencyContact`](./EmergencyContact.md) | No | | | | No | |
23
+ | `ethnicity` | [`Ethnicity`](./Ethnicity.md) | No | | | | Yes | |
24
+ | `flags` | `object` | No | | | | No | The patient's boolean flags. |
25
+ | `gender` | [`Gender`](./Gender.md) | Yes | | | | No | |
26
+ | `gender_identity` | [`GenderIdentity`](./GenderIdentity.md) | No | | | | Yes | |
27
+ | `impilo_patient_id` | `string|null` | No | | | | Yes | Impilo patient id, when linked. |
28
+ | `marital_status` | [`MaritalStatus`](./MaritalStatus.md) | No | | | | Yes | |
29
+ | `mrn` | `string|null` | No | | | | Yes | Medical record number. |
30
+ | `name` | [`PatientName`](./PatientName.md) | Yes | | | | No | |
31
+ | `nationality` | `string|null` | No | | | | Yes | |
32
+ | `openloop_patient_id` | `string|null` | No | | | | Yes | OpenLoop patient id, when linked. |
33
+ | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource id. |
34
+ | `phones` | array of [`Phone`](./Phone.md) | No | | | | No | |
35
+ | `preferred_language` | `string|null` | No | | | | Yes | |
36
+ | `race` | array of [`Race`](./Race.md) | No | | | | No | |
37
+ | `sex_at_birth` | [`SexAtBirth`](./SexAtBirth.md) | No | | | | Yes | |
38
+ | `steadymd_patient_guid` | `string|null` | No | | | | Yes | SteadyMD patient guid, when linked. |
39
+
40
+ ## Example
41
+
42
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # ProviderPatientProfileResponse
2
+
3
+ Model ID: `ProviderPatientProfileResponse`
4
+
5
+ GET /patients/{patient_id}/profile.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `communication_consent` | [`CommunicationConsent`](./CommunicationConsent.md) | Yes | | | | No | SMS and phone contact consent; each is null when never recorded. |
14
+ | `dependents` | array of [`Dependent`](./Dependent.md) | No | | | | No | Dependents the patient recorded. |
15
+ | `patient_id` | `string` | Yes | | | | No | |
16
+ | `preferred_pharmacy` | [`PreferredPharmacy`](./PreferredPharmacy.md) | No | | | | Yes | The patient's preferred pharmacy, when set. |
17
+ | `profile` | [`ProviderPatientProfile`](./ProviderPatientProfile.md) | Yes | | | | No | |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,22 @@
1
+ # TelehealthRequest
2
+
3
+ Model ID: `TelehealthRequest`
4
+
5
+ A request for the patient to schedule a telehealth appointment.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `encounter_id` | `string` | Yes | | | | No | |
14
+ | `patient_id` | `string` | Yes | | | | No | |
15
+ | `preferred_window` | `string|null` | No | | | | Yes | |
16
+ | `request_id` | `string` | Yes | | | | No | FHIR Appointment id of the proposed telehealth appointment. |
17
+ | `requested_at` | `string|null` | No | | | | Yes | ISO 8601 time the request was recorded. |
18
+ | `status` | `string` | Yes | | | | No | proposed until the patient books a time. |
19
+
20
+ ## Example
21
+
22
+ None declared in canonical OpenAPI.
@@ -0,0 +1,17 @@
1
+ # TelehealthRequestInput
2
+
3
+ Model ID: `TelehealthRequestInput`
4
+
5
+ Optional body of POST /encounters/{id}/telehealth-request.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `preferred_window` | `string|null` | No | | | | Yes | When the provider would like the visit, in words. Never sent to the patient. |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # TelehealthRequestResponse
2
+
3
+ Model ID: `TelehealthRequestResponse`
4
+
5
+ Result of POST /encounters/{id}/telehealth-request.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `created` | `boolean` | Yes | | | | No | False when a request for this encounter was already made within the last hour: nothing was created and the patient was not notified again. |
14
+ | `patient_notified` | `boolean` | Yes | | | | No | True when this call wrote the patient notification. |
15
+ | `request` | [`TelehealthRequest`](./TelehealthRequest.md) | Yes | | | | No | |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,17 @@
1
+ # UpdateEncounterMedicationsRequest
2
+
3
+ Model ID: `UpdateEncounterMedicationsRequest`
4
+
5
+ The complete medication list for an encounter. Anything not listed is removed.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `medications` | array of [`EncounterMedicationInput`](./EncounterMedicationInput.md) | Yes | | | | No | At most 25 medications. |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.