@healthcloudai/hc-sdk 2.1.0 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +15 -1
- package/dist/index.d.cts +30184 -28982
- package/dist/index.d.ts +30184 -28982
- package/dist/index.js +15 -1
- package/docs/clients/PatientClient.md +1 -1
- package/docs/docs-manifest.json +15 -2
- package/docs/examples/index.md +1 -1
- package/docs/index.md +1 -1
- package/docs/models/CreateQuestionnaireRequest.md +3 -3
- package/docs/models/CreateQuestionnaireResponse.md +1 -1
- package/docs/models/OnboardEncounterPayload.md +35 -0
- package/docs/models/OnboardEncounterStepResult.md +15 -0
- package/docs/models/OnboardPatientPayload.md +22 -0
- package/docs/models/OnboardPatientRequest.md +4 -4
- package/docs/models/OnboardPatientResponse.md +4 -4
- package/docs/models/OnboardPatientStepResult.md +20 -0
- package/docs/models/OnboardQuestionnaireAnswer.md +15 -0
- package/docs/models/OnboardQuestionnaireDefinition.md +19 -0
- package/docs/models/OnboardQuestionnairePayload.md +19 -0
- package/docs/models/OnboardQuestionnaireResponseItem.md +14 -0
- package/docs/models/OnboardQuestionnaireStepResult.md +16 -0
- package/docs/models/OnboardVitalsPayload.md +19 -0
- package/docs/models/OnboardVitalsStepResult.md +15 -0
- package/docs/models/QuestionItemType.md +11 -0
- package/docs/models/QuestionnaireItemInput.md +21 -0
- package/docs/models/index.md +13 -0
- package/docs/operations/patient.createQuestionnaire.md +4 -4
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -997,6 +997,16 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
997
997
|
body: payload
|
|
998
998
|
});
|
|
999
999
|
}
|
|
1000
|
+
/** POST /patients/health-record/initimport — starts/checks the Zus import with an empty payload. */
|
|
1001
|
+
initHealthRecordImport() {
|
|
1002
|
+
return this.send("POST", "/patients/health-record/initimport", {
|
|
1003
|
+
body: {}
|
|
1004
|
+
});
|
|
1005
|
+
}
|
|
1006
|
+
/** GET /patients/alerts — alerts for the authenticated patient. */
|
|
1007
|
+
getPatientAlerts() {
|
|
1008
|
+
return this.send("GET", "/patients/alerts", {});
|
|
1009
|
+
}
|
|
1000
1010
|
importCCDA(content) {
|
|
1001
1011
|
return this.send("POST", "/patients/health-record/import", {
|
|
1002
1012
|
body: {
|
|
@@ -1095,11 +1105,15 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
1095
1105
|
body: request
|
|
1096
1106
|
});
|
|
1097
1107
|
}
|
|
1098
|
-
|
|
1108
|
+
nearestLocations(query) {
|
|
1099
1109
|
return this.send("GET", "/locations/nearest", {
|
|
1100
1110
|
query
|
|
1101
1111
|
});
|
|
1102
1112
|
}
|
|
1113
|
+
/** @deprecated Use nearestLocations. */
|
|
1114
|
+
listNearestLocations(query) {
|
|
1115
|
+
return this.nearestLocations(query);
|
|
1116
|
+
}
|
|
1103
1117
|
// `...ToJSON` renders the generated `Date` fields (created_date, period_start,
|
|
1104
1118
|
// period_end) back to `YYYY-MM-DD` instead of a full ISO datetime.
|
|
1105
1119
|
createEncounter(request) {
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
- [`connect`](../operations/patient.connect.md) — GET /connect
|
|
26
26
|
- [`createEncounter`](../operations/patient.createEncounter.md) — POST /encounters
|
|
27
27
|
- [`createMedication`](../operations/patient.createMedication.md) — POST /patients/medications
|
|
28
|
-
- [`createQuestionnaire`](../operations/patient.createQuestionnaire.md) —
|
|
28
|
+
- [`createQuestionnaire`](../operations/patient.createQuestionnaire.md) — Create a FHIR Questionnaire
|
|
29
29
|
- [`createQuestionnaireResponse`](../operations/patient.createQuestionnaireResponse.md) — POST /questionnaires/{questionnaire_id}/responses
|
|
30
30
|
- [`deleteActivity`](../operations/patient.deleteActivity.md) — DELETE /patients/activity/{activity_id}
|
|
31
31
|
- [`deleteDependent`](../operations/patient.deleteDependent.md) — DELETE /patients/dependents/{dependent_id}
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:7745a760438ffbb75039fdcb95bb94ec408f579dddbc7b82dfa0d9fdef10ba3d",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AnthropicClient.md",
|
|
@@ -755,8 +755,19 @@
|
|
|
755
755
|
"models/NppesSearchProvidersRequest.md",
|
|
756
756
|
"models/NppesVerifyProviderRequest.md",
|
|
757
757
|
"models/ObservationStatus.md",
|
|
758
|
+
"models/OnboardEncounterPayload.md",
|
|
759
|
+
"models/OnboardEncounterStepResult.md",
|
|
760
|
+
"models/OnboardPatientPayload.md",
|
|
758
761
|
"models/OnboardPatientRequest.md",
|
|
759
762
|
"models/OnboardPatientResponse.md",
|
|
763
|
+
"models/OnboardPatientStepResult.md",
|
|
764
|
+
"models/OnboardQuestionnaireAnswer.md",
|
|
765
|
+
"models/OnboardQuestionnaireDefinition.md",
|
|
766
|
+
"models/OnboardQuestionnairePayload.md",
|
|
767
|
+
"models/OnboardQuestionnaireResponseItem.md",
|
|
768
|
+
"models/OnboardQuestionnaireStepResult.md",
|
|
769
|
+
"models/OnboardVitalsPayload.md",
|
|
770
|
+
"models/OnboardVitalsStepResult.md",
|
|
760
771
|
"models/OpenaiBuildResponseCreatePayloadRequest.md",
|
|
761
772
|
"models/OpenaiChatJsonRequest.md",
|
|
762
773
|
"models/OpenaiChatRequest.md",
|
|
@@ -859,6 +870,8 @@
|
|
|
859
870
|
"models/QuestSubmitFullOrderRequest.md",
|
|
860
871
|
"models/QuestSubmitOrderRequest.md",
|
|
861
872
|
"models/QuestSyncCompendiumsRequest.md",
|
|
873
|
+
"models/QuestionItemType.md",
|
|
874
|
+
"models/QuestionnaireItemInput.md",
|
|
862
875
|
"models/Race.md",
|
|
863
876
|
"models/RapidTest.md",
|
|
864
877
|
"models/RapidTestResult.md",
|
|
@@ -2196,7 +2209,7 @@
|
|
|
2196
2209
|
"operations/vitals.recordVitals.md"
|
|
2197
2210
|
],
|
|
2198
2211
|
"language": "nodejs",
|
|
2199
|
-
"modelCount":
|
|
2212
|
+
"modelCount": 1178,
|
|
2200
2213
|
"operationCount": 975,
|
|
2201
2214
|
"schemaVersion": 1
|
|
2202
2215
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -894,7 +894,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
894
894
|
- [GET /connect](../operations/patient.connect.md)
|
|
895
895
|
- [POST /encounters](../operations/patient.createEncounter.md)
|
|
896
896
|
- [POST /patients/medications](../operations/patient.createMedication.md)
|
|
897
|
-
- [
|
|
897
|
+
- [Create a FHIR Questionnaire](../operations/patient.createQuestionnaire.md)
|
|
898
898
|
- [POST /questionnaires/{questionnaire_id}/responses](../operations/patient.createQuestionnaireResponse.md)
|
|
899
899
|
- [DELETE /patients/activity/{activity_id}](../operations/patient.deleteActivity.md)
|
|
900
900
|
- [DELETE /patients/dependents/{dependent_id}](../operations/patient.deleteDependent.md)
|
package/docs/index.md
CHANGED
|
@@ -902,7 +902,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
902
902
|
- [GET /connect](operations/patient.connect.md) (`patient.connect`)
|
|
903
903
|
- [POST /encounters](operations/patient.createEncounter.md) (`patient.createEncounter`)
|
|
904
904
|
- [POST /patients/medications](operations/patient.createMedication.md) (`patient.createMedication`)
|
|
905
|
-
- [
|
|
905
|
+
- [Create a FHIR Questionnaire](operations/patient.createQuestionnaire.md) (`patient.createQuestionnaire`)
|
|
906
906
|
- [POST /questionnaires/{questionnaire_id}/responses](operations/patient.createQuestionnaireResponse.md) (`patient.createQuestionnaireResponse`)
|
|
907
907
|
- [DELETE /patients/activity/{activity_id}](operations/patient.deleteActivity.md) (`patient.deleteActivity`)
|
|
908
908
|
- [DELETE /patients/dependents/{dependent_id}](operations/patient.deleteDependent.md) (`patient.deleteDependent`)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `CreateQuestionnaireRequest`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Request body for POST /questionnaires — see Questionnaire.from_request_dict().
|
|
6
6
|
|
|
7
7
|
Type: `object`
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `items` |
|
|
13
|
+
| `items` | array of [`QuestionnaireItemInput`](./QuestionnaireItemInput.md) | No | | | | No | |
|
|
14
14
|
| `name` | `string` | Yes | | | | No | |
|
|
15
15
|
| `status` | `string` | No | | | `"active"` | No | |
|
|
16
|
-
| `title` | `string` | No | | | |
|
|
16
|
+
| `title` | `string|null` | No | | | | Yes | |
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# OnboardEncounterPayload
|
|
2
|
+
|
|
3
|
+
Model ID: `OnboardEncounterPayload`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `appointment_id` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `created_date` | `string|null` | No | | | | Yes | ISO 8601 datetime |
|
|
15
|
+
| `diagnoses` | array of [`fieldagent.EncounterDiagnosis`](./fieldagent.EncounterDiagnosis.md) | No | | | | No | |
|
|
16
|
+
| `encounter_class` | [`EncounterClass`](./EncounterClass.md) | No | | | `"AMB"` | No | |
|
|
17
|
+
| `encounter_id` | `string|null` | No | | | | Yes | UUID; server-generated if omitted. |
|
|
18
|
+
| `fhir_id` | `string|null` | No | | | | Yes | |
|
|
19
|
+
| `hospitalization` | [`fieldagent.EncounterHospitalization`](./fieldagent.EncounterHospitalization.md) | No | | | | Yes | |
|
|
20
|
+
| `length_minutes` | `integer|null` | No | | | | Yes | |
|
|
21
|
+
| `locations` | array of [`fieldagent.EncounterLocation`](./fieldagent.EncounterLocation.md) | No | | | | No | |
|
|
22
|
+
| `participants` | array of [`fieldagent.EncounterParticipant`](./fieldagent.EncounterParticipant.md) | No | | | | No | |
|
|
23
|
+
| `period_end` | `string|null` | No | | | | Yes | ISO 8601 datetime |
|
|
24
|
+
| `period_start` | `string|null` | No | | | | Yes | ISO 8601 datetime |
|
|
25
|
+
| `priority_code` | `string|null` | No | | | | Yes | |
|
|
26
|
+
| `priority_display` | `string|null` | No | | | | Yes | |
|
|
27
|
+
| `reason_code` | `string|null` | No | | | | Yes | |
|
|
28
|
+
| `reason_display` | `string|null` | No | | | | Yes | |
|
|
29
|
+
| `service_provider_display` | `string|null` | No | | | | Yes | |
|
|
30
|
+
| `service_provider_id` | `string|null` | No | | | | Yes | |
|
|
31
|
+
| `service_type_code` | `string|null` | No | | | | Yes | |
|
|
32
|
+
| `service_type_display` | `string|null` | No | | | | Yes | |
|
|
33
|
+
| `status` | [`EncounterStatus`](./EncounterStatus.md) | No | | | `"planned"` | No | |
|
|
34
|
+
| `type_code` | `string|null` | No | | | | Yes | |
|
|
35
|
+
| `type_display` | `string|null` | No | | | | Yes | |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# OnboardEncounterStepResult
|
|
2
|
+
|
|
3
|
+
Model ID: `OnboardEncounterStepResult`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `error` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `fhir_id` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `status` | `string` | Yes | | | | No | 'success', 'failed', or 'skipped' |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# OnboardPatientPayload
|
|
2
|
+
|
|
3
|
+
Model ID: `OnboardPatientPayload`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `address` | [`Address`](./Address.md) | No | | | | Yes | Mutually exclusive with addresses. |
|
|
14
|
+
| `addresses` | `array|null` | No | | | | Yes | Mutually exclusive with address. |
|
|
15
|
+
| `date_of_birth` | `string` | Yes | | | | No | ISO 8601 date (YYYY-MM-DD) |
|
|
16
|
+
| `email` | `string` | Yes | | | | No | |
|
|
17
|
+
| `first_name` | `string` | Yes | | | | No | |
|
|
18
|
+
| `last_name` | `string` | Yes | | | | No | |
|
|
19
|
+
| `password` | `string|null` | No | | | | Yes | Auto-generated server-side and not returned if omitted. |
|
|
20
|
+
| `phone` | `string|null` | No | | | | Yes | |
|
|
21
|
+
| `race` | [`Race`](./Race.md) | No | | | | Yes | |
|
|
22
|
+
| `sex_at_birth` | [`SexAtBirth`](./SexAtBirth.md) | No | | | | Yes | |
|
|
@@ -14,8 +14,8 @@ Type: `object`
|
|
|
14
14
|
|
|
15
15
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
16
16
|
|---|---|---:|---|---|---|---:|---|
|
|
17
|
-
| `encounter` | `
|
|
18
|
-
| `patient` | `
|
|
19
|
-
| `questionnaire` | `
|
|
17
|
+
| `encounter` | [`OnboardEncounterPayload`](./OnboardEncounterPayload.md) | No | | | | Yes | Encounter fields accepted by POST /encounters on the Patient API. patient_id and created_by are populated automatically from the newly-registered patient and the calling field agent. |
|
|
18
|
+
| `patient` | [`OnboardPatientPayload`](./OnboardPatientPayload.md) | Yes | | | | No | first_name, last_name, email, date_of_birth required; password (auto-generated and not returned if omitted), phone, sex_at_birth, address/addresses, race optional. Same fields as POST /auth/register on the Patient API. |
|
|
19
|
+
| `questionnaire` | [`OnboardQuestionnairePayload`](./OnboardQuestionnairePayload.md) | No | | | | Yes | Either questionnaire_id (FHIR id of an existing Questionnaire) or definition (create one inline — see OnboardQuestionnaireDefinition) is required. When definition is given instead of questionnaire_id, the Questionnaire is created first and its fhir_id is used for the response — the caller never needs to call POST /questionnaires separately. items are the answers, submitted the same way regardless of which one was supplied. |
|
|
20
20
|
| `tenant_id` | `string|null` | No | | | | Yes | Defaults to the calling field agent's own tenant |
|
|
21
|
-
| `vitals` | `
|
|
21
|
+
| `vitals` | [`OnboardVitalsPayload`](./OnboardVitalsPayload.md) | No | | | | Yes | Same fields as POST /patients/{patient_id}/vitals on the Vitals API. |
|
|
@@ -12,8 +12,8 @@ Type: `object`
|
|
|
12
12
|
|
|
13
13
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
14
14
|
|---|---|---:|---|---|---|---:|---|
|
|
15
|
-
| `encounter` | `
|
|
15
|
+
| `encounter` | [`OnboardEncounterStepResult`](./OnboardEncounterStepResult.md) | Yes | | | | No | |
|
|
16
16
|
| `overall_status` | `string` | Yes | | | | No | 'completed', 'partial', or 'failed' |
|
|
17
|
-
| `patient` | `
|
|
18
|
-
| `questionnaire_response` | `
|
|
19
|
-
| `vitals` | `
|
|
17
|
+
| `patient` | [`OnboardPatientStepResult`](./OnboardPatientStepResult.md) | Yes | | | | No | |
|
|
18
|
+
| `questionnaire_response` | [`OnboardQuestionnaireStepResult`](./OnboardQuestionnaireStepResult.md) | Yes | | | | No | |
|
|
19
|
+
| `vitals` | [`OnboardVitalsStepResult`](./OnboardVitalsStepResult.md) | Yes | | | | No | |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# OnboardPatientStepResult
|
|
2
|
+
|
|
3
|
+
Model ID: `OnboardPatientStepResult`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `cognito_sub` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `email_otp_sent` | `boolean|null` | No | | | | Yes | |
|
|
15
|
+
| `email_verified` | `boolean|null` | No | | | | Yes | |
|
|
16
|
+
| `error` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `fhir_patient_id` | `string|null` | No | | | | Yes | |
|
|
18
|
+
| `status` | `string` | Yes | | | | No | 'success' or 'failed' |
|
|
19
|
+
| `telehealth_id` | `integer|null` | No | | | | Yes | |
|
|
20
|
+
| `temp_password_generated` | `boolean|null` | No | | | | Yes | |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# OnboardQuestionnaireAnswer
|
|
2
|
+
|
|
3
|
+
Model ID: `OnboardQuestionnaireAnswer`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `value_boolean` | `boolean|null` | No | | | | Yes | |
|
|
14
|
+
| `value_integer` | `integer|null` | No | | | | Yes | |
|
|
15
|
+
| `value_string` | `string|null` | No | | | | Yes | |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# OnboardQuestionnaireDefinition
|
|
2
|
+
|
|
3
|
+
Model ID: `OnboardQuestionnaireDefinition`
|
|
4
|
+
|
|
5
|
+
Inline Questionnaire definition — same shape CreateQuestionnaireRequest
|
|
6
|
+
accepts on POST /questionnaires (Patient API). Used when the caller has
|
|
7
|
+
no pre-existing questionnaire_id; the Questionnaire is created from this
|
|
8
|
+
before the response below is submitted against it.
|
|
9
|
+
|
|
10
|
+
Type: `object`
|
|
11
|
+
|
|
12
|
+
## Fields
|
|
13
|
+
|
|
14
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
15
|
+
|---|---|---:|---|---|---|---:|---|
|
|
16
|
+
| `items` | array of [`QuestionnaireItemInput`](./QuestionnaireItemInput.md) | No | | | | No | |
|
|
17
|
+
| `name` | `string` | Yes | | | | No | |
|
|
18
|
+
| `status` | `string` | No | | | `"active"` | No | |
|
|
19
|
+
| `title` | `string|null` | No | | | | Yes | |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# OnboardQuestionnairePayload
|
|
2
|
+
|
|
3
|
+
Model ID: `OnboardQuestionnairePayload`
|
|
4
|
+
|
|
5
|
+
questionnaire section of POST /onboardpatients. Either questionnaire_id
|
|
6
|
+
(an existing Questionnaire) or definition (create one inline) is
|
|
7
|
+
required; items are the answers, submitted the same way regardless of
|
|
8
|
+
which one was supplied.
|
|
9
|
+
|
|
10
|
+
Type: `object`
|
|
11
|
+
|
|
12
|
+
## Fields
|
|
13
|
+
|
|
14
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
15
|
+
|---|---|---:|---|---|---|---:|---|
|
|
16
|
+
| `definition` | [`OnboardQuestionnaireDefinition`](./OnboardQuestionnaireDefinition.md) | No | | | | Yes | |
|
|
17
|
+
| `items` | array of [`OnboardQuestionnaireResponseItem`](./OnboardQuestionnaireResponseItem.md) | No | | | | No | |
|
|
18
|
+
| `questionnaire_id` | `string|null` | No | | | | Yes | FHIR id of an existing Questionnaire. Omit to create one inline via definition. |
|
|
19
|
+
| `status` | `string` | No | | | `"completed"` | No | |
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# OnboardQuestionnaireResponseItem
|
|
2
|
+
|
|
3
|
+
Model ID: `OnboardQuestionnaireResponseItem`
|
|
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 [`OnboardQuestionnaireAnswer`](./OnboardQuestionnaireAnswer.md) | No | | | | No | |
|
|
14
|
+
| `link_id` | `string` | Yes | | | | No | |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# OnboardQuestionnaireStepResult
|
|
2
|
+
|
|
3
|
+
Model ID: `OnboardQuestionnaireStepResult`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `error` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `fhir_id` | `string|null` | No | | | | Yes | FHIR id of the created QuestionnaireResponse. |
|
|
15
|
+
| `questionnaire_fhir_id` | `string|null` | No | | | | Yes | FHIR id of the Questionnaire used — either the supplied questionnaire_id, or the one just created from definition. |
|
|
16
|
+
| `status` | `string` | Yes | | | | No | 'success', 'failed', or 'skipped' |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# OnboardVitalsPayload
|
|
2
|
+
|
|
3
|
+
Model ID: `OnboardVitalsPayload`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `diastolic` | `number|null` | No | | | | Yes | mmHg; requires systolic to be applied |
|
|
14
|
+
| `heart_rate` | `number|null` | No | | | | Yes | beats/min |
|
|
15
|
+
| `height_cm` | `number|null` | No | | | | Yes | |
|
|
16
|
+
| `oxygen_saturation` | `number|null` | No | | | | Yes | SpO2 percentage |
|
|
17
|
+
| `systolic` | `number|null` | No | | | | Yes | mmHg; requires diastolic to be applied |
|
|
18
|
+
| `temperature` | `number|null` | No | | | | Yes | Celsius |
|
|
19
|
+
| `weight_kg` | `number|null` | No | | | | Yes | |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# OnboardVitalsStepResult
|
|
2
|
+
|
|
3
|
+
Model ID: `OnboardVitalsStepResult`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `error` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `observation_count` | `integer|null` | No | | | | Yes | |
|
|
15
|
+
| `status` | `string` | Yes | | | | No | 'success', 'failed', or 'skipped' |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# QuestionnaireItemInput
|
|
2
|
+
|
|
3
|
+
Model ID: `QuestionnaireItemInput`
|
|
4
|
+
|
|
5
|
+
The minimal item shape actually read by Questionnaire.from_request_dict()
|
|
6
|
+
— the exact fields accepted by POST /questionnaires on the Patient API and
|
|
7
|
+
the inline questionnaire.definition.items on POST /onboardpatients (Field
|
|
8
|
+
Agent API). Deliberately narrower than QuestionnaireItem: only link_id,
|
|
9
|
+
text and type are read from a request; the rest of that model's fields
|
|
10
|
+
(required, repeats, answer_options, ...) are not yet accepted here, so
|
|
11
|
+
they are not advertised as part of the request contract.
|
|
12
|
+
|
|
13
|
+
Type: `object`
|
|
14
|
+
|
|
15
|
+
## Fields
|
|
16
|
+
|
|
17
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
18
|
+
|---|---|---:|---|---|---|---:|---|
|
|
19
|
+
| `link_id` | `string|null` | No | | | | Yes | |
|
|
20
|
+
| `text` | `string|null` | No | | | | Yes | |
|
|
21
|
+
| `type` | [`QuestionItemType`](./QuestionItemType.md) | No | | | `"string"` | No | |
|
package/docs/models/index.md
CHANGED
|
@@ -723,8 +723,19 @@
|
|
|
723
723
|
- [NppesSearchProvidersRequest](NppesSearchProvidersRequest.md)
|
|
724
724
|
- [NppesVerifyProviderRequest](NppesVerifyProviderRequest.md)
|
|
725
725
|
- [ObservationStatus](ObservationStatus.md)
|
|
726
|
+
- [OnboardEncounterPayload](OnboardEncounterPayload.md)
|
|
727
|
+
- [OnboardEncounterStepResult](OnboardEncounterStepResult.md)
|
|
728
|
+
- [OnboardPatientPayload](OnboardPatientPayload.md)
|
|
726
729
|
- [OnboardPatientRequest](OnboardPatientRequest.md)
|
|
727
730
|
- [OnboardPatientResponse](OnboardPatientResponse.md)
|
|
731
|
+
- [OnboardPatientStepResult](OnboardPatientStepResult.md)
|
|
732
|
+
- [OnboardQuestionnaireAnswer](OnboardQuestionnaireAnswer.md)
|
|
733
|
+
- [OnboardQuestionnaireDefinition](OnboardQuestionnaireDefinition.md)
|
|
734
|
+
- [OnboardQuestionnairePayload](OnboardQuestionnairePayload.md)
|
|
735
|
+
- [OnboardQuestionnaireResponseItem](OnboardQuestionnaireResponseItem.md)
|
|
736
|
+
- [OnboardQuestionnaireStepResult](OnboardQuestionnaireStepResult.md)
|
|
737
|
+
- [OnboardVitalsPayload](OnboardVitalsPayload.md)
|
|
738
|
+
- [OnboardVitalsStepResult](OnboardVitalsStepResult.md)
|
|
728
739
|
- [OpenaiBuildResponseCreatePayloadRequest](OpenaiBuildResponseCreatePayloadRequest.md)
|
|
729
740
|
- [OpenaiChatJsonRequest](OpenaiChatJsonRequest.md)
|
|
730
741
|
- [OpenaiChatRequest](OpenaiChatRequest.md)
|
|
@@ -862,6 +873,8 @@
|
|
|
862
873
|
- [QuestGetPrintableResultsRequest](QuestGetPrintableResultsRequest.md)
|
|
863
874
|
- [QuestGetRequisitionRequest](QuestGetRequisitionRequest.md)
|
|
864
875
|
- [QuestGetResultsRequest](QuestGetResultsRequest.md)
|
|
876
|
+
- [QuestionItemType](QuestionItemType.md)
|
|
877
|
+
- [QuestionnaireItemInput](QuestionnaireItemInput.md)
|
|
865
878
|
- [QuestListTestsRequest](QuestListTestsRequest.md)
|
|
866
879
|
- [QuestProcessPushedResultRequest](QuestProcessPushedResultRequest.md)
|
|
867
880
|
- [QuestRequestCompendiumsOnDemandRequest](QuestRequestCompendiumsOnDemandRequest.md)
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Create a FHIR Questionnaire
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.createQuestionnaire`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Create a FHIR Questionnaire.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -38,7 +38,7 @@ None.
|
|
|
38
38
|
|
|
39
39
|
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
40
40
|
|---|---|---:|---|---|---|---:|---|
|
|
41
|
-
| `body` | [`CreateQuestionnaireRequest`](../models/CreateQuestionnaireRequest.md) |
|
|
41
|
+
| `body` | [`CreateQuestionnaireRequest`](../models/CreateQuestionnaireRequest.md) | No | | | | Yes | |
|
|
42
42
|
|
|
43
43
|
Request model: [`CreateQuestionnaireRequest`](../models/CreateQuestionnaireRequest.md)
|
|
44
44
|
|
|
@@ -46,7 +46,7 @@ Request model: [`CreateQuestionnaireRequest`](../models/CreateQuestionnaireReque
|
|
|
46
46
|
|
|
47
47
|
| Status | Shape | Content type | Description |
|
|
48
48
|
|---|---|---|---|
|
|
49
|
-
| `201` | [`CreateQuestionnaireResponse`](../models/CreateQuestionnaireResponse.md) | application/json |
|
|
49
|
+
| `201` | [`CreateQuestionnaireResponse`](../models/CreateQuestionnaireResponse.md) | application/json | Questionnaire created |
|
|
50
50
|
|
|
51
51
|
## Common errors
|
|
52
52
|
|
package/package.json
CHANGED