@healthcloudai/hc-sdk 3.31.2 → 3.32.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 +97 -0
- package/dist/index.d.cts +2713 -179
- package/dist/index.d.ts +2713 -179
- package/dist/index.js +97 -0
- package/docs/clients/PatientClient.md +4 -0
- package/docs/clients/ProviderClient.md +8 -0
- package/docs/docs-manifest.json +40 -3
- package/docs/examples/index.md +12 -0
- package/docs/index.md +12 -0
- package/docs/models/CarePlan.md +28 -0
- package/docs/models/CarePlanActivity.md +20 -0
- package/docs/models/CarePlanGoal.md +23 -0
- package/docs/models/CarePlanProblem.md +23 -0
- package/docs/models/CarePlanRelated.md +19 -0
- package/docs/models/CareTeamLanguage.md +19 -0
- package/docs/models/CareTeamMember.md +27 -0
- package/docs/models/CareTeamResponse.md +18 -0
- package/docs/models/CareTeamSpecialty.md +19 -0
- package/docs/models/DeviceCatalogItem.md +24 -0
- package/docs/models/DeviceCatalogResponse.md +18 -0
- package/docs/models/ListPatientCarePlansResponse.md +18 -0
- package/docs/models/ListPatientDevicesResponse.md +18 -0
- package/docs/models/OrderPatientDeviceRequest.md +25 -0
- package/docs/models/PatientCarePlanResponse.md +18 -0
- package/docs/models/PatientDevice.md +38 -0
- package/docs/models/PatientEncounterSummary.md +23 -0
- package/docs/models/PatientVitals.md +20 -0
- package/docs/models/ProviderCarePlanResponse.md +18 -0
- package/docs/models/ProviderMyAppointment.md +26 -0
- package/docs/models/ProviderMyAppointmentsResponse.md +19 -0
- package/docs/models/ProviderMyPatientsVitalsResponse.md +21 -0
- package/docs/models/UpdateCarePlanRequest.md +22 -0
- package/docs/models/VitalsSeries.md +26 -0
- package/docs/models/VitalsWindow.md +19 -0
- package/docs/models/index.md +25 -0
- package/docs/operations/patient.getCareTeam.md +130 -0
- package/docs/operations/patient.getEncounterCarePlan.md +158 -0
- package/docs/operations/patient.listCarePlans.md +144 -0
- package/docs/operations/patient.listDevices.md +125 -0
- package/docs/operations/provider.cancelPatientDevice.md +135 -0
- package/docs/operations/provider.getEncounterCarePlan.md +162 -0
- package/docs/operations/provider.listDeviceCatalog.md +111 -0
- package/docs/operations/provider.listMyAppointments.md +165 -0
- package/docs/operations/provider.listMyPatientsVitals.md +178 -0
- package/docs/operations/provider.listPatientDevices.md +137 -0
- package/docs/operations/provider.orderPatientDevice.md +178 -0
- package/docs/operations/provider.updateEncounterCarePlan.md +207 -0
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -3093,6 +3093,31 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
3093
3093
|
const response = await this.send("GET", "/patients/defaultprovider", {});
|
|
3094
3094
|
return GetDefaultProviderResponseFromJSON(response);
|
|
3095
3095
|
}
|
|
3096
|
+
/**
|
|
3097
|
+
* GET /patients/care-team — the providers on the patient's encounters, most recent first (at most 50): display name,
|
|
3098
|
+
* credentials, roles, specialties, languages spoken, organization, bio (null until written), and first/last encounter
|
|
3099
|
+
* date and count. No contact details.
|
|
3100
|
+
*/
|
|
3101
|
+
getCareTeam() {
|
|
3102
|
+
return this.send("GET", "/patients/care-team", {});
|
|
3103
|
+
}
|
|
3104
|
+
/** GET /patients/devices — devices a provider ordered or added, newest first, with live vendor status when available. */
|
|
3105
|
+
listMyDevices() {
|
|
3106
|
+
return this.send("GET", "/patients/devices", {});
|
|
3107
|
+
}
|
|
3108
|
+
/**
|
|
3109
|
+
* GET /encounters/{id}/care-plan — the care plan a provider wrote for one of the patient's encounters (problems, goals
|
|
3110
|
+
* and expected outcomes, activities) with a summary of the encounter. Active or completed plans only; otherwise 404.
|
|
3111
|
+
*/
|
|
3112
|
+
getEncounterCarePlan(encounterId) {
|
|
3113
|
+
return this.send("GET", "/encounters/{encounter_id}/care-plan", {
|
|
3114
|
+
pathParams: { encounter_id: encounterId }
|
|
3115
|
+
});
|
|
3116
|
+
}
|
|
3117
|
+
/** GET /patients/care-plans — the patient's active and completed care plans, newest first. */
|
|
3118
|
+
listMyCarePlans() {
|
|
3119
|
+
return this.send("GET", "/patients/care-plans", {});
|
|
3120
|
+
}
|
|
3096
3121
|
getAgentConfiguration() {
|
|
3097
3122
|
return this.send("GET", "/agentconfiguration", {});
|
|
3098
3123
|
}
|
|
@@ -4047,6 +4072,78 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
4047
4072
|
listPracticeAppointments(filters) {
|
|
4048
4073
|
return this.send("GET", "/practice/appointments", { query: filters });
|
|
4049
4074
|
}
|
|
4075
|
+
/**
|
|
4076
|
+
* Upcoming appointments of the authenticated provider's own patients (GET /appointments/mine): patients on their care
|
|
4077
|
+
* team plus patients of their encounters. Window `start_date`..`end_date` (YYYY-MM-DD; default today..+30 days, at
|
|
4078
|
+
* most 90 days); `limit` is 1-200 (default 100) and applies after the patient scoping. Only scheduled and confirmed
|
|
4079
|
+
* appointments are returned. Each row has `appointment_id`, `patient_id`, `start`, `end`, `status`, `modality`
|
|
4080
|
+
* (`telehealth` or `in_person`), `telehealth_link`, `encounter_id` (the provider's open encounter for the patient)
|
|
4081
|
+
* and a `patient` summary.
|
|
4082
|
+
*/
|
|
4083
|
+
listMyAppointments(filters) {
|
|
4084
|
+
return this.send("GET", "/appointments/mine", { query: filters });
|
|
4085
|
+
}
|
|
4086
|
+
/**
|
|
4087
|
+
* Vital signs of the patients on the provider's encounters, grouped by patient and chart-ready (GET /vitals/mine). Per
|
|
4088
|
+
* patient one series per `metric` (blood_pressure, heart_rate, respiratory_rate, spo2, temperature, weight, glucose,
|
|
4089
|
+
* fev1, fvc, pef, fev1_fvc_ratio): ascending UTC `points` in one fixed `unit`, the `latest` reading and a min/max/avg
|
|
4090
|
+
* `summary`. Window `start_date`..`end_date` (default the last 30 days, at most 90). `bucket` "hour" or "day" averages
|
|
4091
|
+
* points (with `<field>_min`, `<field>_max`, `count`). `source: "rpm"` keeps remote-monitoring readings only. Patients
|
|
4092
|
+
* are paged by `limit` (default 50, at most 200) and `page_token`; `patient_id` narrows to one patient (403 without an
|
|
4093
|
+
* encounter).
|
|
4094
|
+
*/
|
|
4095
|
+
listMyPatientsVitals(filters) {
|
|
4096
|
+
return this.send("GET", "/vitals/mine", { query: filters });
|
|
4097
|
+
}
|
|
4098
|
+
/** The device types a provider can order for a patient (GET /devices/catalog). Use an item's `id` as `catalog_item_id`. */
|
|
4099
|
+
listDeviceCatalog() {
|
|
4100
|
+
return this.send("GET", "/devices/catalog");
|
|
4101
|
+
}
|
|
4102
|
+
/**
|
|
4103
|
+
* Order a catalog device for a patient (`kind: "order"`, needs `catalog_item_id`), or record one the patient already has
|
|
4104
|
+
* (`kind: "add"`, needs `name` or `catalog_item_id`) (POST /patients/{patient_id}/devices). The provider needs an
|
|
4105
|
+
* encounter with the patient (403). An order creates the patient at the device vendor when needed and needs a complete
|
|
4106
|
+
* patient address (409). The patient is notified.
|
|
4107
|
+
*/
|
|
4108
|
+
orderPatientDevice(patientId, request) {
|
|
4109
|
+
return this.send("POST", "/patients/{patient_id}/devices", {
|
|
4110
|
+
pathParams: { patient_id: patientId },
|
|
4111
|
+
body: request
|
|
4112
|
+
});
|
|
4113
|
+
}
|
|
4114
|
+
/** Devices ordered for or added to a patient, newest first, with live vendor status (GET /patients/{patient_id}/devices). */
|
|
4115
|
+
listPatientDevices(patientId) {
|
|
4116
|
+
return this.send("GET", "/patients/{patient_id}/devices", { pathParams: { patient_id: patientId } });
|
|
4117
|
+
}
|
|
4118
|
+
/** Cancel a patient's device request (DELETE /patients/{patient_id}/devices/{device_id}). A vendor order already placed is not recalled. */
|
|
4119
|
+
cancelPatientDevice(patientId, deviceId) {
|
|
4120
|
+
return this.send("DELETE", "/patients/{patient_id}/devices/{device_id}", {
|
|
4121
|
+
pathParams: { patient_id: patientId, device_id: deviceId }
|
|
4122
|
+
});
|
|
4123
|
+
}
|
|
4124
|
+
/**
|
|
4125
|
+
* The care plan of an encounter (GET /encounters/{id}/care-plan): identified problems, goals and expected outcomes,
|
|
4126
|
+
* activities. `care_plan` is null when none has been saved. `include: "related"` adds the encounter's diagnoses,
|
|
4127
|
+
* medications and devices. Only the assigned provider (403); readable after sign-off.
|
|
4128
|
+
*/
|
|
4129
|
+
getEncounterCarePlan(encounterId, options) {
|
|
4130
|
+
return this.send("GET", "/encounters/{encounter_id}/care-plan", {
|
|
4131
|
+
pathParams: { encounter_id: encounterId },
|
|
4132
|
+
query: options
|
|
4133
|
+
});
|
|
4134
|
+
}
|
|
4135
|
+
/**
|
|
4136
|
+
* Create or replace an encounter's care plan (PUT /encounters/{id}/care-plan). Problems may carry an ICD-10-CM `icd10_code`
|
|
4137
|
+
* (400 if unsupported); goals carry an `expected_outcome`; activities may link the encounter's diagnoses, medications or
|
|
4138
|
+
* devices. Items not sent are removed. `status: "draft"` hides the plan from the patient; `active`/`completed` shows it and
|
|
4139
|
+
* notifies them. Only the assigned provider (403); a signed encounter answers 409.
|
|
4140
|
+
*/
|
|
4141
|
+
updateEncounterCarePlan(encounterId, request) {
|
|
4142
|
+
return this.send("PUT", "/encounters/{encounter_id}/care-plan", {
|
|
4143
|
+
pathParams: { encounter_id: encounterId },
|
|
4144
|
+
body: request
|
|
4145
|
+
});
|
|
4146
|
+
}
|
|
4050
4147
|
/**
|
|
4051
4148
|
* Ask the patient to schedule a telehealth appointment (POST /encounters/{id}/telehealth-request). Records a proposed
|
|
4052
4149
|
* telehealth appointment and sends the patient a generic notice. At most one request per encounter per hour: a repeat
|
|
@@ -43,12 +43,14 @@
|
|
|
43
43
|
- [`compareFaceMatch`](../operations/patient.faceMatch.md) — Compare a selfie to the stored reference photo
|
|
44
44
|
- [`getAgent`](../operations/patient.getAgentAgent.md) — Get the routed AMS agent
|
|
45
45
|
- [`getAgentConfiguration`](../operations/patient.getAgentConfigurationAgentconfiguration.md) — Get AMS agent configuration
|
|
46
|
+
- [`getCareTeam`](../operations/patient.getCareTeam.md) — Get my care team
|
|
46
47
|
- [`getCheckin`](../operations/patient.getCheckinCheckin.md) — Get current check-in state
|
|
47
48
|
- [`getCommunicationConsent`](../operations/patient.getCommunicationConsent.md) — Get SMS/phone contact-preference consent
|
|
48
49
|
- [`getCurrentCareSession`](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md) — Get the current care session
|
|
49
50
|
- [`getDefaultProvider`](../operations/patient.getDefaultProvider.md) — Get the tenant default provider
|
|
50
51
|
- [`getDeliveryOrder`](../operations/patient.getDeliveryOrder.md) — Get delivery order and refresh vendor status
|
|
51
52
|
- [`getEncounter`](../operations/patient.getEncounter.md) — Get an encounter
|
|
53
|
+
- [`getEncounterCarePlan`](../operations/patient.getEncounterCarePlan.md) — Get an encounter's care plan
|
|
52
54
|
- [`listPatientInsurances`](../operations/patient.getInsurance.md) — List insurance coverage
|
|
53
55
|
- [`getLatestEncounter`](../operations/patient.getLatestEncounter.md) — Get the patient's latest open encounter
|
|
54
56
|
- [`getMedication`](../operations/patient.getMedication.md) — Get a medication
|
|
@@ -73,8 +75,10 @@
|
|
|
73
75
|
- [`initHealthRecordImport`](../operations/patient.initHealthRecordImport.md) — Check health-record import status
|
|
74
76
|
- [`listAssistantActions`](../operations/patient.listActions.md) — List assistant actions
|
|
75
77
|
- [`listActivity`](../operations/patient.listActivity.md) — List activity
|
|
78
|
+
- [`listMyCarePlans`](../operations/patient.listCarePlans.md) — List my care plans
|
|
76
79
|
- [`listDeliveryOrders`](../operations/patient.listDeliveryOrders.md) — List the patient's delivery orders
|
|
77
80
|
- [`listDependents`](../operations/patient.listDependents.md) — List dependents
|
|
81
|
+
- [`listMyDevices`](../operations/patient.listDevices.md) — List my devices
|
|
78
82
|
- [`listEncounters`](../operations/patient.listEncounters.md) — List encounters
|
|
79
83
|
- [`listImpiloDevices`](../operations/patient.listImpiloDevices.md) — List Impilo device types
|
|
80
84
|
- [`listKnowledge`](../operations/patient.listKnowledge.md) — List knowledge-base collections and entries
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# ProviderClient
|
|
2
2
|
|
|
3
|
+
- [`cancelPatientDevice`](../operations/provider.cancelPatientDevice.md) — Cancel a patient's device request
|
|
3
4
|
- [`claimEncounter`](../operations/provider.claimEncounter.md) — Take an encounter from the queue
|
|
4
5
|
- [`completePractitionerOnboarding`](../operations/provider.completePractitionerOnboarding.md) — Record onboarding completion for the practitioner's current flow
|
|
5
6
|
- [`confirmPassword`](../operations/provider.confirmResetPassword.md) — Complete a password reset
|
|
@@ -10,6 +11,7 @@
|
|
|
10
11
|
- [`deletePractitionerLocation`](../operations/provider.deletePractitionerLocation.md) — Remove a practice location
|
|
11
12
|
- [`getAppointment`](../operations/provider.getAppointment.md) — Get one appointment with patient demographics
|
|
12
13
|
- [`getEncounter`](../operations/provider.getEncounter.md) — Get one of the caller's encounters with patient demographics
|
|
14
|
+
- [`getEncounterCarePlan`](../operations/provider.getEncounterCarePlan.md) — Get an encounter's care plan
|
|
13
15
|
- [`getEncounterQueue`](../operations/provider.getEncounterQueue.md) — The queue of encounters no provider has taken yet
|
|
14
16
|
- [`getHomeSummary`](../operations/provider.getHomeSummary.md) — Counts for the provider's home screen
|
|
15
17
|
- [`getLabOrder`](../operations/provider.getLabOrder.md) — Get one Quest lab order requisition
|
|
@@ -23,15 +25,20 @@
|
|
|
23
25
|
- [`get`](../operations/provider.getPractitioner.md) — Get a practitioner profile
|
|
24
26
|
- [`getPractitionerLocation`](../operations/provider.getPractitionerLocation.md) — Get one practice location
|
|
25
27
|
- [`listAppointments`](../operations/provider.listAppointments.md) — List tenant appointments
|
|
28
|
+
- [`listDeviceCatalog`](../operations/provider.listDeviceCatalog.md) — List orderable devices
|
|
26
29
|
- [`listEncounterMedications`](../operations/provider.listEncounterMedications.md) — List the medications recorded on an encounter
|
|
27
30
|
- [`listEncounters`](../operations/provider.listEncounters.md) — List the caller's own encounters
|
|
28
31
|
- [`listLabCatalog`](../operations/provider.listLabCatalog.md) — List the tests and panels a provider can order
|
|
29
32
|
- [`listLabOrders`](../operations/provider.listLabOrders.md) — List a tenant patient's Quest lab orders
|
|
33
|
+
- [`listMyAppointments`](../operations/provider.listMyAppointments.md) — List appointments of my patients
|
|
34
|
+
- [`listMyPatientsVitals`](../operations/provider.listMyPatientsVitals.md) — List vital-sign time series of my patients
|
|
35
|
+
- [`listPatientDevices`](../operations/provider.listPatientDevices.md) — List a patient's devices
|
|
30
36
|
- [`listPatients`](../operations/provider.listPatients.md) — List or search the calling practitioner's patients
|
|
31
37
|
- [`listPracticeAppointments`](../operations/provider.listPracticeAppointments.md) — List all appointments of the practice
|
|
32
38
|
- [`listPractitionerLocations`](../operations/provider.listPractitionerLocations.md) — List the practitioner's practice locations
|
|
33
39
|
- [`login`](../operations/provider.login.md) — Log in a practitioner
|
|
34
40
|
- [`logout`](../operations/provider.logout.md) — Sign out the practitioner and revoke their tokens
|
|
41
|
+
- [`orderPatientDevice`](../operations/provider.orderPatientDevice.md) — Order or add a device for a patient
|
|
35
42
|
- [`placeLabOrder`](../operations/provider.placeLabOrder.md) — Place a Quest lab order for a tenant patient
|
|
36
43
|
- [`refreshToken`](../operations/provider.refreshToken.md) — Refresh practitioner access tokens
|
|
37
44
|
- [`register`](../operations/provider.register.md) — Register a practitioner
|
|
@@ -42,6 +49,7 @@
|
|
|
42
49
|
- [`setPracticeAvailability`](../operations/provider.setPracticeAvailability.md) — Set the practice's telehealth booking rules
|
|
43
50
|
- [`setPractitionerPortalRoles`](../operations/provider.setPractitionerPortalRoles.md) — Set a practitioner's provider-portal roles (platform admin only)
|
|
44
51
|
- [`signEncounter`](../operations/provider.signEncounter.md) — Sign and complete an encounter
|
|
52
|
+
- [`updateEncounterCarePlan`](../operations/provider.updateEncounterCarePlan.md) — Create or update an encounter's care plan
|
|
45
53
|
- [`updateEncounterClinicalNote`](../operations/provider.updateEncounterClinicalNote.md) — Update encounter notes and assessment
|
|
46
54
|
- [`updateEncounterDiagnoses`](../operations/provider.updateEncounterDiagnoses.md) — Add, change or remove an encounter's diagnoses
|
|
47
55
|
- [`updateEncounterMedications`](../operations/provider.updateEncounterMedications.md) — Add, change or remove an encounter's medications
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:aa67a0a94c821a16019fca2516a039dbba4c7ee22814728e12db3d1fc0ae45f0",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -439,7 +439,16 @@
|
|
|
439
439
|
"models/CancelAppointmentRequest.md",
|
|
440
440
|
"models/CancelTestOrderResponse.md",
|
|
441
441
|
"models/CapturedTestImageResponse.md",
|
|
442
|
+
"models/CarePlan.md",
|
|
443
|
+
"models/CarePlanActivity.md",
|
|
444
|
+
"models/CarePlanGoal.md",
|
|
445
|
+
"models/CarePlanProblem.md",
|
|
446
|
+
"models/CarePlanRelated.md",
|
|
442
447
|
"models/CareSession.md",
|
|
448
|
+
"models/CareTeamLanguage.md",
|
|
449
|
+
"models/CareTeamMember.md",
|
|
450
|
+
"models/CareTeamResponse.md",
|
|
451
|
+
"models/CareTeamSpecialty.md",
|
|
443
452
|
"models/CarequalityDiscoverPatientRequest.md",
|
|
444
453
|
"models/CarequalityDiscoverPatientResponse.md",
|
|
445
454
|
"models/CarequalityImportPatientDocumentsRequest.md",
|
|
@@ -537,6 +546,8 @@
|
|
|
537
546
|
"models/Dependent.md",
|
|
538
547
|
"models/DependentRelationship.md",
|
|
539
548
|
"models/DependentResponse.md",
|
|
549
|
+
"models/DeviceCatalogItem.md",
|
|
550
|
+
"models/DeviceCatalogResponse.md",
|
|
540
551
|
"models/DiagnosisInput.md",
|
|
541
552
|
"models/DiagnosticTest.md",
|
|
542
553
|
"models/DiagnosticTestRelationship.md",
|
|
@@ -1288,6 +1299,8 @@
|
|
|
1288
1299
|
"models/ListObservationsResponse.md",
|
|
1289
1300
|
"models/ListOrderItemsResponse.md",
|
|
1290
1301
|
"models/ListPatientAppointmentsResponse.md",
|
|
1302
|
+
"models/ListPatientCarePlansResponse.md",
|
|
1303
|
+
"models/ListPatientDevicesResponse.md",
|
|
1291
1304
|
"models/ListPatientsResponse.md",
|
|
1292
1305
|
"models/ListPolicyDocumentsResponse.md",
|
|
1293
1306
|
"models/ListProceduresResponse.md",
|
|
@@ -1374,6 +1387,7 @@
|
|
|
1374
1387
|
"models/OpenAIUpdateAssistantResponse.md",
|
|
1375
1388
|
"models/OpenLoopVitalsMirrorResult.md",
|
|
1376
1389
|
"models/OrderItem.md",
|
|
1390
|
+
"models/OrderPatientDeviceRequest.md",
|
|
1377
1391
|
"models/OrderPriority.md",
|
|
1378
1392
|
"models/OrderStatus.md",
|
|
1379
1393
|
"models/OuraBuildAuthorizationUrlRequest.md",
|
|
@@ -1418,13 +1432,17 @@
|
|
|
1418
1432
|
"models/PainScore.md",
|
|
1419
1433
|
"models/ParticipantType.md",
|
|
1420
1434
|
"models/PatientAlertsResponse.md",
|
|
1435
|
+
"models/PatientCarePlanResponse.md",
|
|
1421
1436
|
"models/PatientDemographics.md",
|
|
1437
|
+
"models/PatientDevice.md",
|
|
1438
|
+
"models/PatientEncounterSummary.md",
|
|
1422
1439
|
"models/PatientIntakeRequest.md",
|
|
1423
1440
|
"models/PatientIntakeResponse.md",
|
|
1424
1441
|
"models/PatientLink.md",
|
|
1425
1442
|
"models/PatientLinkType.md",
|
|
1426
1443
|
"models/PatientName.md",
|
|
1427
1444
|
"models/PatientSidebar.md",
|
|
1445
|
+
"models/PatientVitals.md",
|
|
1428
1446
|
"models/PaymentOperationResult.md",
|
|
1429
1447
|
"models/PeakFlowReading.md",
|
|
1430
1448
|
"models/Person.md",
|
|
@@ -1466,6 +1484,7 @@
|
|
|
1466
1484
|
"models/ProviderAppointment.md",
|
|
1467
1485
|
"models/ProviderAppointmentResponse.md",
|
|
1468
1486
|
"models/ProviderAppointmentsResponse.md",
|
|
1487
|
+
"models/ProviderCarePlanResponse.md",
|
|
1469
1488
|
"models/ProviderContactPoint.md",
|
|
1470
1489
|
"models/ProviderCredential.md",
|
|
1471
1490
|
"models/ProviderDriversLicenseSummary.md",
|
|
@@ -1489,6 +1508,9 @@
|
|
|
1489
1508
|
"models/ProviderLocationListResponse.md",
|
|
1490
1509
|
"models/ProviderLocationPatchRequest.md",
|
|
1491
1510
|
"models/ProviderLocationRequest.md",
|
|
1511
|
+
"models/ProviderMyAppointment.md",
|
|
1512
|
+
"models/ProviderMyAppointmentsResponse.md",
|
|
1513
|
+
"models/ProviderMyPatientsVitalsResponse.md",
|
|
1492
1514
|
"models/ProviderOnboardingStatus.md",
|
|
1493
1515
|
"models/ProviderPatientAddress.md",
|
|
1494
1516
|
"models/ProviderPatientInsuranceResponse.md",
|
|
@@ -1914,6 +1936,7 @@
|
|
|
1914
1936
|
"models/UpdateAddressRequest.md",
|
|
1915
1937
|
"models/UpdateAddressResponse.md",
|
|
1916
1938
|
"models/UpdateAgentRequest.md",
|
|
1939
|
+
"models/UpdateCarePlanRequest.md",
|
|
1917
1940
|
"models/UpdateCommunicationConsentRequest.md",
|
|
1918
1941
|
"models/UpdateDemographicsRequest.md",
|
|
1919
1942
|
"models/UpdateDemographicsResponse.md",
|
|
@@ -1960,7 +1983,9 @@
|
|
|
1960
1983
|
"models/VitalReading.md",
|
|
1961
1984
|
"models/VitalsRecord.md",
|
|
1962
1985
|
"models/VitalsRecordRequest.md",
|
|
1986
|
+
"models/VitalsSeries.md",
|
|
1963
1987
|
"models/VitalsStatus.md",
|
|
1988
|
+
"models/VitalsWindow.md",
|
|
1964
1989
|
"models/WhoopActivityIdMappingResponse.md",
|
|
1965
1990
|
"models/WhoopAddTestDataRequest.md",
|
|
1966
1991
|
"models/WhoopAddTestDataResponse.md",
|
|
@@ -3193,12 +3218,14 @@
|
|
|
3193
3218
|
"operations/patient.faceMatch.md",
|
|
3194
3219
|
"operations/patient.getAgentAgent.md",
|
|
3195
3220
|
"operations/patient.getAgentConfigurationAgentconfiguration.md",
|
|
3221
|
+
"operations/patient.getCareTeam.md",
|
|
3196
3222
|
"operations/patient.getCheckinCheckin.md",
|
|
3197
3223
|
"operations/patient.getCommunicationConsent.md",
|
|
3198
3224
|
"operations/patient.getCurrentCareSessionCareSessionsCurrent.md",
|
|
3199
3225
|
"operations/patient.getDefaultProvider.md",
|
|
3200
3226
|
"operations/patient.getDeliveryOrder.md",
|
|
3201
3227
|
"operations/patient.getEncounter.md",
|
|
3228
|
+
"operations/patient.getEncounterCarePlan.md",
|
|
3202
3229
|
"operations/patient.getInsurance.md",
|
|
3203
3230
|
"operations/patient.getLatestEncounter.md",
|
|
3204
3231
|
"operations/patient.getMedication.md",
|
|
@@ -3223,8 +3250,10 @@
|
|
|
3223
3250
|
"operations/patient.initHealthRecordImport.md",
|
|
3224
3251
|
"operations/patient.listActions.md",
|
|
3225
3252
|
"operations/patient.listActivity.md",
|
|
3253
|
+
"operations/patient.listCarePlans.md",
|
|
3226
3254
|
"operations/patient.listDeliveryOrders.md",
|
|
3227
3255
|
"operations/patient.listDependents.md",
|
|
3256
|
+
"operations/patient.listDevices.md",
|
|
3228
3257
|
"operations/patient.listEncounters.md",
|
|
3229
3258
|
"operations/patient.listImpiloDevices.md",
|
|
3230
3259
|
"operations/patient.listKnowledge.md",
|
|
@@ -3283,6 +3312,7 @@
|
|
|
3283
3312
|
"operations/person.uploadPhoto.md",
|
|
3284
3313
|
"operations/person.verifyEmail.md",
|
|
3285
3314
|
"operations/person.verifySms.md",
|
|
3315
|
+
"operations/provider.cancelPatientDevice.md",
|
|
3286
3316
|
"operations/provider.claimEncounter.md",
|
|
3287
3317
|
"operations/provider.completePractitionerOnboarding.md",
|
|
3288
3318
|
"operations/provider.confirmResetPassword.md",
|
|
@@ -3293,6 +3323,7 @@
|
|
|
3293
3323
|
"operations/provider.deletePractitionerLocation.md",
|
|
3294
3324
|
"operations/provider.getAppointment.md",
|
|
3295
3325
|
"operations/provider.getEncounter.md",
|
|
3326
|
+
"operations/provider.getEncounterCarePlan.md",
|
|
3296
3327
|
"operations/provider.getEncounterQueue.md",
|
|
3297
3328
|
"operations/provider.getHomeSummary.md",
|
|
3298
3329
|
"operations/provider.getLabOrder.md",
|
|
@@ -3306,15 +3337,20 @@
|
|
|
3306
3337
|
"operations/provider.getPractitioner.md",
|
|
3307
3338
|
"operations/provider.getPractitionerLocation.md",
|
|
3308
3339
|
"operations/provider.listAppointments.md",
|
|
3340
|
+
"operations/provider.listDeviceCatalog.md",
|
|
3309
3341
|
"operations/provider.listEncounterMedications.md",
|
|
3310
3342
|
"operations/provider.listEncounters.md",
|
|
3311
3343
|
"operations/provider.listLabCatalog.md",
|
|
3312
3344
|
"operations/provider.listLabOrders.md",
|
|
3345
|
+
"operations/provider.listMyAppointments.md",
|
|
3346
|
+
"operations/provider.listMyPatientsVitals.md",
|
|
3347
|
+
"operations/provider.listPatientDevices.md",
|
|
3313
3348
|
"operations/provider.listPatients.md",
|
|
3314
3349
|
"operations/provider.listPracticeAppointments.md",
|
|
3315
3350
|
"operations/provider.listPractitionerLocations.md",
|
|
3316
3351
|
"operations/provider.login.md",
|
|
3317
3352
|
"operations/provider.logout.md",
|
|
3353
|
+
"operations/provider.orderPatientDevice.md",
|
|
3318
3354
|
"operations/provider.placeLabOrder.md",
|
|
3319
3355
|
"operations/provider.refreshToken.md",
|
|
3320
3356
|
"operations/provider.register.md",
|
|
@@ -3325,6 +3361,7 @@
|
|
|
3325
3361
|
"operations/provider.setPracticeAvailability.md",
|
|
3326
3362
|
"operations/provider.setPractitionerPortalRoles.md",
|
|
3327
3363
|
"operations/provider.signEncounter.md",
|
|
3364
|
+
"operations/provider.updateEncounterCarePlan.md",
|
|
3328
3365
|
"operations/provider.updateEncounterClinicalNote.md",
|
|
3329
3366
|
"operations/provider.updateEncounterDiagnoses.md",
|
|
3330
3367
|
"operations/provider.updateEncounterMedications.md",
|
|
@@ -3347,7 +3384,7 @@
|
|
|
3347
3384
|
"operations/vitals.recordVitals.md"
|
|
3348
3385
|
],
|
|
3349
3386
|
"language": "nodejs",
|
|
3350
|
-
"modelCount":
|
|
3351
|
-
"operationCount":
|
|
3387
|
+
"modelCount": 2231,
|
|
3388
|
+
"operationCount": 1096,
|
|
3352
3389
|
"schemaVersion": 1
|
|
3353
3390
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -934,12 +934,14 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
934
934
|
- [Compare a selfie to the stored reference photo](../operations/patient.faceMatch.md)
|
|
935
935
|
- [Get the routed AMS agent](../operations/patient.getAgentAgent.md)
|
|
936
936
|
- [Get AMS agent configuration](../operations/patient.getAgentConfigurationAgentconfiguration.md)
|
|
937
|
+
- [Get my care team](../operations/patient.getCareTeam.md)
|
|
937
938
|
- [Get current check-in state](../operations/patient.getCheckinCheckin.md)
|
|
938
939
|
- [Get SMS/phone contact-preference consent](../operations/patient.getCommunicationConsent.md)
|
|
939
940
|
- [Get the current care session](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md)
|
|
940
941
|
- [Get the tenant default provider](../operations/patient.getDefaultProvider.md)
|
|
941
942
|
- [Get delivery order and refresh vendor status](../operations/patient.getDeliveryOrder.md)
|
|
942
943
|
- [Get an encounter](../operations/patient.getEncounter.md)
|
|
944
|
+
- [Get an encounter's care plan](../operations/patient.getEncounterCarePlan.md)
|
|
943
945
|
- [List insurance coverage](../operations/patient.getInsurance.md)
|
|
944
946
|
- [Get the patient's latest open encounter](../operations/patient.getLatestEncounter.md)
|
|
945
947
|
- [Get a medication](../operations/patient.getMedication.md)
|
|
@@ -964,8 +966,10 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
964
966
|
- [Check health-record import status](../operations/patient.initHealthRecordImport.md)
|
|
965
967
|
- [List assistant actions](../operations/patient.listActions.md)
|
|
966
968
|
- [List activity](../operations/patient.listActivity.md)
|
|
969
|
+
- [List my care plans](../operations/patient.listCarePlans.md)
|
|
967
970
|
- [List the patient's delivery orders](../operations/patient.listDeliveryOrders.md)
|
|
968
971
|
- [List dependents](../operations/patient.listDependents.md)
|
|
972
|
+
- [List my devices](../operations/patient.listDevices.md)
|
|
969
973
|
- [List encounters](../operations/patient.listEncounters.md)
|
|
970
974
|
- [List Impilo device types](../operations/patient.listImpiloDevices.md)
|
|
971
975
|
- [List knowledge-base collections and entries](../operations/patient.listKnowledge.md)
|
|
@@ -1024,6 +1028,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1024
1028
|
- [Upload a person photo](../operations/person.uploadPhoto.md)
|
|
1025
1029
|
- [Verify a person's email OTP](../operations/person.verifyEmail.md)
|
|
1026
1030
|
- [Verify a person's phone OTP](../operations/person.verifySms.md)
|
|
1031
|
+
- [Cancel a patient's device request](../operations/provider.cancelPatientDevice.md)
|
|
1027
1032
|
- [Take an encounter from the queue](../operations/provider.claimEncounter.md)
|
|
1028
1033
|
- [Record onboarding completion for the practitioner's current flow](../operations/provider.completePractitionerOnboarding.md)
|
|
1029
1034
|
- [Complete a password reset](../operations/provider.confirmResetPassword.md)
|
|
@@ -1034,6 +1039,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1034
1039
|
- [Remove a practice location](../operations/provider.deletePractitionerLocation.md)
|
|
1035
1040
|
- [Get one appointment with patient demographics](../operations/provider.getAppointment.md)
|
|
1036
1041
|
- [Get one of the caller's encounters with patient demographics](../operations/provider.getEncounter.md)
|
|
1042
|
+
- [Get an encounter's care plan](../operations/provider.getEncounterCarePlan.md)
|
|
1037
1043
|
- [The queue of encounters no provider has taken yet](../operations/provider.getEncounterQueue.md)
|
|
1038
1044
|
- [Counts for the provider's home screen](../operations/provider.getHomeSummary.md)
|
|
1039
1045
|
- [Get one Quest lab order requisition](../operations/provider.getLabOrder.md)
|
|
@@ -1047,15 +1053,20 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1047
1053
|
- [Get a practitioner profile](../operations/provider.getPractitioner.md)
|
|
1048
1054
|
- [Get one practice location](../operations/provider.getPractitionerLocation.md)
|
|
1049
1055
|
- [List tenant appointments](../operations/provider.listAppointments.md)
|
|
1056
|
+
- [List orderable devices](../operations/provider.listDeviceCatalog.md)
|
|
1050
1057
|
- [List the medications recorded on an encounter](../operations/provider.listEncounterMedications.md)
|
|
1051
1058
|
- [List the caller's own encounters](../operations/provider.listEncounters.md)
|
|
1052
1059
|
- [List the tests and panels a provider can order](../operations/provider.listLabCatalog.md)
|
|
1053
1060
|
- [List a tenant patient's Quest lab orders](../operations/provider.listLabOrders.md)
|
|
1061
|
+
- [List appointments of my patients](../operations/provider.listMyAppointments.md)
|
|
1062
|
+
- [List vital-sign time series of my patients](../operations/provider.listMyPatientsVitals.md)
|
|
1063
|
+
- [List a patient's devices](../operations/provider.listPatientDevices.md)
|
|
1054
1064
|
- [List or search the calling practitioner's patients](../operations/provider.listPatients.md)
|
|
1055
1065
|
- [List all appointments of the practice](../operations/provider.listPracticeAppointments.md)
|
|
1056
1066
|
- [List the practitioner's practice locations](../operations/provider.listPractitionerLocations.md)
|
|
1057
1067
|
- [Log in a practitioner](../operations/provider.login.md)
|
|
1058
1068
|
- [Sign out the practitioner and revoke their tokens](../operations/provider.logout.md)
|
|
1069
|
+
- [Order or add a device for a patient](../operations/provider.orderPatientDevice.md)
|
|
1059
1070
|
- [Place a Quest lab order for a tenant patient](../operations/provider.placeLabOrder.md)
|
|
1060
1071
|
- [Refresh practitioner access tokens](../operations/provider.refreshToken.md)
|
|
1061
1072
|
- [Register a practitioner](../operations/provider.register.md)
|
|
@@ -1066,6 +1077,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1066
1077
|
- [Set the practice's telehealth booking rules](../operations/provider.setPracticeAvailability.md)
|
|
1067
1078
|
- [Set a practitioner's provider-portal roles (platform admin only)](../operations/provider.setPractitionerPortalRoles.md)
|
|
1068
1079
|
- [Sign and complete an encounter](../operations/provider.signEncounter.md)
|
|
1080
|
+
- [Create or update an encounter's care plan](../operations/provider.updateEncounterCarePlan.md)
|
|
1069
1081
|
- [Update encounter notes and assessment](../operations/provider.updateEncounterClinicalNote.md)
|
|
1070
1082
|
- [Add, change or remove an encounter's diagnoses](../operations/provider.updateEncounterDiagnoses.md)
|
|
1071
1083
|
- [Add, change or remove an encounter's medications](../operations/provider.updateEncounterMedications.md)
|
package/docs/index.md
CHANGED
|
@@ -942,12 +942,14 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
942
942
|
- [Compare a selfie to the stored reference photo](operations/patient.faceMatch.md) (`patient.faceMatch`)
|
|
943
943
|
- [Get the routed AMS agent](operations/patient.getAgentAgent.md) (`patient.getAgentAgent`)
|
|
944
944
|
- [Get AMS agent configuration](operations/patient.getAgentConfigurationAgentconfiguration.md) (`patient.getAgentConfigurationAgentconfiguration`)
|
|
945
|
+
- [Get my care team](operations/patient.getCareTeam.md) (`patient.getCareTeam`)
|
|
945
946
|
- [Get current check-in state](operations/patient.getCheckinCheckin.md) (`patient.getCheckinCheckin`)
|
|
946
947
|
- [Get SMS/phone contact-preference consent](operations/patient.getCommunicationConsent.md) (`patient.getCommunicationConsent`)
|
|
947
948
|
- [Get the current care session](operations/patient.getCurrentCareSessionCareSessionsCurrent.md) (`patient.getCurrentCareSessionCareSessionsCurrent`)
|
|
948
949
|
- [Get the tenant default provider](operations/patient.getDefaultProvider.md) (`patient.getDefaultProvider`)
|
|
949
950
|
- [Get delivery order and refresh vendor status](operations/patient.getDeliveryOrder.md) (`patient.getDeliveryOrder`)
|
|
950
951
|
- [Get an encounter](operations/patient.getEncounter.md) (`patient.getEncounter`)
|
|
952
|
+
- [Get an encounter's care plan](operations/patient.getEncounterCarePlan.md) (`patient.getEncounterCarePlan`)
|
|
951
953
|
- [List insurance coverage](operations/patient.getInsurance.md) (`patient.getInsurance`)
|
|
952
954
|
- [Get the patient's latest open encounter](operations/patient.getLatestEncounter.md) (`patient.getLatestEncounter`)
|
|
953
955
|
- [Get a medication](operations/patient.getMedication.md) (`patient.getMedication`)
|
|
@@ -972,8 +974,10 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
972
974
|
- [Check health-record import status](operations/patient.initHealthRecordImport.md) (`patient.initHealthRecordImport`)
|
|
973
975
|
- [List assistant actions](operations/patient.listActions.md) (`patient.listActions`)
|
|
974
976
|
- [List activity](operations/patient.listActivity.md) (`patient.listActivity`)
|
|
977
|
+
- [List my care plans](operations/patient.listCarePlans.md) (`patient.listCarePlans`)
|
|
975
978
|
- [List the patient's delivery orders](operations/patient.listDeliveryOrders.md) (`patient.listDeliveryOrders`)
|
|
976
979
|
- [List dependents](operations/patient.listDependents.md) (`patient.listDependents`)
|
|
980
|
+
- [List my devices](operations/patient.listDevices.md) (`patient.listDevices`)
|
|
977
981
|
- [List encounters](operations/patient.listEncounters.md) (`patient.listEncounters`)
|
|
978
982
|
- [List Impilo device types](operations/patient.listImpiloDevices.md) (`patient.listImpiloDevices`)
|
|
979
983
|
- [List knowledge-base collections and entries](operations/patient.listKnowledge.md) (`patient.listKnowledge`)
|
|
@@ -1032,6 +1036,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1032
1036
|
- [Upload a person photo](operations/person.uploadPhoto.md) (`person.uploadPhoto`)
|
|
1033
1037
|
- [Verify a person's email OTP](operations/person.verifyEmail.md) (`person.verifyEmail`)
|
|
1034
1038
|
- [Verify a person's phone OTP](operations/person.verifySms.md) (`person.verifySms`)
|
|
1039
|
+
- [Cancel a patient's device request](operations/provider.cancelPatientDevice.md) (`provider.cancelPatientDevice`)
|
|
1035
1040
|
- [Take an encounter from the queue](operations/provider.claimEncounter.md) (`provider.claimEncounter`)
|
|
1036
1041
|
- [Record onboarding completion for the practitioner's current flow](operations/provider.completePractitionerOnboarding.md) (`provider.completePractitionerOnboarding`)
|
|
1037
1042
|
- [Complete a password reset](operations/provider.confirmResetPassword.md) (`provider.confirmResetPassword`)
|
|
@@ -1042,6 +1047,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1042
1047
|
- [Remove a practice location](operations/provider.deletePractitionerLocation.md) (`provider.deletePractitionerLocation`)
|
|
1043
1048
|
- [Get one appointment with patient demographics](operations/provider.getAppointment.md) (`provider.getAppointment`)
|
|
1044
1049
|
- [Get one of the caller's encounters with patient demographics](operations/provider.getEncounter.md) (`provider.getEncounter`)
|
|
1050
|
+
- [Get an encounter's care plan](operations/provider.getEncounterCarePlan.md) (`provider.getEncounterCarePlan`)
|
|
1045
1051
|
- [The queue of encounters no provider has taken yet](operations/provider.getEncounterQueue.md) (`provider.getEncounterQueue`)
|
|
1046
1052
|
- [Counts for the provider's home screen](operations/provider.getHomeSummary.md) (`provider.getHomeSummary`)
|
|
1047
1053
|
- [Get one Quest lab order requisition](operations/provider.getLabOrder.md) (`provider.getLabOrder`)
|
|
@@ -1055,15 +1061,20 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1055
1061
|
- [Get a practitioner profile](operations/provider.getPractitioner.md) (`provider.getPractitioner`)
|
|
1056
1062
|
- [Get one practice location](operations/provider.getPractitionerLocation.md) (`provider.getPractitionerLocation`)
|
|
1057
1063
|
- [List tenant appointments](operations/provider.listAppointments.md) (`provider.listAppointments`)
|
|
1064
|
+
- [List orderable devices](operations/provider.listDeviceCatalog.md) (`provider.listDeviceCatalog`)
|
|
1058
1065
|
- [List the medications recorded on an encounter](operations/provider.listEncounterMedications.md) (`provider.listEncounterMedications`)
|
|
1059
1066
|
- [List the caller's own encounters](operations/provider.listEncounters.md) (`provider.listEncounters`)
|
|
1060
1067
|
- [List the tests and panels a provider can order](operations/provider.listLabCatalog.md) (`provider.listLabCatalog`)
|
|
1061
1068
|
- [List a tenant patient's Quest lab orders](operations/provider.listLabOrders.md) (`provider.listLabOrders`)
|
|
1069
|
+
- [List appointments of my patients](operations/provider.listMyAppointments.md) (`provider.listMyAppointments`)
|
|
1070
|
+
- [List vital-sign time series of my patients](operations/provider.listMyPatientsVitals.md) (`provider.listMyPatientsVitals`)
|
|
1071
|
+
- [List a patient's devices](operations/provider.listPatientDevices.md) (`provider.listPatientDevices`)
|
|
1062
1072
|
- [List or search the calling practitioner's patients](operations/provider.listPatients.md) (`provider.listPatients`)
|
|
1063
1073
|
- [List all appointments of the practice](operations/provider.listPracticeAppointments.md) (`provider.listPracticeAppointments`)
|
|
1064
1074
|
- [List the practitioner's practice locations](operations/provider.listPractitionerLocations.md) (`provider.listPractitionerLocations`)
|
|
1065
1075
|
- [Log in a practitioner](operations/provider.login.md) (`provider.login`)
|
|
1066
1076
|
- [Sign out the practitioner and revoke their tokens](operations/provider.logout.md) (`provider.logout`)
|
|
1077
|
+
- [Order or add a device for a patient](operations/provider.orderPatientDevice.md) (`provider.orderPatientDevice`)
|
|
1067
1078
|
- [Place a Quest lab order for a tenant patient](operations/provider.placeLabOrder.md) (`provider.placeLabOrder`)
|
|
1068
1079
|
- [Refresh practitioner access tokens](operations/provider.refreshToken.md) (`provider.refreshToken`)
|
|
1069
1080
|
- [Register a practitioner](operations/provider.register.md) (`provider.register`)
|
|
@@ -1074,6 +1085,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1074
1085
|
- [Set the practice's telehealth booking rules](operations/provider.setPracticeAvailability.md) (`provider.setPracticeAvailability`)
|
|
1075
1086
|
- [Set a practitioner's provider-portal roles (platform admin only)](operations/provider.setPractitionerPortalRoles.md) (`provider.setPractitionerPortalRoles`)
|
|
1076
1087
|
- [Sign and complete an encounter](operations/provider.signEncounter.md) (`provider.signEncounter`)
|
|
1088
|
+
- [Create or update an encounter's care plan](operations/provider.updateEncounterCarePlan.md) (`provider.updateEncounterCarePlan`)
|
|
1077
1089
|
- [Update encounter notes and assessment](operations/provider.updateEncounterClinicalNote.md) (`provider.updateEncounterClinicalNote`)
|
|
1078
1090
|
- [Add, change or remove an encounter's diagnoses](operations/provider.updateEncounterDiagnoses.md) (`provider.updateEncounterDiagnoses`)
|
|
1079
1091
|
- [Add, change or remove an encounter's medications](operations/provider.updateEncounterMedications.md) (`provider.updateEncounterMedications`)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# CarePlan
|
|
2
|
+
|
|
3
|
+
Model ID: `CarePlan`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `activities` | array of [`CarePlanActivity`](./CarePlanActivity.md) | Yes | | | | No | Planned activities, some linked to existing records. |
|
|
14
|
+
| `author_id` | `string|null` | No | | | | Yes | FHIR Practitioner id of the provider who wrote the plan. |
|
|
15
|
+
| `care_plan_id` | `string` | Yes | | | | No | CarePlan resource id (one per encounter). |
|
|
16
|
+
| `created_at` | `string|null` | No | | | | Yes | ISO 8601 time the plan was first saved. |
|
|
17
|
+
| `encounter_id` | `string` | Yes | | | | No | The encounter the plan belongs to. |
|
|
18
|
+
| `goals` | array of [`CarePlanGoal`](./CarePlanGoal.md) | Yes | | | | No | Goals and expected outcomes. |
|
|
19
|
+
| `patient_id` | `string` | Yes | | | | No | FHIR Patient resource id. |
|
|
20
|
+
| `problems` | array of [`CarePlanProblem`](./CarePlanProblem.md) | Yes | | | | No | Identified problems. |
|
|
21
|
+
| `status` | `string` | Yes | | draft, active, completed | | No | draft (provider only), active or completed. |
|
|
22
|
+
| `summary` | `string|null` | No | | | | Yes | Patient-readable summary of the plan. |
|
|
23
|
+
| `title` | `string|null` | No | | | | Yes | Plan title. |
|
|
24
|
+
| `updated_at` | `string|null` | No | | | | Yes | ISO 8601 time the plan was last saved. |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# CarePlanActivity
|
|
2
|
+
|
|
3
|
+
Model ID: `CarePlanActivity`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `activity_id` | `string` | Yes | | | | No | Stable id of the activity inside the plan. |
|
|
14
|
+
| `description` | `string` | Yes | | | | No | What the patient or provider will do. |
|
|
15
|
+
| `reference_id` | `string|null` | No | | | | Yes | Id of the linked record: a medication on the encounter, a device request or an encounter diagnosis condition. |
|
|
16
|
+
| `type` | `string` | Yes | | medication, device, diagnosis, referral, education, follow_up, other | | No | What kind of activity. medication, device and diagnosis can link a record. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# CarePlanGoal
|
|
2
|
+
|
|
3
|
+
Model ID: `CarePlanGoal`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `description` | `string` | Yes | | | | No | The goal. |
|
|
14
|
+
| `expected_outcome` | `string` | Yes | | | | No | What success looks like. |
|
|
15
|
+
| `goal_id` | `string` | Yes | | | | No | Stable id of the goal inside the plan. Send it back to keep the goal. |
|
|
16
|
+
| `problem_ids` | `array` | No | | | | No | Problems in this plan the goal addresses. |
|
|
17
|
+
| `progress_note` | `string|null` | No | | | | Yes | Patient-visible note on progress toward the goal. |
|
|
18
|
+
| `status` | `string` | No | | proposed, active, achieved, not_achieved, cancelled | `"active"` | No | proposed, active, achieved, not_achieved or cancelled. |
|
|
19
|
+
| `target_date` | `string|null` | No | | | | Yes | YYYY-MM-DD the outcome is expected by. |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# CarePlanProblem
|
|
2
|
+
|
|
3
|
+
Model ID: `CarePlanProblem`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `description` | `string` | Yes | | | | No | The identified problem, in words the patient can read. |
|
|
14
|
+
| `icd10_code` | `string|null` | No | | | | Yes | ICD-10-CM code from GET /icd10, when the problem has one. |
|
|
15
|
+
| `icd10_display` | `string|null` | No | | | | Yes | ICD-10-CM description of the code. Always set by the server. |
|
|
16
|
+
| `notes` | `string|null` | No | | | | Yes | Patient-visible notes about the problem. |
|
|
17
|
+
| `priority` | `string|null` | No | | | | Yes | high, medium or low, when set. |
|
|
18
|
+
| `problem_id` | `string` | Yes | | | | No | Stable id of the problem inside the plan. Send it back to keep the problem. |
|
|
19
|
+
| `status` | `string` | No | | active, resolved, inactive | `"active"` | No | active, resolved or inactive. |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CarePlanRelated
|
|
2
|
+
|
|
3
|
+
Model ID: `CarePlanRelated`
|
|
4
|
+
|
|
5
|
+
The encounter's other records, so one call shows the whole picture.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `devices` | `array` | Yes | | | | No | Devices ordered or added for the encounter. |
|
|
14
|
+
| `diagnoses` | `array` | Yes | | | | No | The encounter's diagnoses. |
|
|
15
|
+
| `medications` | `array` | Yes | | | | No | The encounter's medications. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|