@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
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Icd10SearchResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `Icd10SearchResponse`
|
|
4
|
+
|
|
5
|
+
ICD-10-CM codes matching a search.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `codes` | array of [`Icd10Code`](./Icd10Code.md) | Yes | | | | No | Matches, best first. |
|
|
14
|
+
| `release` | `string` | Yes | | | | No | The ICD-10-CM release the served subset comes from, for example ICD-10-CM FY2026. |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | Number of codes returned. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LabCatalogItem
|
|
2
|
+
|
|
3
|
+
Model ID: `LabCatalogItem`
|
|
4
|
+
|
|
5
|
+
A test or panel a provider can order.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `catalog_item_id` | `string` | Yes | | | | No | Use this as items[].catalog_item_id when placing a lab order. |
|
|
14
|
+
| `collection_modality` | `string|null` | No | | | | Yes | psc, home_kit, clinician_collected, ... |
|
|
15
|
+
| `description` | `string|null` | No | | | | Yes | |
|
|
16
|
+
| `kind` | `string` | Yes | | test, panel | | No | |
|
|
17
|
+
| `loinc_codes` | `array` | No | | | | No | |
|
|
18
|
+
| `name` | `string` | Yes | | | | No | |
|
|
19
|
+
| `short_name` | `string|null` | No | | | | Yes | |
|
|
20
|
+
| `vendor` | `string|null` | No | | | | Yes | |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# LabCatalogResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `LabCatalogResponse`
|
|
4
|
+
|
|
5
|
+
GET /lab-orders/catalog.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `items` | array of [`LabCatalogItem`](./LabCatalogItem.md) | Yes | | | | No | |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
package/docs/models/LabOrder.md
CHANGED
|
@@ -15,6 +15,7 @@ Type: `object`
|
|
|
15
15
|
| `authored_at` | `string|null` | No | | | | Yes | When the order was placed, ISO 8601 with offset. |
|
|
16
16
|
| `collection_modality` | `string` | Yes | | psc, home_kit | | No | |
|
|
17
17
|
| `diagnoses` | array of [`LabOrderDiagnosis`](./LabOrderDiagnosis.md) | Yes | | | | No | |
|
|
18
|
+
| `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter the order was placed from, when linked. |
|
|
18
19
|
| `expected_collection_at` | `string|null` | No | | | | Yes | OBR-7: expected PSC visit or kit collection. |
|
|
19
20
|
| `fhir_status` | `string` | Yes | | | | No | ServiceRequest.status: draft, active, completed (Quest reported every test final) or revoked. |
|
|
20
21
|
| `lab` | `string` | Yes | | | | No | Quest performing lab, MET. |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ProviderDriversLicenseSummary
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderDriversLicenseSummary`
|
|
4
|
+
|
|
5
|
+
A driver's license without its number: only the last four characters are returned.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `expiration_date` | `string|null` | No | | | | Yes | License expiration date, when known. |
|
|
14
|
+
| `number_last4` | `string|null` | No | | | | Yes | Last four characters of the license number, when on file. |
|
|
15
|
+
| `state` | `string|null` | No | | | | Yes | 2-letter US state code. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ProviderEncounterQueueResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderEncounterQueueResponse`
|
|
4
|
+
|
|
5
|
+
The newest encounters in the caller's tenant that no provider is assigned to.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `encounters` | array of [`ProviderQueueEncounter`](./ProviderQueueEncounter.md) | Yes | | | | No | At most `limit` unassigned encounters, newest created first. No status filter is applied. |
|
|
14
|
+
| `limit` | `integer` | Yes | | | | No | Maximum number of encounters the queue returns. |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | Number of encounters returned. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -38,6 +38,8 @@ Type: `object`
|
|
|
38
38
|
| `service_provider_id` | `string|null` | No | | | | Yes | FHIR Organization id of the service provider, when linked. |
|
|
39
39
|
| `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
|
|
40
40
|
| `service_type_display` | `string|null` | No | | | | Yes | Display text for the service type, when available. |
|
|
41
|
+
| `signed_at` | `string|null` | No | | | | Yes | UTC datetime when the encounter was signed, when signed. |
|
|
42
|
+
| `signed_by` | `string|null` | No | | | | Yes | FHIR Practitioner id of the provider who signed (completed) the encounter, when signed. |
|
|
41
43
|
| `status` | [`EncounterStatus`](./EncounterStatus.md) | No | | | `"planned"` | No | Encounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error, or unknown. |
|
|
42
44
|
| `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. |
|
|
43
45
|
| `steadymd_episode_guid` | `string|null` | No | | | | Yes | SteadyMD episode guid this encounter is linked to, when checked in via SteadyMD. |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ProviderPatientInsuranceResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientInsuranceResponse`
|
|
4
|
+
|
|
5
|
+
GET /patients/{patient_id}/insurance.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `insurances` | array of [`Insurance`](./Insurance.md) | Yes | | | | No | The patient's coverages, primary first. |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# ProviderPatientProfile
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientProfile`
|
|
4
|
+
|
|
5
|
+
Everything the patient's own profile holds that a clinician needs.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `active` | `boolean` | No | | | `true` | No | |
|
|
14
|
+
| `addresses` | array of [`Address`](./Address.md) | No | | | | No | |
|
|
15
|
+
| `athena_patient_id` | `string|null` | No | | | | Yes | Athena patient id, when linked. |
|
|
16
|
+
| `communications` | array of [`Communication`](./Communication.md) | No | | | | No | Languages the patient speaks. |
|
|
17
|
+
| `date_of_birth` | `string` | Yes | date | | | No | |
|
|
18
|
+
| `deceased` | `boolean` | No | | | `false` | No | |
|
|
19
|
+
| `deceased_date` | `string|null` | No | | | | Yes | |
|
|
20
|
+
| `drivers_license` | [`ProviderDriversLicenseSummary`](./ProviderDriversLicenseSummary.md) | No | | | | Yes | |
|
|
21
|
+
| `email` | `string|null` | No | | | | Yes | |
|
|
22
|
+
| `emergency_contacts` | array of [`EmergencyContact`](./EmergencyContact.md) | No | | | | No | |
|
|
23
|
+
| `ethnicity` | [`Ethnicity`](./Ethnicity.md) | No | | | | Yes | |
|
|
24
|
+
| `flags` | `object` | No | | | | No | The patient's boolean flags. |
|
|
25
|
+
| `gender` | [`Gender`](./Gender.md) | Yes | | | | No | |
|
|
26
|
+
| `gender_identity` | [`GenderIdentity`](./GenderIdentity.md) | No | | | | Yes | |
|
|
27
|
+
| `impilo_patient_id` | `string|null` | No | | | | Yes | Impilo patient id, when linked. |
|
|
28
|
+
| `marital_status` | [`MaritalStatus`](./MaritalStatus.md) | No | | | | Yes | |
|
|
29
|
+
| `mrn` | `string|null` | No | | | | Yes | Medical record number. |
|
|
30
|
+
| `name` | [`PatientName`](./PatientName.md) | Yes | | | | No | |
|
|
31
|
+
| `nationality` | `string|null` | No | | | | Yes | |
|
|
32
|
+
| `openloop_patient_id` | `string|null` | No | | | | Yes | OpenLoop patient id, when linked. |
|
|
33
|
+
| `patient_id` | `string` | Yes | | | | No | FHIR Patient resource id. |
|
|
34
|
+
| `phones` | array of [`Phone`](./Phone.md) | No | | | | No | |
|
|
35
|
+
| `preferred_language` | `string|null` | No | | | | Yes | |
|
|
36
|
+
| `race` | array of [`Race`](./Race.md) | No | | | | No | |
|
|
37
|
+
| `sex_at_birth` | [`SexAtBirth`](./SexAtBirth.md) | No | | | | Yes | |
|
|
38
|
+
| `steadymd_patient_guid` | `string|null` | No | | | | Yes | SteadyMD patient guid, when linked. |
|
|
39
|
+
|
|
40
|
+
## Example
|
|
41
|
+
|
|
42
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# ProviderPatientProfileResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientProfileResponse`
|
|
4
|
+
|
|
5
|
+
GET /patients/{patient_id}/profile.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `communication_consent` | [`CommunicationConsent`](./CommunicationConsent.md) | Yes | | | | No | SMS and phone contact consent; each is null when never recorded. |
|
|
14
|
+
| `dependents` | array of [`Dependent`](./Dependent.md) | No | | | | No | Dependents the patient recorded. |
|
|
15
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
16
|
+
| `preferred_pharmacy` | [`PreferredPharmacy`](./PreferredPharmacy.md) | No | | | | Yes | The patient's preferred pharmacy, when set. |
|
|
17
|
+
| `profile` | [`ProviderPatientProfile`](./ProviderPatientProfile.md) | Yes | | | | No | |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# ProviderQueueEncounter
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderQueueEncounter`
|
|
4
|
+
|
|
5
|
+
One unassigned encounter in the queue. Use `fhir_id` in route paths such as /encounters/{id}/claim.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `created_date` | `string|null` | No | | | | Yes | When the encounter was created, in ISO 8601 form, when recorded. |
|
|
14
|
+
| `encounter_class` | `string` | Yes | | | | No | Encounter class code, for example AMB or VR. |
|
|
15
|
+
| `encounter_id` | `string` | Yes | | | | No | HealthCloud encounter identifier (UUID). |
|
|
16
|
+
| `fhir_id` | `string` | Yes | | | | No | FHIR Encounter resource ID. Use this in route paths. |
|
|
17
|
+
| `patient` | [`ProviderQueuePatient`](./ProviderQueuePatient.md) | No | | | | Yes | Minimal patient summary, present when the patient record is readable. |
|
|
18
|
+
| `period_start` | `string|null` | No | | | | Yes | Scheduled or actual start in ISO 8601 form, when recorded. |
|
|
19
|
+
| `priority_display` | `string|null` | No | | | | Yes | Priority text, when available. |
|
|
20
|
+
| `reason_code` | `string|null` | No | | | | Yes | Reason-for-visit code, when coded. |
|
|
21
|
+
| `reason_display` | `string|null` | No | | | | Yes | Reason-for-visit text, when available. |
|
|
22
|
+
| `status` | `string` | Yes | | | | No | Encounter status, for example planned, arrived or triaged. |
|
|
23
|
+
| `type_code` | `string|null` | No | | | | Yes | SNOMED CT encounter type code, when coded. |
|
|
24
|
+
| `type_display` | `string|null` | No | | | | Yes | Encounter type text, when available. |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# ProviderQueuePatient
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderQueuePatient`
|
|
4
|
+
|
|
5
|
+
The minimum about a patient that the open-encounter queue shows before a provider takes the encounter.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `date_of_birth` | `string|null` | No | | | | Yes | Patient's date of birth in ISO date format. |
|
|
14
|
+
| `first_name` | `string|null` | No | | | | Yes | Patient's first (given) name. |
|
|
15
|
+
| `gender` | `string|null` | No | | | | Yes | Administrative gender: male, female, other, or unknown. |
|
|
16
|
+
| `last_name` | `string|null` | No | | | | Yes | Patient's last (family) name. |
|
|
17
|
+
| `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# SignEncounterResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `SignEncounterResponse`
|
|
4
|
+
|
|
5
|
+
Result of signing (completing) an encounter.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `ehr_status` | `string` | Yes | | updated, not_linked, skipped | | No | Whether a linked EHR encounter was updated too. |
|
|
14
|
+
| `encounter` | [`ProviderEncounterRecord`](./ProviderEncounterRecord.md) | Yes | | | | No | The finished encounter, with `signed_by` and `signed_at`. It is locked: later changes answer 409. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TelehealthRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `TelehealthRequest`
|
|
4
|
+
|
|
5
|
+
A request for the patient to schedule a telehealth appointment.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `encounter_id` | `string` | Yes | | | | No | |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
15
|
+
| `preferred_window` | `string|null` | No | | | | Yes | |
|
|
16
|
+
| `request_id` | `string` | Yes | | | | No | FHIR Appointment id of the proposed telehealth appointment. |
|
|
17
|
+
| `requested_at` | `string|null` | No | | | | Yes | ISO 8601 time the request was recorded. |
|
|
18
|
+
| `status` | `string` | Yes | | | | No | proposed until the patient books a time. |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TelehealthRequestInput
|
|
2
|
+
|
|
3
|
+
Model ID: `TelehealthRequestInput`
|
|
4
|
+
|
|
5
|
+
Optional body of POST /encounters/{id}/telehealth-request.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `preferred_window` | `string|null` | No | | | | Yes | When the provider would like the visit, in words. Never sent to the patient. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TelehealthRequestResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `TelehealthRequestResponse`
|
|
4
|
+
|
|
5
|
+
Result of POST /encounters/{id}/telehealth-request.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `created` | `boolean` | Yes | | | | No | False when a request for this encounter was already made within the last hour: nothing was created and the patient was not notified again. |
|
|
14
|
+
| `patient_notified` | `boolean` | Yes | | | | No | True when this call wrote the patient notification. |
|
|
15
|
+
| `request` | [`TelehealthRequest`](./TelehealthRequest.md) | Yes | | | | No | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# UpdateEncounterDiagnosesRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `UpdateEncounterDiagnosesRequest`
|
|
4
|
+
|
|
5
|
+
The complete diagnosis list for an encounter. Anything not listed is removed.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `diagnoses` | array of [`DiagnosisInput`](./DiagnosisInput.md) | Yes | | | | No | At most 12 diagnoses. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# UpdateEncounterDiagnosesResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `UpdateEncounterDiagnosesResponse`
|
|
4
|
+
|
|
5
|
+
Result of replacing an encounter's diagnoses.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `encounter` | [`ProviderEncounterRecord`](./ProviderEncounterRecord.md) | Yes | | | | No | The updated encounter. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# UpdateEncounterMedicationsRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `UpdateEncounterMedicationsRequest`
|
|
4
|
+
|
|
5
|
+
The complete medication list for an encounter. Anything not listed is removed.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `medications` | array of [`EncounterMedicationInput`](./EncounterMedicationInput.md) | Yes | | | | No | At most 25 medications. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -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. |
|
package/docs/models/index.md
CHANGED
|
@@ -405,6 +405,7 @@
|
|
|
405
405
|
- [CheckEncounterResponse](CheckEncounterResponse.md)
|
|
406
406
|
- [CheckInEncounterRequest](CheckInEncounterRequest.md)
|
|
407
407
|
- [CheckInEncounterResponse](CheckInEncounterResponse.md)
|
|
408
|
+
- [ClaimEncounterResponse](ClaimEncounterResponse.md)
|
|
408
409
|
- [ClinicalObservation](ClinicalObservation.md)
|
|
409
410
|
- [CMSCounty](CMSCounty.md)
|
|
410
411
|
- [CmsGetCountyFipsRequest](CmsGetCountyFipsRequest.md)
|
|
@@ -421,6 +422,7 @@
|
|
|
421
422
|
- [CommsListMessagesResponse](CommsListMessagesResponse.md)
|
|
422
423
|
- [CommsListPresenceResponse](CommsListPresenceResponse.md)
|
|
423
424
|
- [Communication](Communication.md)
|
|
425
|
+
- [CommunicationConsent](CommunicationConsent.md)
|
|
424
426
|
- [CommunicationConsentResponse](CommunicationConsentResponse.md)
|
|
425
427
|
- [CompendiumSyncResult](CompendiumSyncResult.md)
|
|
426
428
|
- [ConnectivityResponse](ConnectivityResponse.md)
|
|
@@ -480,7 +482,10 @@
|
|
|
480
482
|
- [DeliveryOrder](DeliveryOrder.md)
|
|
481
483
|
- [DeliveryPharmacy](DeliveryPharmacy.md)
|
|
482
484
|
- [DemographicsMatch](DemographicsMatch.md)
|
|
485
|
+
- [Dependent](Dependent.md)
|
|
486
|
+
- [DependentRelationship](DependentRelationship.md)
|
|
483
487
|
- [DependentResponse](DependentResponse.md)
|
|
488
|
+
- [EncounterDiagnosisInput](DiagnosisInput.md)
|
|
484
489
|
- [Coding](diagnostics.Coding.md)
|
|
485
490
|
- [diagnostics.ConnectResponse](diagnostics.ConnectResponse.md)
|
|
486
491
|
- [ErrorResponse](diagnostics.ErrorResponse.md)
|
|
@@ -562,6 +567,8 @@
|
|
|
562
567
|
- [EncounterClass](EncounterClass.md)
|
|
563
568
|
- [EncounterClinicalState](EncounterClinicalState.md)
|
|
564
569
|
- [EncounterEffect](EncounterEffect.md)
|
|
570
|
+
- [EncounterMedicationInput](EncounterMedicationInput.md)
|
|
571
|
+
- [EncounterMedicationsResponse](EncounterMedicationsResponse.md)
|
|
565
572
|
- [EncounterOperationError](EncounterOperationError.md)
|
|
566
573
|
- [EncounterOperationResponse](EncounterOperationResponse.md)
|
|
567
574
|
- [EncounterSections](EncounterSections.md)
|
|
@@ -1109,6 +1116,8 @@
|
|
|
1109
1116
|
- [HealthPlanSearchResponse](HealthPlanSearchResponse.md)
|
|
1110
1117
|
- [HealthPlanSummary](HealthPlanSummary.md)
|
|
1111
1118
|
- [HeartRateVital](HeartRateVital.md)
|
|
1119
|
+
- [Icd10Code](Icd10Code.md)
|
|
1120
|
+
- [Icd10SearchResponse](Icd10SearchResponse.md)
|
|
1112
1121
|
- [ImmunizationRoute](ImmunizationRoute.md)
|
|
1113
1122
|
- [ImmunizationStatus](ImmunizationStatus.md)
|
|
1114
1123
|
- [ImpiloAddress](ImpiloAddress.md)
|
|
@@ -1245,6 +1254,8 @@
|
|
|
1245
1254
|
- [KnowledgeCollection](KnowledgeCollection.md)
|
|
1246
1255
|
- [KnowledgeEntrySummary](KnowledgeEntrySummary.md)
|
|
1247
1256
|
- [KnowledgeSearchResult](KnowledgeSearchResult.md)
|
|
1257
|
+
- [LabCatalogItem](LabCatalogItem.md)
|
|
1258
|
+
- [LabCatalogResponse](LabCatalogResponse.md)
|
|
1248
1259
|
- [LabOrder](LabOrder.md)
|
|
1249
1260
|
- [LabOrderDiagnosis](LabOrderDiagnosis.md)
|
|
1250
1261
|
- [LabOrderErrorResponse](LabOrderErrorResponse.md)
|
|
@@ -1552,8 +1563,10 @@
|
|
|
1552
1563
|
- [ProviderAppointmentsResponse](ProviderAppointmentsResponse.md)
|
|
1553
1564
|
- [ProviderContactPoint](ProviderContactPoint.md)
|
|
1554
1565
|
- [ProviderCredential](ProviderCredential.md)
|
|
1566
|
+
- [ProviderDriversLicenseSummary](ProviderDriversLicenseSummary.md)
|
|
1555
1567
|
- [ProviderEducationCredential](ProviderEducationCredential.md)
|
|
1556
1568
|
- [ProviderEncounterListResponse](ProviderEncounterListResponse.md)
|
|
1569
|
+
- [ProviderEncounterQueueResponse](ProviderEncounterQueueResponse.md)
|
|
1557
1570
|
- [ProviderEncounterRecord](ProviderEncounterRecord.md)
|
|
1558
1571
|
- [ProviderEncounterResponse](ProviderEncounterResponse.md)
|
|
1559
1572
|
- [ProviderEncounterStatusCounts](ProviderEncounterStatusCounts.md)
|
|
@@ -1571,14 +1584,19 @@
|
|
|
1571
1584
|
- [ProviderLocationRequest](ProviderLocationRequest.md)
|
|
1572
1585
|
- [ProviderOnboardingStatus](ProviderOnboardingStatus.md)
|
|
1573
1586
|
- [ProviderPatientAddress](ProviderPatientAddress.md)
|
|
1587
|
+
- [ProviderPatientInsuranceResponse](ProviderPatientInsuranceResponse.md)
|
|
1574
1588
|
- [ProviderPatientListResponse](ProviderPatientListResponse.md)
|
|
1575
1589
|
- [ProviderPatientPhone](ProviderPatientPhone.md)
|
|
1590
|
+
- [ProviderPatientProfile](ProviderPatientProfile.md)
|
|
1591
|
+
- [ProviderPatientProfileResponse](ProviderPatientProfileResponse.md)
|
|
1576
1592
|
- [ProviderPatientRecordResources](ProviderPatientRecordResources.md)
|
|
1577
1593
|
- [ProviderPatientRecordResponse](ProviderPatientRecordResponse.md)
|
|
1578
1594
|
- [ProviderPatientResponse](ProviderPatientResponse.md)
|
|
1579
1595
|
- [ProviderPatientSummary](ProviderPatientSummary.md)
|
|
1580
1596
|
- [ProviderPostgraduateTraining](ProviderPostgraduateTraining.md)
|
|
1581
1597
|
- [ProviderProfessionalLiability](ProviderProfessionalLiability.md)
|
|
1598
|
+
- [ProviderQueueEncounter](ProviderQueueEncounter.md)
|
|
1599
|
+
- [ProviderQueuePatient](ProviderQueuePatient.md)
|
|
1582
1600
|
- [ProviderRole](ProviderRole.md)
|
|
1583
1601
|
- [ProviderSearchRequest](ProviderSearchRequest.md)
|
|
1584
1602
|
- [ProviderSearchResponse](ProviderSearchResponse.md)
|
|
@@ -1836,6 +1854,7 @@
|
|
|
1836
1854
|
- [SetPreferredPharmacyResponse](SetPreferredPharmacyResponse.md)
|
|
1837
1855
|
- [SexAtBirth](SexAtBirth.md)
|
|
1838
1856
|
- [SexualOrientation](SexualOrientation.md)
|
|
1857
|
+
- [SignEncounterResponse](SignEncounterResponse.md)
|
|
1839
1858
|
- [Slot](Slot.md)
|
|
1840
1859
|
- [SlotStatus](SlotStatus.md)
|
|
1841
1860
|
- [SmokingStatus](SmokingStatus.md)
|
|
@@ -1957,6 +1976,9 @@
|
|
|
1957
1976
|
- [SubstanceUse](SubstanceUse.md)
|
|
1958
1977
|
- [telehealth.ConnectResponse](telehealth.ConnectResponse.md)
|
|
1959
1978
|
- [ErrorResponse](telehealth.ErrorResponse.md)
|
|
1979
|
+
- [TelehealthRequest](TelehealthRequest.md)
|
|
1980
|
+
- [TelehealthRequestInput](TelehealthRequestInput.md)
|
|
1981
|
+
- [TelehealthRequestResponse](TelehealthRequestResponse.md)
|
|
1960
1982
|
- [TelehealthToken](TelehealthToken.md)
|
|
1961
1983
|
- [TemperatureRoute](TemperatureRoute.md)
|
|
1962
1984
|
- [TestOrder](TestOrder.md)
|
|
@@ -1993,6 +2015,9 @@
|
|
|
1993
2015
|
- [UpdateDriversLicenseResponse](UpdateDriversLicenseResponse.md)
|
|
1994
2016
|
- [UpdateEncounterClinicalNoteRequest](UpdateEncounterClinicalNoteRequest.md)
|
|
1995
2017
|
- [UpdateEncounterClinicalNoteResponse](UpdateEncounterClinicalNoteResponse.md)
|
|
2018
|
+
- [UpdateEncounterDiagnosesRequest](UpdateEncounterDiagnosesRequest.md)
|
|
2019
|
+
- [UpdateEncounterDiagnosesResponse](UpdateEncounterDiagnosesResponse.md)
|
|
2020
|
+
- [UpdateEncounterMedicationsRequest](UpdateEncounterMedicationsRequest.md)
|
|
1996
2021
|
- [UpdateEncounterStatusRequest](UpdateEncounterStatusRequest.md)
|
|
1997
2022
|
- [UpdateEncounterStatusResponse](UpdateEncounterStatusResponse.md)
|
|
1998
2023
|
- [UpdateMedicationRequest](UpdateMedicationRequest.md)
|
|
@@ -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. |
|
|
@@ -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. |
|
|
@@ -121,6 +121,8 @@ None declared in canonical OpenAPI.
|
|
|
121
121
|
"service_provider_id": "string",
|
|
122
122
|
"service_type_code": "string",
|
|
123
123
|
"service_type_display": "string",
|
|
124
|
+
"signed_at": "2026-01-01T09:00:00Z",
|
|
125
|
+
"signed_by": "string",
|
|
124
126
|
"status": "planned",
|
|
125
127
|
"steadymd_consult_guid": "string",
|
|
126
128
|
"steadymd_episode_guid": "string",
|