@healthcloudai/hc-sdk 3.5.2 → 3.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +153 -17
- package/dist/index.d.cts +1618 -182
- package/dist/index.d.ts +1618 -182
- package/dist/index.js +153 -17
- package/docs/clients/AppointmentsClient.md +1 -1
- package/docs/clients/PatientClient.md +4 -1
- package/docs/clients/ProviderClient.md +1 -0
- package/docs/docs-manifest.json +28 -5
- package/docs/examples/index.md +6 -2
- package/docs/index.md +6 -2
- package/docs/models/AddPatientIntakeRequest.md +24 -0
- package/docs/models/AddPatientIntakeResponse.md +17 -0
- package/docs/models/AdvanceDirective.md +31 -0
- package/docs/models/AdvanceDirectiveType.md +15 -0
- package/docs/models/AthenaListAppointmentsRequest.md +1 -1
- package/docs/models/CarequalityRetrieveDocumentsRequest.md +1 -1
- package/docs/models/DirectiveScope.md +15 -0
- package/docs/models/DirectiveStatus.md +15 -0
- package/docs/models/GetAppointmentTelehealthLinkResponse.md +1 -1
- package/docs/models/GetHealthRecordResponse.md +2 -2
- package/docs/models/Immunization.md +40 -0
- package/docs/models/ImmunizationRoute.md +15 -0
- package/docs/models/ImmunizationStatus.md +15 -0
- package/docs/models/ListDirectivesResponse.md +1 -1
- package/docs/models/ListImmunizationsResponse.md +1 -1
- package/docs/models/ListProceduresResponse.md +1 -1
- package/docs/models/OpenAIEmbedRequest.md +1 -1
- package/docs/models/Procedure.md +37 -0
- package/docs/models/ProcedureLaterality.md +15 -0
- package/docs/models/ProcedureStatus.md +15 -0
- package/docs/models/SendGridSendEmailRequest.md +1 -1
- package/docs/models/StediClaimsResponse.md +18 -0
- package/docs/models/StediEligibilityBatchItem.md +22 -0
- package/docs/models/StediEligibilityBatchRequest.md +17 -0
- package/docs/models/StediEligibilityBatchResponse.md +17 -0
- package/docs/models/StediEligibilityCheckRequest.md +21 -0
- package/docs/models/StediRawX12EligibilityRequest.md +17 -0
- package/docs/models/VaccinationSite.md +15 -0
- package/docs/models/ehr.ImmunizationReaction.md +20 -0
- package/docs/models/ehr.ListMedicationsResponse.md +1 -1
- package/docs/models/index.md +20 -1
- package/docs/operations/appointments.getTelehealthLink.md +4 -4
- package/docs/operations/connectors.athenaListAppointments.md +1 -3
- package/docs/operations/connectors.carequalityRetrieveDocuments.md +11 -7
- package/docs/operations/connectors.openaiEmbed.md +3 -7
- package/docs/operations/connectors.sendgridSend.md +3 -7
- package/docs/operations/diagnostics.lookupTestByGs1.md +11 -3
- package/docs/operations/ehr.listMedications.md +2 -2
- package/docs/operations/patient.addPatientIntake.md +138 -0
- package/docs/operations/patient.checkPatientInsuranceEligibility.md +170 -0
- package/docs/operations/patient.listMedications.md +2 -2
- package/docs/operations/patient.listPatientInsuranceClaims.md +181 -0
- package/docs/operations/patient.submitPatientRawX12Eligibility.md +162 -0
- package/docs/operations/provider.submitInsuranceEligibilityBatch.md +164 -0
- package/package.json +1 -1
- package/docs/models/CheckEligibilityRequest.md +0 -23
- package/docs/operations/patient.checkEligibility.md +0 -147
|
@@ -10,7 +10,7 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `date` | `string` |
|
|
13
|
+
| `date` | `string` | No | | | | Yes | |
|
|
14
14
|
| `department_id` | `string` | No | | | | No | |
|
|
15
15
|
| `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
|
|
16
16
|
| `patient_id` | `string` | No | | | | Yes | |
|
|
@@ -11,7 +11,7 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `api_key` | `string` | No | | | | No | Vendor credential. Sent with the request and never returned. |
|
|
14
|
-
| `documents` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | |
|
|
14
|
+
| `documents` | array of [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | Yes | |
|
|
15
15
|
| `initiator_url` | `string` | No | | | | No | |
|
|
16
16
|
| `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
|
|
17
17
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `GetHealthRecordResponse`
|
|
4
4
|
|
|
5
|
-
Response for GET /patients/{patient_id}/record. Consolidated
|
|
5
|
+
Response for GET /patients/{patient_id}/record. Consolidated health-record envelope, serialized domain models throughout.
|
|
6
6
|
|
|
7
7
|
Type: `object`
|
|
8
8
|
|
|
@@ -11,7 +11,7 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
|
|
14
|
-
| `resources` | `object` | Yes | | | | No | Resources grouped by type (conditions, allergies, medications, procedures, immunizations, family_history,
|
|
14
|
+
| `resources` | `object` | Yes | | | | No | Resources grouped by type (conditions, allergies, medications, procedures, immunizations, family_history, consents, social_history, functional_status, gyn_history, perinatal_history, observations, encounters, vitals, questionnaire_responses, diagnostics, intake_submissions). Medications includes MedicationRequest and patient-reported MedicationStatement. intake_submissions lists this patient's raw intake submission records (same shape as the patient intake GET endpoint); it is also available individually from that endpoint by submission_id. conditions/allergies/medications/procedures/immunizations/family_history/consents/gyn_history/perinatal_history are serialized domain models (Problem, Allergy, Medication, Procedure, Immunization, FamilyHistoryEntry, AdvanceDirective, GynHistory, PerinatalHistory) — the same shape returned by each resource's own list endpoint where one exists. social_history and functional_status are each a single serialized SocialHistory/FunctionalStatus record (0 or 1 entries), aggregated from that patient's social-history/survey-category Observations; fields never recorded as an Observation (e.g. SocialHistory.gender_identity) stay at their default. observations still holds every raw FHIR Observation for the patient, including the ones folded into social_history/functional_status/gyn_history/perinatal_history above — there is no dedicated domain model for Observation in general. encounters, questionnaire responses, diagnostics, the vitals list, and intake_submissions are serialized service results. A resource type with a failed downstream fetch appears as an empty list, not an error. |
|
|
15
15
|
| `totals` | `object` | Yes | | | | No | Count of records per resource type key in `resources`. |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Immunization
|
|
2
|
+
|
|
3
|
+
Model ID: `Immunization`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `administered_by` | `string|null` | No | | | `null` | Yes | |
|
|
14
|
+
| `administered_date` | `string|null` | No | | | `null` | Yes | |
|
|
15
|
+
| `administered_datetime` | `string|null` | No | | | `null` | Yes | |
|
|
16
|
+
| `cvx_code` | `string|null` | No | | | `null` | Yes | |
|
|
17
|
+
| `dose_number` | `integer|null` | No | | | `null` | Yes | |
|
|
18
|
+
| `dose_quantity` | `number|null` | No | | | `null` | Yes | |
|
|
19
|
+
| `dose_unit` | `string|null` | No | | | `null` | Yes | |
|
|
20
|
+
| `expiration_date` | `string|null` | No | | | `null` | Yes | |
|
|
21
|
+
| `fhir_id` | `string|null` | No | | | `null` | Yes | |
|
|
22
|
+
| `immunization_id` | `string` | No | uuid | | | No | |
|
|
23
|
+
| `lot_number` | `string|null` | No | | | `null` | Yes | |
|
|
24
|
+
| `manufacturer` | `string|null` | No | | | `null` | Yes | |
|
|
25
|
+
| `mvx_code` | `string|null` | No | | | `null` | Yes | |
|
|
26
|
+
| `not_done_reason` | `string|null` | No | | | `null` | Yes | |
|
|
27
|
+
| `notes` | `string|null` | No | | | `null` | Yes | |
|
|
28
|
+
| `reactions` | array of [`ehr.ImmunizationReaction`](./ehr.ImmunizationReaction.md) | No | | | | No | |
|
|
29
|
+
| `reason_codes` | `array` | No | | | | No | |
|
|
30
|
+
| `route` | [`ImmunizationRoute`](./ImmunizationRoute.md) | No | | | `null` | Yes | |
|
|
31
|
+
| `series_doses` | `integer|null` | No | | | `null` | Yes | |
|
|
32
|
+
| `series_name` | `string|null` | No | | | `null` | Yes | |
|
|
33
|
+
| `site` | [`VaccinationSite`](./VaccinationSite.md) | No | | | `null` | Yes | |
|
|
34
|
+
| `status` | [`ImmunizationStatus`](./ImmunizationStatus.md) | No | | | `"completed"` | No | |
|
|
35
|
+
| `vaccine_name` | `string` | Yes | | | | No | |
|
|
36
|
+
| `vis_document_date` | `string|null` | No | | | `null` | Yes | |
|
|
37
|
+
|
|
38
|
+
## Example
|
|
39
|
+
|
|
40
|
+
None declared in canonical OpenAPI.
|
|
@@ -10,7 +10,7 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `directives` |
|
|
13
|
+
| `directives` | array of [`AdvanceDirective`](./AdvanceDirective.md) | Yes | | | | No | |
|
|
14
14
|
| `patient_id` | `string` | Yes | | | | No | |
|
|
15
15
|
| `total` | `integer` | Yes | | | | No | |
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `immunizations` |
|
|
13
|
+
| `immunizations` | array of [`Immunization`](./Immunization.md) | Yes | | | | No | |
|
|
14
14
|
| `patient_id` | `string` | Yes | | | | No | |
|
|
15
15
|
| `total` | `integer` | Yes | | | | No | |
|
|
16
16
|
|
|
@@ -11,7 +11,7 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `patient_id` | `string` | Yes | | | | No | |
|
|
14
|
-
| `procedures` |
|
|
14
|
+
| `procedures` | array of [`Procedure`](./Procedure.md) | Yes | | | | No | |
|
|
15
15
|
| `total` | `integer` | Yes | | | | No | |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
@@ -16,7 +16,7 @@ Type: `object`
|
|
|
16
16
|
| `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
|
|
17
17
|
| `model` | `string` | No | | | `"text-embedding-3-small"` | No | |
|
|
18
18
|
| `organization` | `string` | No | | | | Yes | |
|
|
19
|
-
| `text` |
|
|
19
|
+
| `text` | `string|array` | Yes | | | | No | |
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Procedure
|
|
2
|
+
|
|
3
|
+
Model ID: `Procedure`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `anesthesia_type` | `string|null` | No | | | `null` | Yes | |
|
|
14
|
+
| `body_sites` | `array` | No | | | | No | |
|
|
15
|
+
| `complications` | `array` | No | | | | No | |
|
|
16
|
+
| `cpt_code` | `string|null` | No | | | `null` | Yes | |
|
|
17
|
+
| `description` | `string` | Yes | | | | No | |
|
|
18
|
+
| `encounter_id` | `string|null` | No | | | `null` | Yes | |
|
|
19
|
+
| `facility` | `string|null` | No | | | `null` | Yes | |
|
|
20
|
+
| `fhir_id` | `string|null` | No | | | `null` | Yes | |
|
|
21
|
+
| `indication` | `string|null` | No | | | `null` | Yes | |
|
|
22
|
+
| `laterality` | [`ProcedureLaterality`](./ProcedureLaterality.md) | No | | | `null` | Yes | |
|
|
23
|
+
| `notes` | `string|null` | No | | | `null` | Yes | |
|
|
24
|
+
| `outcome` | `string|null` | No | | | `null` | Yes | |
|
|
25
|
+
| `performed_date` | `string|null` | No | | | `null` | Yes | |
|
|
26
|
+
| `performed_date_end` | `string|null` | No | | | `null` | Yes | |
|
|
27
|
+
| `performer_id` | `string|null` | No | | | `null` | Yes | |
|
|
28
|
+
| `performer_name` | `string|null` | No | | | `null` | Yes | |
|
|
29
|
+
| `problem_reference` | `string|null` | No | | | `null` | Yes | |
|
|
30
|
+
| `procedure_id` | `string` | No | uuid | | | No | |
|
|
31
|
+
| `reported` | `boolean` | No | | | `false` | No | |
|
|
32
|
+
| `snomed_code` | `string|null` | No | | | `null` | Yes | |
|
|
33
|
+
| `status` | [`ProcedureStatus`](./ProcedureStatus.md) | No | | | `"completed"` | No | |
|
|
34
|
+
|
|
35
|
+
## Example
|
|
36
|
+
|
|
37
|
+
None declared in canonical OpenAPI.
|
|
@@ -21,7 +21,7 @@ Type: `object`
|
|
|
21
21
|
| `subject` | `string` | Yes | | | | No | |
|
|
22
22
|
| `template_id` | `string` | No | | | | Yes | |
|
|
23
23
|
| `text_content` | `string` | No | | | | Yes | |
|
|
24
|
-
| `to` |
|
|
24
|
+
| `to` | `string|array` | Yes | | | | No | |
|
|
25
25
|
|
|
26
26
|
## Example
|
|
27
27
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# StediClaimsResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `StediClaimsResponse`
|
|
4
|
+
|
|
5
|
+
Paginated Stedi claims returned for the authenticated patient.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `items` | `array` | No | | | | No | Claim summaries returned by Stedi. |
|
|
14
|
+
| `nextPageToken` | `string|null` | No | | | | Yes | Token for the next claims page, when available. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# StediEligibilityBatchItem
|
|
2
|
+
|
|
3
|
+
Model ID: `StediEligibilityBatchItem`
|
|
4
|
+
|
|
5
|
+
One Stedi Eligibility Manager request item.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `dependent` | `object|null` | No | | | | Yes | Optional dependent identity when checking dependent coverage. |
|
|
14
|
+
| `encounter` | `object|null` | No | | | | Yes | Optional requested service types and service dates. |
|
|
15
|
+
| `provider` | `object` | Yes | | | | No | Requesting provider identity in Stedi batch format. |
|
|
16
|
+
| `submitter_transaction_identifier` | `string` | Yes | | | | No | Caller-generated identifier for this eligibility transaction. |
|
|
17
|
+
| `subscriber` | `object` | Yes | | | | No | Subscriber identity and member ID in Stedi batch format. |
|
|
18
|
+
| `trading_partner_service_id` | `string` | Yes | | | | No | Stedi payer or trading-partner service identifier. |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# StediEligibilityBatchRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `StediEligibilityBatchRequest`
|
|
4
|
+
|
|
5
|
+
Asynchronous Stedi Eligibility Manager batch submission.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `items` | array of [`StediEligibilityBatchItem`](./StediEligibilityBatchItem.md) | Yes | | | | No | Eligibility checks to submit asynchronously. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# StediEligibilityBatchResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `StediEligibilityBatchResponse`
|
|
4
|
+
|
|
5
|
+
Stedi tracking information returned after accepting a batch.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `batchId` | `string` | Yes | | | | No | Stedi identifier used to retrieve batch processing results. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# StediEligibilityCheckRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `StediEligibilityCheckRequest`
|
|
4
|
+
|
|
5
|
+
Request for the current Stedi real-time eligibility API.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `dependent` | `object|null` | No | | | | Yes | Dependent identity when eligibility is not for the subscriber. |
|
|
14
|
+
| `encounter` | `object|null` | No | | | | Yes | Optional service types and service dates. |
|
|
15
|
+
| `payer_id` | `string` | Yes | | | | No | Stedi payer identifier. |
|
|
16
|
+
| `provider` | `object` | Yes | | | | No | Requesting provider identity in Stedi eligibility format. |
|
|
17
|
+
| `subscriber` | `object` | Yes | | | | No | Subscriber identity and member ID in Stedi eligibility format. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# StediRawX12EligibilityRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `StediRawX12EligibilityRequest`
|
|
4
|
+
|
|
5
|
+
Raw X12 270 request for POST /insurance/eligibility/x12.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `x12` | `string` | Yes | | | | No | Complete X12 270 eligibility request. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ImmunizationReaction
|
|
2
|
+
|
|
3
|
+
Model ID: `ehr.ImmunizationReaction`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `notes` | `string|null` | No | | | `null` | Yes | |
|
|
14
|
+
| `onset_date` | `string|null` | No | | | `null` | Yes | |
|
|
15
|
+
| `reaction` | `string` | Yes | | | | No | |
|
|
16
|
+
| `severity` | [`ReactionSeverity`](./ReactionSeverity.md) | No | | | `null` | Yes | |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -10,7 +10,7 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `medications` | `array` | Yes | | | | No | Medication resources matching the ?resource_type= filter
|
|
13
|
+
| `medications` | `array` | Yes | | | | No | Medication resources matching the ?resource_type= filter, in serialized domain-model format. Without ?resource_type=, returns both MedicationRequest and MedicationStatement. |
|
|
14
14
|
| `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
|
|
15
15
|
| `total` | `integer` | Yes | | | | No | Number of medications in this response. |
|
|
16
16
|
|
package/docs/models/index.md
CHANGED
|
@@ -10,8 +10,12 @@
|
|
|
10
10
|
- [AddInsuranceRequest](AddInsuranceRequest.md)
|
|
11
11
|
- [AddInsuranceResponse](AddInsuranceResponse.md)
|
|
12
12
|
- [AddNotificationResponse](AddNotificationResponse.md)
|
|
13
|
+
- [AddPatientIntakeRequest](AddPatientIntakeRequest.md)
|
|
14
|
+
- [AddPatientIntakeResponse](AddPatientIntakeResponse.md)
|
|
13
15
|
- [Address](Address.md)
|
|
14
16
|
- [AddressType](AddressType.md)
|
|
17
|
+
- [AdvanceDirective](AdvanceDirective.md)
|
|
18
|
+
- [AdvanceDirectiveType](AdvanceDirectiveType.md)
|
|
15
19
|
- [AgentDashboardResponse](AgentDashboardResponse.md)
|
|
16
20
|
- [Allergy](Allergy.md)
|
|
17
21
|
- [AllergyCategory](AllergyCategory.md)
|
|
@@ -386,7 +390,6 @@
|
|
|
386
390
|
- [CarequalityRetrieveDocumentsResponse](CarequalityRetrieveDocumentsResponse.md)
|
|
387
391
|
- [CareSession](CareSession.md)
|
|
388
392
|
- [ChatMessageRecord](ChatMessageRecord.md)
|
|
389
|
-
- [CheckEligibilityRequest](CheckEligibilityRequest.md)
|
|
390
393
|
- [CheckEncounterRequest](CheckEncounterRequest.md)
|
|
391
394
|
- [CheckEncounterResponse](CheckEncounterResponse.md)
|
|
392
395
|
- [CheckInEncounterRequest](CheckInEncounterRequest.md)
|
|
@@ -467,6 +470,8 @@
|
|
|
467
470
|
- [ReferenceRange](diagnostics.ReferenceRange.md)
|
|
468
471
|
- [DiagnosticTest](DiagnosticTest.md)
|
|
469
472
|
- [DiagnosticTestRelationship](DiagnosticTestRelationship.md)
|
|
473
|
+
- [DirectiveScope](DirectiveScope.md)
|
|
474
|
+
- [DirectiveStatus](DirectiveStatus.md)
|
|
470
475
|
- [DischargeDisposition](DischargeDisposition.md)
|
|
471
476
|
- [DocumentSummary](DocumentSummary.md)
|
|
472
477
|
- [DocumentSummarySearchRequest](DocumentSummarySearchRequest.md)
|
|
@@ -477,6 +482,7 @@
|
|
|
477
482
|
- [CodedConcept](ehr.CodedConcept.md)
|
|
478
483
|
- [ehr.ConnectResponse](ehr.ConnectResponse.md)
|
|
479
484
|
- [FamilyCondition](ehr.FamilyCondition.md)
|
|
485
|
+
- [ImmunizationReaction](ehr.ImmunizationReaction.md)
|
|
480
486
|
- [DiagnosticsListResponse](ehr.ListDiagnosticsResponse.md)
|
|
481
487
|
- [EncounterListResponse](ehr.ListEncountersResponse.md)
|
|
482
488
|
- [MedicationListResponse](ehr.ListMedicationsResponse.md)
|
|
@@ -1060,6 +1066,9 @@
|
|
|
1060
1066
|
- [HealthPlanSearchResponse](HealthPlanSearchResponse.md)
|
|
1061
1067
|
- [HealthPlanSummary](HealthPlanSummary.md)
|
|
1062
1068
|
- [HeartRateVital](HeartRateVital.md)
|
|
1069
|
+
- [Immunization](Immunization.md)
|
|
1070
|
+
- [ImmunizationRoute](ImmunizationRoute.md)
|
|
1071
|
+
- [ImmunizationStatus](ImmunizationStatus.md)
|
|
1063
1072
|
- [ImpiloAddress](ImpiloAddress.md)
|
|
1064
1073
|
- [ImpiloAlertConfig](ImpiloAlertConfig.md)
|
|
1065
1074
|
- [ImpiloAlertConfiguration](ImpiloAlertConfiguration.md)
|
|
@@ -1407,6 +1416,9 @@
|
|
|
1407
1416
|
- [ProblemClinicalStatus](ProblemClinicalStatus.md)
|
|
1408
1417
|
- [ProblemSeverity](ProblemSeverity.md)
|
|
1409
1418
|
- [ProblemVerificationStatus](ProblemVerificationStatus.md)
|
|
1419
|
+
- [Procedure](Procedure.md)
|
|
1420
|
+
- [ProcedureLaterality](ProcedureLaterality.md)
|
|
1421
|
+
- [ProcedureStatus](ProcedureStatus.md)
|
|
1410
1422
|
- [ProviderConfirmResetPasswordRequest](provider.ConfirmResetPasswordRequest.md)
|
|
1411
1423
|
- [ProviderConfirmResetPasswordResponse](provider.ConfirmResetPasswordResponse.md)
|
|
1412
1424
|
- [provider.ConnectResponse](provider.ConnectResponse.md)
|
|
@@ -1768,10 +1780,16 @@
|
|
|
1768
1780
|
- [StediCheckClaimStatusRequest](StediCheckClaimStatusRequest.md)
|
|
1769
1781
|
- [StediCheckCoordinationOfBenefitsRequest](StediCheckCoordinationOfBenefitsRequest.md)
|
|
1770
1782
|
- [StediCheckEligibilityRequest](StediCheckEligibilityRequest.md)
|
|
1783
|
+
- [StediClaimsResponse](StediClaimsResponse.md)
|
|
1771
1784
|
- [StediDiscoverInsuranceRequest](StediDiscoverInsuranceRequest.md)
|
|
1785
|
+
- [StediEligibilityBatchItem](StediEligibilityBatchItem.md)
|
|
1786
|
+
- [StediEligibilityBatchRequest](StediEligibilityBatchRequest.md)
|
|
1787
|
+
- [StediEligibilityBatchResponse](StediEligibilityBatchResponse.md)
|
|
1788
|
+
- [StediEligibilityCheckRequest](StediEligibilityCheckRequest.md)
|
|
1772
1789
|
- [StediEligibilityCheckResponse](StediEligibilityCheckResponse.md)
|
|
1773
1790
|
- [StediGet835EraReportRequest](StediGet835EraReportRequest.md)
|
|
1774
1791
|
- [StediGetInsuranceDiscoveryResultsRequest](StediGetInsuranceDiscoveryResultsRequest.md)
|
|
1792
|
+
- [StediRawX12EligibilityRequest](StediRawX12EligibilityRequest.md)
|
|
1775
1793
|
- [StediSubmitClaimRequest](StediSubmitClaimRequest.md)
|
|
1776
1794
|
- [StediSubmitInstitutionalClaimRequest](StediSubmitInstitutionalClaimRequest.md)
|
|
1777
1795
|
- [StediSubmitProfessionalClaimRequest](StediSubmitProfessionalClaimRequest.md)
|
|
@@ -1852,6 +1870,7 @@
|
|
|
1852
1870
|
- [UpsertInviteRequest](UpsertInviteRequest.md)
|
|
1853
1871
|
- [UpsertMessageRequest](UpsertMessageRequest.md)
|
|
1854
1872
|
- [UpsertPresenceRequest](UpsertPresenceRequest.md)
|
|
1873
|
+
- [VaccinationSite](VaccinationSite.md)
|
|
1855
1874
|
- [VectorCollection](VectorCollection.md)
|
|
1856
1875
|
- [VectorSearchDocumentsRequest](VectorSearchDocumentsRequest.md)
|
|
1857
1876
|
- [VectorSearchHit](VectorSearchHit.md)
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Get
|
|
1
|
+
# Get an authorized appointment's telehealth join link
|
|
2
2
|
|
|
3
3
|
Operation ID: `appointments.getTelehealthLink`
|
|
4
4
|
|
|
5
|
-
Get
|
|
5
|
+
Get an authorized appointment's telehealth join link
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -50,7 +50,7 @@ None declared in canonical OpenAPI.
|
|
|
50
50
|
|
|
51
51
|
| Status | Shape | Content type | Description |
|
|
52
52
|
|---|---|---|---|
|
|
53
|
-
| `200` | [`GetAppointmentTelehealthLinkResponse`](../models/GetAppointmentTelehealthLinkResponse.md) | application/json |
|
|
53
|
+
| `200` | [`GetAppointmentTelehealthLinkResponse`](../models/GetAppointmentTelehealthLinkResponse.md) | application/json | Telehealth join link for the requested appointment |
|
|
54
54
|
|
|
55
55
|
## Success response examples
|
|
56
56
|
|
|
@@ -58,7 +58,7 @@ None declared in canonical OpenAPI.
|
|
|
58
58
|
|
|
59
59
|
```json
|
|
60
60
|
{
|
|
61
|
-
"telehealth_link": "
|
|
61
|
+
"telehealth_link": "string"
|
|
62
62
|
}
|
|
63
63
|
```
|
|
64
64
|
|
|
@@ -49,7 +49,6 @@ Request model: [`AthenaListAppointmentsRequest`](../models/AthenaListAppointment
|
|
|
49
49
|
"date": "example-date",
|
|
50
50
|
"department_id": "12345",
|
|
51
51
|
"mode": "sandbox",
|
|
52
|
-
"patient_id": "12345",
|
|
53
52
|
"practice_id": "12345",
|
|
54
53
|
"provider_id": "12345",
|
|
55
54
|
"secret_key": "example-api-key"
|
|
@@ -150,7 +149,6 @@ const body = {
|
|
|
150
149
|
"date": "example-date",
|
|
151
150
|
"department_id": "12345",
|
|
152
151
|
"mode": "sandbox",
|
|
153
|
-
"patient_id": "12345",
|
|
154
152
|
"practice_id": "12345",
|
|
155
153
|
"provider_id": "12345",
|
|
156
154
|
"secret_key": "example-api-key"
|
|
@@ -165,7 +163,7 @@ const result = await connectors.athena.createClient(config).listAppointments(bod
|
|
|
165
163
|
curl -X POST \
|
|
166
164
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
167
165
|
-H 'Content-Type: application/json' \
|
|
168
|
-
-d '{"date":"example-date","department_id":"12345","mode":"sandbox","
|
|
166
|
+
-d '{"date":"example-date","department_id":"12345","mode":"sandbox","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
|
|
169
167
|
'https://dev-api-connectors.health.cloud/connectors/athena-health/list-appointments'
|
|
170
168
|
```
|
|
171
169
|
|
|
@@ -47,9 +47,11 @@ Request model: [`CarequalityRetrieveDocumentsRequest`](../models/CarequalityRetr
|
|
|
47
47
|
```json
|
|
48
48
|
{
|
|
49
49
|
"api_key": "example-api-key",
|
|
50
|
-
"documents":
|
|
51
|
-
|
|
52
|
-
|
|
50
|
+
"documents": [
|
|
51
|
+
{
|
|
52
|
+
"vendorField": "vendor-defined value"
|
|
53
|
+
}
|
|
54
|
+
],
|
|
53
55
|
"initiator_url": "https://example.com/resource",
|
|
54
56
|
"mode": "sandbox"
|
|
55
57
|
}
|
|
@@ -135,9 +137,11 @@ import type { CarequalityRetrieveDocumentsRequest } from "@healthcloudai/hc-sdk"
|
|
|
135
137
|
```ts
|
|
136
138
|
const body = {
|
|
137
139
|
"api_key": "example-api-key",
|
|
138
|
-
"documents":
|
|
139
|
-
|
|
140
|
-
|
|
140
|
+
"documents": [
|
|
141
|
+
{
|
|
142
|
+
"vendorField": "vendor-defined value"
|
|
143
|
+
}
|
|
144
|
+
],
|
|
141
145
|
"initiator_url": "https://example.com/resource",
|
|
142
146
|
"mode": "sandbox"
|
|
143
147
|
};
|
|
@@ -151,7 +155,7 @@ const result = await connectors.carequality.createClient(config).retrieveDocumen
|
|
|
151
155
|
curl -X POST \
|
|
152
156
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
153
157
|
-H 'Content-Type: application/json' \
|
|
154
|
-
-d '{"api_key":"example-api-key","documents":{"vendorField":"vendor-defined value"},"initiator_url":"https://example.com/resource","mode":"sandbox"}' \
|
|
158
|
+
-d '{"api_key":"example-api-key","documents":[{"vendorField":"vendor-defined value"}],"initiator_url":"https://example.com/resource","mode":"sandbox"}' \
|
|
155
159
|
'https://dev-api-connectors.health.cloud/connectors/carequality/retrieve-documents'
|
|
156
160
|
```
|
|
157
161
|
|