@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
package/dist/index.js CHANGED
@@ -430,6 +430,109 @@ var EhrClient = class extends BaseServiceClient {
430
430
  connect() {
431
431
  return this.connectService();
432
432
  }
433
+ // ─── Clinical Record ─────────────────────────────────────────────────
434
+ /** List a patient's allergies. */
435
+ listAllergies(patientId) {
436
+ return this.send("GET", "/patients/{patient_id}/allergies", {
437
+ pathParams: { patient_id: patientId }
438
+ });
439
+ }
440
+ /** List a patient's conditions. */
441
+ listConditions(patientId, clinicalStatus) {
442
+ return this.send("GET", "/patients/{patient_id}/conditions", {
443
+ pathParams: { patient_id: patientId },
444
+ query: clinicalStatus ? { clinical_status: clinicalStatus } : void 0
445
+ });
446
+ }
447
+ /** List a patient's diagnostic/lab observations. */
448
+ listDiagnostics(patientId, code) {
449
+ return this.send("GET", "/patients/{patient_id}/diagnostics", {
450
+ pathParams: { patient_id: patientId },
451
+ query: code ? { code } : void 0
452
+ });
453
+ }
454
+ /** List a patient's advance directives. */
455
+ listDirectives(patientId) {
456
+ return this.send("GET", "/patients/{patient_id}/directives", {
457
+ pathParams: { patient_id: patientId }
458
+ });
459
+ }
460
+ /** List a patient's encounters. */
461
+ listEncounters(patientId, status) {
462
+ return this.send("GET", "/patients/{patient_id}/encounters", {
463
+ pathParams: { patient_id: patientId },
464
+ query: status ? { status } : void 0
465
+ });
466
+ }
467
+ /** List a patient's family history. */
468
+ listFamilyHistory(patientId) {
469
+ return this.send("GET", "/patients/{patient_id}/family-history", {
470
+ pathParams: { patient_id: patientId }
471
+ });
472
+ }
473
+ /** List a patient's functional-status observations. */
474
+ listFunctionalStatus(patientId) {
475
+ return this.send("GET", "/patients/{patient_id}/functional-status", {
476
+ pathParams: { patient_id: patientId }
477
+ });
478
+ }
479
+ /** List a patient's immunizations. */
480
+ listImmunizations(patientId) {
481
+ return this.send("GET", "/patients/{patient_id}/immunizations", {
482
+ pathParams: { patient_id: patientId }
483
+ });
484
+ }
485
+ /** List a patient's medications. */
486
+ listMedications(patientId, resourceType) {
487
+ return this.send("GET", "/patients/{patient_id}/medications", {
488
+ pathParams: { patient_id: patientId },
489
+ query: resourceType ? { resource_type: resourceType } : void 0
490
+ });
491
+ }
492
+ /** List a patient's observations. */
493
+ listObservations(patientId, category) {
494
+ return this.send("GET", "/patients/{patient_id}/observations", {
495
+ pathParams: { patient_id: patientId },
496
+ query: category ? { category } : void 0
497
+ });
498
+ }
499
+ /** List a patient's procedures. */
500
+ listProcedures(patientId) {
501
+ return this.send("GET", "/patients/{patient_id}/procedures", {
502
+ pathParams: { patient_id: patientId }
503
+ });
504
+ }
505
+ /** List a patient's questionnaire responses. */
506
+ listQuestionnaireResponses(patientId, questionnaireUrl) {
507
+ return this.send("GET", "/patients/{patient_id}/questionnaire-responses", {
508
+ pathParams: { patient_id: patientId },
509
+ query: questionnaireUrl ? { questionnaire_url: questionnaireUrl } : void 0
510
+ });
511
+ }
512
+ /** Get a patient's consolidated health record. */
513
+ getHealthRecord(patientId) {
514
+ return this.send("GET", "/patients/{patient_id}/record", {
515
+ pathParams: { patient_id: patientId }
516
+ });
517
+ }
518
+ /** List a patient's social history. */
519
+ listSocialHistory(patientId) {
520
+ return this.send("GET", "/patients/{patient_id}/social-history", {
521
+ pathParams: { patient_id: patientId }
522
+ });
523
+ }
524
+ /** List a patient's vitals. */
525
+ listVitals(patientId, dateFrom, dateTo, type) {
526
+ const query = dateFrom || dateTo || type ? {
527
+ ...dateFrom ? { date_from: dateFrom } : {},
528
+ ...dateTo ? { date_to: dateTo } : {},
529
+ ...type ? { type } : {}
530
+ } : void 0;
531
+ return this.send("GET", "/patients/{patient_id}/vitals", {
532
+ pathParams: { patient_id: patientId },
533
+ query
534
+ });
535
+ }
433
536
  };
434
537
 
435
538
  // src/clients/FieldAgentClient.ts
@@ -1,3 +1,18 @@
1
1
  # EhrClient
2
2
 
3
3
  - [`connect`](../operations/ehr.connect.md) — Health check
4
+ - [`getHealthRecord`](../operations/ehr.getHealthRecord.md) — Get a patient's consolidated health record
5
+ - [`listAllergies`](../operations/ehr.listAllergies.md) — List a patient's allergies
6
+ - [`listConditions`](../operations/ehr.listConditions.md) — List a patient's conditions
7
+ - [`listDiagnostics`](../operations/ehr.listDiagnostics.md) — List a patient's diagnostic/lab observations
8
+ - [`listDirectives`](../operations/ehr.listDirectives.md) — List a patient's advance directives
9
+ - [`listEncounters`](../operations/ehr.listEncounters.md) — List a patient's encounters
10
+ - [`listFamilyHistory`](../operations/ehr.listFamilyHistory.md) — List a patient's family history
11
+ - [`listFunctionalStatus`](../operations/ehr.listFunctionalStatus.md) — List a patient's functional-status observations
12
+ - [`listImmunizations`](../operations/ehr.listImmunizations.md) — List a patient's immunizations
13
+ - [`listMedications`](../operations/ehr.listMedications.md) — List a patient's medications
14
+ - [`listObservations`](../operations/ehr.listObservations.md) — List a patient's observations
15
+ - [`listProcedures`](../operations/ehr.listProcedures.md) — List a patient's procedures
16
+ - [`listQuestionnaireResponses`](../operations/ehr.listQuestionnaireResponses.md) — List a patient's questionnaire responses
17
+ - [`listSocialHistory`](../operations/ehr.listSocialHistory.md) — List a patient's social history
18
+ - [`listVitals`](../operations/ehr.listVitals.md) — List a patient's vitals
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:90801279447f9821beec4a9253955e18ac6c540dfdeee67576aa32c734ef6038",
2
+ "docsDataContentDigest": "sha256:66eaa85f930df6ea0e0a429b9842cc4d3bed53310e8725f9989df2bf1abb23ef",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AnthropicClient.md",
@@ -62,6 +62,12 @@
62
62
  "models/Address.md",
63
63
  "models/AddressType.md",
64
64
  "models/AgentDashboardResponse.md",
65
+ "models/Allergy.md",
66
+ "models/AllergyCategory.md",
67
+ "models/AllergyCriticality.md",
68
+ "models/AllergyReaction.md",
69
+ "models/AllergyStatus.md",
70
+ "models/AllergyVerificationStatus.md",
65
71
  "models/AnalyzeIdentityDocumentRequest.md",
66
72
  "models/AnalyzeIdentityDocumentResponse.md",
67
73
  "models/AnthropicContentBlock.md",
@@ -431,6 +437,7 @@
431
437
  "models/CmsGetCountyFipsRequest.md",
432
438
  "models/CmsSearchHealthPlansRequest.md",
433
439
  "models/CmsSearchHealthPlansResponse.md",
440
+ "models/CodedConcept.md",
434
441
  "models/CommGroupRecord.md",
435
442
  "models/CommsGetStateResponse.md",
436
443
  "models/CommsGetUnreadCountResponse.md",
@@ -543,6 +550,10 @@
543
550
  "models/Ethnicity.md",
544
551
  "models/FaceMatchRequest.md",
545
552
  "models/FaceMatchResponse.md",
553
+ "models/FamilyCondition.md",
554
+ "models/FamilyHistoryEntry.md",
555
+ "models/FamilyHistoryStatus.md",
556
+ "models/FamilyRelationship.md",
546
557
  "models/FedexCreateShipmentRequest.md",
547
558
  "models/FedexDeliveryDetails.md",
548
559
  "models/FedexLatestStatusDetail.md",
@@ -568,6 +579,7 @@
568
579
  "models/GetDiagnosticTestResponse.md",
569
580
  "models/GetDiagnosticTestSystemResponse.md",
570
581
  "models/GetEncounterResponse.md",
582
+ "models/GetHealthRecordResponse.md",
571
583
  "models/GetInsuranceResponse.md",
572
584
  "models/GetMedicalConceptAncestorsResponse.md",
573
585
  "models/GetMedicalConceptDescendantsResponse.md",
@@ -1159,6 +1171,7 @@
1159
1171
  "models/Insurance.md",
1160
1172
  "models/InsurancePriority.md",
1161
1173
  "models/InterpretationCode.md",
1174
+ "models/IntoleranceType.md",
1162
1175
  "models/IntraocularPressure.md",
1163
1176
  "models/InviteChannel.md",
1164
1177
  "models/InviteRecord.md",
@@ -1177,15 +1190,26 @@
1177
1190
  "models/KnowledgeSearchResult.md",
1178
1191
  "models/ListActionsResponse.md",
1179
1192
  "models/ListActivityResponse.md",
1193
+ "models/ListAllergiesResponse.md",
1194
+ "models/ListConditionsResponse.md",
1180
1195
  "models/ListDependentsResponse.md",
1181
1196
  "models/ListDiagnosticTestsResponse.md",
1197
+ "models/ListDirectivesResponse.md",
1198
+ "models/ListFamilyHistoryResponse.md",
1199
+ "models/ListFunctionalStatusResponse.md",
1200
+ "models/ListImmunizationsResponse.md",
1182
1201
  "models/ListKnowledgeResponse.md",
1183
1202
  "models/ListMedicalConceptsGetResponse.md",
1184
1203
  "models/ListNotificationsResponse.md",
1204
+ "models/ListObservationsResponse.md",
1185
1205
  "models/ListPatientAppointmentsResponse.md",
1186
1206
  "models/ListPatientsResponse.md",
1187
1207
  "models/ListPolicyDocumentsResponse.md",
1208
+ "models/ListProceduresResponse.md",
1209
+ "models/ListQuestionnaireResponsesResponse.md",
1188
1210
  "models/ListSlotsResponse.md",
1211
+ "models/ListSocialHistoryResponse.md",
1212
+ "models/ListVitalsResponse.md",
1189
1213
  "models/LocationStatus.md",
1190
1214
  "models/MaritalStatus.md",
1191
1215
  "models/McpFieldagentRequest.md",
@@ -1317,6 +1341,11 @@
1317
1341
  "models/PreferredPharmacy.md",
1318
1342
  "models/PresenceRecord.md",
1319
1343
  "models/PresenceStatus.md",
1344
+ "models/Problem.md",
1345
+ "models/ProblemCategory.md",
1346
+ "models/ProblemClinicalStatus.md",
1347
+ "models/ProblemSeverity.md",
1348
+ "models/ProblemVerificationStatus.md",
1320
1349
  "models/ProviderAcceptedInsurance.md",
1321
1350
  "models/ProviderContactPoint.md",
1322
1351
  "models/ProviderEducationCredential.md",
@@ -1376,13 +1405,18 @@
1376
1405
  "models/QuestSyncCompendiumsRequest.md",
1377
1406
  "models/QuestionItemType.md",
1378
1407
  "models/QuestionnaireItemInput.md",
1408
+ "models/QuestionnaireResponse.md",
1409
+ "models/QuestionnaireResponseStatus.md",
1379
1410
  "models/Race.md",
1380
1411
  "models/RapidTest.md",
1381
1412
  "models/RapidTestResult.md",
1382
1413
  "models/RapidTestType.md",
1414
+ "models/ReactionSeverity.md",
1383
1415
  "models/RecordVitalsResponse.md",
1384
1416
  "models/RescheduleAppointmentRequest.md",
1385
1417
  "models/RespiratoryRate.md",
1418
+ "models/ResponseAnswer.md",
1419
+ "models/ResponseItem.md",
1386
1420
  "models/SalesforceAccount.md",
1387
1421
  "models/SalesforceAccountAssets.md",
1388
1422
  "models/SalesforceAddress.md",
@@ -1876,6 +1910,9 @@
1876
1910
  "models/diagnostics.ListDiagnosticsResponse.md",
1877
1911
  "models/diagnostics.ReferenceRange.md",
1878
1912
  "models/ehr.ConnectResponse.md",
1913
+ "models/ehr.ListDiagnosticsResponse.md",
1914
+ "models/ehr.ListEncountersResponse.md",
1915
+ "models/ehr.ListMedicationsResponse.md",
1879
1916
  "models/fieldagent.ConfirmResetPasswordRequest.md",
1880
1917
  "models/fieldagent.ConfirmResetPasswordResponse.md",
1881
1918
  "models/fieldagent.ConnectResponse.md",
@@ -2799,6 +2836,21 @@
2799
2836
  "operations/diagnostics.listDiagnostics.md",
2800
2837
  "operations/diagnostics.lookupTestByGs1.md",
2801
2838
  "operations/ehr.connect.md",
2839
+ "operations/ehr.getHealthRecord.md",
2840
+ "operations/ehr.listAllergies.md",
2841
+ "operations/ehr.listConditions.md",
2842
+ "operations/ehr.listDiagnostics.md",
2843
+ "operations/ehr.listDirectives.md",
2844
+ "operations/ehr.listEncounters.md",
2845
+ "operations/ehr.listFamilyHistory.md",
2846
+ "operations/ehr.listFunctionalStatus.md",
2847
+ "operations/ehr.listImmunizations.md",
2848
+ "operations/ehr.listMedications.md",
2849
+ "operations/ehr.listObservations.md",
2850
+ "operations/ehr.listProcedures.md",
2851
+ "operations/ehr.listQuestionnaireResponses.md",
2852
+ "operations/ehr.listSocialHistory.md",
2853
+ "operations/ehr.listVitals.md",
2802
2854
  "operations/fieldagent.agentPhotoUploadUrl.md",
2803
2855
  "operations/fieldagent.confirmResetPassword.md",
2804
2856
  "operations/fieldagent.connect.md",
@@ -2967,7 +3019,7 @@
2967
3019
  "operations/vitals.recordVitals.md"
2968
3020
  ],
2969
3021
  "language": "nodejs",
2970
- "modelCount": 1928,
2971
- "operationCount": 983,
3022
+ "modelCount": 1965,
3023
+ "operationCount": 998,
2972
3024
  "schemaVersion": 1
2973
3025
  }
@@ -819,6 +819,21 @@ Generated call examples use exact public surface signatures. Workflow examples r
819
819
  - [List lab observations](../operations/diagnostics.listDiagnostics.md)
820
820
  - [Look up a test kit from a GS1 barcode](../operations/diagnostics.lookupTestByGs1.md)
821
821
  - [Health check](../operations/ehr.connect.md)
822
+ - [Get a patient's consolidated health record](../operations/ehr.getHealthRecord.md)
823
+ - [List a patient's allergies](../operations/ehr.listAllergies.md)
824
+ - [List a patient's conditions](../operations/ehr.listConditions.md)
825
+ - [List a patient's diagnostic/lab observations](../operations/ehr.listDiagnostics.md)
826
+ - [List a patient's advance directives](../operations/ehr.listDirectives.md)
827
+ - [List a patient's encounters](../operations/ehr.listEncounters.md)
828
+ - [List a patient's family history](../operations/ehr.listFamilyHistory.md)
829
+ - [List a patient's functional-status observations](../operations/ehr.listFunctionalStatus.md)
830
+ - [List a patient's immunizations](../operations/ehr.listImmunizations.md)
831
+ - [List a patient's medications](../operations/ehr.listMedications.md)
832
+ - [List a patient's observations](../operations/ehr.listObservations.md)
833
+ - [List a patient's procedures](../operations/ehr.listProcedures.md)
834
+ - [List a patient's questionnaire responses](../operations/ehr.listQuestionnaireResponses.md)
835
+ - [List a patient's social history](../operations/ehr.listSocialHistory.md)
836
+ - [List a patient's vitals](../operations/ehr.listVitals.md)
822
837
  - [Get a presigned agent photo upload URL](../operations/fieldagent.agentPhotoUploadUrl.md)
823
838
  - [Complete a password reset](../operations/fieldagent.confirmResetPassword.md)
824
839
  - [Health check](../operations/fieldagent.connect.md)
package/docs/index.md CHANGED
@@ -827,6 +827,21 @@ This directory is generated from the shared structured docs data. Do not edit ge
827
827
  - [List lab observations](operations/diagnostics.listDiagnostics.md) (`diagnostics.listDiagnostics`)
828
828
  - [Look up a test kit from a GS1 barcode](operations/diagnostics.lookupTestByGs1.md) (`diagnostics.lookupTestByGs1`)
829
829
  - [Health check](operations/ehr.connect.md) (`ehr.connect`)
830
+ - [Get a patient's consolidated health record](operations/ehr.getHealthRecord.md) (`ehr.getHealthRecord`)
831
+ - [List a patient's allergies](operations/ehr.listAllergies.md) (`ehr.listAllergies`)
832
+ - [List a patient's conditions](operations/ehr.listConditions.md) (`ehr.listConditions`)
833
+ - [List a patient's diagnostic/lab observations](operations/ehr.listDiagnostics.md) (`ehr.listDiagnostics`)
834
+ - [List a patient's advance directives](operations/ehr.listDirectives.md) (`ehr.listDirectives`)
835
+ - [List a patient's encounters](operations/ehr.listEncounters.md) (`ehr.listEncounters`)
836
+ - [List a patient's family history](operations/ehr.listFamilyHistory.md) (`ehr.listFamilyHistory`)
837
+ - [List a patient's functional-status observations](operations/ehr.listFunctionalStatus.md) (`ehr.listFunctionalStatus`)
838
+ - [List a patient's immunizations](operations/ehr.listImmunizations.md) (`ehr.listImmunizations`)
839
+ - [List a patient's medications](operations/ehr.listMedications.md) (`ehr.listMedications`)
840
+ - [List a patient's observations](operations/ehr.listObservations.md) (`ehr.listObservations`)
841
+ - [List a patient's procedures](operations/ehr.listProcedures.md) (`ehr.listProcedures`)
842
+ - [List a patient's questionnaire responses](operations/ehr.listQuestionnaireResponses.md) (`ehr.listQuestionnaireResponses`)
843
+ - [List a patient's social history](operations/ehr.listSocialHistory.md) (`ehr.listSocialHistory`)
844
+ - [List a patient's vitals](operations/ehr.listVitals.md) (`ehr.listVitals`)
830
845
  - [Get a presigned agent photo upload URL](operations/fieldagent.agentPhotoUploadUrl.md) (`fieldagent.agentPhotoUploadUrl`)
831
846
  - [Complete a password reset](operations/fieldagent.confirmResetPassword.md) (`fieldagent.confirmResetPassword`)
832
847
  - [Health check](operations/fieldagent.connect.md) (`fieldagent.connect`)
@@ -0,0 +1,31 @@
1
+ # Allergy
2
+
3
+ Model ID: `Allergy`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `allergen` | `string` | Yes | | | | No | Substance name (e.g. Penicillin, Peanut, Latex) |
14
+ | `allergen_code` | [`CodedConcept`](./CodedConcept.md) | No | | | `null` | Yes | Coded allergen concept (SNOMED CT), when available. |
15
+ | `allergy_id` | `string` | No | uuid | | | No | HealthCloud allergy identifier (UUID). |
16
+ | `asserted_by` | `string|null` | No | | | `null` | Yes | Patient self-reported or provider name |
17
+ | `asserted_date` | `string|null` | No | | | `null` | Yes | Date the allergy was asserted/recorded, when known. |
18
+ | `category` | [`AllergyCategory`](./AllergyCategory.md) | Yes | | | | No | Allergy category: food, medication, environment, biologic, other, or unknown. |
19
+ | `criticality` | [`AllergyCriticality`](./AllergyCriticality.md) | No | | | `"unable-to-assess"` | No | Clinical criticality: low, high, or unable-to-assess. |
20
+ | `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR AllergyIntolerance resource id, when stored. |
21
+ | `intolerance_type` | [`IntoleranceType`](./IntoleranceType.md) | No | | | `"allergy"` | No | Whether this is an allergy or an intolerance. |
22
+ | `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the allergy, when present. |
23
+ | `onset_date` | `string|null` | No | | | `null` | Yes | Date the allergy first onset, when known. |
24
+ | `reactions` | array of [`AllergyReaction`](./AllergyReaction.md) | No | | | | No | Adverse reactions associated with the allergy. |
25
+ | `resolved_date` | `string|null` | No | | | `null` | Yes | Date the allergy was resolved, when applicable. |
26
+ | `status` | [`AllergyStatus`](./AllergyStatus.md) | No | | | `"active"` | No | Clinical status: active, inactive, resolved, or entered-in-error. |
27
+ | `verification_status` | [`AllergyVerificationStatus`](./AllergyVerificationStatus.md) | No | | | `"confirmed"` | No | Verification status: unconfirmed, presumed, confirmed, refuted, or entered-in-error. |
28
+
29
+ ## Example
30
+
31
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # AllergyCategory
2
+
3
+ Model ID: `AllergyCategory`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # AllergyCriticality
2
+
3
+ Model ID: `AllergyCriticality`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # AllergyReaction
2
+
3
+ Model ID: `AllergyReaction`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `manifestation` | `string` | Yes | | | | No | e.g. Hives, Anaphylaxis, Nausea |
14
+ | `manifestation_code` | [`CodedConcept`](./CodedConcept.md) | No | | | `null` | Yes | SNOMED-CT coded manifestation for FHIR |
15
+ | `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the reaction, when present. |
16
+ | `onset` | `string|null` | No | | | `null` | Yes | Date the reaction first occurred, when known. |
17
+ | `severity` | [`ReactionSeverity`](./ReactionSeverity.md) | No | | | `null` | Yes | Severity of the reaction: mild, moderate, severe, or life_threatening. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # AllergyStatus
2
+
3
+ Model ID: `AllergyStatus`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # AllergyVerificationStatus
2
+
3
+ Model ID: `AllergyVerificationStatus`
4
+
5
+ Maps directly to FHIR AllergyIntolerance.verificationStatus.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # CodedConcept
2
+
3
+ Model ID: `CodedConcept`
4
+
5
+ A clinical concept identified by one or more coding systems.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `code` | `string` | Yes | | | | No | Code value from the coding system (e.g. an ICD-10 or SNOMED CT code). |
14
+ | `display` | `string` | Yes | | | | No | Human-readable display text for the code. |
15
+ | `system` | `string|null` | No | | | `null` | Yes | e.g. ICD-10, SNOMED-CT, CPT, CVX, RxNorm, NDC |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # FamilyCondition
2
+
3
+ Model ID: `FamilyCondition`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `age_at_death` | `integer|null` | No | | | `null` | Yes | Age of the family member at death, when known. |
14
+ | `age_at_onset` | `integer|null` | No | | | `null` | Yes | Age of the family member at onset of the condition, when known. |
15
+ | `condition` | `string` | Yes | | | | No | Name/description of the family member's condition. |
16
+ | `icd10_code` | `string|null` | No | | | `null` | Yes | ICD-10-CM code for the condition, when coded. |
17
+ | `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the condition, when present. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,30 @@
1
+ # FamilyHistoryEntry
2
+
3
+ Model ID: `FamilyHistoryEntry`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `age_at_death` | `integer|null` | No | | | `null` | Yes | Age of the family member at death, when known. |
14
+ | `biological` | `boolean` | No | | | `true` | No | Whether the family member is a biological relative. |
15
+ | `born_date` | `string|null` | No | | | `null` | Yes | Birth date of the family member, when known. |
16
+ | `cause_of_death` | `string|null` | No | | | `null` | Yes | Cause of death of the family member, when recorded. |
17
+ | `conditions` | array of [`FamilyCondition`](./FamilyCondition.md) | No | | | | No | Conditions recorded for this family member. |
18
+ | `deceased` | `boolean|null` | No | | | `null` | Yes | Whether the family member is deceased, when known. |
19
+ | `entry_id` | `string` | No | uuid | | | No | HealthCloud family-history entry identifier (UUID). |
20
+ | `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR FamilyMemberHistory resource id, when stored. |
21
+ | `member_name` | `string|null` | No | | | `null` | Yes | Name of the family member, when known (FHIR FamilyMemberHistory.name). |
22
+ | `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the family member, when present. |
23
+ | `recorded_date` | `string|null` | No | | | `null` | Yes | Date the family-history entry was recorded, when known. |
24
+ | `relationship` | [`FamilyRelationship`](./FamilyRelationship.md) | Yes | | | | No | Relationship of the family member to the patient (e.g. mother, father, sibling). |
25
+ | `sex` | `string|null` | No | | | `null` | Yes | Sex of the family member, when known. |
26
+ | `status` | [`FamilyHistoryStatus`](./FamilyHistoryStatus.md) | No | | | `"completed"` | No | Status of the family-history entry (required in FHIR): partial, completed, entered-in-error, or health-unknown. |
27
+
28
+ ## Example
29
+
30
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # FamilyHistoryStatus
2
+
3
+ Model ID: `FamilyHistoryStatus`
4
+
5
+ Required by FHIR FamilyMemberHistory.status.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # FamilyRelationship
2
+
3
+ Model ID: `FamilyRelationship`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # HealthRecordResponse
2
+
3
+ Model ID: `GetHealthRecordResponse`
4
+
5
+ Response for GET /patients/{patient_id}/record. Consolidated raw-FHIR health-record envelope.
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 | Echoes the {patient_id} path parameter. |
14
+ | `resources` | `object` | Yes | | | | No | Resources grouped by type (conditions, allergies, medications, procedures, immunizations, family_history, directives, encounters, vitals, questionnaire_responses, diagnostics). Core record collections are raw FHIR resources; encounters, questionnaire responses, diagnostics, and the vitals list are serialized service results. A resource type with a failed downstream fetch appears as an empty list, not an error. |
15
+ | `totals` | `object` | Yes | | | | No | Count of records per resource type key in `resources`. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # IntoleranceType
2
+
3
+ Model ID: `IntoleranceType`
4
+
5
+ FHIR AllergyIntolerance.type.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # ListAllergiesResponse
2
+
3
+ Model ID: `ListAllergiesResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `allergies` | array of [`Allergy`](./Allergy.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
+ # ListConditionsResponse
2
+
3
+ Model ID: `ListConditionsResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `conditions` | array of [`Problem`](./Problem.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
+ # ListDirectivesResponse
2
+
3
+ Model ID: `ListDirectivesResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `directives` | `array` | Yes | | | | No | |
14
+ | `patient_id` | `string` | Yes | | | | No | |
15
+ | `total` | `integer` | Yes | | | | No | |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.