@healthcloudai/hc-sdk 2.6.1 → 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 +5837 -5797
- package/dist/index.d.ts +5837 -5797
- 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/InitHealthRecordImportResponse.md +2 -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/fieldagent.ResetPasswordRequest.md +1 -1
- package/docs/models/index.md +37 -0
- package/docs/models/person.ResetPasswordRequest.md +1 -1
- package/docs/models/provider.ResetPasswordRequest.md +1 -1
- package/docs/operations/diagnostics.getTestResult.md +1 -1
- package/docs/operations/diagnostics.lookupTestByGs1.md +1 -1
- 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/docs/operations/fieldagent.resetPassword.md +1 -1
- package/docs/operations/patient.initHealthRecordImport.md +3 -1
- package/docs/operations/patient.resetPassword.md +1 -1
- package/docs/operations/person.resetPassword.md +1 -1
- package/docs/operations/provider.resetPassword.md +1 -1
- package/package.json +1 -1
- /package/docs/models/{GoogleAiEmbedRequest.md → GoogleAIEmbedRequest.md} +0 -0
- /package/docs/models/{GoogleAiGenerateRequest.md → GoogleAIGenerateRequest.md} +0 -0
- /package/docs/models/{GoogleAiInvokeA1cVisionCaptureRequest.md → GoogleAIInvokeA1cVisionCaptureRequest.md} +0 -0
- /package/docs/models/{OpenaiBuildResponseCreatePayloadRequest.md → OpenAIBuildResponseCreatePayloadRequest.md} +0 -0
- /package/docs/models/{OpenaiChatJsonRequest.md → OpenAIChatJsonRequest.md} +0 -0
- /package/docs/models/{OpenaiChatRequest.md → OpenAIChatRequest.md} +0 -0
- /package/docs/models/{OpenaiCreateAssistantRequest.md → OpenAICreateAssistantRequest.md} +0 -0
- /package/docs/models/{OpenaiDeleteAssistantRequest.md → OpenAIDeleteAssistantRequest.md} +0 -0
- /package/docs/models/{OpenaiEmbedRequest.md → OpenAIEmbedRequest.md} +0 -0
- /package/docs/models/{OpenaiGetAssistantRequest.md → OpenAIGetAssistantRequest.md} +0 -0
- /package/docs/models/{OpenaiModerateRequest.md → OpenAIModerateRequest.md} +0 -0
- /package/docs/models/{OpenaiUpdateAssistantRequest.md → OpenAIUpdateAssistantRequest.md} +0 -0
- /package/docs/models/{SendgridListTemplatesRequest.md → SendGridListTemplatesRequest.md} +0 -0
- /package/docs/models/{SteadymdAddAllergyIntoleranceRequest.md → SteadyMDAddAllergyIntoleranceRequest.md} +0 -0
- /package/docs/models/{SteadymdClaimIdentityVerificationRequest.md → SteadyMDClaimIdentityVerificationRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateConsultIssueRequest.md → SteadyMDCreateConsultIssueRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateConsultRequest.md → SteadyMDCreateConsultRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateEpisodeLabRequisitionRequest.md → SteadyMDCreateEpisodeLabRequisitionRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateEpisodeRequest.md → SteadyMDCreateEpisodeRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateIntakeRequest.md → SteadyMDCreateIntakeRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateLabOrderRequest.md → SteadyMDCreateLabOrderRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateLabOrderResultRequest.md → SteadyMDCreateLabOrderResultRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateMessageRequest.md → SteadyMDCreateMessageRequest.md} +0 -0
- /package/docs/models/{SteadymdCreatePatientRequest.md → SteadyMDCreatePatientRequest.md} +0 -0
- /package/docs/models/{SteadymdGetClinicianRequest.md → SteadyMDGetClinicianRequest.md} +0 -0
- /package/docs/models/{SteadymdGetConsultAvailabilityRequest.md → SteadyMDGetConsultAvailabilityRequest.md} +0 -0
- /package/docs/models/{SteadymdGetConsultPatientUiRequest.md → SteadyMDGetConsultPatientUiRequest.md} +0 -0
- /package/docs/models/{SteadymdGetConsultRequest.md → SteadyMDGetConsultRequest.md} +0 -0
- /package/docs/models/{SteadymdGetEpisodeLabRequisitionRequest.md → SteadyMDGetEpisodeLabRequisitionRequest.md} +0 -0
- /package/docs/models/{SteadymdGetEpisodeRequest.md → SteadyMDGetEpisodeRequest.md} +0 -0
- /package/docs/models/{SteadymdGetEpisodeSignedDocumentsRequest.md → SteadyMDGetEpisodeSignedDocumentsRequest.md} +0 -0
- /package/docs/models/{SteadymdGetIntakeRequest.md → SteadyMDGetIntakeRequest.md} +0 -0
- /package/docs/models/{SteadymdGetLabOrderPdfRequest.md → SteadyMDGetLabOrderPdfRequest.md} +0 -0
- /package/docs/models/{SteadymdGetLabOrderRequest.md → SteadyMDGetLabOrderRequest.md} +0 -0
- /package/docs/models/{SteadymdGetLabOrderResultRequest.md → SteadyMDGetLabOrderResultRequest.md} +0 -0
- /package/docs/models/{SteadymdGetLabResultPdfRequest.md → SteadyMDGetLabResultPdfRequest.md} +0 -0
- /package/docs/models/{SteadymdGetMessageRequest.md → SteadyMDGetMessageRequest.md} +0 -0
- /package/docs/models/{SteadymdGetPatientRequest.md → SteadyMDGetPatientRequest.md} +0 -0
- /package/docs/models/{SteadymdGetProgramAppointmentsRequest.md → SteadyMDGetProgramAppointmentsRequest.md} +0 -0
- /package/docs/models/{SteadymdGetProgramConsultOptionsRequest.md → SteadyMDGetProgramConsultOptionsRequest.md} +0 -0
- /package/docs/models/{SteadymdGetProgramLabsRequest.md → SteadyMDGetProgramLabsRequest.md} +0 -0
- /package/docs/models/{SteadymdGetProgramRequest.md → SteadyMDGetProgramRequest.md} +0 -0
- /package/docs/models/{SteadymdListConsultsRequest.md → SteadyMDListConsultsRequest.md} +0 -0
- /package/docs/models/{SteadymdListIntakesRequest.md → SteadyMDListIntakesRequest.md} +0 -0
- /package/docs/models/{SteadymdListLabOrderResultsRequest.md → SteadyMDListLabOrderResultsRequest.md} +0 -0
- /package/docs/models/{SteadymdListLabOrdersRequest.md → SteadyMDListLabOrdersRequest.md} +0 -0
- /package/docs/models/{SteadymdListMessagesRequest.md → SteadyMDListMessagesRequest.md} +0 -0
- /package/docs/models/{SteadymdListPharmaciesRequest.md → SteadyMDListPharmaciesRequest.md} +0 -0
- /package/docs/models/{SteadymdListProgramCliniciansRequest.md → SteadyMDListProgramCliniciansRequest.md} +0 -0
- /package/docs/models/{SteadymdListProgramsRequest.md → SteadyMDListProgramsRequest.md} +0 -0
- /package/docs/models/{SteadymdPatchEpisodeRequest.md → SteadyMDPatchEpisodeRequest.md} +0 -0
- /package/docs/models/{SteadymdScheduleConsultAppointmentRequest.md → SteadyMDScheduleConsultAppointmentRequest.md} +0 -0
- /package/docs/models/{SteadymdSendConsultMessageRequest.md → SteadyMDSendConsultMessageRequest.md} +0 -0
- /package/docs/models/{SteadymdUpdateConsultStatusRequest.md → SteadyMDUpdateConsultStatusRequest.md} +0 -0
- /package/docs/models/{SteadymdUpdateEpisodeRequest.md → SteadyMDUpdateEpisodeRequest.md} +0 -0
- /package/docs/models/{SteadymdUpdateIntakeRequest.md → SteadyMDUpdateIntakeRequest.md} +0 -0
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# List a patient's vitals
|
|
2
|
+
|
|
3
|
+
Operation ID: `ehr.listVitals`
|
|
4
|
+
|
|
5
|
+
List vital-sign Observations for a patient, optionally filtered by ?type= (LOINC code), ?date_from=, and/or ?date_to=.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listVitals`
|
|
10
|
+
|
|
11
|
+
Signature: `ehr.listVitals(patientId, dateFrom, dateTo, type)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ListVitalsResponse>`
|
|
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}/vitals`
|
|
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
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
38
|
+
|---|---|---:|---|---|---|---:|---|
|
|
39
|
+
| `date_from` | `string` | No | | | | No | ISO date filter start (e.g. 2025-01-01) |
|
|
40
|
+
| `date_to` | `string` | No | | | | No | ISO date filter end (e.g. 2025-12-31) |
|
|
41
|
+
| `type` | `string` | No | | | | No | Filter: blood-pressure, heart-rate, body-temperature, body-weight, oxygen-saturation, etc. |
|
|
42
|
+
|
|
43
|
+
## Body parameters
|
|
44
|
+
|
|
45
|
+
None.
|
|
46
|
+
|
|
47
|
+
Request model: None.
|
|
48
|
+
|
|
49
|
+
## Request example
|
|
50
|
+
|
|
51
|
+
None declared in canonical OpenAPI.
|
|
52
|
+
|
|
53
|
+
## Success responses
|
|
54
|
+
|
|
55
|
+
| Status | Shape | Content type | Description |
|
|
56
|
+
|---|---|---|---|
|
|
57
|
+
| `200` | [`ListVitalsResponse`](../models/ListVitalsResponse.md) | application/json | Successful Response |
|
|
58
|
+
|
|
59
|
+
## Success response examples
|
|
60
|
+
|
|
61
|
+
### 200
|
|
62
|
+
|
|
63
|
+
```json
|
|
64
|
+
{
|
|
65
|
+
"patient_id": "patient-example-001",
|
|
66
|
+
"total": 0,
|
|
67
|
+
"vitals": []
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Common errors
|
|
72
|
+
|
|
73
|
+
| Status | Shape | Content type | Description |
|
|
74
|
+
|---|---|---|---|
|
|
75
|
+
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
76
|
+
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Internal server error |
|
|
77
|
+
|
|
78
|
+
## Error examples
|
|
79
|
+
|
|
80
|
+
### 401 — Missing or invalid access token
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"error": "Authorization required"
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### 500 — Unexpected service failure (sanitized example)
|
|
89
|
+
|
|
90
|
+
```json
|
|
91
|
+
{
|
|
92
|
+
"error": "Internal server error"
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## NodeJS / TypeScript implementation
|
|
97
|
+
|
|
98
|
+
```ts
|
|
99
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
```ts
|
|
103
|
+
const patientId = "<PATIENT_ID>";
|
|
104
|
+
|
|
105
|
+
const dateFrom = "2026-08-01";
|
|
106
|
+
|
|
107
|
+
const dateTo = "2026-08-31";
|
|
108
|
+
|
|
109
|
+
const type = "<TYPE>";
|
|
110
|
+
|
|
111
|
+
const result = await ehr.listVitals(patientId, dateFrom, dateTo, type);
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## cURL
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
curl -X GET \
|
|
118
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
119
|
+
'https://dev-api-ehr.health.cloud/patients/%3CPATIENT_ID%3E/vitals?date_from=2026-08-01&date_to=2026-08-31&type=%3CTYPE%3E'
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
## Notes
|
|
123
|
+
|
|
124
|
+
None.
|
|
125
|
+
|
|
126
|
+
## Prepared Test Console scenario
|
|
127
|
+
|
|
128
|
+
No canonical scenario is currently associated.
|
|
129
|
+
|
|
130
|
+
## Real response
|
|
131
|
+
|
|
132
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `fieldagent.resetPassword`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Generate a password reset code and email it to the account via SendGrid; the client submits that code plus the new password to fieldagent.confirmResetPassword — no other server round-trip is needed in between.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.resetPassword`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Generate a password-reset confirmation code and email it to the patient via SendGrid. No authentication is required. Follow up with `patient.confirmResetPassword` once the code is received.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `person.resetPassword`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Generate a password reset code and email it to the account via SendGrid; the client submits that code plus the new password to person.confirmResetPassword — no other server round-trip is needed in between.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `provider.resetPassword`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Generate a password reset code and email it to the account via SendGrid; the client submits that code plus the new password to provider.confirmResetPassword — no other server round-trip is needed in between.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
package/package.json
CHANGED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/docs/models/{SteadymdCreateConsultIssueRequest.md → SteadyMDCreateConsultIssueRequest.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/docs/models/{SteadymdGetConsultPatientUiRequest.md → SteadyMDGetConsultPatientUiRequest.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/docs/models/{SteadymdGetLabOrderResultRequest.md → SteadyMDGetLabOrderResultRequest.md}
RENAMED
|
File without changes
|
/package/docs/models/{SteadymdGetLabResultPdfRequest.md → SteadyMDGetLabResultPdfRequest.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/docs/models/{SteadymdListLabOrderResultsRequest.md → SteadyMDListLabOrderResultsRequest.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/docs/models/{SteadymdSendConsultMessageRequest.md → SteadyMDSendConsultMessageRequest.md}
RENAMED
|
File without changes
|
/package/docs/models/{SteadymdUpdateConsultStatusRequest.md → SteadyMDUpdateConsultStatusRequest.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|