@healthcloudai/hc-sdk 3.5.2 → 3.6.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 +35 -0
- package/dist/index.d.cts +1028 -101
- package/dist/index.d.ts +1028 -101
- package/dist/index.js +35 -0
- package/docs/clients/PatientClient.md +1 -0
- package/docs/docs-manifest.json +18 -3
- package/docs/examples/index.md +1 -0
- package/docs/index.md +1 -0
- 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/CarequalityRetrieveDocumentsRequest.md +1 -1
- package/docs/models/DirectiveScope.md +15 -0
- package/docs/models/DirectiveStatus.md +15 -0
- 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/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 +14 -0
- 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 +117 -0
- package/docs/operations/patient.listMedications.md +2 -2
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -2007,8 +2007,43 @@ function PatientIntakeResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
2007
2007
|
};
|
|
2008
2008
|
}
|
|
2009
2009
|
|
|
2010
|
+
// src/models/openapi-generated/patient/models/AddPatientIntakeRequest.ts
|
|
2011
|
+
function AddPatientIntakeRequestToJSON(json) {
|
|
2012
|
+
return AddPatientIntakeRequestToJSONTyped(json, false);
|
|
2013
|
+
}
|
|
2014
|
+
function AddPatientIntakeRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
2015
|
+
if (value == null) {
|
|
2016
|
+
return value;
|
|
2017
|
+
}
|
|
2018
|
+
return {
|
|
2019
|
+
"patient_id": value["patient_id"],
|
|
2020
|
+
"section": value["section"],
|
|
2021
|
+
"summary": value["summary"]
|
|
2022
|
+
};
|
|
2023
|
+
}
|
|
2024
|
+
|
|
2025
|
+
// src/models/openapi-generated/patient/models/AddPatientIntakeResponse.ts
|
|
2026
|
+
function AddPatientIntakeResponseFromJSON(json) {
|
|
2027
|
+
return AddPatientIntakeResponseFromJSONTyped(json, false);
|
|
2028
|
+
}
|
|
2029
|
+
function AddPatientIntakeResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
2030
|
+
if (json == null) {
|
|
2031
|
+
return json;
|
|
2032
|
+
}
|
|
2033
|
+
return {
|
|
2034
|
+
"error_messages": json["error_messages"] == null ? void 0 : json["error_messages"]
|
|
2035
|
+
};
|
|
2036
|
+
}
|
|
2037
|
+
|
|
2010
2038
|
// src/clients/PatientClient.ts
|
|
2011
2039
|
var PatientClient = class extends BaseServiceClient {
|
|
2040
|
+
/** Add one agent-collected intake section and return actionable validation errors. */
|
|
2041
|
+
async addToIntake(patientId, section, summary) {
|
|
2042
|
+
const response = await this.send("POST", "/healthrecords/intake/add", {
|
|
2043
|
+
body: AddPatientIntakeRequestToJSON({ patient_id: patientId, section, summary })
|
|
2044
|
+
});
|
|
2045
|
+
return AddPatientIntakeResponseFromJSON(response);
|
|
2046
|
+
}
|
|
2012
2047
|
/** Add patient-reported history; each call creates a new server-identified submission. */
|
|
2013
2048
|
async submitPatientIntake(request) {
|
|
2014
2049
|
const response = await this.send("POST", "/patients/health-record/intake", {
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
- [`saveDependent`](../operations/patient.addDependent.md) — Add a dependent
|
|
4
4
|
- [`createInsurance`](../operations/patient.addInsurance.md) — Add insurance coverage
|
|
5
5
|
- [`saveNotification`](../operations/patient.addNotification.md) — Add a notification
|
|
6
|
+
- [`addToIntake`](../operations/patient.addPatientIntake.md) — Add one structured patient intake section
|
|
6
7
|
- [`scanIdentityDocument`](../operations/patient.analyzeIdentityDocument.md) — OCR an identity document
|
|
7
8
|
- [`askAssistant`](../operations/patient.assistantChat.md) — Grounded assistant chat
|
|
8
9
|
- [`classifyVoiceCommand`](../operations/patient.assistantClassify.md) — Classify a voice command into an action code
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:9dac17adea31cd5e5abf5a8401ec858439479d3cc87a23b2ee5b052e97aee3ec",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -60,8 +60,12 @@
|
|
|
60
60
|
"models/AddInsuranceRequest.md",
|
|
61
61
|
"models/AddInsuranceResponse.md",
|
|
62
62
|
"models/AddNotificationResponse.md",
|
|
63
|
+
"models/AddPatientIntakeRequest.md",
|
|
64
|
+
"models/AddPatientIntakeResponse.md",
|
|
63
65
|
"models/Address.md",
|
|
64
66
|
"models/AddressType.md",
|
|
67
|
+
"models/AdvanceDirective.md",
|
|
68
|
+
"models/AdvanceDirectiveType.md",
|
|
65
69
|
"models/AgentDashboardResponse.md",
|
|
66
70
|
"models/Allergy.md",
|
|
67
71
|
"models/AllergyCategory.md",
|
|
@@ -509,6 +513,8 @@
|
|
|
509
513
|
"models/DependentResponse.md",
|
|
510
514
|
"models/DiagnosticTest.md",
|
|
511
515
|
"models/DiagnosticTestRelationship.md",
|
|
516
|
+
"models/DirectiveScope.md",
|
|
517
|
+
"models/DirectiveStatus.md",
|
|
512
518
|
"models/DischargeDisposition.md",
|
|
513
519
|
"models/DocumentSummary.md",
|
|
514
520
|
"models/DocumentSummarySearchRequest.md",
|
|
@@ -1071,6 +1077,9 @@
|
|
|
1071
1077
|
"models/HealthieUpdateUserRequest.md",
|
|
1072
1078
|
"models/HealthieUpdateUserResponse.md",
|
|
1073
1079
|
"models/HeartRateVital.md",
|
|
1080
|
+
"models/Immunization.md",
|
|
1081
|
+
"models/ImmunizationRoute.md",
|
|
1082
|
+
"models/ImmunizationStatus.md",
|
|
1074
1083
|
"models/ImpiloAddress.md",
|
|
1075
1084
|
"models/ImpiloAlertConfig.md",
|
|
1076
1085
|
"models/ImpiloAlertConfiguration.md",
|
|
@@ -1362,6 +1371,9 @@
|
|
|
1362
1371
|
"models/ProblemClinicalStatus.md",
|
|
1363
1372
|
"models/ProblemSeverity.md",
|
|
1364
1373
|
"models/ProblemVerificationStatus.md",
|
|
1374
|
+
"models/Procedure.md",
|
|
1375
|
+
"models/ProcedureLaterality.md",
|
|
1376
|
+
"models/ProcedureStatus.md",
|
|
1365
1377
|
"models/ProviderAcceptedInsurance.md",
|
|
1366
1378
|
"models/ProviderContactPoint.md",
|
|
1367
1379
|
"models/ProviderEducationCredential.md",
|
|
@@ -1783,6 +1795,7 @@
|
|
|
1783
1795
|
"models/UpsertInviteRequest.md",
|
|
1784
1796
|
"models/UpsertMessageRequest.md",
|
|
1785
1797
|
"models/UpsertPresenceRequest.md",
|
|
1798
|
+
"models/VaccinationSite.md",
|
|
1786
1799
|
"models/VectorCollection.md",
|
|
1787
1800
|
"models/VectorSearchDocumentsRequest.md",
|
|
1788
1801
|
"models/VectorSearchHit.md",
|
|
@@ -1937,6 +1950,7 @@
|
|
|
1937
1950
|
"models/ehr.CodedConcept.md",
|
|
1938
1951
|
"models/ehr.ConnectResponse.md",
|
|
1939
1952
|
"models/ehr.FamilyCondition.md",
|
|
1953
|
+
"models/ehr.ImmunizationReaction.md",
|
|
1940
1954
|
"models/ehr.ListDiagnosticsResponse.md",
|
|
1941
1955
|
"models/ehr.ListEncountersResponse.md",
|
|
1942
1956
|
"models/ehr.ListMedicationsResponse.md",
|
|
@@ -2937,6 +2951,7 @@
|
|
|
2937
2951
|
"operations/patient.addDependent.md",
|
|
2938
2952
|
"operations/patient.addInsurance.md",
|
|
2939
2953
|
"operations/patient.addNotification.md",
|
|
2954
|
+
"operations/patient.addPatientIntake.md",
|
|
2940
2955
|
"operations/patient.analyzeIdentityDocument.md",
|
|
2941
2956
|
"operations/patient.assistantChat.md",
|
|
2942
2957
|
"operations/patient.assistantClassify.md",
|
|
@@ -3061,7 +3076,7 @@
|
|
|
3061
3076
|
"operations/vitals.recordVitals.md"
|
|
3062
3077
|
],
|
|
3063
3078
|
"language": "nodejs",
|
|
3064
|
-
"modelCount":
|
|
3065
|
-
"operationCount":
|
|
3079
|
+
"modelCount": 2005,
|
|
3080
|
+
"operationCount": 1014,
|
|
3066
3081
|
"schemaVersion": 1
|
|
3067
3082
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -893,6 +893,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
893
893
|
- [Add a dependent](../operations/patient.addDependent.md)
|
|
894
894
|
- [Add insurance coverage](../operations/patient.addInsurance.md)
|
|
895
895
|
- [Add a notification](../operations/patient.addNotification.md)
|
|
896
|
+
- [Add one structured patient intake section](../operations/patient.addPatientIntake.md)
|
|
896
897
|
- [OCR an identity document](../operations/patient.analyzeIdentityDocument.md)
|
|
897
898
|
- [Grounded assistant chat](../operations/patient.assistantChat.md)
|
|
898
899
|
- [Classify a voice command into an action code](../operations/patient.assistantClassify.md)
|
package/docs/index.md
CHANGED
|
@@ -901,6 +901,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
901
901
|
- [Add a dependent](operations/patient.addDependent.md) (`patient.addDependent`)
|
|
902
902
|
- [Add insurance coverage](operations/patient.addInsurance.md) (`patient.addInsurance`)
|
|
903
903
|
- [Add a notification](operations/patient.addNotification.md) (`patient.addNotification`)
|
|
904
|
+
- [Add one structured patient intake section](operations/patient.addPatientIntake.md) (`patient.addPatientIntake`)
|
|
904
905
|
- [OCR an identity document](operations/patient.analyzeIdentityDocument.md) (`patient.analyzeIdentityDocument`)
|
|
905
906
|
- [Grounded assistant chat](operations/patient.assistantChat.md) (`patient.assistantChat`)
|
|
906
907
|
- [Classify a voice command into an action code](operations/patient.assistantClassify.md) (`patient.assistantClassify`)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# AddPatientIntakeRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `AddPatientIntakeRequest`
|
|
4
|
+
|
|
5
|
+
One structured intake section collected by an agent.
|
|
6
|
+
|
|
7
|
+
``summary`` deliberately stays a JSON object rather than free text: the
|
|
8
|
+
caller has already collected structured facts and must not ask this API to
|
|
9
|
+
infer clinical facts that were not supplied. It must contain exactly the
|
|
10
|
+
section named by ``section``.
|
|
11
|
+
|
|
12
|
+
Type: `object`
|
|
13
|
+
|
|
14
|
+
## Fields
|
|
15
|
+
|
|
16
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
17
|
+
|---|---|---:|---|---|---|---:|---|
|
|
18
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
19
|
+
| `section` | `string` | Yes | | allergies, cancer_cases, family_history, gyn_history, perinatal_history, medications, problems, social_history, surgical_history, vaccines | | No | |
|
|
20
|
+
| `summary` | `object` | Yes | | | | No | |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# AddPatientIntakeResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `AddPatientIntakeResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `error_messages` | `array` | No | | | | No | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# AdvanceDirective
|
|
2
|
+
|
|
3
|
+
Model ID: `AdvanceDirective`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `directive_id` | `string` | No | uuid | | | No | |
|
|
14
|
+
| `document_location` | `string|null` | No | | | `null` | Yes | |
|
|
15
|
+
| `effective_date` | `string|null` | No | | | `null` | Yes | |
|
|
16
|
+
| `expiration_date` | `string|null` | No | | | `null` | Yes | |
|
|
17
|
+
| `fhir_id` | `string|null` | No | | | `null` | Yes | |
|
|
18
|
+
| `instructions` | `string|null` | No | | | `null` | Yes | |
|
|
19
|
+
| `on_file` | `boolean` | No | | | `false` | No | |
|
|
20
|
+
| `proxy_name` | `string|null` | No | | | `null` | Yes | |
|
|
21
|
+
| `proxy_phone` | `string|null` | No | | | `null` | Yes | |
|
|
22
|
+
| `proxy_relationship` | `string|null` | No | | | `null` | Yes | |
|
|
23
|
+
| `scope` | [`DirectiveScope`](./DirectiveScope.md) | No | | | `"adr"` | No | |
|
|
24
|
+
| `status` | [`DirectiveStatus`](./DirectiveStatus.md) | No | | | `"active"` | No | |
|
|
25
|
+
| `type` | [`AdvanceDirectiveType`](./AdvanceDirectiveType.md) | Yes | | | | No | |
|
|
26
|
+
| `verified_by` | `string|null` | No | | | `null` | Yes | |
|
|
27
|
+
| `verified_date` | `string|null` | No | | | `null` | Yes | |
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
None declared in canonical OpenAPI.
|
|
@@ -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,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)
|
|
@@ -467,6 +471,8 @@
|
|
|
467
471
|
- [ReferenceRange](diagnostics.ReferenceRange.md)
|
|
468
472
|
- [DiagnosticTest](DiagnosticTest.md)
|
|
469
473
|
- [DiagnosticTestRelationship](DiagnosticTestRelationship.md)
|
|
474
|
+
- [DirectiveScope](DirectiveScope.md)
|
|
475
|
+
- [DirectiveStatus](DirectiveStatus.md)
|
|
470
476
|
- [DischargeDisposition](DischargeDisposition.md)
|
|
471
477
|
- [DocumentSummary](DocumentSummary.md)
|
|
472
478
|
- [DocumentSummarySearchRequest](DocumentSummarySearchRequest.md)
|
|
@@ -477,6 +483,7 @@
|
|
|
477
483
|
- [CodedConcept](ehr.CodedConcept.md)
|
|
478
484
|
- [ehr.ConnectResponse](ehr.ConnectResponse.md)
|
|
479
485
|
- [FamilyCondition](ehr.FamilyCondition.md)
|
|
486
|
+
- [ImmunizationReaction](ehr.ImmunizationReaction.md)
|
|
480
487
|
- [DiagnosticsListResponse](ehr.ListDiagnosticsResponse.md)
|
|
481
488
|
- [EncounterListResponse](ehr.ListEncountersResponse.md)
|
|
482
489
|
- [MedicationListResponse](ehr.ListMedicationsResponse.md)
|
|
@@ -1060,6 +1067,9 @@
|
|
|
1060
1067
|
- [HealthPlanSearchResponse](HealthPlanSearchResponse.md)
|
|
1061
1068
|
- [HealthPlanSummary](HealthPlanSummary.md)
|
|
1062
1069
|
- [HeartRateVital](HeartRateVital.md)
|
|
1070
|
+
- [Immunization](Immunization.md)
|
|
1071
|
+
- [ImmunizationRoute](ImmunizationRoute.md)
|
|
1072
|
+
- [ImmunizationStatus](ImmunizationStatus.md)
|
|
1063
1073
|
- [ImpiloAddress](ImpiloAddress.md)
|
|
1064
1074
|
- [ImpiloAlertConfig](ImpiloAlertConfig.md)
|
|
1065
1075
|
- [ImpiloAlertConfiguration](ImpiloAlertConfiguration.md)
|
|
@@ -1407,6 +1417,9 @@
|
|
|
1407
1417
|
- [ProblemClinicalStatus](ProblemClinicalStatus.md)
|
|
1408
1418
|
- [ProblemSeverity](ProblemSeverity.md)
|
|
1409
1419
|
- [ProblemVerificationStatus](ProblemVerificationStatus.md)
|
|
1420
|
+
- [Procedure](Procedure.md)
|
|
1421
|
+
- [ProcedureLaterality](ProcedureLaterality.md)
|
|
1422
|
+
- [ProcedureStatus](ProcedureStatus.md)
|
|
1410
1423
|
- [ProviderConfirmResetPasswordRequest](provider.ConfirmResetPasswordRequest.md)
|
|
1411
1424
|
- [ProviderConfirmResetPasswordResponse](provider.ConfirmResetPasswordResponse.md)
|
|
1412
1425
|
- [provider.ConnectResponse](provider.ConnectResponse.md)
|
|
@@ -1852,6 +1865,7 @@
|
|
|
1852
1865
|
- [UpsertInviteRequest](UpsertInviteRequest.md)
|
|
1853
1866
|
- [UpsertMessageRequest](UpsertMessageRequest.md)
|
|
1854
1867
|
- [UpsertPresenceRequest](UpsertPresenceRequest.md)
|
|
1868
|
+
- [VaccinationSite](VaccinationSite.md)
|
|
1855
1869
|
- [VectorCollection](VectorCollection.md)
|
|
1856
1870
|
- [VectorSearchDocumentsRequest](VectorSearchDocumentsRequest.md)
|
|
1857
1871
|
- [VectorSearchHit](VectorSearchHit.md)
|
|
@@ -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
|
|