@healthcloudai/hc-sdk 2.6.2 → 2.7.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 +103 -0
- package/dist/index.d.cts +5805 -5777
- package/dist/index.d.ts +5805 -5777
- package/dist/index.js +103 -0
- package/docs/clients/EhrClient.md +15 -0
- package/docs/docs-manifest.json +55 -3
- package/docs/examples/index.md +15 -0
- package/docs/index.md +15 -0
- package/docs/models/Allergy.md +31 -0
- package/docs/models/AllergyCategory.md +15 -0
- package/docs/models/AllergyCriticality.md +15 -0
- package/docs/models/AllergyReaction.md +21 -0
- package/docs/models/AllergyStatus.md +15 -0
- package/docs/models/AllergyVerificationStatus.md +15 -0
- package/docs/models/CodedConcept.md +19 -0
- package/docs/models/FamilyCondition.md +21 -0
- package/docs/models/FamilyHistoryEntry.md +30 -0
- package/docs/models/FamilyHistoryStatus.md +15 -0
- package/docs/models/FamilyRelationship.md +15 -0
- package/docs/models/GetHealthRecordResponse.md +19 -0
- package/docs/models/IntoleranceType.md +15 -0
- package/docs/models/ListAllergiesResponse.md +19 -0
- package/docs/models/ListConditionsResponse.md +19 -0
- package/docs/models/ListDirectivesResponse.md +19 -0
- package/docs/models/ListFamilyHistoryResponse.md +19 -0
- package/docs/models/ListFunctionalStatusResponse.md +19 -0
- package/docs/models/ListImmunizationsResponse.md +19 -0
- package/docs/models/ListObservationsResponse.md +19 -0
- package/docs/models/ListProceduresResponse.md +19 -0
- package/docs/models/ListQuestionnaireResponsesResponse.md +19 -0
- package/docs/models/ListSocialHistoryResponse.md +19 -0
- package/docs/models/ListVitalsResponse.md +19 -0
- package/docs/models/Problem.md +37 -0
- package/docs/models/ProblemCategory.md +15 -0
- package/docs/models/ProblemClinicalStatus.md +15 -0
- package/docs/models/ProblemSeverity.md +15 -0
- package/docs/models/ProblemVerificationStatus.md +15 -0
- package/docs/models/QuestionnaireResponse.md +27 -0
- package/docs/models/QuestionnaireResponseStatus.md +15 -0
- package/docs/models/ReactionSeverity.md +15 -0
- package/docs/models/ResponseAnswer.md +27 -0
- package/docs/models/ResponseItem.md +21 -0
- package/docs/models/ehr.ListDiagnosticsResponse.md +19 -0
- package/docs/models/ehr.ListEncountersResponse.md +19 -0
- package/docs/models/ehr.ListMedicationsResponse.md +19 -0
- package/docs/models/index.md +37 -0
- package/docs/operations/ehr.getHealthRecord.md +122 -0
- package/docs/operations/ehr.listAllergies.md +156 -0
- package/docs/operations/ehr.listConditions.md +152 -0
- package/docs/operations/ehr.listDiagnostics.md +147 -0
- package/docs/operations/ehr.listDirectives.md +122 -0
- package/docs/operations/ehr.listEncounters.md +178 -0
- package/docs/operations/ehr.listFamilyHistory.md +147 -0
- package/docs/operations/ehr.listFunctionalStatus.md +122 -0
- package/docs/operations/ehr.listImmunizations.md +122 -0
- package/docs/operations/ehr.listMedications.md +163 -0
- package/docs/operations/ehr.listObservations.md +126 -0
- package/docs/operations/ehr.listProcedures.md +122 -0
- package/docs/operations/ehr.listQuestionnaireResponses.md +162 -0
- package/docs/operations/ehr.listSocialHistory.md +122 -0
- package/docs/operations/ehr.listVitals.md +132 -0
- package/package.json +1 -1
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ListFamilyHistoryResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListFamilyHistoryResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `family_history` | array of [`FamilyHistoryEntry`](./FamilyHistoryEntry.md) | Yes | | | | No | |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# FunctionalStatusListResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListFunctionalStatusResponse`
|
|
4
|
+
|
|
5
|
+
Response for GET /patients/{patient_id}/functional-status. Contains raw FHIR Observation resources.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `functional_status` | `array` | Yes | | | | No | Raw FHIR Observation resources with category survey or functional-status. |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | Number of observations in this response. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ListImmunizationsResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListImmunizationsResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `immunizations` | `array` | Yes | | | | No | |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ObservationListResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListObservationsResponse`
|
|
4
|
+
|
|
5
|
+
Response for GET /patients/{patient_id}/observations. Contains raw FHIR Observation resources.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `observations` | `array` | Yes | | | | No | Raw FHIR Observation resources matching the optional ?category= filter. |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | Number of observations in this response. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ListProceduresResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListProceduresResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
14
|
+
| `procedures` | `array` | Yes | | | | No | |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ListQuestionnaireResponsesResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListQuestionnaireResponsesResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
14
|
+
| `questionnaire_responses` | array of [`QuestionnaireResponse`](./QuestionnaireResponse.md) | Yes | | | | No | |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ListSocialHistoryResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListSocialHistoryResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
14
|
+
| `social_history` | `array` | Yes | | | | No | |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ListVitalsResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListVitalsResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | |
|
|
15
|
+
| `vitals` | `array` | Yes | | | | No | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Problem
|
|
2
|
+
|
|
3
|
+
Model ID: `Problem`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `asserted_date` | `string|null` | No | | | `null` | Yes | Date the problem was asserted, when recorded. |
|
|
14
|
+
| `asserter_name` | `string|null` | No | | | `null` | Yes | Name of the person who asserted the problem, when recorded. |
|
|
15
|
+
| `asserter_type` | `string|null` | No | | | `null` | Yes | Type of asserter (e.g. patient, practitioner), when recorded. |
|
|
16
|
+
| `body_site` | `string|null` | No | | | `null` | Yes | Body site affected, when specified. |
|
|
17
|
+
| `categories` | array of [`ProblemCategory`](./ProblemCategory.md) | No | | | | No | Condition categories (e.g. problem-list-item, encounter-diagnosis). |
|
|
18
|
+
| `clinical_status` | [`ProblemClinicalStatus`](./ProblemClinicalStatus.md) | No | | | `"active"` | No | Clinical status: active, recurrence, relapse, inactive, remission, or resolved. |
|
|
19
|
+
| `description` | `string` | Yes | | | | No | Human-readable description of the problem/condition. |
|
|
20
|
+
| `encounter_id` | `string|null` | No | | | `null` | Yes | FHIR Encounter id during which the problem was recorded, when linked. |
|
|
21
|
+
| `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR Condition resource id, when stored. |
|
|
22
|
+
| `icd10_code` | `string|null` | No | | | `null` | Yes | ICD-10-CM code for the condition, when coded. |
|
|
23
|
+
| `laterality` | `string|null` | No | | | `null` | Yes | Left, Right, Bilateral |
|
|
24
|
+
| `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the problem, when present. |
|
|
25
|
+
| `onset_age` | `integer|null` | No | | | `null` | Yes | Age at onset in years |
|
|
26
|
+
| `onset_date` | `string|null` | No | | | `null` | Yes | Date the problem first onset, when known. |
|
|
27
|
+
| `problem_id` | `string` | No | uuid | | | No | HealthCloud problem/condition identifier (UUID). |
|
|
28
|
+
| `recorded_date` | `string|null` | No | | | `null` | Yes | Datetime the problem was recorded, when known. |
|
|
29
|
+
| `recorder_name` | `string|null` | No | | | `null` | Yes | Name of the person who recorded the problem, when known. |
|
|
30
|
+
| `resolved_date` | `string|null` | No | | | `null` | Yes | Date the problem was resolved/abated, when applicable. |
|
|
31
|
+
| `severity` | [`ProblemSeverity`](./ProblemSeverity.md) | No | | | `null` | Yes | Severity: mild, moderate, or severe, when assessed. |
|
|
32
|
+
| `snomed_code` | `string|null` | No | | | `null` | Yes | SNOMED CT code for the condition, when coded. |
|
|
33
|
+
| `verification_status` | [`ProblemVerificationStatus`](./ProblemVerificationStatus.md) | No | | | `"confirmed"` | No | Verification status: unconfirmed, provisional, differential, confirmed, refuted, or entered-in-error. |
|
|
34
|
+
|
|
35
|
+
## Example
|
|
36
|
+
|
|
37
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# QuestionnaireResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `QuestionnaireResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `authored` | `string|null` | No | | | `null` | Yes | ISO 8601 dateTime |
|
|
14
|
+
| `authored_by_name` | `string|null` | No | | | `null` | Yes | Display name of the author, when known. |
|
|
15
|
+
| `authored_by_patient` | `boolean` | No | | | `true` | No | Whether the response was authored by the patient (true) or a practitioner (false). |
|
|
16
|
+
| `encounter_id` | `string|null` | No | | | `null` | Yes | FHIR Encounter id during which the response was collected, when linked. |
|
|
17
|
+
| `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR QuestionnaireResponse resource id, when stored. |
|
|
18
|
+
| `items` | array of [`ResponseItem`](./ResponseItem.md) | No | | | | No | Response items (answers), one per Questionnaire item linkId. |
|
|
19
|
+
| `patient_fhir_id` | `string|null` | No | | | `null` | Yes | FHIR Patient id who is the subject of the response, when linked. |
|
|
20
|
+
| `questionnaire_fhir_id` | `string|null` | No | | | `null` | Yes | FHIR Questionnaire id this response answers, when linked. |
|
|
21
|
+
| `questionnaire_url` | `string|null` | No | | | `null` | Yes | Canonical URL of the Questionnaire |
|
|
22
|
+
| `response_id` | `string` | No | uuid | | | No | HealthCloud questionnaire-response identifier (UUID). |
|
|
23
|
+
| `status` | [`QuestionnaireResponseStatus`](./QuestionnaireResponseStatus.md) | No | | | `"completed"` | No | Response status: in-progress, completed, amended, entered-in-error, or stopped. |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# ResponseAnswer
|
|
2
|
+
|
|
3
|
+
Model ID: `ResponseAnswer`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `sub_items` | array of [`ResponseItem`](./ResponseItem.md) | No | | | | No | Nested sub-items under this answer, for grouped questions. |
|
|
14
|
+
| `value_boolean` | `boolean|null` | No | | | `null` | Yes | Boolean answer value, when the question type is boolean. |
|
|
15
|
+
| `value_coding` | `object|null` | No | | | `null` | Yes | Coded answer value (system/code/display), when the question type is choice or open-choice. |
|
|
16
|
+
| `value_date` | `string|null` | No | | | `null` | Yes | Date answer value (ISO date), when the question type is date. |
|
|
17
|
+
| `value_date_time` | `string|null` | No | | | `null` | Yes | DateTime answer value (ISO dateTime), when the question type is dateTime. |
|
|
18
|
+
| `value_decimal` | `number|null` | No | | | `null` | Yes | Decimal answer value, when the question type is decimal. |
|
|
19
|
+
| `value_integer` | `integer|null` | No | | | `null` | Yes | Integer answer value, when the question type is integer. |
|
|
20
|
+
| `value_quantity` | `object|null` | No | | | `null` | Yes | Quantity answer value (value/unit/system), when the question type is quantity. |
|
|
21
|
+
| `value_string` | `string|null` | No | | | `null` | Yes | String answer value, when the question type is string. |
|
|
22
|
+
| `value_time` | `string|null` | No | | | `null` | Yes | Time answer value, when the question type is time. |
|
|
23
|
+
| `value_uri` | `string|null` | No | | | `null` | Yes | URI answer value, when the question type is uri. |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# ResponseItem
|
|
2
|
+
|
|
3
|
+
Model ID: `ResponseItem`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `answers` | array of [`ResponseAnswer`](./ResponseAnswer.md) | No | | | | No | Answers given for this item. |
|
|
14
|
+
| `definition` | `string|null` | No | | | `null` | Yes | Canonical URI of the element this item collects, when defined. |
|
|
15
|
+
| `link_id` | `string` | Yes | | | | No | Stable linkId matching the corresponding Questionnaire.item.linkId. |
|
|
16
|
+
| `sub_items` | array of [`ResponseItem`](./ResponseItem.md) | No | | | | No | Nested sub-items, for grouped questions. |
|
|
17
|
+
| `text` | `string|null` | No | | | `null` | Yes | Display text of the question, when present. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# DiagnosticsListResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ehr.ListDiagnosticsResponse`
|
|
4
|
+
|
|
5
|
+
Response for GET /patients/{patient_id}/diagnostics. Contains serialized lab/diagnostic Observation domain models.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `diagnostics` | `array` | Yes | | | | No | Lab/diagnostic Observations matching the optional ?code= (LOINC) filter, in serialized domain-model format. |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | Number of diagnostics in this response. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# EncounterListResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ehr.ListEncountersResponse`
|
|
4
|
+
|
|
5
|
+
Response for GET /patients/{patient_id}/encounters. Contains serialized Encounter domain models.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `encounters` | `array` | Yes | | | | No | Encounter resources matching the optional ?status= filter, in serialized domain-model format. |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | Number of encounters in this response. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# MedicationListResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ehr.ListMedicationsResponse`
|
|
4
|
+
|
|
5
|
+
Response for GET /patients/{patient_id}/medications. Contains serialized Medication domain models.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `medications` | `array` | Yes | | | | No | Medication resources matching the ?resource_type= filter (defaults to MedicationRequest), in serialized domain-model format. |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | Number of medications in this response. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
package/docs/models/index.md
CHANGED
|
@@ -13,6 +13,12 @@
|
|
|
13
13
|
- [Address](Address.md)
|
|
14
14
|
- [AddressType](AddressType.md)
|
|
15
15
|
- [AgentDashboardResponse](AgentDashboardResponse.md)
|
|
16
|
+
- [Allergy](Allergy.md)
|
|
17
|
+
- [AllergyCategory](AllergyCategory.md)
|
|
18
|
+
- [AllergyCriticality](AllergyCriticality.md)
|
|
19
|
+
- [AllergyReaction](AllergyReaction.md)
|
|
20
|
+
- [AllergyStatus](AllergyStatus.md)
|
|
21
|
+
- [AllergyVerificationStatus](AllergyVerificationStatus.md)
|
|
16
22
|
- [AnalyzeIdentityDocumentRequest](AnalyzeIdentityDocumentRequest.md)
|
|
17
23
|
- [AnalyzeIdentityDocumentResponse](AnalyzeIdentityDocumentResponse.md)
|
|
18
24
|
- [AnthropicContentBlock](AnthropicContentBlock.md)
|
|
@@ -383,6 +389,7 @@
|
|
|
383
389
|
- [CmsGetCountyFipsRequest](CmsGetCountyFipsRequest.md)
|
|
384
390
|
- [CmsSearchHealthPlansRequest](CmsSearchHealthPlansRequest.md)
|
|
385
391
|
- [CmsSearchHealthPlansResponse](CmsSearchHealthPlansResponse.md)
|
|
392
|
+
- [CodedConcept](CodedConcept.md)
|
|
386
393
|
- [CommGroupRecord](CommGroupRecord.md)
|
|
387
394
|
- [CommunicationsState](CommsGetStateResponse.md)
|
|
388
395
|
- [CommsGetUnreadCountResponse](CommsGetUnreadCountResponse.md)
|
|
@@ -457,6 +464,9 @@
|
|
|
457
464
|
- [DocumentSummarySearchRequest](DocumentSummarySearchRequest.md)
|
|
458
465
|
- [DocumentSummarySearchResponse](DocumentSummarySearchResponse.md)
|
|
459
466
|
- [ehr.ConnectResponse](ehr.ConnectResponse.md)
|
|
467
|
+
- [DiagnosticsListResponse](ehr.ListDiagnosticsResponse.md)
|
|
468
|
+
- [EncounterListResponse](ehr.ListEncountersResponse.md)
|
|
469
|
+
- [MedicationListResponse](ehr.ListMedicationsResponse.md)
|
|
460
470
|
- [ElevenLabsAccessInfo](ElevenLabsAccessInfo.md)
|
|
461
471
|
- [ElevenLabsAgent](ElevenLabsAgent.md)
|
|
462
472
|
- [ElevenLabsAgentSettings](ElevenLabsAgentSettings.md)
|
|
@@ -503,6 +513,10 @@
|
|
|
503
513
|
- [Ethnicity](Ethnicity.md)
|
|
504
514
|
- [FaceMatchRequest](FaceMatchRequest.md)
|
|
505
515
|
- [FaceMatchResponse](FaceMatchResponse.md)
|
|
516
|
+
- [FamilyCondition](FamilyCondition.md)
|
|
517
|
+
- [FamilyHistoryEntry](FamilyHistoryEntry.md)
|
|
518
|
+
- [FamilyHistoryStatus](FamilyHistoryStatus.md)
|
|
519
|
+
- [FamilyRelationship](FamilyRelationship.md)
|
|
506
520
|
- [FedexCreateShipmentRequest](FedexCreateShipmentRequest.md)
|
|
507
521
|
- [FedexDeliveryDetails](FedexDeliveryDetails.md)
|
|
508
522
|
- [FedexLatestStatusDetail](FedexLatestStatusDetail.md)
|
|
@@ -547,6 +561,7 @@
|
|
|
547
561
|
- [GetDiagnosticTestResponse](GetDiagnosticTestResponse.md)
|
|
548
562
|
- [GetDiagnosticTestSystemResponse](GetDiagnosticTestSystemResponse.md)
|
|
549
563
|
- [GetEncounterResponse](GetEncounterResponse.md)
|
|
564
|
+
- [HealthRecordResponse](GetHealthRecordResponse.md)
|
|
550
565
|
- [GetInsuranceResponse](GetInsuranceResponse.md)
|
|
551
566
|
- [GetMedicalConceptAncestorsResponse](GetMedicalConceptAncestorsResponse.md)
|
|
552
567
|
- [GetMedicalConceptDescendantsResponse](GetMedicalConceptDescendantsResponse.md)
|
|
@@ -1143,6 +1158,7 @@
|
|
|
1143
1158
|
- [Insurance](Insurance.md)
|
|
1144
1159
|
- [InsurancePriority](InsurancePriority.md)
|
|
1145
1160
|
- [InterpretationCode](InterpretationCode.md)
|
|
1161
|
+
- [IntoleranceType](IntoleranceType.md)
|
|
1146
1162
|
- [IntraocularPressure](IntraocularPressure.md)
|
|
1147
1163
|
- [InviteChannel](InviteChannel.md)
|
|
1148
1164
|
- [InviteRecord](InviteRecord.md)
|
|
@@ -1161,15 +1177,26 @@
|
|
|
1161
1177
|
- [KnowledgeSearchResult](KnowledgeSearchResult.md)
|
|
1162
1178
|
- [ListActionsResponse](ListActionsResponse.md)
|
|
1163
1179
|
- [ListActivityResponse](ListActivityResponse.md)
|
|
1180
|
+
- [ListAllergiesResponse](ListAllergiesResponse.md)
|
|
1181
|
+
- [ListConditionsResponse](ListConditionsResponse.md)
|
|
1164
1182
|
- [ListDependentsResponse](ListDependentsResponse.md)
|
|
1165
1183
|
- [ListDiagnosticTestsResponse](ListDiagnosticTestsResponse.md)
|
|
1184
|
+
- [ListDirectivesResponse](ListDirectivesResponse.md)
|
|
1185
|
+
- [ListFamilyHistoryResponse](ListFamilyHistoryResponse.md)
|
|
1186
|
+
- [FunctionalStatusListResponse](ListFunctionalStatusResponse.md)
|
|
1187
|
+
- [ListImmunizationsResponse](ListImmunizationsResponse.md)
|
|
1166
1188
|
- [ListKnowledgeResponse](ListKnowledgeResponse.md)
|
|
1167
1189
|
- [ListMedicalConceptsGetResponse](ListMedicalConceptsGetResponse.md)
|
|
1168
1190
|
- [ListNotificationsResponse](ListNotificationsResponse.md)
|
|
1191
|
+
- [ObservationListResponse](ListObservationsResponse.md)
|
|
1169
1192
|
- [ListPatientAppointmentsResponse](ListPatientAppointmentsResponse.md)
|
|
1170
1193
|
- [FieldAgentListPatientsResponse](ListPatientsResponse.md)
|
|
1171
1194
|
- [ListPolicyDocumentsResponse](ListPolicyDocumentsResponse.md)
|
|
1195
|
+
- [ListProceduresResponse](ListProceduresResponse.md)
|
|
1196
|
+
- [ListQuestionnaireResponsesResponse](ListQuestionnaireResponsesResponse.md)
|
|
1172
1197
|
- [ListSlotsResponse](ListSlotsResponse.md)
|
|
1198
|
+
- [ListSocialHistoryResponse](ListSocialHistoryResponse.md)
|
|
1199
|
+
- [ListVitalsResponse](ListVitalsResponse.md)
|
|
1173
1200
|
- [LocationStatus](LocationStatus.md)
|
|
1174
1201
|
- [MaritalStatus](MaritalStatus.md)
|
|
1175
1202
|
- [mcp.ConnectResponse](mcp.ConnectResponse.md)
|
|
@@ -1357,6 +1384,11 @@
|
|
|
1357
1384
|
- [PreferredPharmacy](PreferredPharmacy.md)
|
|
1358
1385
|
- [PresenceRecord](PresenceRecord.md)
|
|
1359
1386
|
- [PresenceStatus](PresenceStatus.md)
|
|
1387
|
+
- [Problem](Problem.md)
|
|
1388
|
+
- [ProblemCategory](ProblemCategory.md)
|
|
1389
|
+
- [ProblemClinicalStatus](ProblemClinicalStatus.md)
|
|
1390
|
+
- [ProblemSeverity](ProblemSeverity.md)
|
|
1391
|
+
- [ProblemVerificationStatus](ProblemVerificationStatus.md)
|
|
1360
1392
|
- [ProviderConfirmResetPasswordRequest](provider.ConfirmResetPasswordRequest.md)
|
|
1361
1393
|
- [ProviderConfirmResetPasswordResponse](provider.ConfirmResetPasswordResponse.md)
|
|
1362
1394
|
- [provider.ConnectResponse](provider.ConnectResponse.md)
|
|
@@ -1417,6 +1449,8 @@
|
|
|
1417
1449
|
- [QuestHL7MessageContent](QuestHL7MessageContent.md)
|
|
1418
1450
|
- [QuestionItemType](QuestionItemType.md)
|
|
1419
1451
|
- [QuestionnaireItemInput](QuestionnaireItemInput.md)
|
|
1452
|
+
- [QuestionnaireResponse](QuestionnaireResponse.md)
|
|
1453
|
+
- [QuestionnaireResponseStatus](QuestionnaireResponseStatus.md)
|
|
1420
1454
|
- [QuestListTestCatalogRequest](QuestListTestCatalogRequest.md)
|
|
1421
1455
|
- [QuestOrderDocument](QuestOrderDocument.md)
|
|
1422
1456
|
- [QuestOrderDocumentsResponse](QuestOrderDocumentsResponse.md)
|
|
@@ -1440,9 +1474,12 @@
|
|
|
1440
1474
|
- [RapidTest](RapidTest.md)
|
|
1441
1475
|
- [RapidTestResult](RapidTestResult.md)
|
|
1442
1476
|
- [RapidTestType](RapidTestType.md)
|
|
1477
|
+
- [ReactionSeverity](ReactionSeverity.md)
|
|
1443
1478
|
- [RecordVitalsResponse](RecordVitalsResponse.md)
|
|
1444
1479
|
- [RescheduleAppointmentRequest](RescheduleAppointmentRequest.md)
|
|
1445
1480
|
- [RespiratoryRate](RespiratoryRate.md)
|
|
1481
|
+
- [ResponseAnswer](ResponseAnswer.md)
|
|
1482
|
+
- [ResponseItem](ResponseItem.md)
|
|
1446
1483
|
- [rppg.ConnectResponse](rppg.ConnectResponse.md)
|
|
1447
1484
|
- [SalesforceAccount](SalesforceAccount.md)
|
|
1448
1485
|
- [SalesforceAccountAssets](SalesforceAccountAssets.md)
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Get a patient's consolidated health record
|
|
2
|
+
|
|
3
|
+
Operation ID: `ehr.getHealthRecord`
|
|
4
|
+
|
|
5
|
+
Return a consolidated view of a patient's clinical record — conditions, allergies, medications, procedures, immunizations, family history, and directives from the EHR service, plus encounters, vitals, questionnaire responses, and diagnostics fetched from their respective services. Aggregation is best-effort per resource type: if one downstream fetch fails, that resource type comes back as an empty list rather than failing the whole request — the response is not proof that a resource type genuinely has zero records.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getHealthRecord`
|
|
10
|
+
|
|
11
|
+
Signature: `ehr.getHealthRecord(patientId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<GetHealthRecordResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /patients/{patient_id}/record`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
None.
|
|
38
|
+
|
|
39
|
+
## Body parameters
|
|
40
|
+
|
|
41
|
+
None.
|
|
42
|
+
|
|
43
|
+
Request model: None.
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
None declared in canonical OpenAPI.
|
|
48
|
+
|
|
49
|
+
## Success responses
|
|
50
|
+
|
|
51
|
+
| Status | Shape | Content type | Description |
|
|
52
|
+
|---|---|---|---|
|
|
53
|
+
| `200` | [`GetHealthRecordResponse`](../models/GetHealthRecordResponse.md) | application/json | Consolidated patient health record |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"patient_id": "patient-example-001",
|
|
62
|
+
"resources": {},
|
|
63
|
+
"totals": {}
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Common errors
|
|
68
|
+
|
|
69
|
+
| Status | Shape | Content type | Description |
|
|
70
|
+
|---|---|---|---|
|
|
71
|
+
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
72
|
+
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Internal server error |
|
|
73
|
+
|
|
74
|
+
## Error examples
|
|
75
|
+
|
|
76
|
+
### 401 — Missing or invalid access token
|
|
77
|
+
|
|
78
|
+
```json
|
|
79
|
+
{
|
|
80
|
+
"error": "Authorization required"
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### 500 — Unexpected service failure (sanitized example)
|
|
85
|
+
|
|
86
|
+
```json
|
|
87
|
+
{
|
|
88
|
+
"error": "Internal server error"
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## NodeJS / TypeScript implementation
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
```ts
|
|
99
|
+
const patientId = "<PATIENT_ID>";
|
|
100
|
+
|
|
101
|
+
const result = await ehr.getHealthRecord(patientId);
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## cURL
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
curl -X GET \
|
|
108
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
109
|
+
'https://dev-api-ehr.health.cloud/patients/%3CPATIENT_ID%3E/record'
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Notes
|
|
113
|
+
|
|
114
|
+
None.
|
|
115
|
+
|
|
116
|
+
## Prepared Test Console scenario
|
|
117
|
+
|
|
118
|
+
No canonical scenario is currently associated.
|
|
119
|
+
|
|
120
|
+
## Real response
|
|
121
|
+
|
|
122
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|