@healthcloudai/hc-sdk 3.24.1 → 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.
- package/dist/index.cjs +92 -3
- package/dist/index.d.cts +2788 -168
- package/dist/index.d.ts +2788 -168
- package/dist/index.js +92 -3
- package/docs/clients/ProviderClient.md +13 -2
- package/docs/docs-manifest.json +39 -3
- package/docs/examples/index.md +13 -2
- package/docs/index.md +13 -2
- package/docs/models/CheckInEncounterResponse.md +2 -0
- package/docs/models/ClaimEncounterResponse.md +20 -0
- package/docs/models/CommunicationConsent.md +24 -0
- package/docs/models/Dependent.md +21 -0
- package/docs/models/DependentRelationship.md +15 -0
- package/docs/models/DiagnosisInput.md +20 -0
- package/docs/models/EncounterMedicationInput.md +29 -0
- package/docs/models/EncounterMedicationsResponse.md +19 -0
- package/docs/models/GetEncounterResponse.md +2 -0
- package/docs/models/Icd10Code.md +18 -0
- package/docs/models/Icd10SearchResponse.md +19 -0
- package/docs/models/LabCatalogItem.md +24 -0
- package/docs/models/LabCatalogResponse.md +18 -0
- package/docs/models/LabOrder.md +1 -0
- package/docs/models/ProviderDriversLicenseSummary.md +19 -0
- package/docs/models/ProviderEncounterQueueResponse.md +19 -0
- package/docs/models/ProviderEncounterRecord.md +2 -0
- package/docs/models/ProviderPatientInsuranceResponse.md +19 -0
- package/docs/models/ProviderPatientProfile.md +42 -0
- package/docs/models/ProviderPatientProfileResponse.md +21 -0
- package/docs/models/ProviderQueueEncounter.md +28 -0
- package/docs/models/ProviderQueuePatient.md +21 -0
- package/docs/models/SignEncounterResponse.md +18 -0
- package/docs/models/TelehealthRequest.md +22 -0
- package/docs/models/TelehealthRequestInput.md +17 -0
- package/docs/models/TelehealthRequestResponse.md +19 -0
- package/docs/models/UpdateEncounterDiagnosesRequest.md +17 -0
- package/docs/models/UpdateEncounterDiagnosesResponse.md +17 -0
- package/docs/models/UpdateEncounterMedicationsRequest.md +17 -0
- package/docs/models/fieldagent.Encounter.md +2 -0
- package/docs/models/index.md +25 -0
- package/docs/models/patient.Encounter.md +2 -0
- package/docs/models/provider.Encounter.md +2 -0
- package/docs/operations/fieldagent.listEncounters.md +2 -0
- package/docs/operations/patient.checkEncounter.md +64 -64
- package/docs/operations/patient.checkInEncounter.md +2 -0
- package/docs/operations/patient.createEncounter.md +2 -0
- package/docs/operations/patient.getCheckinCheckin.md +2 -0
- package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +2 -0
- package/docs/operations/patient.getEncounter.md +2 -0
- package/docs/operations/patient.getLatestEncounter.md +2 -0
- package/docs/operations/patient.getPatientSidebarPatientSidebar.md +2 -0
- package/docs/operations/patient.listEncounters.md +2 -0
- package/docs/operations/provider.claimEncounter.md +235 -0
- package/docs/operations/provider.getEncounter.md +12 -1
- package/docs/operations/provider.getEncounterQueue.md +148 -0
- package/docs/operations/provider.getLabOrder.md +21 -25
- package/docs/operations/provider.getPatientInsurance.md +134 -0
- package/docs/operations/provider.getPatientProfile.md +188 -0
- package/docs/operations/provider.getPatientRecord.md +11 -0
- package/docs/operations/provider.listEncounterMedications.md +142 -0
- package/docs/operations/provider.listEncounters.md +24 -3
- package/docs/operations/provider.listLabCatalog.md +215 -0
- package/docs/operations/provider.listLabOrders.md +24 -27
- package/docs/operations/provider.placeLabOrder.md +26 -28
- package/docs/operations/provider.requestTelehealthVisit.md +124 -0
- package/docs/operations/provider.searchIcd10.md +128 -0
- package/docs/operations/provider.signEncounter.md +233 -0
- package/docs/operations/provider.updateEncounterClinicalNote.md +20 -0
- package/docs/operations/provider.updateEncounterDiagnoses.md +267 -0
- package/docs/operations/provider.updateEncounterMedications.md +186 -0
- package/docs/operations/provider.updateEncounterStatus.md +20 -0
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -3742,11 +3742,52 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
3742
3742
|
connect() {
|
|
3743
3743
|
return this.connectService();
|
|
3744
3744
|
}
|
|
3745
|
-
/**
|
|
3745
|
+
/**
|
|
3746
|
+
* List the caller's OWN encounters (never tenant-wide). Pass `open: true` for the provider's task list: encounters that
|
|
3747
|
+
* are not finished, cancelled or entered in error.
|
|
3748
|
+
*/
|
|
3746
3749
|
listEncounters(filters) {
|
|
3747
3750
|
return this.send("GET", "/encounters", { query: filters });
|
|
3748
3751
|
}
|
|
3749
|
-
/**
|
|
3752
|
+
/**
|
|
3753
|
+
* The queue (GET /encounters/queue): the newest 10 encounters in the tenant that no provider has taken, newest created
|
|
3754
|
+
* first, each with a minimal patient summary. Use the item's `fhir_id` with claimEncounter.
|
|
3755
|
+
*/
|
|
3756
|
+
getEncounterQueue() {
|
|
3757
|
+
return this.send("GET", "/encounters/queue", {});
|
|
3758
|
+
}
|
|
3759
|
+
/**
|
|
3760
|
+
* Take an encounter from the queue (POST /encounters/{id}/claim): assigns the caller, starts it (in-progress), adds the
|
|
3761
|
+
* patient to the caller's patient list and notifies the patient. Repeating the call as the same provider changes nothing
|
|
3762
|
+
* (`claimed: false`). Rejects with a 409 when another provider took it first, 403 when the caller's role or account may not
|
|
3763
|
+
* work the queue, and 404 when the encounter does not exist.
|
|
3764
|
+
*/
|
|
3765
|
+
claimEncounter(encounterId) {
|
|
3766
|
+
return this.send("POST", "/encounters/{encounter_id}/claim", { pathParams: { encounter_id: encounterId } });
|
|
3767
|
+
}
|
|
3768
|
+
/**
|
|
3769
|
+
* Replace an encounter's diagnoses (PUT /encounters/{id}/diagnoses): add, change or remove. Codes come from
|
|
3770
|
+
* searchIcd10; codes left out of the list are removed, and the display text always comes from the ICD-10 data. Only the
|
|
3771
|
+
* assigned provider (403 otherwise), and not once the encounter is signed (409).
|
|
3772
|
+
*/
|
|
3773
|
+
updateEncounterDiagnoses(encounterId, request) {
|
|
3774
|
+
return this.send("PUT", "/encounters/{encounter_id}/diagnoses", {
|
|
3775
|
+
pathParams: { encounter_id: encounterId },
|
|
3776
|
+
body: request
|
|
3777
|
+
});
|
|
3778
|
+
}
|
|
3779
|
+
/**
|
|
3780
|
+
* Sign and complete an encounter (POST /encounters/{id}/sign): finished, end time, signer and time recorded, patient
|
|
3781
|
+
* notified. The encounter is then locked (409 on later edits). Only the assigned provider.
|
|
3782
|
+
*/
|
|
3783
|
+
signEncounter(encounterId) {
|
|
3784
|
+
return this.send("POST", "/encounters/{encounter_id}/sign", { pathParams: { encounter_id: encounterId } });
|
|
3785
|
+
}
|
|
3786
|
+
/** Search the ICD-10-CM codes accepted on encounters (GET /icd10). `q` is a code prefix or description words. */
|
|
3787
|
+
searchIcd10(filters) {
|
|
3788
|
+
return this.send("GET", "/icd10", { query: filters });
|
|
3789
|
+
}
|
|
3790
|
+
/** Get one of the caller's own encounters with its patient demographic summary (404 until the caller holds it). */
|
|
3750
3791
|
getEncounter(encounterId) {
|
|
3751
3792
|
return this.send("GET", "/encounters/{encounter_id}", { pathParams: { encounter_id: encounterId } });
|
|
3752
3793
|
}
|
|
@@ -3797,7 +3838,10 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
3797
3838
|
placeLabOrder(patientId, request) {
|
|
3798
3839
|
return this.send("POST", "/patients/{patient_id}/lab-orders", { pathParams: { patient_id: patientId }, body: request });
|
|
3799
3840
|
}
|
|
3800
|
-
/**
|
|
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
|
+
*/
|
|
3801
3845
|
listLabOrders(patientId, filters) {
|
|
3802
3846
|
return this.send("GET", "/patients/{patient_id}/lab-orders", { pathParams: { patient_id: patientId }, query: filters });
|
|
3803
3847
|
}
|
|
@@ -3809,6 +3853,51 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
3809
3853
|
getLabOrderRequisition(patientId, orderId) {
|
|
3810
3854
|
return this.send("GET", "/patients/{patient_id}/lab-orders/{order_id}/requisition", { pathParams: { patient_id: patientId, order_id: orderId } });
|
|
3811
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
|
+
}
|
|
3812
3901
|
/** Get a patient's consolidated health record (provider tenant scope). */
|
|
3813
3902
|
getPatientRecord(patientId) {
|
|
3814
3903
|
return this.send("GET", "/patients/{patient_id}/record", { pathParams: { patient_id: patientId } });
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# ProviderClient
|
|
2
2
|
|
|
3
|
+
- [`claimEncounter`](../operations/provider.claimEncounter.md) — Take an encounter from the queue
|
|
3
4
|
- [`completePractitionerOnboarding`](../operations/provider.completePractitionerOnboarding.md) — Record onboarding completion for the practitioner's current flow
|
|
4
5
|
- [`confirmPassword`](../operations/provider.confirmResetPassword.md) — Complete a password reset
|
|
5
6
|
- [`connect`](../operations/provider.connect.md) — Health check
|
|
@@ -7,17 +8,22 @@
|
|
|
7
8
|
- [`createPractitionerLocation`](../operations/provider.createPractitionerLocation.md) — Add a practice location
|
|
8
9
|
- [`deletePractitionerLocation`](../operations/provider.deletePractitionerLocation.md) — Remove a practice location
|
|
9
10
|
- [`getAppointment`](../operations/provider.getAppointment.md) — Get one appointment with patient demographics
|
|
10
|
-
- [`getEncounter`](../operations/provider.getEncounter.md) — Get one
|
|
11
|
+
- [`getEncounter`](../operations/provider.getEncounter.md) — Get one of the caller's encounters with patient demographics
|
|
12
|
+
- [`getEncounterQueue`](../operations/provider.getEncounterQueue.md) — The queue of encounters no provider has taken yet
|
|
11
13
|
- [`getHomeSummary`](../operations/provider.getHomeSummary.md) — Counts for the provider's home screen
|
|
12
14
|
- [`getLabOrder`](../operations/provider.getLabOrder.md) — Get one Quest lab order requisition
|
|
13
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
|
|
14
18
|
- [`getPatientRecord`](../operations/provider.getPatientRecord.md) — Get a patient's consolidated health record (provider tenant scope)
|
|
15
19
|
- [`getPhoto`](../operations/provider.getPhoto.md) — Get a practitioner photo
|
|
16
20
|
- [`getPhotoUploadUrl`](../operations/provider.getPhotoUploadUrl.md) — Get a presigned photo upload URL
|
|
17
21
|
- [`get`](../operations/provider.getPractitioner.md) — Get a practitioner profile
|
|
18
22
|
- [`getPractitionerLocation`](../operations/provider.getPractitionerLocation.md) — Get one practice location
|
|
19
23
|
- [`listAppointments`](../operations/provider.listAppointments.md) — List tenant appointments
|
|
20
|
-
- [`
|
|
24
|
+
- [`listEncounterMedications`](../operations/provider.listEncounterMedications.md) — List the medications recorded on an encounter
|
|
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
|
|
21
27
|
- [`listLabOrders`](../operations/provider.listLabOrders.md) — List a tenant patient's Quest lab orders
|
|
22
28
|
- [`listPatients`](../operations/provider.listPatients.md) — List or search the calling practitioner's patients
|
|
23
29
|
- [`listPractitionerLocations`](../operations/provider.listPractitionerLocations.md) — List the practitioner's practice locations
|
|
@@ -26,10 +32,15 @@
|
|
|
26
32
|
- [`placeLabOrder`](../operations/provider.placeLabOrder.md) — Place a Quest lab order for a tenant patient
|
|
27
33
|
- [`refreshToken`](../operations/provider.refreshToken.md) — Refresh practitioner access tokens
|
|
28
34
|
- [`register`](../operations/provider.register.md) — Register a practitioner
|
|
35
|
+
- [`requestTelehealthVisit`](../operations/provider.requestTelehealthVisit.md) — Ask the patient to schedule a telehealth appointment
|
|
29
36
|
- [`resendEmailVerification`](../operations/provider.resendVerificationCode.md) — Resend the email verification OTP
|
|
30
37
|
- [`resetPassword`](../operations/provider.resetPassword.md) — Start a password reset
|
|
38
|
+
- [`searchIcd10`](../operations/provider.searchIcd10.md) — Search ICD-10-CM diagnosis codes
|
|
31
39
|
- [`setPractitionerPortalRoles`](../operations/provider.setPractitionerPortalRoles.md) — Set a practitioner's provider-portal roles (platform admin only)
|
|
40
|
+
- [`signEncounter`](../operations/provider.signEncounter.md) — Sign and complete an encounter
|
|
32
41
|
- [`updateEncounterClinicalNote`](../operations/provider.updateEncounterClinicalNote.md) — Update encounter notes and assessment
|
|
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
|
|
33
44
|
- [`updateEncounterStatus`](../operations/provider.updateEncounterStatus.md) — Update encounter status
|
|
34
45
|
- [`updatePhone`](../operations/provider.updatePhone.md) — Update a practitioner's phone number
|
|
35
46
|
- [`update`](../operations/provider.updatePractitioner.md) — Update a practitioner profile
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:e95a173c50b6a889818e2a0f518338dd91a28023a4daa1c4d0a9b1b50f223490",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -455,6 +455,7 @@
|
|
|
455
455
|
"models/CheckEncounterResponse.md",
|
|
456
456
|
"models/CheckInEncounterRequest.md",
|
|
457
457
|
"models/CheckInEncounterResponse.md",
|
|
458
|
+
"models/ClaimEncounterResponse.md",
|
|
458
459
|
"models/ClinicalObservation.md",
|
|
459
460
|
"models/CmsGetCountyFipsRequest.md",
|
|
460
461
|
"models/CmsSearchHealthPlansRequest.md",
|
|
@@ -470,6 +471,7 @@
|
|
|
470
471
|
"models/CommsListMessagesResponse.md",
|
|
471
472
|
"models/CommsListPresenceResponse.md",
|
|
472
473
|
"models/Communication.md",
|
|
474
|
+
"models/CommunicationConsent.md",
|
|
473
475
|
"models/CommunicationConsentResponse.md",
|
|
474
476
|
"models/CompendiumSyncResult.md",
|
|
475
477
|
"models/ConnectivityResponse.md",
|
|
@@ -527,7 +529,10 @@
|
|
|
527
529
|
"models/DeliveryOrder.md",
|
|
528
530
|
"models/DeliveryPharmacy.md",
|
|
529
531
|
"models/DemographicsMatch.md",
|
|
532
|
+
"models/Dependent.md",
|
|
533
|
+
"models/DependentRelationship.md",
|
|
530
534
|
"models/DependentResponse.md",
|
|
535
|
+
"models/DiagnosisInput.md",
|
|
531
536
|
"models/DiagnosticTest.md",
|
|
532
537
|
"models/DiagnosticTestRelationship.md",
|
|
533
538
|
"models/DietCategory.md",
|
|
@@ -584,6 +589,8 @@
|
|
|
584
589
|
"models/EncounterClass.md",
|
|
585
590
|
"models/EncounterClinicalState.md",
|
|
586
591
|
"models/EncounterEffect.md",
|
|
592
|
+
"models/EncounterMedicationInput.md",
|
|
593
|
+
"models/EncounterMedicationsResponse.md",
|
|
587
594
|
"models/EncounterOperationError.md",
|
|
588
595
|
"models/EncounterOperationResponse.md",
|
|
589
596
|
"models/EncounterSections.md",
|
|
@@ -1107,6 +1114,8 @@
|
|
|
1107
1114
|
"models/HealthieUpdateUserRequest.md",
|
|
1108
1115
|
"models/HealthieUpdateUserResponse.md",
|
|
1109
1116
|
"models/HeartRateVital.md",
|
|
1117
|
+
"models/Icd10Code.md",
|
|
1118
|
+
"models/Icd10SearchResponse.md",
|
|
1110
1119
|
"models/ImmunizationRoute.md",
|
|
1111
1120
|
"models/ImmunizationStatus.md",
|
|
1112
1121
|
"models/ImpiloAddress.md",
|
|
@@ -1243,6 +1252,8 @@
|
|
|
1243
1252
|
"models/KnowledgeCollection.md",
|
|
1244
1253
|
"models/KnowledgeEntrySummary.md",
|
|
1245
1254
|
"models/KnowledgeSearchResult.md",
|
|
1255
|
+
"models/LabCatalogItem.md",
|
|
1256
|
+
"models/LabCatalogResponse.md",
|
|
1246
1257
|
"models/LabOrder.md",
|
|
1247
1258
|
"models/LabOrderDiagnosis.md",
|
|
1248
1259
|
"models/LabOrderErrorResponse.md",
|
|
@@ -1441,8 +1452,10 @@
|
|
|
1441
1452
|
"models/ProviderAppointmentsResponse.md",
|
|
1442
1453
|
"models/ProviderContactPoint.md",
|
|
1443
1454
|
"models/ProviderCredential.md",
|
|
1455
|
+
"models/ProviderDriversLicenseSummary.md",
|
|
1444
1456
|
"models/ProviderEducationCredential.md",
|
|
1445
1457
|
"models/ProviderEncounterListResponse.md",
|
|
1458
|
+
"models/ProviderEncounterQueueResponse.md",
|
|
1446
1459
|
"models/ProviderEncounterRecord.md",
|
|
1447
1460
|
"models/ProviderEncounterResponse.md",
|
|
1448
1461
|
"models/ProviderEncounterStatusCounts.md",
|
|
@@ -1460,14 +1473,19 @@
|
|
|
1460
1473
|
"models/ProviderLocationRequest.md",
|
|
1461
1474
|
"models/ProviderOnboardingStatus.md",
|
|
1462
1475
|
"models/ProviderPatientAddress.md",
|
|
1476
|
+
"models/ProviderPatientInsuranceResponse.md",
|
|
1463
1477
|
"models/ProviderPatientListResponse.md",
|
|
1464
1478
|
"models/ProviderPatientPhone.md",
|
|
1479
|
+
"models/ProviderPatientProfile.md",
|
|
1480
|
+
"models/ProviderPatientProfileResponse.md",
|
|
1465
1481
|
"models/ProviderPatientRecordResources.md",
|
|
1466
1482
|
"models/ProviderPatientRecordResponse.md",
|
|
1467
1483
|
"models/ProviderPatientResponse.md",
|
|
1468
1484
|
"models/ProviderPatientSummary.md",
|
|
1469
1485
|
"models/ProviderPostgraduateTraining.md",
|
|
1470
1486
|
"models/ProviderProfessionalLiability.md",
|
|
1487
|
+
"models/ProviderQueueEncounter.md",
|
|
1488
|
+
"models/ProviderQueuePatient.md",
|
|
1471
1489
|
"models/ProviderRole.md",
|
|
1472
1490
|
"models/ProviderSearchRequest.md",
|
|
1473
1491
|
"models/ProviderSearchResponse.md",
|
|
@@ -1723,6 +1741,7 @@
|
|
|
1723
1741
|
"models/SetPreferredPharmacyResponse.md",
|
|
1724
1742
|
"models/SexAtBirth.md",
|
|
1725
1743
|
"models/SexualOrientation.md",
|
|
1744
|
+
"models/SignEncounterResponse.md",
|
|
1726
1745
|
"models/Slot.md",
|
|
1727
1746
|
"models/SlotStatus.md",
|
|
1728
1747
|
"models/SmokingStatus.md",
|
|
@@ -1842,6 +1861,9 @@
|
|
|
1842
1861
|
"models/SubscriberRelationship.md",
|
|
1843
1862
|
"models/SubstanceStatus.md",
|
|
1844
1863
|
"models/SubstanceUse.md",
|
|
1864
|
+
"models/TelehealthRequest.md",
|
|
1865
|
+
"models/TelehealthRequestInput.md",
|
|
1866
|
+
"models/TelehealthRequestResponse.md",
|
|
1845
1867
|
"models/TelehealthToken.md",
|
|
1846
1868
|
"models/TemperatureRoute.md",
|
|
1847
1869
|
"models/TestOrder.md",
|
|
@@ -1878,6 +1900,9 @@
|
|
|
1878
1900
|
"models/UpdateDriversLicenseResponse.md",
|
|
1879
1901
|
"models/UpdateEncounterClinicalNoteRequest.md",
|
|
1880
1902
|
"models/UpdateEncounterClinicalNoteResponse.md",
|
|
1903
|
+
"models/UpdateEncounterDiagnosesRequest.md",
|
|
1904
|
+
"models/UpdateEncounterDiagnosesResponse.md",
|
|
1905
|
+
"models/UpdateEncounterMedicationsRequest.md",
|
|
1881
1906
|
"models/UpdateEncounterStatusRequest.md",
|
|
1882
1907
|
"models/UpdateEncounterStatusResponse.md",
|
|
1883
1908
|
"models/UpdateMedicationRequest.md",
|
|
@@ -3230,6 +3255,7 @@
|
|
|
3230
3255
|
"operations/person.uploadPhoto.md",
|
|
3231
3256
|
"operations/person.verifyEmail.md",
|
|
3232
3257
|
"operations/person.verifySms.md",
|
|
3258
|
+
"operations/provider.claimEncounter.md",
|
|
3233
3259
|
"operations/provider.completePractitionerOnboarding.md",
|
|
3234
3260
|
"operations/provider.confirmResetPassword.md",
|
|
3235
3261
|
"operations/provider.connect.md",
|
|
@@ -3238,16 +3264,21 @@
|
|
|
3238
3264
|
"operations/provider.deletePractitionerLocation.md",
|
|
3239
3265
|
"operations/provider.getAppointment.md",
|
|
3240
3266
|
"operations/provider.getEncounter.md",
|
|
3267
|
+
"operations/provider.getEncounterQueue.md",
|
|
3241
3268
|
"operations/provider.getHomeSummary.md",
|
|
3242
3269
|
"operations/provider.getLabOrder.md",
|
|
3243
3270
|
"operations/provider.getLabOrderRequisition.md",
|
|
3271
|
+
"operations/provider.getPatientInsurance.md",
|
|
3272
|
+
"operations/provider.getPatientProfile.md",
|
|
3244
3273
|
"operations/provider.getPatientRecord.md",
|
|
3245
3274
|
"operations/provider.getPhoto.md",
|
|
3246
3275
|
"operations/provider.getPhotoUploadUrl.md",
|
|
3247
3276
|
"operations/provider.getPractitioner.md",
|
|
3248
3277
|
"operations/provider.getPractitionerLocation.md",
|
|
3249
3278
|
"operations/provider.listAppointments.md",
|
|
3279
|
+
"operations/provider.listEncounterMedications.md",
|
|
3250
3280
|
"operations/provider.listEncounters.md",
|
|
3281
|
+
"operations/provider.listLabCatalog.md",
|
|
3251
3282
|
"operations/provider.listLabOrders.md",
|
|
3252
3283
|
"operations/provider.listPatients.md",
|
|
3253
3284
|
"operations/provider.listPractitionerLocations.md",
|
|
@@ -3256,10 +3287,15 @@
|
|
|
3256
3287
|
"operations/provider.placeLabOrder.md",
|
|
3257
3288
|
"operations/provider.refreshToken.md",
|
|
3258
3289
|
"operations/provider.register.md",
|
|
3290
|
+
"operations/provider.requestTelehealthVisit.md",
|
|
3259
3291
|
"operations/provider.resendVerificationCode.md",
|
|
3260
3292
|
"operations/provider.resetPassword.md",
|
|
3293
|
+
"operations/provider.searchIcd10.md",
|
|
3261
3294
|
"operations/provider.setPractitionerPortalRoles.md",
|
|
3295
|
+
"operations/provider.signEncounter.md",
|
|
3262
3296
|
"operations/provider.updateEncounterClinicalNote.md",
|
|
3297
|
+
"operations/provider.updateEncounterDiagnoses.md",
|
|
3298
|
+
"operations/provider.updateEncounterMedications.md",
|
|
3263
3299
|
"operations/provider.updateEncounterStatus.md",
|
|
3264
3300
|
"operations/provider.updatePhone.md",
|
|
3265
3301
|
"operations/provider.updatePractitioner.md",
|
|
@@ -3279,7 +3315,7 @@
|
|
|
3279
3315
|
"operations/vitals.recordVitals.md"
|
|
3280
3316
|
],
|
|
3281
3317
|
"language": "nodejs",
|
|
3282
|
-
"modelCount":
|
|
3283
|
-
"operationCount":
|
|
3318
|
+
"modelCount": 2185,
|
|
3319
|
+
"operationCount": 1073,
|
|
3284
3320
|
"schemaVersion": 1
|
|
3285
3321
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -1017,6 +1017,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1017
1017
|
- [Upload a person photo](../operations/person.uploadPhoto.md)
|
|
1018
1018
|
- [Verify a person's email OTP](../operations/person.verifyEmail.md)
|
|
1019
1019
|
- [Verify a person's phone OTP](../operations/person.verifySms.md)
|
|
1020
|
+
- [Take an encounter from the queue](../operations/provider.claimEncounter.md)
|
|
1020
1021
|
- [Record onboarding completion for the practitioner's current flow](../operations/provider.completePractitionerOnboarding.md)
|
|
1021
1022
|
- [Complete a password reset](../operations/provider.confirmResetPassword.md)
|
|
1022
1023
|
- [Health check](../operations/provider.connect.md)
|
|
@@ -1024,17 +1025,22 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1024
1025
|
- [Add a practice location](../operations/provider.createPractitionerLocation.md)
|
|
1025
1026
|
- [Remove a practice location](../operations/provider.deletePractitionerLocation.md)
|
|
1026
1027
|
- [Get one appointment with patient demographics](../operations/provider.getAppointment.md)
|
|
1027
|
-
- [Get one
|
|
1028
|
+
- [Get one of the caller's encounters with patient demographics](../operations/provider.getEncounter.md)
|
|
1029
|
+
- [The queue of encounters no provider has taken yet](../operations/provider.getEncounterQueue.md)
|
|
1028
1030
|
- [Counts for the provider's home screen](../operations/provider.getHomeSummary.md)
|
|
1029
1031
|
- [Get one Quest lab order requisition](../operations/provider.getLabOrder.md)
|
|
1030
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)
|
|
1031
1035
|
- [Get a patient's consolidated health record (provider tenant scope)](../operations/provider.getPatientRecord.md)
|
|
1032
1036
|
- [Get a practitioner photo](../operations/provider.getPhoto.md)
|
|
1033
1037
|
- [Get a presigned photo upload URL](../operations/provider.getPhotoUploadUrl.md)
|
|
1034
1038
|
- [Get a practitioner profile](../operations/provider.getPractitioner.md)
|
|
1035
1039
|
- [Get one practice location](../operations/provider.getPractitionerLocation.md)
|
|
1036
1040
|
- [List tenant appointments](../operations/provider.listAppointments.md)
|
|
1037
|
-
- [List
|
|
1041
|
+
- [List the medications recorded on an encounter](../operations/provider.listEncounterMedications.md)
|
|
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)
|
|
1038
1044
|
- [List a tenant patient's Quest lab orders](../operations/provider.listLabOrders.md)
|
|
1039
1045
|
- [List or search the calling practitioner's patients](../operations/provider.listPatients.md)
|
|
1040
1046
|
- [List the practitioner's practice locations](../operations/provider.listPractitionerLocations.md)
|
|
@@ -1043,10 +1049,15 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1043
1049
|
- [Place a Quest lab order for a tenant patient](../operations/provider.placeLabOrder.md)
|
|
1044
1050
|
- [Refresh practitioner access tokens](../operations/provider.refreshToken.md)
|
|
1045
1051
|
- [Register a practitioner](../operations/provider.register.md)
|
|
1052
|
+
- [Ask the patient to schedule a telehealth appointment](../operations/provider.requestTelehealthVisit.md)
|
|
1046
1053
|
- [Resend the email verification OTP](../operations/provider.resendVerificationCode.md)
|
|
1047
1054
|
- [Start a password reset](../operations/provider.resetPassword.md)
|
|
1055
|
+
- [Search ICD-10-CM diagnosis codes](../operations/provider.searchIcd10.md)
|
|
1048
1056
|
- [Set a practitioner's provider-portal roles (platform admin only)](../operations/provider.setPractitionerPortalRoles.md)
|
|
1057
|
+
- [Sign and complete an encounter](../operations/provider.signEncounter.md)
|
|
1049
1058
|
- [Update encounter notes and assessment](../operations/provider.updateEncounterClinicalNote.md)
|
|
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)
|
|
1050
1061
|
- [Update encounter status](../operations/provider.updateEncounterStatus.md)
|
|
1051
1062
|
- [Update a practitioner's phone number](../operations/provider.updatePhone.md)
|
|
1052
1063
|
- [Update a practitioner profile](../operations/provider.updatePractitioner.md)
|
package/docs/index.md
CHANGED
|
@@ -1025,6 +1025,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1025
1025
|
- [Upload a person photo](operations/person.uploadPhoto.md) (`person.uploadPhoto`)
|
|
1026
1026
|
- [Verify a person's email OTP](operations/person.verifyEmail.md) (`person.verifyEmail`)
|
|
1027
1027
|
- [Verify a person's phone OTP](operations/person.verifySms.md) (`person.verifySms`)
|
|
1028
|
+
- [Take an encounter from the queue](operations/provider.claimEncounter.md) (`provider.claimEncounter`)
|
|
1028
1029
|
- [Record onboarding completion for the practitioner's current flow](operations/provider.completePractitionerOnboarding.md) (`provider.completePractitionerOnboarding`)
|
|
1029
1030
|
- [Complete a password reset](operations/provider.confirmResetPassword.md) (`provider.confirmResetPassword`)
|
|
1030
1031
|
- [Health check](operations/provider.connect.md) (`provider.connect`)
|
|
@@ -1032,17 +1033,22 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1032
1033
|
- [Add a practice location](operations/provider.createPractitionerLocation.md) (`provider.createPractitionerLocation`)
|
|
1033
1034
|
- [Remove a practice location](operations/provider.deletePractitionerLocation.md) (`provider.deletePractitionerLocation`)
|
|
1034
1035
|
- [Get one appointment with patient demographics](operations/provider.getAppointment.md) (`provider.getAppointment`)
|
|
1035
|
-
- [Get one
|
|
1036
|
+
- [Get one of the caller's encounters with patient demographics](operations/provider.getEncounter.md) (`provider.getEncounter`)
|
|
1037
|
+
- [The queue of encounters no provider has taken yet](operations/provider.getEncounterQueue.md) (`provider.getEncounterQueue`)
|
|
1036
1038
|
- [Counts for the provider's home screen](operations/provider.getHomeSummary.md) (`provider.getHomeSummary`)
|
|
1037
1039
|
- [Get one Quest lab order requisition](operations/provider.getLabOrder.md) (`provider.getLabOrder`)
|
|
1038
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`)
|
|
1039
1043
|
- [Get a patient's consolidated health record (provider tenant scope)](operations/provider.getPatientRecord.md) (`provider.getPatientRecord`)
|
|
1040
1044
|
- [Get a practitioner photo](operations/provider.getPhoto.md) (`provider.getPhoto`)
|
|
1041
1045
|
- [Get a presigned photo upload URL](operations/provider.getPhotoUploadUrl.md) (`provider.getPhotoUploadUrl`)
|
|
1042
1046
|
- [Get a practitioner profile](operations/provider.getPractitioner.md) (`provider.getPractitioner`)
|
|
1043
1047
|
- [Get one practice location](operations/provider.getPractitionerLocation.md) (`provider.getPractitionerLocation`)
|
|
1044
1048
|
- [List tenant appointments](operations/provider.listAppointments.md) (`provider.listAppointments`)
|
|
1045
|
-
- [List
|
|
1049
|
+
- [List the medications recorded on an encounter](operations/provider.listEncounterMedications.md) (`provider.listEncounterMedications`)
|
|
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`)
|
|
1046
1052
|
- [List a tenant patient's Quest lab orders](operations/provider.listLabOrders.md) (`provider.listLabOrders`)
|
|
1047
1053
|
- [List or search the calling practitioner's patients](operations/provider.listPatients.md) (`provider.listPatients`)
|
|
1048
1054
|
- [List the practitioner's practice locations](operations/provider.listPractitionerLocations.md) (`provider.listPractitionerLocations`)
|
|
@@ -1051,10 +1057,15 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1051
1057
|
- [Place a Quest lab order for a tenant patient](operations/provider.placeLabOrder.md) (`provider.placeLabOrder`)
|
|
1052
1058
|
- [Refresh practitioner access tokens](operations/provider.refreshToken.md) (`provider.refreshToken`)
|
|
1053
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`)
|
|
1054
1061
|
- [Resend the email verification OTP](operations/provider.resendVerificationCode.md) (`provider.resendVerificationCode`)
|
|
1055
1062
|
- [Start a password reset](operations/provider.resetPassword.md) (`provider.resetPassword`)
|
|
1063
|
+
- [Search ICD-10-CM diagnosis codes](operations/provider.searchIcd10.md) (`provider.searchIcd10`)
|
|
1056
1064
|
- [Set a practitioner's provider-portal roles (platform admin only)](operations/provider.setPractitionerPortalRoles.md) (`provider.setPractitionerPortalRoles`)
|
|
1065
|
+
- [Sign and complete an encounter](operations/provider.signEncounter.md) (`provider.signEncounter`)
|
|
1057
1066
|
- [Update encounter notes and assessment](operations/provider.updateEncounterClinicalNote.md) (`provider.updateEncounterClinicalNote`)
|
|
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`)
|
|
1058
1069
|
- [Update encounter status](operations/provider.updateEncounterStatus.md) (`provider.updateEncounterStatus`)
|
|
1059
1070
|
- [Update a practitioner's phone number](operations/provider.updatePhone.md) (`provider.updatePhone`)
|
|
1060
1071
|
- [Update a practitioner profile](operations/provider.updatePractitioner.md) (`provider.updatePractitioner`)
|
|
@@ -40,6 +40,8 @@ Type: `object`
|
|
|
40
40
|
| `service_provider_id` | `string|null` | No | | | | Yes | FHIR Organization id of the service provider, when linked. |
|
|
41
41
|
| `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
|
|
42
42
|
| `service_type_display` | `string|null` | No | | | | Yes | Display text for the service type, when available. |
|
|
43
|
+
| `signed_at` | `string|null` | No | | | | Yes | UTC datetime when the encounter was signed, when signed. |
|
|
44
|
+
| `signed_by` | `string|null` | No | | | | Yes | FHIR Practitioner id of the provider who signed (completed) the encounter, when signed. |
|
|
43
45
|
| `status` | [`EncounterStatus`](./EncounterStatus.md) | No | | | `"planned"` | No | Encounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error, or unknown. |
|
|
44
46
|
| `steadymd_consult_guid` | `string|null` | No | | | | Yes | SteadyMD consult guid this encounter was checked in from, when checked in via SteadyMD. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
|
|
45
47
|
| `steadymd_episode_guid` | `string|null` | No | | | | Yes | SteadyMD episode guid this encounter is linked to, when checked in via SteadyMD. |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ClaimEncounterResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ClaimEncounterResponse`
|
|
4
|
+
|
|
5
|
+
Result of taking an encounter from the queue.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `claimed` | `boolean` | Yes | | | | No | True when this call took the encounter; false when the caller already held it (nothing changed). |
|
|
14
|
+
| `ehr_status` | `string` | Yes | | updated, not_linked, skipped | | No | Whether a linked EHR encounter was updated too. |
|
|
15
|
+
| `encounter` | [`ProviderEncounterRecord`](./ProviderEncounterRecord.md) | Yes | | | | No | The encounter, now in progress and assigned to the caller. |
|
|
16
|
+
| `patient_on_care_team` | `boolean` | Yes | | | | No | True when the patient is now on the caller's patient list (GET /patients). False means that step failed and a repeat claim will retry it. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -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,20 @@
|
|
|
1
|
+
# EncounterDiagnosisInput
|
|
2
|
+
|
|
3
|
+
Model ID: `DiagnosisInput`
|
|
4
|
+
|
|
5
|
+
One diagnosis 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
|
+
| `display` | `string|null` | No | | | | Yes | Ignored: the display text always comes from the ICD-10 data. Accepted for convenience. |
|
|
14
|
+
| `icd10_code` | `string` | Yes | | | | No | ICD-10-CM code from GET /icd10, for example E11.9. |
|
|
15
|
+
| `rank` | `integer|null` | No | | | | Yes | 1 is the primary diagnosis. Defaults to the position in the list. |
|
|
16
|
+
| `use` | `string|null` | No | | | | Yes | Diagnosis role: CC (default), AD, DD, CM, pre-op, post-op or billing. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
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.
|
|
@@ -37,6 +37,8 @@ Type: `object`
|
|
|
37
37
|
| `service_provider_id` | `string|null` | No | | | | Yes | FHIR Organization id of the service provider, when linked. |
|
|
38
38
|
| `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
|
|
39
39
|
| `service_type_display` | `string|null` | No | | | | Yes | Display text for the service type, when available. |
|
|
40
|
+
| `signed_at` | `string|null` | No | | | | Yes | UTC datetime when the encounter was signed, when signed. |
|
|
41
|
+
| `signed_by` | `string|null` | No | | | | Yes | FHIR Practitioner id of the provider who signed (completed) the encounter, when signed. |
|
|
40
42
|
| `status` | [`EncounterStatus`](./EncounterStatus.md) | No | | | `"planned"` | No | Encounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error, or unknown. |
|
|
41
43
|
| `steadymd_consult_guid` | `string|null` | No | | | | Yes | SteadyMD consult guid this encounter was checked in from, when checked in via SteadyMD. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
|
|
42
44
|
| `steadymd_episode_guid` | `string|null` | No | | | | Yes | SteadyMD episode guid this encounter is linked to, when checked in via SteadyMD. |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Icd10Code
|
|
2
|
+
|
|
3
|
+
Model ID: `Icd10Code`
|
|
4
|
+
|
|
5
|
+
One ICD-10-CM code.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `code` | `string` | Yes | | | | No | ICD-10-CM code with its dot, for example E11.9. |
|
|
14
|
+
| `description` | `string` | Yes | | | | No | Official long description. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|