@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.
Files changed (62) hide show
  1. package/dist/index.cjs +103 -0
  2. package/dist/index.d.cts +5805 -5777
  3. package/dist/index.d.ts +5805 -5777
  4. package/dist/index.js +103 -0
  5. package/docs/clients/EhrClient.md +15 -0
  6. package/docs/docs-manifest.json +55 -3
  7. package/docs/examples/index.md +15 -0
  8. package/docs/index.md +15 -0
  9. package/docs/models/Allergy.md +31 -0
  10. package/docs/models/AllergyCategory.md +15 -0
  11. package/docs/models/AllergyCriticality.md +15 -0
  12. package/docs/models/AllergyReaction.md +21 -0
  13. package/docs/models/AllergyStatus.md +15 -0
  14. package/docs/models/AllergyVerificationStatus.md +15 -0
  15. package/docs/models/CodedConcept.md +19 -0
  16. package/docs/models/FamilyCondition.md +21 -0
  17. package/docs/models/FamilyHistoryEntry.md +30 -0
  18. package/docs/models/FamilyHistoryStatus.md +15 -0
  19. package/docs/models/FamilyRelationship.md +15 -0
  20. package/docs/models/GetHealthRecordResponse.md +19 -0
  21. package/docs/models/IntoleranceType.md +15 -0
  22. package/docs/models/ListAllergiesResponse.md +19 -0
  23. package/docs/models/ListConditionsResponse.md +19 -0
  24. package/docs/models/ListDirectivesResponse.md +19 -0
  25. package/docs/models/ListFamilyHistoryResponse.md +19 -0
  26. package/docs/models/ListFunctionalStatusResponse.md +19 -0
  27. package/docs/models/ListImmunizationsResponse.md +19 -0
  28. package/docs/models/ListObservationsResponse.md +19 -0
  29. package/docs/models/ListProceduresResponse.md +19 -0
  30. package/docs/models/ListQuestionnaireResponsesResponse.md +19 -0
  31. package/docs/models/ListSocialHistoryResponse.md +19 -0
  32. package/docs/models/ListVitalsResponse.md +19 -0
  33. package/docs/models/Problem.md +37 -0
  34. package/docs/models/ProblemCategory.md +15 -0
  35. package/docs/models/ProblemClinicalStatus.md +15 -0
  36. package/docs/models/ProblemSeverity.md +15 -0
  37. package/docs/models/ProblemVerificationStatus.md +15 -0
  38. package/docs/models/QuestionnaireResponse.md +27 -0
  39. package/docs/models/QuestionnaireResponseStatus.md +15 -0
  40. package/docs/models/ReactionSeverity.md +15 -0
  41. package/docs/models/ResponseAnswer.md +27 -0
  42. package/docs/models/ResponseItem.md +21 -0
  43. package/docs/models/ehr.ListDiagnosticsResponse.md +19 -0
  44. package/docs/models/ehr.ListEncountersResponse.md +19 -0
  45. package/docs/models/ehr.ListMedicationsResponse.md +19 -0
  46. package/docs/models/index.md +37 -0
  47. package/docs/operations/ehr.getHealthRecord.md +122 -0
  48. package/docs/operations/ehr.listAllergies.md +156 -0
  49. package/docs/operations/ehr.listConditions.md +152 -0
  50. package/docs/operations/ehr.listDiagnostics.md +147 -0
  51. package/docs/operations/ehr.listDirectives.md +122 -0
  52. package/docs/operations/ehr.listEncounters.md +178 -0
  53. package/docs/operations/ehr.listFamilyHistory.md +147 -0
  54. package/docs/operations/ehr.listFunctionalStatus.md +122 -0
  55. package/docs/operations/ehr.listImmunizations.md +122 -0
  56. package/docs/operations/ehr.listMedications.md +163 -0
  57. package/docs/operations/ehr.listObservations.md +126 -0
  58. package/docs/operations/ehr.listProcedures.md +122 -0
  59. package/docs/operations/ehr.listQuestionnaireResponses.md +162 -0
  60. package/docs/operations/ehr.listSocialHistory.md +122 -0
  61. package/docs/operations/ehr.listVitals.md +132 -0
  62. package/package.json +1 -1
@@ -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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "2.6.2",
3
+ "version": "2.7.0",
4
4
  "description": "All-in-one HealthCloud SDK with typed platform APIs and secure connector clients.",
5
5
  "author": "Healthcheck Systems Inc",
6
6
  "license": "MIT",