@healthcloudai/hc-sdk 3.9.0 → 3.11.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 CHANGED
@@ -691,7 +691,7 @@ var EhrClient = class extends BaseServiceClient {
691
691
  pathParams: { patient_id: patientId }
692
692
  });
693
693
  }
694
- /** List a patient's functional-status observations. */
694
+ /** List a patient's functional-status observations as serialized ClinicalObservation domain models (never raw FHIR). */
695
695
  listFunctionalStatus(patientId) {
696
696
  return this.send("GET", "/patients/{patient_id}/functional-status", {
697
697
  pathParams: { patient_id: patientId }
@@ -710,7 +710,12 @@ var EhrClient = class extends BaseServiceClient {
710
710
  query: resourceType ? { resource_type: resourceType } : void 0
711
711
  });
712
712
  }
713
- /** List a patient's observations. */
713
+ /**
714
+ * List a patient's observations as serialized ClinicalObservation domain
715
+ * models (never raw FHIR). Vital-sign observations are excluded by default
716
+ * (use {@link listVitals} for those); pass category "vital-signs"
717
+ * explicitly to include them here.
718
+ */
714
719
  listObservations(patientId, category) {
715
720
  return this.send("GET", "/patients/{patient_id}/observations", {
716
721
  pathParams: { patient_id: patientId },
@@ -730,19 +735,31 @@ var EhrClient = class extends BaseServiceClient {
730
735
  query: questionnaireUrl ? { questionnaire_url: questionnaireUrl } : void 0
731
736
  });
732
737
  }
733
- /** Get a patient's consolidated health record. */
738
+ /**
739
+ * Get a patient's consolidated health record. The record carries its mapped
740
+ * domain sections (social/functional/gyn/perinatal history, encounters,
741
+ * vitals, diagnostics, …) but no raw `observations` bucket — list general
742
+ * observations with {@link listObservations} (vital signs excluded) and
743
+ * vital signs with {@link listVitals}. The vitals section is the full
744
+ * history serialized as VitalReading domain models (never raw FHIR).
745
+ */
734
746
  getHealthRecord(patientId) {
735
747
  return this.send("GET", "/patients/{patient_id}/record", {
736
748
  pathParams: { patient_id: patientId }
737
749
  });
738
750
  }
739
- /** List a patient's social history. */
751
+ /** List a patient's social history as serialized ClinicalObservation domain models (never raw FHIR). */
740
752
  listSocialHistory(patientId) {
741
753
  return this.send("GET", "/patients/{patient_id}/social-history", {
742
754
  pathParams: { patient_id: patientId }
743
755
  });
744
756
  }
745
- /** List a patient's vitals. */
757
+ /**
758
+ * List a patient's vital signs as serialized VitalReading domain models
759
+ * (full history — never raw FHIR; blood-pressure panels carry systolic
760
+ * and diastolic). This is the only place vital-sign observations are
761
+ * returned — {@link listObservations} excludes them by default.
762
+ */
746
763
  listVitals(patientId, dateFrom, dateTo, type) {
747
764
  const query = dateFrom || dateTo || type ? {
748
765
  ...dateFrom ? { date_from: dateFrom } : {},