@healthcloudai/hc-sdk 2.6.2 → 2.8.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 (112) hide show
  1. package/dist/index.cjs +173 -0
  2. package/dist/index.d.cts +5950 -5764
  3. package/dist/index.d.ts +5950 -5764
  4. package/dist/index.js +173 -0
  5. package/docs/clients/EhrClient.md +15 -0
  6. package/docs/clients/PatientClient.md +3 -0
  7. package/docs/docs-manifest.json +62 -5
  8. package/docs/examples/index.md +18 -0
  9. package/docs/index.md +18 -0
  10. package/docs/models/AddInsuranceRequest.md +1 -0
  11. package/docs/models/AddInsuranceResponse.md +2 -0
  12. package/docs/models/Allergy.md +31 -0
  13. package/docs/models/AllergyCategory.md +15 -0
  14. package/docs/models/AllergyCriticality.md +15 -0
  15. package/docs/models/AllergyReaction.md +21 -0
  16. package/docs/models/AllergyStatus.md +15 -0
  17. package/docs/models/AllergyVerificationStatus.md +15 -0
  18. package/docs/models/Appointment.md +1 -0
  19. package/docs/models/AthenaAppointment.md +1 -0
  20. package/docs/models/BookAppointmentRequest.md +1 -0
  21. package/docs/models/CheckEncounterRequest.md +17 -0
  22. package/docs/models/CheckInEncounterRequest.md +17 -0
  23. package/docs/models/CodedConcept.md +19 -0
  24. package/docs/models/FamilyCondition.md +21 -0
  25. package/docs/models/FamilyHistoryEntry.md +30 -0
  26. package/docs/models/FamilyHistoryStatus.md +15 -0
  27. package/docs/models/FamilyRelationship.md +15 -0
  28. package/docs/models/GS1LookupResponse.md +3 -2
  29. package/docs/models/GetEncounterResponse.md +3 -0
  30. package/docs/models/GetHealthRecordResponse.md +19 -0
  31. package/docs/models/GetLatestEncounterResponse.md +17 -0
  32. package/docs/models/GetPatientResponse.md +2 -0
  33. package/docs/models/GetScanUploadUrlRequest.md +3 -2
  34. package/docs/models/GetTestResultResponse.md +20 -0
  35. package/docs/models/IntoleranceType.md +15 -0
  36. package/docs/models/ListAllergiesResponse.md +19 -0
  37. package/docs/models/ListConditionsResponse.md +19 -0
  38. package/docs/models/ListDirectivesResponse.md +19 -0
  39. package/docs/models/ListFamilyHistoryResponse.md +19 -0
  40. package/docs/models/ListFunctionalStatusResponse.md +19 -0
  41. package/docs/models/ListImmunizationsResponse.md +19 -0
  42. package/docs/models/ListObservationsResponse.md +19 -0
  43. package/docs/models/ListProceduresResponse.md +19 -0
  44. package/docs/models/ListQuestionnaireResponsesResponse.md +19 -0
  45. package/docs/models/ListSocialHistoryResponse.md +19 -0
  46. package/docs/models/ListVitalsResponse.md +19 -0
  47. package/docs/models/PatientDemographics.md +2 -0
  48. package/docs/models/Problem.md +37 -0
  49. package/docs/models/ProblemCategory.md +15 -0
  50. package/docs/models/ProblemClinicalStatus.md +15 -0
  51. package/docs/models/ProblemSeverity.md +15 -0
  52. package/docs/models/ProblemVerificationStatus.md +15 -0
  53. package/docs/models/QuestionnaireResponse.md +27 -0
  54. package/docs/models/QuestionnaireResponseStatus.md +15 -0
  55. package/docs/models/ReactionSeverity.md +15 -0
  56. package/docs/models/ResponseAnswer.md +27 -0
  57. package/docs/models/ResponseItem.md +21 -0
  58. package/docs/models/ScanUploadResponse.md +4 -4
  59. package/docs/models/Slot.md +1 -0
  60. package/docs/models/ehr.ListDiagnosticsResponse.md +19 -0
  61. package/docs/models/ehr.ListEncountersResponse.md +19 -0
  62. package/docs/models/ehr.ListMedicationsResponse.md +19 -0
  63. package/docs/models/fieldagent.Encounter.md +3 -0
  64. package/docs/models/index.md +41 -2
  65. package/docs/models/patient.Encounter.md +3 -0
  66. package/docs/operations/appointments.book.md +18 -15
  67. package/docs/operations/appointments.cancel.md +12 -11
  68. package/docs/operations/appointments.createSlot.md +44 -9
  69. package/docs/operations/appointments.listPatientAppointments.md +13 -12
  70. package/docs/operations/appointments.listSlots.md +9 -8
  71. package/docs/operations/appointments.reschedule.md +11 -10
  72. package/docs/operations/connectors.athenaBookAppointment.md +1 -0
  73. package/docs/operations/connectors.athenaCreateInsurancePackage.md +1 -1
  74. package/docs/operations/connectors.athenaGetAppointmentDetails.md +1 -0
  75. package/docs/operations/connectors.athenaGetBookedAppointments.md +1 -0
  76. package/docs/operations/connectors.athenaGetEncounter.md +1 -0
  77. package/docs/operations/connectors.athenaListAppointments.md +1 -0
  78. package/docs/operations/connectors.athenaListPatientAppointments.md +1 -0
  79. package/docs/operations/diagnostics.getScanUploadUrl.md +7 -5
  80. package/docs/operations/diagnostics.getTestResult.md +5 -23
  81. package/docs/operations/diagnostics.lookupTestByGs1.md +12 -6
  82. package/docs/operations/ehr.getHealthRecord.md +122 -0
  83. package/docs/operations/ehr.listAllergies.md +156 -0
  84. package/docs/operations/ehr.listConditions.md +152 -0
  85. package/docs/operations/ehr.listDiagnostics.md +147 -0
  86. package/docs/operations/ehr.listDirectives.md +122 -0
  87. package/docs/operations/ehr.listEncounters.md +178 -0
  88. package/docs/operations/ehr.listFamilyHistory.md +147 -0
  89. package/docs/operations/ehr.listFunctionalStatus.md +122 -0
  90. package/docs/operations/ehr.listImmunizations.md +122 -0
  91. package/docs/operations/ehr.listMedications.md +163 -0
  92. package/docs/operations/ehr.listObservations.md +126 -0
  93. package/docs/operations/ehr.listProcedures.md +122 -0
  94. package/docs/operations/ehr.listQuestionnaireResponses.md +162 -0
  95. package/docs/operations/ehr.listSocialHistory.md +122 -0
  96. package/docs/operations/ehr.listVitals.md +132 -0
  97. package/docs/operations/fieldagent.listEncounters.md +42 -39
  98. package/docs/operations/fieldagent.listPatients.md +60 -95
  99. package/docs/operations/patient.addInsurance.md +14 -10
  100. package/docs/operations/patient.checkEncounter.md +110 -0
  101. package/docs/operations/patient.checkInEncounter.md +173 -0
  102. package/docs/operations/patient.createEncounter.md +40 -37
  103. package/docs/operations/patient.getCheckinCheckin.md +41 -38
  104. package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +43 -40
  105. package/docs/operations/patient.getEncounter.md +40 -37
  106. package/docs/operations/patient.getLatestEncounter.md +162 -0
  107. package/docs/operations/patient.getPatient.md +57 -92
  108. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +97 -129
  109. package/docs/operations/patient.listEncounters.md +41 -38
  110. package/package.json +1 -1
  111. package/docs/models/PanelResult.md +0 -24
  112. package/docs/models/SingleTestResultResponse.md +0 -28
@@ -11,6 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `appointment_id` | `string` | Yes | | | | No | Stable appointment identifier used to cancel or reschedule. |
14
+ | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id this appointment is linked to, when booked via Athena. |
14
15
  | `created_at` | `string|null` | No | date-time | | | Yes | Creation timestamp in ISO 8601 date-time format, when available. |
15
16
  | `end` | `string|null` | No | date-time | | | Yes | Appointment end in ISO 8601 date-time format, when scheduled. |
16
17
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID associated with the appointment. |
@@ -17,6 +17,7 @@ Type: `object`
17
17
  | `date` | `string|null` | No | | | `null` | Yes | |
18
18
  | `department_id` | `string|null` | No | | | `null` | Yes | |
19
19
  | `duration` | `unknown|null` | No | | | `null` | Yes | |
20
+ | `encounter_id` | `string|null` | No | | | `null` | Yes | |
20
21
  | `last_modified` | `string|null` | No | | | `null` | Yes | |
21
22
  | `patient_appointment_type_name` | `string|null` | No | | | `null` | Yes | |
22
23
  | `patient_id` | `string|null` | No | | | `null` | Yes | |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id of the slot being booked, taken from the `athena_appointment_id` of the chosen `appointments.listSlots` result. Required on an Athena-integrated tenant, where the booking is made in Athena against this id (the request is rejected without it); ignored on a FHIR-only tenant, which books against `slot_id`. |
13
14
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID for whom the appointment is booked. |
14
15
  | `slot_id` | `string` | Yes | | | | No | FHIR Slot resource ID returned by `appointments.listSlots`. |
15
16
 
@@ -0,0 +1,17 @@
1
+ # CheckEncounterRequest
2
+
3
+ Model ID: `CheckEncounterRequest`
4
+
5
+ Request body for POST /encounters/check.
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 | FHIR Patient resource id. |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.
@@ -0,0 +1,17 @@
1
+ # CheckInEncounterRequest
2
+
3
+ Model ID: `CheckInEncounterRequest`
4
+
5
+ Request body for POST /encounters/{encounter_id}/check-in.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `appointment_id` | `string` | Yes | | | | No | EHR (e.g. Athena) appointment id to check the patient in against. |
14
+
15
+ ## Example
16
+
17
+ 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.
@@ -10,9 +10,10 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `gs1_parsed` | [`GS1ParsedData`](./GS1ParsedData.md) | Yes | | | | No | Structured components parsed from the raw_gs1 barcode string. |
14
- | `product` | `object|null` | No | | | | Yes | Opaque source-catalog product map returned verbatim when the parsed GTIN is recognized; null if no match was found. Its PascalCase/source-specific fields are not the TestProfile schema. |
13
+ | `gs1_parsed` | [`GS1ParsedData`](./GS1ParsedData.md) | Yes | | | | No | Structured components parsed from the raw GS1 barcode. |
14
+ | `product` | `object|null` | No | | | | Yes | Opaque source-catalog product map returned when the parsed GTIN is recognized. |
15
15
  | `raw_gs1` | `string` | Yes | | | | No | The raw GS1 barcode string that was looked up. |
16
+ | `scan_upload` | [`ScanUploadResponse`](./ScanUploadResponse.md) | No | | | | Yes | SAFE CDX upload information generated for this patient/test. Present when the product supports SAFE CDX image processing. |
16
17
 
17
18
  ## Example
18
19
 
@@ -11,6 +11,8 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `appointment_id` | `string|null` | No | | | | Yes | FHIR Appointment id this encounter fulfills, when linked. |
14
+ | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id this encounter was checked in from, when checked in via Athena. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
15
+ | `athena_encounter_id` | `string|null` | No | | | | Yes | Athena Health encounter id this encounter is linked to, when checked in via Athena. |
14
16
  | `created_by` | `string` | No | | | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
15
17
  | `created_date` | `string|null` | No | | | | Yes | UTC datetime when the encounter was created |
16
18
  | `diagnoses` | array of [`patient.EncounterDiagnosis`](./patient.EncounterDiagnosis.md) | No | | | | No | Diagnoses recorded for this encounter, ranked by rank. |
@@ -20,6 +22,7 @@ Type: `object`
20
22
  | `hospitalization` | [`patient.EncounterHospitalization`](./patient.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
21
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
22
24
  | `locations` | array of [`patient.EncounterLocation`](./patient.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
23
26
  | `participants` | array of [`patient.EncounterParticipant`](./patient.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
24
27
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient id who is the subject of the encounter. |
25
28
  | `period_end` | `string|null` | No | | | | Yes | When the encounter ended, when recorded. |
@@ -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,17 @@
1
+ # GetLatestEncounterResponse
2
+
3
+ Model ID: `GetLatestEncounterResponse`
4
+
5
+ Response for GET /patients/{patient_id}/encounters/latest.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `encounter` | [`patient.Encounter`](./patient.Encounter.md) | No | | | | Yes | The patient's latest open encounter, or null if none is currently open. |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.
@@ -17,6 +17,8 @@ Type: `object`
17
17
  |---|---|---:|---|---|---|---:|---|
18
18
  | `active` | `boolean` | No | | | `true` | No | Whether the patient record is active. |
19
19
  | `addresses` | array of [`Address`](./Address.md) | No | | | | No | Patient's addresses (home, work, mailing, etc.). |
20
+ | `athena_patient_id` | `string|null` | No | | | | Yes | Athena Health patient identifier when this patient is linked to Athena |
21
+ | `athena_practice_id` | `string|null` | No | | | | Yes | Athena Health practice identifier that scopes athena_patient_id |
20
22
  | `attributes` | `object` | No | | | | No | Arbitrary JSON-compatible metadata for this patient |
21
23
  | `communications` | array of [`Communication`](./Communication.md) | No | | | | No | Languages the patient communicates in, with preferred flag. |
22
24
  | `created_by` | `string` | No | | | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
@@ -11,8 +11,9 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `content_type` | `string` | No | | | `"image/jpeg"` | No | MIME type of the scan image. Defaults to image/jpeg. |
14
- | `filename` | `string` | No | | | `"scan.jpg"` | No | Filename to use for the uploaded scan. Defaults to scan.jpg. |
15
- | `test_id` | `string` | Yes | uuid | | | No | Domain UUID of the rapid test this scan belongs to. |
14
+ | `filename` | `string` | No | | | `"scan.jpg"` | No | Filename of the uploaded scan. Defaults to scan.jpg. |
15
+ | `gtin` | `string|null` | No | | | | Yes | GTIN of the test kit. Optional for the compatibility upload endpoint; the combined GS1 lookup flow supplies it automatically. |
16
+ | `test_id` | `string` | Yes | uuid | | | No | Health Cloud correlation UUID for the diagnostic scan. |
16
17
 
17
18
  ## Example
18
19
 
@@ -0,0 +1,20 @@
1
+ # GetTestResultResponse
2
+
3
+ Model ID: `GetTestResultResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `code` | `integer` | Yes | | | | No | |
14
+ | `data` | `object` | Yes | | | | No | |
15
+ | `message` | `string` | Yes | | | | No | |
16
+ | `success` | `boolean` | Yes | | | | No | |
17
+
18
+ ## Example
19
+
20
+ 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.
@@ -0,0 +1,19 @@
1
+ # ListFamilyHistoryResponse
2
+
3
+ Model ID: `ListFamilyHistoryResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `family_history` | array of [`FamilyHistoryEntry`](./FamilyHistoryEntry.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
+ # FunctionalStatusListResponse
2
+
3
+ Model ID: `ListFunctionalStatusResponse`
4
+
5
+ Response for GET /patients/{patient_id}/functional-status. Contains raw FHIR Observation resources.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `functional_status` | `array` | Yes | | | | No | Raw FHIR Observation resources with category survey or functional-status. |
14
+ | `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
15
+ | `total` | `integer` | Yes | | | | No | Number of observations in this response. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # ListImmunizationsResponse
2
+
3
+ Model ID: `ListImmunizationsResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `immunizations` | `array` | 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
+ # ObservationListResponse
2
+
3
+ Model ID: `ListObservationsResponse`
4
+
5
+ Response for GET /patients/{patient_id}/observations. Contains raw FHIR Observation resources.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `observations` | `array` | Yes | | | | No | Raw FHIR Observation resources matching the optional ?category= filter. |
14
+ | `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
15
+ | `total` | `integer` | Yes | | | | No | Number of observations in this response. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # ListProceduresResponse
2
+
3
+ Model ID: `ListProceduresResponse`
4
+
5
+ No description.
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 | |
14
+ | `procedures` | `array` | Yes | | | | No | |
15
+ | `total` | `integer` | Yes | | | | No | |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # ListQuestionnaireResponsesResponse
2
+
3
+ Model ID: `ListQuestionnaireResponsesResponse`
4
+
5
+ No description.
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 | |
14
+ | `questionnaire_responses` | array of [`QuestionnaireResponse`](./QuestionnaireResponse.md) | Yes | | | | No | |
15
+ | `total` | `integer` | Yes | | | | No | |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # ListSocialHistoryResponse
2
+
3
+ Model ID: `ListSocialHistoryResponse`
4
+
5
+ No description.
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 | |
14
+ | `social_history` | `array` | Yes | | | | No | |
15
+ | `total` | `integer` | Yes | | | | No | |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # ListVitalsResponse
2
+
3
+ Model ID: `ListVitalsResponse`
4
+
5
+ No description.
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 | |
14
+ | `total` | `integer` | Yes | | | | No | |
15
+ | `vitals` | `array` | Yes | | | | No | |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -12,6 +12,8 @@ Type: `object`
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `active` | `boolean` | No | | | `true` | No | Whether the patient record is active. |
14
14
  | `addresses` | array of [`Address`](./Address.md) | No | | | | No | Patient's addresses (home, work, mailing, etc.). |
15
+ | `athena_patient_id` | `string|null` | No | | | | Yes | Athena Health patient identifier when this patient is linked to Athena |
16
+ | `athena_practice_id` | `string|null` | No | | | | Yes | Athena Health practice identifier that scopes athena_patient_id |
15
17
  | `attributes` | `object` | No | | | | No | Arbitrary JSON-compatible metadata for this patient |
16
18
  | `communications` | array of [`Communication`](./Communication.md) | No | | | | No | Languages the patient communicates in, with preferred flag. |
17
19
  | `created_by` | `string` | No | | | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
@@ -0,0 +1,37 @@
1
+ # Problem
2
+
3
+ Model ID: `Problem`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `asserted_date` | `string|null` | No | | | `null` | Yes | Date the problem was asserted, when recorded. |
14
+ | `asserter_name` | `string|null` | No | | | `null` | Yes | Name of the person who asserted the problem, when recorded. |
15
+ | `asserter_type` | `string|null` | No | | | `null` | Yes | Type of asserter (e.g. patient, practitioner), when recorded. |
16
+ | `body_site` | `string|null` | No | | | `null` | Yes | Body site affected, when specified. |
17
+ | `categories` | array of [`ProblemCategory`](./ProblemCategory.md) | No | | | | No | Condition categories (e.g. problem-list-item, encounter-diagnosis). |
18
+ | `clinical_status` | [`ProblemClinicalStatus`](./ProblemClinicalStatus.md) | No | | | `"active"` | No | Clinical status: active, recurrence, relapse, inactive, remission, or resolved. |
19
+ | `description` | `string` | Yes | | | | No | Human-readable description of the problem/condition. |
20
+ | `encounter_id` | `string|null` | No | | | `null` | Yes | FHIR Encounter id during which the problem was recorded, when linked. |
21
+ | `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR Condition resource id, when stored. |
22
+ | `icd10_code` | `string|null` | No | | | `null` | Yes | ICD-10-CM code for the condition, when coded. |
23
+ | `laterality` | `string|null` | No | | | `null` | Yes | Left, Right, Bilateral |
24
+ | `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the problem, when present. |
25
+ | `onset_age` | `integer|null` | No | | | `null` | Yes | Age at onset in years |
26
+ | `onset_date` | `string|null` | No | | | `null` | Yes | Date the problem first onset, when known. |
27
+ | `problem_id` | `string` | No | uuid | | | No | HealthCloud problem/condition identifier (UUID). |
28
+ | `recorded_date` | `string|null` | No | | | `null` | Yes | Datetime the problem was recorded, when known. |
29
+ | `recorder_name` | `string|null` | No | | | `null` | Yes | Name of the person who recorded the problem, when known. |
30
+ | `resolved_date` | `string|null` | No | | | `null` | Yes | Date the problem was resolved/abated, when applicable. |
31
+ | `severity` | [`ProblemSeverity`](./ProblemSeverity.md) | No | | | `null` | Yes | Severity: mild, moderate, or severe, when assessed. |
32
+ | `snomed_code` | `string|null` | No | | | `null` | Yes | SNOMED CT code for the condition, when coded. |
33
+ | `verification_status` | [`ProblemVerificationStatus`](./ProblemVerificationStatus.md) | No | | | `"confirmed"` | No | Verification status: unconfirmed, provisional, differential, confirmed, refuted, or entered-in-error. |
34
+
35
+ ## Example
36
+
37
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # ProblemCategory
2
+
3
+ Model ID: `ProblemCategory`
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
+ # ProblemClinicalStatus
2
+
3
+ Model ID: `ProblemClinicalStatus`
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
+ # ProblemSeverity
2
+
3
+ Model ID: `ProblemSeverity`
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
+ # ProblemVerificationStatus
2
+
3
+ Model ID: `ProblemVerificationStatus`
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.