@healthcloudai/hc-sdk 2.6.1 → 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 (129) hide show
  1. package/dist/index.cjs +103 -0
  2. package/dist/index.d.cts +5837 -5797
  3. package/dist/index.d.ts +5837 -5797
  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/InitHealthRecordImportResponse.md +2 -0
  22. package/docs/models/IntoleranceType.md +15 -0
  23. package/docs/models/ListAllergiesResponse.md +19 -0
  24. package/docs/models/ListConditionsResponse.md +19 -0
  25. package/docs/models/ListDirectivesResponse.md +19 -0
  26. package/docs/models/ListFamilyHistoryResponse.md +19 -0
  27. package/docs/models/ListFunctionalStatusResponse.md +19 -0
  28. package/docs/models/ListImmunizationsResponse.md +19 -0
  29. package/docs/models/ListObservationsResponse.md +19 -0
  30. package/docs/models/ListProceduresResponse.md +19 -0
  31. package/docs/models/ListQuestionnaireResponsesResponse.md +19 -0
  32. package/docs/models/ListSocialHistoryResponse.md +19 -0
  33. package/docs/models/ListVitalsResponse.md +19 -0
  34. package/docs/models/Problem.md +37 -0
  35. package/docs/models/ProblemCategory.md +15 -0
  36. package/docs/models/ProblemClinicalStatus.md +15 -0
  37. package/docs/models/ProblemSeverity.md +15 -0
  38. package/docs/models/ProblemVerificationStatus.md +15 -0
  39. package/docs/models/QuestionnaireResponse.md +27 -0
  40. package/docs/models/QuestionnaireResponseStatus.md +15 -0
  41. package/docs/models/ReactionSeverity.md +15 -0
  42. package/docs/models/ResponseAnswer.md +27 -0
  43. package/docs/models/ResponseItem.md +21 -0
  44. package/docs/models/ehr.ListDiagnosticsResponse.md +19 -0
  45. package/docs/models/ehr.ListEncountersResponse.md +19 -0
  46. package/docs/models/ehr.ListMedicationsResponse.md +19 -0
  47. package/docs/models/fieldagent.ResetPasswordRequest.md +1 -1
  48. package/docs/models/index.md +37 -0
  49. package/docs/models/person.ResetPasswordRequest.md +1 -1
  50. package/docs/models/provider.ResetPasswordRequest.md +1 -1
  51. package/docs/operations/diagnostics.getTestResult.md +1 -1
  52. package/docs/operations/diagnostics.lookupTestByGs1.md +1 -1
  53. package/docs/operations/ehr.getHealthRecord.md +122 -0
  54. package/docs/operations/ehr.listAllergies.md +156 -0
  55. package/docs/operations/ehr.listConditions.md +152 -0
  56. package/docs/operations/ehr.listDiagnostics.md +147 -0
  57. package/docs/operations/ehr.listDirectives.md +122 -0
  58. package/docs/operations/ehr.listEncounters.md +178 -0
  59. package/docs/operations/ehr.listFamilyHistory.md +147 -0
  60. package/docs/operations/ehr.listFunctionalStatus.md +122 -0
  61. package/docs/operations/ehr.listImmunizations.md +122 -0
  62. package/docs/operations/ehr.listMedications.md +163 -0
  63. package/docs/operations/ehr.listObservations.md +126 -0
  64. package/docs/operations/ehr.listProcedures.md +122 -0
  65. package/docs/operations/ehr.listQuestionnaireResponses.md +162 -0
  66. package/docs/operations/ehr.listSocialHistory.md +122 -0
  67. package/docs/operations/ehr.listVitals.md +132 -0
  68. package/docs/operations/fieldagent.resetPassword.md +1 -1
  69. package/docs/operations/patient.initHealthRecordImport.md +3 -1
  70. package/docs/operations/patient.resetPassword.md +1 -1
  71. package/docs/operations/person.resetPassword.md +1 -1
  72. package/docs/operations/provider.resetPassword.md +1 -1
  73. package/package.json +1 -1
  74. /package/docs/models/{GoogleAiEmbedRequest.md → GoogleAIEmbedRequest.md} +0 -0
  75. /package/docs/models/{GoogleAiGenerateRequest.md → GoogleAIGenerateRequest.md} +0 -0
  76. /package/docs/models/{GoogleAiInvokeA1cVisionCaptureRequest.md → GoogleAIInvokeA1cVisionCaptureRequest.md} +0 -0
  77. /package/docs/models/{OpenaiBuildResponseCreatePayloadRequest.md → OpenAIBuildResponseCreatePayloadRequest.md} +0 -0
  78. /package/docs/models/{OpenaiChatJsonRequest.md → OpenAIChatJsonRequest.md} +0 -0
  79. /package/docs/models/{OpenaiChatRequest.md → OpenAIChatRequest.md} +0 -0
  80. /package/docs/models/{OpenaiCreateAssistantRequest.md → OpenAICreateAssistantRequest.md} +0 -0
  81. /package/docs/models/{OpenaiDeleteAssistantRequest.md → OpenAIDeleteAssistantRequest.md} +0 -0
  82. /package/docs/models/{OpenaiEmbedRequest.md → OpenAIEmbedRequest.md} +0 -0
  83. /package/docs/models/{OpenaiGetAssistantRequest.md → OpenAIGetAssistantRequest.md} +0 -0
  84. /package/docs/models/{OpenaiModerateRequest.md → OpenAIModerateRequest.md} +0 -0
  85. /package/docs/models/{OpenaiUpdateAssistantRequest.md → OpenAIUpdateAssistantRequest.md} +0 -0
  86. /package/docs/models/{SendgridListTemplatesRequest.md → SendGridListTemplatesRequest.md} +0 -0
  87. /package/docs/models/{SteadymdAddAllergyIntoleranceRequest.md → SteadyMDAddAllergyIntoleranceRequest.md} +0 -0
  88. /package/docs/models/{SteadymdClaimIdentityVerificationRequest.md → SteadyMDClaimIdentityVerificationRequest.md} +0 -0
  89. /package/docs/models/{SteadymdCreateConsultIssueRequest.md → SteadyMDCreateConsultIssueRequest.md} +0 -0
  90. /package/docs/models/{SteadymdCreateConsultRequest.md → SteadyMDCreateConsultRequest.md} +0 -0
  91. /package/docs/models/{SteadymdCreateEpisodeLabRequisitionRequest.md → SteadyMDCreateEpisodeLabRequisitionRequest.md} +0 -0
  92. /package/docs/models/{SteadymdCreateEpisodeRequest.md → SteadyMDCreateEpisodeRequest.md} +0 -0
  93. /package/docs/models/{SteadymdCreateIntakeRequest.md → SteadyMDCreateIntakeRequest.md} +0 -0
  94. /package/docs/models/{SteadymdCreateLabOrderRequest.md → SteadyMDCreateLabOrderRequest.md} +0 -0
  95. /package/docs/models/{SteadymdCreateLabOrderResultRequest.md → SteadyMDCreateLabOrderResultRequest.md} +0 -0
  96. /package/docs/models/{SteadymdCreateMessageRequest.md → SteadyMDCreateMessageRequest.md} +0 -0
  97. /package/docs/models/{SteadymdCreatePatientRequest.md → SteadyMDCreatePatientRequest.md} +0 -0
  98. /package/docs/models/{SteadymdGetClinicianRequest.md → SteadyMDGetClinicianRequest.md} +0 -0
  99. /package/docs/models/{SteadymdGetConsultAvailabilityRequest.md → SteadyMDGetConsultAvailabilityRequest.md} +0 -0
  100. /package/docs/models/{SteadymdGetConsultPatientUiRequest.md → SteadyMDGetConsultPatientUiRequest.md} +0 -0
  101. /package/docs/models/{SteadymdGetConsultRequest.md → SteadyMDGetConsultRequest.md} +0 -0
  102. /package/docs/models/{SteadymdGetEpisodeLabRequisitionRequest.md → SteadyMDGetEpisodeLabRequisitionRequest.md} +0 -0
  103. /package/docs/models/{SteadymdGetEpisodeRequest.md → SteadyMDGetEpisodeRequest.md} +0 -0
  104. /package/docs/models/{SteadymdGetEpisodeSignedDocumentsRequest.md → SteadyMDGetEpisodeSignedDocumentsRequest.md} +0 -0
  105. /package/docs/models/{SteadymdGetIntakeRequest.md → SteadyMDGetIntakeRequest.md} +0 -0
  106. /package/docs/models/{SteadymdGetLabOrderPdfRequest.md → SteadyMDGetLabOrderPdfRequest.md} +0 -0
  107. /package/docs/models/{SteadymdGetLabOrderRequest.md → SteadyMDGetLabOrderRequest.md} +0 -0
  108. /package/docs/models/{SteadymdGetLabOrderResultRequest.md → SteadyMDGetLabOrderResultRequest.md} +0 -0
  109. /package/docs/models/{SteadymdGetLabResultPdfRequest.md → SteadyMDGetLabResultPdfRequest.md} +0 -0
  110. /package/docs/models/{SteadymdGetMessageRequest.md → SteadyMDGetMessageRequest.md} +0 -0
  111. /package/docs/models/{SteadymdGetPatientRequest.md → SteadyMDGetPatientRequest.md} +0 -0
  112. /package/docs/models/{SteadymdGetProgramAppointmentsRequest.md → SteadyMDGetProgramAppointmentsRequest.md} +0 -0
  113. /package/docs/models/{SteadymdGetProgramConsultOptionsRequest.md → SteadyMDGetProgramConsultOptionsRequest.md} +0 -0
  114. /package/docs/models/{SteadymdGetProgramLabsRequest.md → SteadyMDGetProgramLabsRequest.md} +0 -0
  115. /package/docs/models/{SteadymdGetProgramRequest.md → SteadyMDGetProgramRequest.md} +0 -0
  116. /package/docs/models/{SteadymdListConsultsRequest.md → SteadyMDListConsultsRequest.md} +0 -0
  117. /package/docs/models/{SteadymdListIntakesRequest.md → SteadyMDListIntakesRequest.md} +0 -0
  118. /package/docs/models/{SteadymdListLabOrderResultsRequest.md → SteadyMDListLabOrderResultsRequest.md} +0 -0
  119. /package/docs/models/{SteadymdListLabOrdersRequest.md → SteadyMDListLabOrdersRequest.md} +0 -0
  120. /package/docs/models/{SteadymdListMessagesRequest.md → SteadyMDListMessagesRequest.md} +0 -0
  121. /package/docs/models/{SteadymdListPharmaciesRequest.md → SteadyMDListPharmaciesRequest.md} +0 -0
  122. /package/docs/models/{SteadymdListProgramCliniciansRequest.md → SteadyMDListProgramCliniciansRequest.md} +0 -0
  123. /package/docs/models/{SteadymdListProgramsRequest.md → SteadyMDListProgramsRequest.md} +0 -0
  124. /package/docs/models/{SteadymdPatchEpisodeRequest.md → SteadyMDPatchEpisodeRequest.md} +0 -0
  125. /package/docs/models/{SteadymdScheduleConsultAppointmentRequest.md → SteadyMDScheduleConsultAppointmentRequest.md} +0 -0
  126. /package/docs/models/{SteadymdSendConsultMessageRequest.md → SteadyMDSendConsultMessageRequest.md} +0 -0
  127. /package/docs/models/{SteadymdUpdateConsultStatusRequest.md → SteadyMDUpdateConsultStatusRequest.md} +0 -0
  128. /package/docs/models/{SteadymdUpdateEpisodeRequest.md → SteadyMDUpdateEpisodeRequest.md} +0 -0
  129. /package/docs/models/{SteadymdUpdateIntakeRequest.md → SteadyMDUpdateIntakeRequest.md} +0 -0
@@ -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.
@@ -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.
@@ -0,0 +1,27 @@
1
+ # QuestionnaireResponse
2
+
3
+ Model ID: `QuestionnaireResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `authored` | `string|null` | No | | | `null` | Yes | ISO 8601 dateTime |
14
+ | `authored_by_name` | `string|null` | No | | | `null` | Yes | Display name of the author, when known. |
15
+ | `authored_by_patient` | `boolean` | No | | | `true` | No | Whether the response was authored by the patient (true) or a practitioner (false). |
16
+ | `encounter_id` | `string|null` | No | | | `null` | Yes | FHIR Encounter id during which the response was collected, when linked. |
17
+ | `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR QuestionnaireResponse resource id, when stored. |
18
+ | `items` | array of [`ResponseItem`](./ResponseItem.md) | No | | | | No | Response items (answers), one per Questionnaire item linkId. |
19
+ | `patient_fhir_id` | `string|null` | No | | | `null` | Yes | FHIR Patient id who is the subject of the response, when linked. |
20
+ | `questionnaire_fhir_id` | `string|null` | No | | | `null` | Yes | FHIR Questionnaire id this response answers, when linked. |
21
+ | `questionnaire_url` | `string|null` | No | | | `null` | Yes | Canonical URL of the Questionnaire |
22
+ | `response_id` | `string` | No | uuid | | | No | HealthCloud questionnaire-response identifier (UUID). |
23
+ | `status` | [`QuestionnaireResponseStatus`](./QuestionnaireResponseStatus.md) | No | | | `"completed"` | No | Response status: in-progress, completed, amended, entered-in-error, or stopped. |
24
+
25
+ ## Example
26
+
27
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # QuestionnaireResponseStatus
2
+
3
+ Model ID: `QuestionnaireResponseStatus`
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
+ # ReactionSeverity
2
+
3
+ Model ID: `ReactionSeverity`
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,27 @@
1
+ # ResponseAnswer
2
+
3
+ Model ID: `ResponseAnswer`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `sub_items` | array of [`ResponseItem`](./ResponseItem.md) | No | | | | No | Nested sub-items under this answer, for grouped questions. |
14
+ | `value_boolean` | `boolean|null` | No | | | `null` | Yes | Boolean answer value, when the question type is boolean. |
15
+ | `value_coding` | `object|null` | No | | | `null` | Yes | Coded answer value (system/code/display), when the question type is choice or open-choice. |
16
+ | `value_date` | `string|null` | No | | | `null` | Yes | Date answer value (ISO date), when the question type is date. |
17
+ | `value_date_time` | `string|null` | No | | | `null` | Yes | DateTime answer value (ISO dateTime), when the question type is dateTime. |
18
+ | `value_decimal` | `number|null` | No | | | `null` | Yes | Decimal answer value, when the question type is decimal. |
19
+ | `value_integer` | `integer|null` | No | | | `null` | Yes | Integer answer value, when the question type is integer. |
20
+ | `value_quantity` | `object|null` | No | | | `null` | Yes | Quantity answer value (value/unit/system), when the question type is quantity. |
21
+ | `value_string` | `string|null` | No | | | `null` | Yes | String answer value, when the question type is string. |
22
+ | `value_time` | `string|null` | No | | | `null` | Yes | Time answer value, when the question type is time. |
23
+ | `value_uri` | `string|null` | No | | | `null` | Yes | URI answer value, when the question type is uri. |
24
+
25
+ ## Example
26
+
27
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # ResponseItem
2
+
3
+ Model ID: `ResponseItem`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `answers` | array of [`ResponseAnswer`](./ResponseAnswer.md) | No | | | | No | Answers given for this item. |
14
+ | `definition` | `string|null` | No | | | `null` | Yes | Canonical URI of the element this item collects, when defined. |
15
+ | `link_id` | `string` | Yes | | | | No | Stable linkId matching the corresponding Questionnaire.item.linkId. |
16
+ | `sub_items` | array of [`ResponseItem`](./ResponseItem.md) | No | | | | No | Nested sub-items, for grouped questions. |
17
+ | `text` | `string|null` | No | | | `null` | Yes | Display text of the question, when present. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # DiagnosticsListResponse
2
+
3
+ Model ID: `ehr.ListDiagnosticsResponse`
4
+
5
+ Response for GET /patients/{patient_id}/diagnostics. Contains serialized lab/diagnostic Observation domain models.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `diagnostics` | `array` | Yes | | | | No | Lab/diagnostic Observations matching the optional ?code= (LOINC) filter, in serialized domain-model format. |
14
+ | `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
15
+ | `total` | `integer` | Yes | | | | No | Number of diagnostics in this response. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # EncounterListResponse
2
+
3
+ Model ID: `ehr.ListEncountersResponse`
4
+
5
+ Response for GET /patients/{patient_id}/encounters. Contains serialized Encounter domain models.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `encounters` | `array` | Yes | | | | No | Encounter resources matching the optional ?status= filter, in serialized domain-model format. |
14
+ | `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
15
+ | `total` | `integer` | Yes | | | | No | Number of encounters in this response. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # MedicationListResponse
2
+
3
+ Model ID: `ehr.ListMedicationsResponse`
4
+
5
+ Response for GET /patients/{patient_id}/medications. Contains serialized Medication domain models.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `medications` | `array` | Yes | | | | No | Medication resources matching the ?resource_type= filter (defaults to MedicationRequest), in serialized domain-model format. |
14
+ | `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
15
+ | `total` | `integer` | Yes | | | | No | Number of medications in this response. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -3,7 +3,7 @@
3
3
  Model ID: `fieldagent.ResetPasswordRequest`
4
4
 
5
5
  Request body for POST /auth/reset-password — starts Cognito's
6
- ForgotPassword flow. Cognito emails a confirmation code directly; the
6
+ password reset flow. A confirmation code is emailed via SendGrid; the
7
7
  client then calls fieldagent.confirmResetPassword with that code.
8
8
 
9
9
  Type: `object`
@@ -13,6 +13,12 @@
13
13
  - [Address](Address.md)
14
14
  - [AddressType](AddressType.md)
15
15
  - [AgentDashboardResponse](AgentDashboardResponse.md)
16
+ - [Allergy](Allergy.md)
17
+ - [AllergyCategory](AllergyCategory.md)
18
+ - [AllergyCriticality](AllergyCriticality.md)
19
+ - [AllergyReaction](AllergyReaction.md)
20
+ - [AllergyStatus](AllergyStatus.md)
21
+ - [AllergyVerificationStatus](AllergyVerificationStatus.md)
16
22
  - [AnalyzeIdentityDocumentRequest](AnalyzeIdentityDocumentRequest.md)
17
23
  - [AnalyzeIdentityDocumentResponse](AnalyzeIdentityDocumentResponse.md)
18
24
  - [AnthropicContentBlock](AnthropicContentBlock.md)
@@ -383,6 +389,7 @@
383
389
  - [CmsGetCountyFipsRequest](CmsGetCountyFipsRequest.md)
384
390
  - [CmsSearchHealthPlansRequest](CmsSearchHealthPlansRequest.md)
385
391
  - [CmsSearchHealthPlansResponse](CmsSearchHealthPlansResponse.md)
392
+ - [CodedConcept](CodedConcept.md)
386
393
  - [CommGroupRecord](CommGroupRecord.md)
387
394
  - [CommunicationsState](CommsGetStateResponse.md)
388
395
  - [CommsGetUnreadCountResponse](CommsGetUnreadCountResponse.md)
@@ -457,6 +464,9 @@
457
464
  - [DocumentSummarySearchRequest](DocumentSummarySearchRequest.md)
458
465
  - [DocumentSummarySearchResponse](DocumentSummarySearchResponse.md)
459
466
  - [ehr.ConnectResponse](ehr.ConnectResponse.md)
467
+ - [DiagnosticsListResponse](ehr.ListDiagnosticsResponse.md)
468
+ - [EncounterListResponse](ehr.ListEncountersResponse.md)
469
+ - [MedicationListResponse](ehr.ListMedicationsResponse.md)
460
470
  - [ElevenLabsAccessInfo](ElevenLabsAccessInfo.md)
461
471
  - [ElevenLabsAgent](ElevenLabsAgent.md)
462
472
  - [ElevenLabsAgentSettings](ElevenLabsAgentSettings.md)
@@ -503,6 +513,10 @@
503
513
  - [Ethnicity](Ethnicity.md)
504
514
  - [FaceMatchRequest](FaceMatchRequest.md)
505
515
  - [FaceMatchResponse](FaceMatchResponse.md)
516
+ - [FamilyCondition](FamilyCondition.md)
517
+ - [FamilyHistoryEntry](FamilyHistoryEntry.md)
518
+ - [FamilyHistoryStatus](FamilyHistoryStatus.md)
519
+ - [FamilyRelationship](FamilyRelationship.md)
506
520
  - [FedexCreateShipmentRequest](FedexCreateShipmentRequest.md)
507
521
  - [FedexDeliveryDetails](FedexDeliveryDetails.md)
508
522
  - [FedexLatestStatusDetail](FedexLatestStatusDetail.md)
@@ -547,6 +561,7 @@
547
561
  - [GetDiagnosticTestResponse](GetDiagnosticTestResponse.md)
548
562
  - [GetDiagnosticTestSystemResponse](GetDiagnosticTestSystemResponse.md)
549
563
  - [GetEncounterResponse](GetEncounterResponse.md)
564
+ - [HealthRecordResponse](GetHealthRecordResponse.md)
550
565
  - [GetInsuranceResponse](GetInsuranceResponse.md)
551
566
  - [GetMedicalConceptAncestorsResponse](GetMedicalConceptAncestorsResponse.md)
552
567
  - [GetMedicalConceptDescendantsResponse](GetMedicalConceptDescendantsResponse.md)
@@ -1143,6 +1158,7 @@
1143
1158
  - [Insurance](Insurance.md)
1144
1159
  - [InsurancePriority](InsurancePriority.md)
1145
1160
  - [InterpretationCode](InterpretationCode.md)
1161
+ - [IntoleranceType](IntoleranceType.md)
1146
1162
  - [IntraocularPressure](IntraocularPressure.md)
1147
1163
  - [InviteChannel](InviteChannel.md)
1148
1164
  - [InviteRecord](InviteRecord.md)
@@ -1161,15 +1177,26 @@
1161
1177
  - [KnowledgeSearchResult](KnowledgeSearchResult.md)
1162
1178
  - [ListActionsResponse](ListActionsResponse.md)
1163
1179
  - [ListActivityResponse](ListActivityResponse.md)
1180
+ - [ListAllergiesResponse](ListAllergiesResponse.md)
1181
+ - [ListConditionsResponse](ListConditionsResponse.md)
1164
1182
  - [ListDependentsResponse](ListDependentsResponse.md)
1165
1183
  - [ListDiagnosticTestsResponse](ListDiagnosticTestsResponse.md)
1184
+ - [ListDirectivesResponse](ListDirectivesResponse.md)
1185
+ - [ListFamilyHistoryResponse](ListFamilyHistoryResponse.md)
1186
+ - [FunctionalStatusListResponse](ListFunctionalStatusResponse.md)
1187
+ - [ListImmunizationsResponse](ListImmunizationsResponse.md)
1166
1188
  - [ListKnowledgeResponse](ListKnowledgeResponse.md)
1167
1189
  - [ListMedicalConceptsGetResponse](ListMedicalConceptsGetResponse.md)
1168
1190
  - [ListNotificationsResponse](ListNotificationsResponse.md)
1191
+ - [ObservationListResponse](ListObservationsResponse.md)
1169
1192
  - [ListPatientAppointmentsResponse](ListPatientAppointmentsResponse.md)
1170
1193
  - [FieldAgentListPatientsResponse](ListPatientsResponse.md)
1171
1194
  - [ListPolicyDocumentsResponse](ListPolicyDocumentsResponse.md)
1195
+ - [ListProceduresResponse](ListProceduresResponse.md)
1196
+ - [ListQuestionnaireResponsesResponse](ListQuestionnaireResponsesResponse.md)
1172
1197
  - [ListSlotsResponse](ListSlotsResponse.md)
1198
+ - [ListSocialHistoryResponse](ListSocialHistoryResponse.md)
1199
+ - [ListVitalsResponse](ListVitalsResponse.md)
1173
1200
  - [LocationStatus](LocationStatus.md)
1174
1201
  - [MaritalStatus](MaritalStatus.md)
1175
1202
  - [mcp.ConnectResponse](mcp.ConnectResponse.md)
@@ -1357,6 +1384,11 @@
1357
1384
  - [PreferredPharmacy](PreferredPharmacy.md)
1358
1385
  - [PresenceRecord](PresenceRecord.md)
1359
1386
  - [PresenceStatus](PresenceStatus.md)
1387
+ - [Problem](Problem.md)
1388
+ - [ProblemCategory](ProblemCategory.md)
1389
+ - [ProblemClinicalStatus](ProblemClinicalStatus.md)
1390
+ - [ProblemSeverity](ProblemSeverity.md)
1391
+ - [ProblemVerificationStatus](ProblemVerificationStatus.md)
1360
1392
  - [ProviderConfirmResetPasswordRequest](provider.ConfirmResetPasswordRequest.md)
1361
1393
  - [ProviderConfirmResetPasswordResponse](provider.ConfirmResetPasswordResponse.md)
1362
1394
  - [provider.ConnectResponse](provider.ConnectResponse.md)
@@ -1417,6 +1449,8 @@
1417
1449
  - [QuestHL7MessageContent](QuestHL7MessageContent.md)
1418
1450
  - [QuestionItemType](QuestionItemType.md)
1419
1451
  - [QuestionnaireItemInput](QuestionnaireItemInput.md)
1452
+ - [QuestionnaireResponse](QuestionnaireResponse.md)
1453
+ - [QuestionnaireResponseStatus](QuestionnaireResponseStatus.md)
1420
1454
  - [QuestListTestCatalogRequest](QuestListTestCatalogRequest.md)
1421
1455
  - [QuestOrderDocument](QuestOrderDocument.md)
1422
1456
  - [QuestOrderDocumentsResponse](QuestOrderDocumentsResponse.md)
@@ -1440,9 +1474,12 @@
1440
1474
  - [RapidTest](RapidTest.md)
1441
1475
  - [RapidTestResult](RapidTestResult.md)
1442
1476
  - [RapidTestType](RapidTestType.md)
1477
+ - [ReactionSeverity](ReactionSeverity.md)
1443
1478
  - [RecordVitalsResponse](RecordVitalsResponse.md)
1444
1479
  - [RescheduleAppointmentRequest](RescheduleAppointmentRequest.md)
1445
1480
  - [RespiratoryRate](RespiratoryRate.md)
1481
+ - [ResponseAnswer](ResponseAnswer.md)
1482
+ - [ResponseItem](ResponseItem.md)
1446
1483
  - [rppg.ConnectResponse](rppg.ConnectResponse.md)
1447
1484
  - [SalesforceAccount](SalesforceAccount.md)
1448
1485
  - [SalesforceAccountAssets](SalesforceAccountAssets.md)
@@ -3,7 +3,7 @@
3
3
  Model ID: `person.ResetPasswordRequest`
4
4
 
5
5
  Request body for POST /auth/reset-password — starts Cognito's
6
- ForgotPassword flow. Cognito emails a confirmation code directly; the
6
+ password reset flow. A confirmation code is emailed via SendGrid; the
7
7
  client then calls person.confirmResetPassword with that code.
8
8
 
9
9
  Type: `object`
@@ -3,7 +3,7 @@
3
3
  Model ID: `provider.ResetPasswordRequest`
4
4
 
5
5
  Request body for POST /auth/reset-password — starts Cognito's
6
- ForgotPassword flow. Cognito emails a confirmation code directly; the
6
+ password reset flow. A confirmation code is emailed via SendGrid; the
7
7
  client then calls provider.confirmResetPassword with that code.
8
8
 
9
9
  Type: `object`
@@ -151,7 +151,7 @@ curl -X GET \
151
151
 
152
152
  ## Notes
153
153
 
154
- None.
154
+ - Interim note pending a backend contract update: since the SAFE CDX integration (merged to healthcloud-services main 2026-08-21), the live response no longer matches the `SingleTestResultResponse` schema shown on this page. The actual response is `{success: boolean, data: object, message: string, code: integer}`, where `data` carries the processed SAFE CVML result (including `userID`, `testID`, `uploadID`, and analyte-specific fields) rather than the documented `test_id`/`patient_id`/`panels` fields. `SingleTestResultResponse` will be replaced once the backend declares a typed response model for this operation and the contract is re-synced. Confirmed live against DEV on 2026-08-21.
155
155
 
156
156
  ## Prepared Test Console scenario
157
157
 
@@ -149,7 +149,7 @@ curl -X GET \
149
149
 
150
150
  ## Notes
151
151
 
152
- None.
152
+ - Interim note pending a backend contract update: since the SAFE CDX integration (merged to healthcloud-services main 2026-08-21), for the OraQuick HIV GTIN (00608337001792) the live response also includes a `scan_upload` field — `{test_id, upload_url, expires_in, storage_key}`, a SAFE CDX presigned S3 upload URL generated inline. This field is not yet declared on the `GS1LookupResponse` schema shown on this page; it will appear once the backend contract is re-synced. Confirmed live against DEV on 2026-08-21.
153
153
 
154
154
  ## Prepared Test Console scenario
155
155