@healthcloudai/hc-sdk 3.10.0 → 3.12.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 +30 -7
- package/dist/index.d.cts +558 -42
- package/dist/index.d.ts +558 -42
- package/dist/index.js +30 -7
- package/docs/clients/PatientClient.md +1 -0
- package/docs/docs-manifest.json +8 -3
- package/docs/examples/index.md +1 -0
- package/docs/index.md +1 -0
- package/docs/models/ClinicalObservation.md +44 -0
- package/docs/models/GetDefaultProviderResponse.md +18 -0
- package/docs/models/GetHealthRecordResponse.md +1 -1
- package/docs/models/ListFunctionalStatusResponse.md +2 -2
- package/docs/models/ListObservationsResponse.md +2 -2
- package/docs/models/ListSocialHistoryResponse.md +1 -1
- package/docs/models/ListVitalsResponse.md +1 -1
- package/docs/models/ObservationComponent.md +23 -0
- package/docs/models/VitalReading.md +44 -0
- package/docs/models/index.md +4 -0
- package/docs/operations/patient.getDefaultProvider.md +117 -0
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -616,7 +616,7 @@ var EhrClient = class extends BaseServiceClient {
|
|
|
616
616
|
pathParams: { patient_id: patientId }
|
|
617
617
|
});
|
|
618
618
|
}
|
|
619
|
-
/** List a patient's functional-status observations. */
|
|
619
|
+
/** List a patient's functional-status observations as serialized ClinicalObservation domain models (never raw FHIR). */
|
|
620
620
|
listFunctionalStatus(patientId) {
|
|
621
621
|
return this.send("GET", "/patients/{patient_id}/functional-status", {
|
|
622
622
|
pathParams: { patient_id: patientId }
|
|
@@ -636,8 +636,9 @@ var EhrClient = class extends BaseServiceClient {
|
|
|
636
636
|
});
|
|
637
637
|
}
|
|
638
638
|
/**
|
|
639
|
-
* List a patient's observations
|
|
640
|
-
*
|
|
639
|
+
* List a patient's observations as serialized ClinicalObservation domain
|
|
640
|
+
* models (never raw FHIR). Vital-sign observations are excluded by default
|
|
641
|
+
* (use {@link listVitals} for those); pass category "vital-signs"
|
|
641
642
|
* explicitly to include them here.
|
|
642
643
|
*/
|
|
643
644
|
listObservations(patientId, category) {
|
|
@@ -664,22 +665,25 @@ var EhrClient = class extends BaseServiceClient {
|
|
|
664
665
|
* domain sections (social/functional/gyn/perinatal history, encounters,
|
|
665
666
|
* vitals, diagnostics, …) but no raw `observations` bucket — list general
|
|
666
667
|
* observations with {@link listObservations} (vital signs excluded) and
|
|
667
|
-
* vital signs with {@link listVitals}.
|
|
668
|
+
* vital signs with {@link listVitals}. The vitals section is the full
|
|
669
|
+
* history serialized as VitalReading domain models (never raw FHIR).
|
|
668
670
|
*/
|
|
669
671
|
getHealthRecord(patientId) {
|
|
670
672
|
return this.send("GET", "/patients/{patient_id}/record", {
|
|
671
673
|
pathParams: { patient_id: patientId }
|
|
672
674
|
});
|
|
673
675
|
}
|
|
674
|
-
/** List a patient's social history. */
|
|
676
|
+
/** List a patient's social history as serialized ClinicalObservation domain models (never raw FHIR). */
|
|
675
677
|
listSocialHistory(patientId) {
|
|
676
678
|
return this.send("GET", "/patients/{patient_id}/social-history", {
|
|
677
679
|
pathParams: { patient_id: patientId }
|
|
678
680
|
});
|
|
679
681
|
}
|
|
680
682
|
/**
|
|
681
|
-
* List a patient's vital signs
|
|
682
|
-
*
|
|
683
|
+
* List a patient's vital signs as serialized VitalReading domain models
|
|
684
|
+
* (full history — never raw FHIR; blood-pressure panels carry systolic
|
|
685
|
+
* and diastolic). This is the only place vital-sign observations are
|
|
686
|
+
* returned — {@link listObservations} excludes them by default.
|
|
683
687
|
*/
|
|
684
688
|
listVitals(patientId, dateFrom, dateTo, type) {
|
|
685
689
|
const query = dateFrom || dateTo || type ? {
|
|
@@ -2092,6 +2096,20 @@ function AddPatientIntakeResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
2092
2096
|
};
|
|
2093
2097
|
}
|
|
2094
2098
|
|
|
2099
|
+
// src/models/openapi-generated/patient/models/GetDefaultProviderResponse.ts
|
|
2100
|
+
function GetDefaultProviderResponseFromJSON(json) {
|
|
2101
|
+
return GetDefaultProviderResponseFromJSONTyped(json, false);
|
|
2102
|
+
}
|
|
2103
|
+
function GetDefaultProviderResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
2104
|
+
if (json == null) {
|
|
2105
|
+
return json;
|
|
2106
|
+
}
|
|
2107
|
+
return {
|
|
2108
|
+
"name": json["name"],
|
|
2109
|
+
"npi": json["npi"]
|
|
2110
|
+
};
|
|
2111
|
+
}
|
|
2112
|
+
|
|
2095
2113
|
// src/clients/PatientClient.ts
|
|
2096
2114
|
var PatientClient = class extends BaseServiceClient {
|
|
2097
2115
|
/** Add one agent-collected intake section and return actionable validation errors. */
|
|
@@ -2184,6 +2202,11 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
2184
2202
|
getDashboard() {
|
|
2185
2203
|
return this.send("GET", "/patients/dashboard", {});
|
|
2186
2204
|
}
|
|
2205
|
+
/** GET /patients/defaultprovider — return the authenticated patient's tenant default provider. */
|
|
2206
|
+
async getDefaultProvider() {
|
|
2207
|
+
const response = await this.send("GET", "/patients/defaultprovider", {});
|
|
2208
|
+
return GetDefaultProviderResponseFromJSON(response);
|
|
2209
|
+
}
|
|
2187
2210
|
getAgentConfiguration() {
|
|
2188
2211
|
return this.send("GET", "/agentconfiguration", {});
|
|
2189
2212
|
}
|
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
- [`getCheckin`](../operations/patient.getCheckinCheckin.md) — Get current check-in state
|
|
40
40
|
- [`getCommunicationConsent`](../operations/patient.getCommunicationConsent.md) — Get SMS/phone contact-preference consent
|
|
41
41
|
- [`getCurrentCareSession`](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md) — Get the current care session
|
|
42
|
+
- [`getDefaultProvider`](../operations/patient.getDefaultProvider.md) — Get the tenant default provider
|
|
42
43
|
- [`getEncounter`](../operations/patient.getEncounter.md) — Get an encounter
|
|
43
44
|
- [`listPatientInsurances`](../operations/patient.getInsurance.md) — List insurance coverage
|
|
44
45
|
- [`getLatestEncounter`](../operations/patient.getLatestEncounter.md) — Get the patient's latest open encounter
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:5475deccae12d7b690d5249fdec94ca286cbc8482df0fd5224b5e3e8d21c252b",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -443,6 +443,7 @@
|
|
|
443
443
|
"models/CheckEncounterResponse.md",
|
|
444
444
|
"models/CheckInEncounterRequest.md",
|
|
445
445
|
"models/CheckInEncounterResponse.md",
|
|
446
|
+
"models/ClinicalObservation.md",
|
|
446
447
|
"models/CmsGetCountyFipsRequest.md",
|
|
447
448
|
"models/CmsSearchHealthPlansRequest.md",
|
|
448
449
|
"models/CmsSearchHealthPlansResponse.md",
|
|
@@ -587,6 +588,7 @@
|
|
|
587
588
|
"models/GetAppointmentTelehealthLinkResponse.md",
|
|
588
589
|
"models/GetCheckinCheckinResponse.md",
|
|
589
590
|
"models/GetCurrentCareSessionCareSessionsCurrentResponse.md",
|
|
591
|
+
"models/GetDefaultProviderResponse.md",
|
|
590
592
|
"models/GetDiagnosticAnalyteResponse.md",
|
|
591
593
|
"models/GetDiagnosticSpecialtiesResponse.md",
|
|
592
594
|
"models/GetDiagnosticTestRelationshipsResponse.md",
|
|
@@ -1265,6 +1267,7 @@
|
|
|
1265
1267
|
"models/NppesSearchProvidersResponse.md",
|
|
1266
1268
|
"models/NppesVerifyProviderRequest.md",
|
|
1267
1269
|
"models/NppesVerifyProviderResponse.md",
|
|
1270
|
+
"models/ObservationComponent.md",
|
|
1268
1271
|
"models/ObservationStatus.md",
|
|
1269
1272
|
"models/OnboardEncounterPayload.md",
|
|
1270
1273
|
"models/OnboardEncounterStepResult.md",
|
|
@@ -1820,6 +1823,7 @@
|
|
|
1820
1823
|
"models/VerifyOtpResponse.md",
|
|
1821
1824
|
"models/VisionFaceCompareRequest.md",
|
|
1822
1825
|
"models/VisionFaceCompareResponse.md",
|
|
1826
|
+
"models/VitalReading.md",
|
|
1823
1827
|
"models/VitalsRecordRequest.md",
|
|
1824
1828
|
"models/VitalsStatus.md",
|
|
1825
1829
|
"models/WhoopActivityIdMappingResponse.md",
|
|
@@ -3007,6 +3011,7 @@
|
|
|
3007
3011
|
"operations/patient.getCheckinCheckin.md",
|
|
3008
3012
|
"operations/patient.getCommunicationConsent.md",
|
|
3009
3013
|
"operations/patient.getCurrentCareSessionCareSessionsCurrent.md",
|
|
3014
|
+
"operations/patient.getDefaultProvider.md",
|
|
3010
3015
|
"operations/patient.getEncounter.md",
|
|
3011
3016
|
"operations/patient.getInsurance.md",
|
|
3012
3017
|
"operations/patient.getLatestEncounter.md",
|
|
@@ -3106,7 +3111,7 @@
|
|
|
3106
3111
|
"operations/vitals.recordVitals.md"
|
|
3107
3112
|
],
|
|
3108
3113
|
"language": "nodejs",
|
|
3109
|
-
"modelCount":
|
|
3110
|
-
"operationCount":
|
|
3114
|
+
"modelCount": 2028,
|
|
3115
|
+
"operationCount": 1026,
|
|
3111
3116
|
"schemaVersion": 1
|
|
3112
3117
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -930,6 +930,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
930
930
|
- [Get current check-in state](../operations/patient.getCheckinCheckin.md)
|
|
931
931
|
- [Get SMS/phone contact-preference consent](../operations/patient.getCommunicationConsent.md)
|
|
932
932
|
- [Get the current care session](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md)
|
|
933
|
+
- [Get the tenant default provider](../operations/patient.getDefaultProvider.md)
|
|
933
934
|
- [Get an encounter](../operations/patient.getEncounter.md)
|
|
934
935
|
- [List insurance coverage](../operations/patient.getInsurance.md)
|
|
935
936
|
- [Get the patient's latest open encounter](../operations/patient.getLatestEncounter.md)
|
package/docs/index.md
CHANGED
|
@@ -938,6 +938,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
938
938
|
- [Get current check-in state](operations/patient.getCheckinCheckin.md) (`patient.getCheckinCheckin`)
|
|
939
939
|
- [Get SMS/phone contact-preference consent](operations/patient.getCommunicationConsent.md) (`patient.getCommunicationConsent`)
|
|
940
940
|
- [Get the current care session](operations/patient.getCurrentCareSessionCareSessionsCurrent.md) (`patient.getCurrentCareSessionCareSessionsCurrent`)
|
|
941
|
+
- [Get the tenant default provider](operations/patient.getDefaultProvider.md) (`patient.getDefaultProvider`)
|
|
941
942
|
- [Get an encounter](operations/patient.getEncounter.md) (`patient.getEncounter`)
|
|
942
943
|
- [List insurance coverage](operations/patient.getInsurance.md) (`patient.getInsurance`)
|
|
943
944
|
- [Get the patient's latest open encounter](operations/patient.getLatestEncounter.md) (`patient.getLatestEncounter`)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# ClinicalObservation
|
|
2
|
+
|
|
3
|
+
Model ID: `ClinicalObservation`
|
|
4
|
+
|
|
5
|
+
A single FHIR Observation mapped into a domain model.
|
|
6
|
+
|
|
7
|
+
All clinically relevant data on the FHIR resource is carried over:
|
|
8
|
+
category, code, status, effective time, every value[x] variant, panel
|
|
9
|
+
components, interpretation, body site, method, notes and device — so
|
|
10
|
+
mapping never loses clinical content, it only sheds raw FHIR scaffolding
|
|
11
|
+
(resourceType, meta, subject, extensions, identifiers...).
|
|
12
|
+
|
|
13
|
+
Type: `object`
|
|
14
|
+
|
|
15
|
+
## Fields
|
|
16
|
+
|
|
17
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
18
|
+
|---|---|---:|---|---|---|---:|---|
|
|
19
|
+
| `body_site` | `string|null` | No | | | `null` | Yes | Body site of the observation, optional. |
|
|
20
|
+
| `category` | `string|null` | No | | | `null` | Yes | Observation category code (e.g. social-history, survey, laboratory, activity). |
|
|
21
|
+
| `code` | `string|null` | No | | | `null` | Yes | Primary code identifying what was observed (e.g. LOINC). |
|
|
22
|
+
| `code_system` | `string|null` | No | | | `null` | Yes | Code system of the primary code, optional. |
|
|
23
|
+
| `components` | array of [`ObservationComponent`](./ObservationComponent.md) | No | | | | No | Panel components (e.g. blood pressure systolic/diastolic), each mapped like the observation itself. |
|
|
24
|
+
| `device` | `string|null` | No | | | `null` | Yes | Device used to take the measurement (HC vitals-device-type extension), optional. |
|
|
25
|
+
| `display` | `string|null` | No | | | `null` | Yes | Human-readable name of what was observed. |
|
|
26
|
+
| `effective_datetime` | `string|null` | No | | | `null` | Yes | ISO 8601 datetime the observation was effective. |
|
|
27
|
+
| `interpretation` | `string|null` | No | | | `null` | Yes | Clinical interpretation flag (e.g. H, L, HH, POS). |
|
|
28
|
+
| `method` | `string|null` | No | | | `null` | Yes | Method by which the observation was made, optional. |
|
|
29
|
+
| `notes` | `array` | No | | | | No | Free-text notes attached to the observation. |
|
|
30
|
+
| `observation_id` | `string|null` | No | | | `null` | Yes | FHIR Observation resource ID. |
|
|
31
|
+
| `status` | `string|null` | No | | | `null` | Yes | Observation lifecycle status. |
|
|
32
|
+
| `value_boolean` | `boolean|null` | No | | | `null` | Yes | Boolean result value, when applicable. |
|
|
33
|
+
| `value_code` | `string|null` | No | | | `null` | Yes | Coded form of the value unit, optional. |
|
|
34
|
+
| `value_codeable_concept` | `object|null` | No | | | `null` | Yes | Coded result value, when applicable. |
|
|
35
|
+
| `value_integer` | `integer|null` | No | | | `null` | Yes | Integer result value, when applicable. |
|
|
36
|
+
| `value_quantity` | `number|null` | No | | | `null` | Yes | Numeric result, when the observation is quantitative. |
|
|
37
|
+
| `value_range` | `object|null` | No | | | `null` | Yes | Range result value, when applicable. |
|
|
38
|
+
| `value_string` | `string|null` | No | | | `null` | Yes | Free-text result value, when not quantitative. |
|
|
39
|
+
| `value_system` | `string|null` | No | | | `null` | Yes | Code system of the value unit (UCUM), optional. |
|
|
40
|
+
| `value_unit` | `string|null` | No | | | `null` | Yes | Unit of measure for value_quantity, optional. |
|
|
41
|
+
|
|
42
|
+
## Example
|
|
43
|
+
|
|
44
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# GetDefaultProviderResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `GetDefaultProviderResponse`
|
|
4
|
+
|
|
5
|
+
Default provider configured for the authenticated patient's tenant.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `name` | `string` | Yes | | | | No | Provider's full name. |
|
|
14
|
+
| `npi` | `string` | Yes | | | | No | Provider's 10-digit US National Provider Identifier. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
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
|
| `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, consents, social_history, functional_status, gyn_history, perinatal_history, 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.
|
|
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, 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. vitals is the full vital-sign history, each reading serialized as a VitalReading domain model (code, value, unit, effective time, blood-pressure panel components surface as systolic/diastolic, interpretation, body site, method, device, notes) — never raw FHIR resources. The record carries no raw observations bucket — list general Observations with GET /patients/{patient_id}/observations (vital signs excluded) and vital signs with GET /patients/{patient_id}/vitals, so observations and vitals never appear twice across the record and its sections. encounters, questionnaire responses, diagnostics, 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
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `ListFunctionalStatusResponse`
|
|
4
4
|
|
|
5
|
-
Response for GET /patients/{patient_id}/functional-status. Contains
|
|
5
|
+
Response for GET /patients/{patient_id}/functional-status. Contains serialized domain models mapped from FHIR Observations.
|
|
6
6
|
|
|
7
7
|
Type: `object`
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `functional_status` | `array` | Yes | | | | No |
|
|
13
|
+
| `functional_status` | `array` | Yes | | | | No | Functional-status observations (category survey or functional-status), serialized as ClinicalObservation domain models — never raw FHIR resources. |
|
|
14
14
|
| `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
|
|
15
15
|
| `total` | `integer` | Yes | | | | No | Number of observations in this response. |
|
|
16
16
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `ListObservationsResponse`
|
|
4
4
|
|
|
5
|
-
Response for GET /patients/{patient_id}/observations. Contains
|
|
5
|
+
Response for GET /patients/{patient_id}/observations. Contains serialized domain models mapped from FHIR Observations.
|
|
6
6
|
|
|
7
7
|
Type: `object`
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `observations` | `array` | Yes | | | | No |
|
|
13
|
+
| `observations` | `array` | Yes | | | | No | Observations serialized as ClinicalObservation domain models (category, code, display, status, effective time, every value[x] variant, panel components, interpretation, body site, method, device, notes) — never raw FHIR resources. Matching the optional ?category= filter; vital-sign observations are excluded by default because they are served by GET /patients/{patient_id}/vitals — pass ?category=vital-signs to fetch them here. |
|
|
14
14
|
| `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
|
|
15
15
|
| `total` | `integer` | Yes | | | | No | Number of observations in this response. |
|
|
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
|
-
| `social_history` |
|
|
14
|
+
| `social_history` | array of [`ClinicalObservation`](./ClinicalObservation.md) | Yes | | | | No | |
|
|
15
15
|
| `total` | `integer` | Yes | | | | No | |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
@@ -12,7 +12,7 @@ Type: `object`
|
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `patient_id` | `string` | Yes | | | | No | |
|
|
14
14
|
| `total` | `integer` | Yes | | | | No | |
|
|
15
|
-
| `vitals` |
|
|
15
|
+
| `vitals` | array of [`VitalReading`](./VitalReading.md) | Yes | | | | No | |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ObservationComponent
|
|
2
|
+
|
|
3
|
+
Model ID: `ObservationComponent`
|
|
4
|
+
|
|
5
|
+
One component of a multi-part Observation (e.g. a blood-pressure panel).
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `code` | `string|null` | No | | | `null` | Yes | Component code (e.g. LOINC 8480-6 systolic). |
|
|
14
|
+
| `code_system` | `string|null` | No | | | `null` | Yes | Code system of the component code, optional. |
|
|
15
|
+
| `display` | `string|null` | No | | | `null` | Yes | Human-readable name of the component, optional. |
|
|
16
|
+
| `value_codeable_concept` | `object|null` | No | | | `null` | Yes | Coded component value, when applicable. |
|
|
17
|
+
| `value_quantity` | `number|null` | No | | | `null` | Yes | Numeric component value, when quantitative. |
|
|
18
|
+
| `value_string` | `string|null` | No | | | `null` | Yes | Free-text component value, when not quantitative. |
|
|
19
|
+
| `value_unit` | `string|null` | No | | | `null` | Yes | Unit of measure for value_quantity, optional. |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# VitalReading
|
|
2
|
+
|
|
3
|
+
Model ID: `VitalReading`
|
|
4
|
+
|
|
5
|
+
One FHIR vital-sign Observation mapped into a domain model.
|
|
6
|
+
|
|
7
|
+
Every clinically relevant field on the FHIR resource is carried over —
|
|
8
|
+
code, value, unit, effective time, panel components (with systolic and
|
|
9
|
+
diastolic extracted from blood-pressure panels), interpretation, body
|
|
10
|
+
site, method, device and notes — so no data is lost, only the raw FHIR
|
|
11
|
+
scaffolding (resourceType, meta, subject, extensions...) is shed.
|
|
12
|
+
Used by GET /patients/{id}/vitals and the record's vitals section.
|
|
13
|
+
|
|
14
|
+
Type: `object`
|
|
15
|
+
|
|
16
|
+
## Fields
|
|
17
|
+
|
|
18
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
19
|
+
|---|---|---:|---|---|---|---:|---|
|
|
20
|
+
| `body_site` | `string|null` | No | | | `null` | Yes | Body site of the reading, optional. |
|
|
21
|
+
| `category` | `string|null` | No | | | `null` | Yes | Observation category code (vital-signs or activity). |
|
|
22
|
+
| `components` | array of [`ObservationComponent`](./ObservationComponent.md) | No | | | | No | Panel components (e.g. SpO2 panel), each mapped like the reading itself. |
|
|
23
|
+
| `device` | `string|null` | No | | | `null` | Yes | Device used to take the reading (HC vitals-device-type extension), optional. |
|
|
24
|
+
| `diastolic` | `number|null` | No | | | `null` | Yes | Diastolic blood pressure in mmHg, extracted from the 8462-4 component of a blood-pressure panel. |
|
|
25
|
+
| `display` | `string|null` | No | | | `null` | Yes | Human-readable name of the vital sign. |
|
|
26
|
+
| `effective_datetime` | `string|null` | No | | | `null` | Yes | ISO 8601 datetime the reading was taken. |
|
|
27
|
+
| `interpretation` | `string|null` | No | | | `null` | Yes | Clinical interpretation flag (e.g. H, L, HH). |
|
|
28
|
+
| `loinc_code` | `string|null` | No | | | `null` | Yes | LOINC code identifying the vital sign (e.g. 85354-9 blood pressure panel, 8310-5 body temperature). |
|
|
29
|
+
| `method` | `string|null` | No | | | `null` | Yes | Method by which the reading was made, optional. |
|
|
30
|
+
| `notes` | `array` | No | | | | No | Free-text notes attached to the reading. |
|
|
31
|
+
| `observation_id` | `string|null` | No | | | `null` | Yes | FHIR Observation resource ID. |
|
|
32
|
+
| `status` | `string|null` | No | | | `null` | Yes | Observation lifecycle status. |
|
|
33
|
+
| `systolic` | `number|null` | No | | | `null` | Yes | Systolic blood pressure in mmHg, extracted from the 8480-6 component of a blood-pressure panel. |
|
|
34
|
+
| `value_code` | `string|null` | No | | | `null` | Yes | Coded form of the value unit, optional. |
|
|
35
|
+
| `value_codeable_concept` | `object|null` | No | | | `null` | Yes | Coded reading, when applicable. |
|
|
36
|
+
| `value_integer` | `integer|null` | No | | | `null` | Yes | Integer reading, when applicable. |
|
|
37
|
+
| `value_quantity` | `number|null` | No | | | `null` | Yes | Numeric reading (e.g. 72 for heart rate), when quantitative. |
|
|
38
|
+
| `value_string` | `string|null` | No | | | `null` | Yes | Free-text reading, when not quantitative. |
|
|
39
|
+
| `value_system` | `string|null` | No | | | `null` | Yes | Code system of the value unit (UCUM), optional. |
|
|
40
|
+
| `value_unit` | `string|null` | No | | | `null` | Yes | Unit of measure for value_quantity (e.g. /min), optional. |
|
|
41
|
+
|
|
42
|
+
## Example
|
|
43
|
+
|
|
44
|
+
None declared in canonical OpenAPI.
|
package/docs/models/index.md
CHANGED
|
@@ -393,6 +393,7 @@
|
|
|
393
393
|
- [CheckEncounterResponse](CheckEncounterResponse.md)
|
|
394
394
|
- [CheckInEncounterRequest](CheckInEncounterRequest.md)
|
|
395
395
|
- [CheckInEncounterResponse](CheckInEncounterResponse.md)
|
|
396
|
+
- [ClinicalObservation](ClinicalObservation.md)
|
|
396
397
|
- [CMSCounty](CMSCounty.md)
|
|
397
398
|
- [CmsGetCountyFipsRequest](CmsGetCountyFipsRequest.md)
|
|
398
399
|
- [CmsSearchHealthPlansRequest](CmsSearchHealthPlansRequest.md)
|
|
@@ -572,6 +573,7 @@
|
|
|
572
573
|
- [GetAppointmentTelehealthLinkResponse](GetAppointmentTelehealthLinkResponse.md)
|
|
573
574
|
- [GetCheckinCheckinResponse](GetCheckinCheckinResponse.md)
|
|
574
575
|
- [GetCurrentCareSessionCareSessionsCurrentResponse](GetCurrentCareSessionCareSessionsCurrentResponse.md)
|
|
576
|
+
- [GetDefaultProviderResponse](GetDefaultProviderResponse.md)
|
|
575
577
|
- [GetDiagnosticAnalyteResponse](GetDiagnosticAnalyteResponse.md)
|
|
576
578
|
- [GetDiagnosticSpecialtiesResponse](GetDiagnosticSpecialtiesResponse.md)
|
|
577
579
|
- [GetDiagnosticTestRelationshipsResponse](GetDiagnosticTestRelationshipsResponse.md)
|
|
@@ -1256,6 +1258,7 @@
|
|
|
1256
1258
|
- [NppesSearchProvidersResponse](NppesSearchProvidersResponse.md)
|
|
1257
1259
|
- [NppesVerifyProviderRequest](NppesVerifyProviderRequest.md)
|
|
1258
1260
|
- [NppesVerifyProviderResponse](NppesVerifyProviderResponse.md)
|
|
1261
|
+
- [ObservationComponent](ObservationComponent.md)
|
|
1259
1262
|
- [ObservationStatus](ObservationStatus.md)
|
|
1260
1263
|
- [OnboardEncounterPayload](OnboardEncounterPayload.md)
|
|
1261
1264
|
- [OnboardEncounterStepResult](OnboardEncounterStepResult.md)
|
|
@@ -1892,6 +1895,7 @@
|
|
|
1892
1895
|
- [VerifyOtpResponse](VerifyOtpResponse.md)
|
|
1893
1896
|
- [VisionFaceCompareRequest](VisionFaceCompareRequest.md)
|
|
1894
1897
|
- [VisionFaceCompareResponse](VisionFaceCompareResponse.md)
|
|
1898
|
+
- [VitalReading](VitalReading.md)
|
|
1895
1899
|
- [vitals.ConnectResponse](vitals.ConnectResponse.md)
|
|
1896
1900
|
- [VitalsRecordRequest](VitalsRecordRequest.md)
|
|
1897
1901
|
- [VitalsStatus](VitalsStatus.md)
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# Get the tenant default provider
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.getDefaultProvider`
|
|
4
|
+
|
|
5
|
+
Return the configured default provider's full name and 10-digit NPI for the authenticated patient's tenant. Requires a patient Bearer JWT; the tenant is derived from that token and cannot be supplied by the client. Returns 404 when the account has no default provider configured.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getDefaultProvider`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.getDefaultProvider()`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<GetDefaultProviderResponse>`
|
|
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/defaultprovider`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
None.
|
|
32
|
+
|
|
33
|
+
## Query parameters
|
|
34
|
+
|
|
35
|
+
None.
|
|
36
|
+
|
|
37
|
+
## Body parameters
|
|
38
|
+
|
|
39
|
+
None.
|
|
40
|
+
|
|
41
|
+
Request model: None.
|
|
42
|
+
|
|
43
|
+
## Request example
|
|
44
|
+
|
|
45
|
+
None declared in canonical OpenAPI.
|
|
46
|
+
|
|
47
|
+
## Success responses
|
|
48
|
+
|
|
49
|
+
| Status | Shape | Content type | Description |
|
|
50
|
+
|---|---|---|---|
|
|
51
|
+
| `200` | [`GetDefaultProviderResponse`](../models/GetDefaultProviderResponse.md) | application/json | Default provider configured for the authenticated patient's tenant |
|
|
52
|
+
|
|
53
|
+
## Success response examples
|
|
54
|
+
|
|
55
|
+
### 200
|
|
56
|
+
|
|
57
|
+
```json
|
|
58
|
+
{
|
|
59
|
+
"name": "Murdoc Khaleghi",
|
|
60
|
+
"npi": "1942427778"
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Common errors
|
|
65
|
+
|
|
66
|
+
| Status | Shape | Content type | Description |
|
|
67
|
+
|---|---|---|---|
|
|
68
|
+
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing, invalid, expired, or non-patient Bearer JWT |
|
|
69
|
+
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The authenticated patient has no FHIR Patient record |
|
|
70
|
+
|
|
71
|
+
## Error examples
|
|
72
|
+
|
|
73
|
+
### 401 — Missing or invalid access token
|
|
74
|
+
|
|
75
|
+
```json
|
|
76
|
+
{
|
|
77
|
+
"error": "Authorization required"
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### 404 — Patient not found
|
|
82
|
+
|
|
83
|
+
```json
|
|
84
|
+
{
|
|
85
|
+
"error": "Patient not found"
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## NodeJS / TypeScript implementation
|
|
90
|
+
|
|
91
|
+
```ts
|
|
92
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
```ts
|
|
96
|
+
const result = await patient.getDefaultProvider();
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## cURL
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
curl -X GET \
|
|
103
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
104
|
+
'https://dev-api-patient.health.cloud/patients/defaultprovider'
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Notes
|
|
108
|
+
|
|
109
|
+
None.
|
|
110
|
+
|
|
111
|
+
## Prepared Test Console scenario
|
|
112
|
+
|
|
113
|
+
No canonical scenario is currently associated.
|
|
114
|
+
|
|
115
|
+
## Real response
|
|
116
|
+
|
|
117
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
package/package.json
CHANGED