@healthcloudai/hc-sdk 3.17.0 → 3.19.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 +37 -0
- package/dist/index.d.cts +9261 -2031
- package/dist/index.d.ts +9261 -2031
- package/dist/index.js +37 -0
- package/docs/clients/ProviderClient.md +8 -0
- package/docs/docs-manifest.json +90 -12
- package/docs/examples/index.md +8 -0
- package/docs/index.md +8 -0
- package/docs/models/AlcoholFrequency.md +15 -0
- package/docs/models/AlcoholUse.md +20 -0
- package/docs/models/BodyHeight.md +17 -0
- package/docs/models/BodyTemperature.md +18 -0
- package/docs/models/BodyWeight.md +18 -0
- package/docs/models/BookAppointmentRequest.md +2 -0
- package/docs/models/DietCategory.md +19 -0
- package/docs/models/EducationLevel.md +15 -0
- package/docs/models/ExerciseFrequency.md +15 -0
- package/docs/models/FunctionalLevel.md +15 -0
- package/docs/models/FunctionalStatus.md +40 -0
- package/docs/models/GetPractitionerResponse.md +8 -2
- package/docs/models/LicenseVerification.md +19 -0
- package/docs/models/ListAllergiesResponse.md +1 -1
- package/docs/models/ListConditionsResponse.md +1 -1
- package/docs/models/ListDirectivesResponse.md +1 -1
- package/docs/models/ListFamilyHistoryResponse.md +1 -1
- package/docs/models/ListImmunizationsResponse.md +1 -1
- package/docs/models/ListProceduresResponse.md +1 -1
- package/docs/models/ListQuestionnaireResponsesResponse.md +1 -1
- package/docs/models/LivingSituation.md +15 -0
- package/docs/models/LocationAddress.md +21 -0
- package/docs/models/LocationHours.md +19 -0
- package/docs/models/NpiVerification.md +21 -0
- package/docs/models/OnboardingProgressRequest.md +18 -0
- package/docs/models/PortalRole.md +18 -0
- package/docs/models/Practitioner.md +9 -2
- package/docs/models/ProviderCredential.md +19 -0
- package/docs/models/ProviderEducationCredential.md +6 -2
- package/docs/models/ProviderEncounterListResponse.md +1 -1
- package/docs/models/ProviderEncounterRecord.md +49 -0
- package/docs/models/ProviderEncounterResponse.md +1 -1
- package/docs/models/ProviderLanguage.md +3 -2
- package/docs/models/ProviderLocation.md +63 -0
- package/docs/models/ProviderLocationAddressRequest.md +21 -0
- package/docs/models/ProviderLocationDeletedResponse.md +18 -0
- package/docs/models/ProviderLocationHoursRequest.md +19 -0
- package/docs/models/ProviderLocationListResponse.md +18 -0
- package/docs/models/ProviderLocationPatchRequest.md +28 -0
- package/docs/models/ProviderLocationRequest.md +57 -0
- package/docs/models/ProviderOnboardingStatus.md +19 -0
- package/docs/models/ProviderPatientRecordResources.md +32 -0
- package/docs/models/ProviderPatientRecordResponse.md +1 -1
- package/docs/models/ProviderPostgraduateTraining.md +22 -0
- package/docs/models/ProviderProfessionalLiability.md +19 -0
- package/docs/models/ProviderSpecialty.md +1 -1
- package/docs/models/ProviderStateLicense.md +9 -2
- package/docs/models/SetPortalRolesRequest.md +17 -0
- package/docs/models/SexualOrientation.md +15 -0
- package/docs/models/SmokingStatus.md +15 -0
- package/docs/models/SocialHistory.md +35 -0
- package/docs/models/SubstanceStatus.md +15 -0
- package/docs/models/SubstanceUse.md +23 -0
- package/docs/models/TobaccoUse.md +22 -0
- package/docs/models/UpdateEncounterClinicalNoteResponse.md +1 -1
- package/docs/models/UpdateEncounterStatusResponse.md +1 -1
- package/docs/models/UpdatePractitionerRequest.md +5 -0
- package/docs/models/UpdatePractitionerResponse.md +8 -2
- package/docs/models/VitalsRecord.md +41 -0
- package/docs/models/appointments.ErrorResponse.md +1 -0
- package/docs/models/diagnostics.Coding.md +19 -0
- package/docs/models/diagnostics.LabObservation.md +1 -1
- package/docs/models/{AdvanceDirective.md → ehr.AdvanceDirective.md} +1 -1
- package/docs/models/{Allergy.md → ehr.Allergy.md} +1 -1
- package/docs/models/ehr.Coding.md +19 -0
- package/docs/models/{FamilyHistoryEntry.md → ehr.FamilyHistoryEntry.md} +1 -1
- package/docs/models/{Immunization.md → ehr.Immunization.md} +1 -1
- package/docs/models/{Problem.md → ehr.Problem.md} +1 -1
- package/docs/models/{Procedure.md → ehr.Procedure.md} +1 -1
- package/docs/models/ehr.Quantity.md +20 -0
- package/docs/models/{QuestionnaireResponse.md → ehr.QuestionnaireResponse.md} +2 -2
- package/docs/models/{ResponseAnswer.md → ehr.ResponseAnswer.md} +4 -4
- package/docs/models/{ResponseItem.md → ehr.ResponseItem.md} +3 -3
- package/docs/models/index.md +79 -9
- package/docs/models/provider.AdvanceDirective.md +31 -0
- package/docs/models/provider.Allergy.md +31 -0
- package/docs/models/provider.AllergyReaction.md +21 -0
- package/docs/models/provider.BloodPressure.md +20 -0
- package/docs/models/provider.CodedConcept.md +19 -0
- package/docs/models/provider.Coding.md +19 -0
- package/docs/models/provider.Dosage.md +24 -0
- package/docs/models/provider.Encounter.md +48 -0
- package/docs/models/provider.EncounterDiagnosis.md +20 -0
- package/docs/models/provider.EncounterHospitalization.md +22 -0
- package/docs/models/provider.EncounterLocation.md +21 -0
- package/docs/models/provider.EncounterParticipant.md +21 -0
- package/docs/models/provider.FamilyCondition.md +22 -0
- package/docs/models/provider.FamilyHistoryEntry.md +30 -0
- package/docs/models/provider.GynHistory.md +25 -0
- package/docs/models/provider.HeartRate.md +18 -0
- package/docs/models/provider.Immunization.md +40 -0
- package/docs/models/provider.ImmunizationReaction.md +20 -0
- package/docs/models/provider.LabObservation.md +29 -0
- package/docs/models/provider.Medication.md +41 -0
- package/docs/models/provider.PerinatalHistory.md +25 -0
- package/docs/models/provider.Problem.md +37 -0
- package/docs/models/provider.Procedure.md +37 -0
- package/docs/models/provider.PulseOximetry.md +20 -0
- package/docs/models/provider.Quantity.md +20 -0
- package/docs/models/provider.QuestionnaireResponse.md +27 -0
- package/docs/models/provider.ReferenceRange.md +20 -0
- package/docs/models/provider.ResponseAnswer.md +27 -0
- package/docs/models/provider.ResponseItem.md +21 -0
- package/docs/operations/appointments.book.md +34 -1
- package/docs/operations/provider.completePractitionerOnboarding.md +264 -0
- package/docs/operations/provider.createPractitionerLocation.md +221 -0
- package/docs/operations/provider.deletePractitionerLocation.md +133 -0
- package/docs/operations/provider.getEncounter.md +84 -1
- package/docs/operations/provider.getPatientRecord.md +516 -1
- package/docs/operations/provider.getPractitioner.md +92 -53
- package/docs/operations/provider.getPractitionerLocation.md +162 -0
- package/docs/operations/provider.listEncounters.md +84 -1
- package/docs/operations/provider.listPractitionerLocations.md +130 -0
- package/docs/operations/provider.register.md +25 -3
- package/docs/operations/provider.setPractitionerPortalRoles.md +271 -0
- package/docs/operations/provider.updateEncounterClinicalNote.md +84 -1
- package/docs/operations/provider.updateEncounterStatus.md +84 -1
- package/docs/operations/provider.updatePractitioner.md +256 -150
- package/docs/operations/provider.updatePractitionerLocation.md +233 -0
- package/docs/operations/provider.verifyPractitionerNpi.md +273 -0
- package/package.json +1 -1
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# ProviderLocationPatchRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderLocationPatchRequest`
|
|
4
|
+
|
|
5
|
+
Partial update of a practice location. Omitted fields are unchanged.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `accepts_new_patients` | `boolean|null` | No | | | | Yes | |
|
|
14
|
+
| `address` | [`ProviderLocationAddressRequest`](./ProviderLocationAddressRequest.md) | No | | | | Yes | |
|
|
15
|
+
| `hours` | `array|null` | No | | | | Yes | |
|
|
16
|
+
| `location_type` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `name` | `string|null` | No | | | | Yes | |
|
|
18
|
+
| `organization_name` | `string|null` | No | | | | Yes | |
|
|
19
|
+
| `organization_npi` | `string|null` | No | | | | Yes | Organization NPI (type 2), 10 digits. |
|
|
20
|
+
| `primary` | `boolean|null` | No | | | | Yes | |
|
|
21
|
+
| `status` | `string|null` | No | | | | Yes | |
|
|
22
|
+
| `telehealth` | `boolean|null` | No | | | | Yes | |
|
|
23
|
+
| `telephone` | `string|null` | No | | | | Yes | E.164 telephone number, e.g. +14155550184. |
|
|
24
|
+
| `tin` | `string|null` | No | | | | Yes | Write-only. Empty clears it. Omit to keep the stored value. |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# ProviderLocationRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderLocationRequest`
|
|
4
|
+
|
|
5
|
+
Create a practice location. Responses return the stored location, never the TIN.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `accepts_new_patients` | `boolean` | No | | | `true` | No | |
|
|
14
|
+
| `address` | [`ProviderLocationAddressRequest`](./ProviderLocationAddressRequest.md) | Yes | | | | No | |
|
|
15
|
+
| `hours` | array of [`ProviderLocationHoursRequest`](./ProviderLocationHoursRequest.md) | No | | | | No | |
|
|
16
|
+
| `location_type` | `string` | No | | office, clinic, hospital, telehealth, other | `"office"` | No | |
|
|
17
|
+
| `name` | `string` | Yes | | | | No | Site name, e.g. 'San Francisco office'. |
|
|
18
|
+
| `organization_name` | `string|null` | No | | | | Yes | Facility or organization name. |
|
|
19
|
+
| `organization_npi` | `string|null` | No | | | | Yes | Organization NPI (type 2), 10 digits. |
|
|
20
|
+
| `primary` | `boolean` | No | | | `false` | No | |
|
|
21
|
+
| `status` | `string` | No | | active, inactive | `"active"` | No | |
|
|
22
|
+
| `telehealth` | `boolean` | No | | | `false` | No | |
|
|
23
|
+
| `telephone` | `string|null` | No | | | | Yes | E.164 telephone number, e.g. +14155550184. |
|
|
24
|
+
| `tin` | `string|null` | No | | | | Yes | Tax identification number. Write-only. Empty clears it on update. Never returned; the response has tin_on_file. |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```json
|
|
29
|
+
{
|
|
30
|
+
"address": {
|
|
31
|
+
"city": "San Francisco",
|
|
32
|
+
"state": "CA",
|
|
33
|
+
"street": "220 Montgomery St",
|
|
34
|
+
"zip_code": "94104"
|
|
35
|
+
},
|
|
36
|
+
"hours": [
|
|
37
|
+
{
|
|
38
|
+
"close": "17:00",
|
|
39
|
+
"days": [
|
|
40
|
+
"mon",
|
|
41
|
+
"tue",
|
|
42
|
+
"wed",
|
|
43
|
+
"thu",
|
|
44
|
+
"fri"
|
|
45
|
+
],
|
|
46
|
+
"open": "08:00"
|
|
47
|
+
}
|
|
48
|
+
],
|
|
49
|
+
"location_type": "office",
|
|
50
|
+
"name": "San Francisco office",
|
|
51
|
+
"organization_name": "Chen Primary Care",
|
|
52
|
+
"organization_npi": "1234567890",
|
|
53
|
+
"primary": true,
|
|
54
|
+
"telephone": "+14155550184",
|
|
55
|
+
"tin": "12-3456789"
|
|
56
|
+
}
|
|
57
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ProviderOnboardingStatus
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderOnboardingStatus`
|
|
4
|
+
|
|
5
|
+
Onboarding progress. completed_at is set by the server on completion, never by the practitioner.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `completed_at` | `string|null` | No | | | | Yes | Server-set completion time. |
|
|
14
|
+
| `completed_steps` | `array` | No | | | | No | Step ids completed so far. |
|
|
15
|
+
| `flow` | `string|null` | No | | | | Yes | Onboarding flow. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# ProviderPatientRecordResources
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientRecordResources`
|
|
4
|
+
|
|
5
|
+
Typed sections of a provider-visible patient health record.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `allergies` | array of [`provider.Allergy`](./provider.Allergy.md) | No | | | | No | |
|
|
14
|
+
| `conditions` | array of [`provider.Problem`](./provider.Problem.md) | No | | | | No | |
|
|
15
|
+
| `consents` | array of [`provider.AdvanceDirective`](./provider.AdvanceDirective.md) | No | | | | No | |
|
|
16
|
+
| `diagnostics` | array of [`provider.LabObservation`](./provider.LabObservation.md) | No | | | | No | |
|
|
17
|
+
| `encounters` | array of [`provider.Encounter`](./provider.Encounter.md) | No | | | | No | |
|
|
18
|
+
| `family_history` | array of [`provider.FamilyHistoryEntry`](./provider.FamilyHistoryEntry.md) | No | | | | No | |
|
|
19
|
+
| `functional_status` | array of [`FunctionalStatus`](./FunctionalStatus.md) | No | | | | No | |
|
|
20
|
+
| `gyn_history` | array of [`provider.GynHistory`](./provider.GynHistory.md) | No | | | | No | |
|
|
21
|
+
| `immunizations` | array of [`provider.Immunization`](./provider.Immunization.md) | No | | | | No | |
|
|
22
|
+
| `intake_submissions` | array of [`PatientIntakeResponse`](./PatientIntakeResponse.md) | No | | | | No | |
|
|
23
|
+
| `medications` | array of [`provider.Medication`](./provider.Medication.md) | No | | | | No | |
|
|
24
|
+
| `perinatal_history` | array of [`provider.PerinatalHistory`](./provider.PerinatalHistory.md) | No | | | | No | |
|
|
25
|
+
| `procedures` | array of [`provider.Procedure`](./provider.Procedure.md) | No | | | | No | |
|
|
26
|
+
| `questionnaire_responses` | array of [`provider.QuestionnaireResponse`](./provider.QuestionnaireResponse.md) | No | | | | No | |
|
|
27
|
+
| `social_history` | array of [`SocialHistory`](./SocialHistory.md) | No | | | | No | |
|
|
28
|
+
| `vitals` | array of [`VitalsRecord`](./VitalsRecord.md) | No | | | | No | |
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
None declared in canonical OpenAPI.
|
|
@@ -16,7 +16,7 @@ Type: `object`
|
|
|
16
16
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
17
17
|
|---|---|---:|---|---|---|---:|---|
|
|
18
18
|
| `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
|
|
19
|
-
| `resources` | `
|
|
19
|
+
| `resources` | [`ProviderPatientRecordResources`](./ProviderPatientRecordResources.md) | Yes | | | | No | Health record sections. Each is a domain model, never a raw FHIR resource. Vitals is the latest-reading VitalsRecord summary per LOINC code. A section with a failed downstream fetch is an empty list, not an error. |
|
|
20
20
|
| `totals` | `object` | Yes | | | | No | Count of records per resource type key in `resources`. |
|
|
21
21
|
|
|
22
22
|
## Example
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ProviderPostgraduateTraining
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPostgraduateTraining`
|
|
4
|
+
|
|
5
|
+
Residency or fellowship training after medical school.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `end_year` | `integer|null` | No | | | | Yes | Year training ended, optional. |
|
|
14
|
+
| `id` | `string` | No | | | | No | Record identifier. |
|
|
15
|
+
| `institution` | `string` | Yes | | | | No | Training institution. |
|
|
16
|
+
| `specialty` | `string` | Yes | | | | No | Training specialty. |
|
|
17
|
+
| `start_year` | `integer|null` | No | | | | Yes | Year training started, optional. |
|
|
18
|
+
| `type` | `string` | Yes | | residency, fellowship | | No | Training type. |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ProviderProfessionalLiability
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderProfessionalLiability`
|
|
4
|
+
|
|
5
|
+
Professional liability (malpractice) coverage.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `carrier` | `string|null` | No | | | | Yes | Insurance carrier name. |
|
|
14
|
+
| `coverage_expiration` | `string|null` | No | | | | Yes | ISO 8601 expiration date. |
|
|
15
|
+
| `policy_number` | `string|null` | No | | | | Yes | Policy number. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -13,7 +13,7 @@ Type: `object`
|
|
|
13
13
|
| `board_certified` | `boolean` | No | | | `false` | No | True if the practitioner is board-certified in this specialty. |
|
|
14
14
|
| `code` | `string` | Yes | | | | No | NUCC taxonomy code or SNOMED code |
|
|
15
15
|
| `display` | `string` | Yes | | | | No | Human-readable specialty name. |
|
|
16
|
-
| `primary` | `boolean` | No | | | `
|
|
16
|
+
| `primary` | `boolean` | No | | | `false` | No | True if this is the practitioner's primary specialty. At most one. |
|
|
17
17
|
| `system` | `string` | No | | | `"http://nucc.org/provider-taxonomy"` | No | Coding system the code belongs to. Defaults to the NUCC provider taxonomy. |
|
|
18
18
|
|
|
19
19
|
## Example
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `ProviderStateLicense`
|
|
4
4
|
|
|
5
|
-
A state medical license held by this practitioner.
|
|
5
|
+
A state medical license held by this practitioner. Several are allowed.
|
|
6
6
|
|
|
7
7
|
Type: `object`
|
|
8
8
|
|
|
@@ -10,9 +10,16 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `compact` | `boolean` | No | | | `false` | No | True for a multistate compact license. |
|
|
13
14
|
| `expiration_date` | `string|null` | No | | | | Yes | ISO 8601 expiration date, optional. |
|
|
15
|
+
| `id` | `string` | No | | | | No | Record identifier. |
|
|
16
|
+
| `issued_date` | `string|null` | No | | | | Yes | ISO 8601 issue date, optional. |
|
|
14
17
|
| `license_number` | `string` | Yes | | | | No | The license number. |
|
|
15
|
-
| `
|
|
18
|
+
| `license_type` | `string|null` | No | | | | Yes | Discipline code, e.g. MD, DO, RN. |
|
|
19
|
+
| `primary` | `boolean` | No | | | `false` | No | True for the license the practitioner practices under primarily. |
|
|
20
|
+
| `state` | `string` | Yes | | | | No | Two-letter US state code. |
|
|
21
|
+
| `status` | `string` | No | | active, inactive, pending, expired | `"active"` | No | License status. |
|
|
22
|
+
| `verification` | [`LicenseVerification`](./LicenseVerification.md) | No | | | | No | |
|
|
16
23
|
|
|
17
24
|
## Example
|
|
18
25
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# SetPortalRolesRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `SetPortalRolesRequest`
|
|
4
|
+
|
|
5
|
+
Platform-admin request to replace a practitioner's provider-portal roles.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `portal_roles` | array of [`PortalRole`](./PortalRole.md) | Yes | | | | No | The complete new set of portal roles. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# SocialHistory
|
|
2
|
+
|
|
3
|
+
Model ID: `SocialHistory`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `alcohol` | [`AlcoholUse`](./AlcoholUse.md) | No | | | | No | |
|
|
14
|
+
| `contraception` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `diet_category` | [`DietCategory`](./DietCategory.md) | No | | | | Yes | |
|
|
16
|
+
| `diet_description` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `education` | [`EducationLevel`](./EducationLevel.md) | No | | | | Yes | |
|
|
18
|
+
| `employer` | `string|null` | No | | | | Yes | |
|
|
19
|
+
| `exercise_frequency` | [`ExerciseFrequency`](./ExerciseFrequency.md) | No | | | | Yes | |
|
|
20
|
+
| `exercise_minutes_per_week` | `integer|null` | No | | | | Yes | |
|
|
21
|
+
| `gender_identity` | [`GenderIdentity`](./GenderIdentity.md) | No | | | | Yes | |
|
|
22
|
+
| `living_situation` | [`LivingSituation`](./LivingSituation.md) | No | | | | Yes | |
|
|
23
|
+
| `notes` | `string|null` | No | | | | Yes | |
|
|
24
|
+
| `number_of_dependents` | `integer|null` | No | | | | Yes | |
|
|
25
|
+
| `occupation` | `string|null` | No | | | | Yes | |
|
|
26
|
+
| `occupational_exposures` | `array` | No | | | | No | |
|
|
27
|
+
| `sexual_orientation` | [`SexualOrientation`](./SexualOrientation.md) | No | | | | Yes | |
|
|
28
|
+
| `sexually_active` | `boolean|null` | No | | | | Yes | |
|
|
29
|
+
| `substances` | array of [`SubstanceUse`](./SubstanceUse.md) | No | | | | No | |
|
|
30
|
+
| `tobacco` | [`TobaccoUse`](./TobaccoUse.md) | No | | | | No | |
|
|
31
|
+
| `travel_history` | `array` | No | | | | No | |
|
|
32
|
+
|
|
33
|
+
## Example
|
|
34
|
+
|
|
35
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# SubstanceUse
|
|
2
|
+
|
|
3
|
+
Model ID: `SubstanceUse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `frequency` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `notes` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `quit_year` | `integer|null` | No | | | | Yes | |
|
|
16
|
+
| `route` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `start_year` | `integer|null` | No | | | | Yes | |
|
|
18
|
+
| `status` | [`SubstanceStatus`](./SubstanceStatus.md) | No | | | `"unknown"` | No | |
|
|
19
|
+
| `substance` | `string` | Yes | | | | No | |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TobaccoUse
|
|
2
|
+
|
|
3
|
+
Model ID: `TobaccoUse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `cessation_aids` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `cigarettes_per_day` | `integer|null` | No | | | | Yes | |
|
|
15
|
+
| `pack_years` | `number|null` | No | | | | Yes | |
|
|
16
|
+
| `quit_year` | `integer|null` | No | | | | Yes | |
|
|
17
|
+
| `start_year` | `integer|null` | No | | | | Yes | |
|
|
18
|
+
| `status` | [`SmokingStatus`](./SmokingStatus.md) | No | | | `"unknown"` | No | |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
None declared in canonical OpenAPI.
|
|
@@ -11,7 +11,7 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `ehr_status` | `string` | Yes | | updated, not_linked | | No | Whether a linked EHR encounter was updated too. |
|
|
14
|
-
| `encounter` | `
|
|
14
|
+
| `encounter` | [`ProviderEncounterRecord`](./ProviderEncounterRecord.md) | Yes | | | | No | The updated encounter. |
|
|
15
15
|
| `fhir_status` | `string` | Yes | | | | No | FHIR update completed. |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
@@ -11,7 +11,7 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `ehr_status` | `string` | Yes | | updated, not_linked, skipped | | No | Whether a linked EHR encounter was updated too. 'skipped' means the encounter is linked but this HealthCloud status has no flow-board equivalent, so only FHIR was updated. |
|
|
14
|
-
| `encounter` | `
|
|
14
|
+
| `encounter` | [`ProviderEncounterRecord`](./ProviderEncounterRecord.md) | Yes | | | | No | The updated encounter. |
|
|
15
15
|
| `fhir_status` | `string` | Yes | | | | No | FHIR update completed. |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
@@ -27,6 +27,7 @@ Type: `object`
|
|
|
27
27
|
| `birth_date` | `string|null` | No | | | | Yes | ISO 8601 date of birth (YYYY-MM-DD). |
|
|
28
28
|
| `board_certifications` | `array|null` | No | | | | Yes | Board certification names. Replaces the existing list. |
|
|
29
29
|
| `credential` | `string|null` | No | | | | Yes | MD, DO, NP, PA, RN, etc. |
|
|
30
|
+
| `credentials` | `array|null` | No | | | | Yes | Professional credentials (HL7 v2-0360). At most one primary. Replaces the existing list. |
|
|
30
31
|
| `department` | `string|null` | No | | | | Yes | Department within the organization. |
|
|
31
32
|
| `education_credentials` | `array|null` | No | | | | Yes | Degrees and education credentials. Replaces the existing list. |
|
|
32
33
|
| `email` | `string|null` | No | | | | Yes | Email address. |
|
|
@@ -41,9 +42,13 @@ Type: `object`
|
|
|
41
42
|
| `middle_name` | `string|null` | No | | | | Yes | Middle name. |
|
|
42
43
|
| `notes` | `string|null` | No | | | | Yes | Free-text internal notes. |
|
|
43
44
|
| `npi` | `string|null` | No | | | | Yes | 10-digit National Provider Identifier. |
|
|
45
|
+
| `onboarding` | [`OnboardingProgressRequest`](./OnboardingProgressRequest.md) | No | | | | Yes | Onboarding progress: flow and completed step ids. Completion is recorded by the server. |
|
|
44
46
|
| `organization_id` | `string|null` | No | | | | Yes | Identifier of the affiliated organization. |
|
|
45
47
|
| `organization_name` | `string|null` | No | | | | Yes | Display name of the affiliated organization. |
|
|
48
|
+
| `postgraduate_training` | `array|null` | No | | | | Yes | Residency and fellowship training. Replaces the existing list. |
|
|
46
49
|
| `prefix` | `string|null` | No | | | | Yes | Name prefix, e.g. 'Dr.'. |
|
|
50
|
+
| `professional_display_name` | `string|null` | No | | | | Yes | Patient-facing name, e.g. 'Dr. Elena Chen'. |
|
|
51
|
+
| `professional_liability` | [`ProviderProfessionalLiability`](./ProviderProfessionalLiability.md) | No | | | | Yes | Professional liability coverage. Replaces the existing value. |
|
|
47
52
|
| `race` | `array|null` | No | | | | Yes | One or more race values. Replaces the existing list. |
|
|
48
53
|
| `roles` | `array|null` | No | | | | Yes | NUCC provider taxonomy categories. Replaces the existing list. |
|
|
49
54
|
| `specialty` | `array|null` | No | | | | Yes | Clinical specialties. Replaces the existing list. Sent as 'specialty', not 'specialties'. |
|
|
@@ -17,10 +17,10 @@ Type: `object`
|
|
|
17
17
|
| `birth_date` | `string|null` | No | | | | Yes | ISO 8601 date of birth, optional. |
|
|
18
18
|
| `board_certifications` | `array` | No | | | | No | Board certification names, optional. |
|
|
19
19
|
| `credential` | `string|null` | No | | | | Yes | MD, DO, NP, PA, RN, etc. |
|
|
20
|
+
| `credentials` | array of [`ProviderCredential`](./ProviderCredential.md) | No | | | | No | Professional credentials. At most one primary. |
|
|
20
21
|
| `department` | `string|null` | No | | | | Yes | Department within the organization, optional. |
|
|
21
22
|
| `education_credentials` | array of [`ProviderEducationCredential`](./ProviderEducationCredential.md) | No | | | | No | Degrees and education credentials held by this practitioner. |
|
|
22
23
|
| `email` | `string|null` | No | | | | Yes | Email address, optional. |
|
|
23
|
-
| `fhir_id` | `string|null` | No | | | | Yes | FHIR Practitioner resource ID; set once the record has been persisted. |
|
|
24
24
|
| `first_name` | `string` | Yes | | | | No | Given name. |
|
|
25
25
|
| `gender` | [`ProviderGender`](./ProviderGender.md) | No | | | `"unknown"` | No | Administrative gender. |
|
|
26
26
|
| `graduation_year` | `integer|null` | No | | | | Yes | Graduation year, optional. |
|
|
@@ -32,10 +32,16 @@ Type: `object`
|
|
|
32
32
|
| `middle_name` | `string|null` | No | | | | Yes | Middle name, optional. |
|
|
33
33
|
| `notes` | `string|null` | No | | | | Yes | Free-text internal notes, optional. |
|
|
34
34
|
| `npi` | `string|null` | No | | | | Yes | 10-digit NPI |
|
|
35
|
+
| `npi_verification` | [`NpiVerification`](./NpiVerification.md) | No | | | | No | NPI registry check. Server-written. |
|
|
36
|
+
| `onboarding` | [`ProviderOnboardingStatus`](./ProviderOnboardingStatus.md) | No | | | | No | Onboarding progress. |
|
|
35
37
|
| `organization_id` | `string|null` | No | | | | Yes | Identifier of the affiliated organization, optional. |
|
|
36
38
|
| `organization_name` | `string|null` | No | | | | Yes | Display name of the affiliated organization, optional. |
|
|
37
|
-
| `
|
|
39
|
+
| `portal_roles` | array of [`PortalRole`](./PortalRole.md) | No | | | | No | Provider-portal access roles, assigned by the platform. Not writable through profile updates. |
|
|
40
|
+
| `postgraduate_training` | array of [`ProviderPostgraduateTraining`](./ProviderPostgraduateTraining.md) | No | | | | No | Residency and fellowship training. |
|
|
41
|
+
| `practitioner_id` | `string` | No | | | | No | Practitioner identifier used in API paths. Equals the stored resource id once persisted. |
|
|
38
42
|
| `prefix` | `string|null` | No | | | | Yes | Name prefix, e.g. 'Dr.'. |
|
|
43
|
+
| `professional_display_name` | `string|null` | No | | | | Yes | Patient-facing name, e.g. 'Dr. Elena Chen'. |
|
|
44
|
+
| `professional_liability` | [`ProviderProfessionalLiability`](./ProviderProfessionalLiability.md) | No | | | | Yes | Professional liability coverage. |
|
|
39
45
|
| `race` | array of [`Race`](./Race.md) | No | | | | No | One or more race values, optional. |
|
|
40
46
|
| `roles` | array of [`ProviderRole`](./ProviderRole.md) | No | | | | No | NUCC provider taxonomy high-level categories this practitioner practices under. |
|
|
41
47
|
| `specialty` | array of [`ProviderSpecialty`](./ProviderSpecialty.md) | No | | | | No | Clinical specialties, coded to a taxonomy system (NUCC by default). Sent/received on the wire as 'specialty'. |
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# VitalsRecord
|
|
2
|
+
|
|
3
|
+
Model ID: `VitalsRecord`
|
|
4
|
+
|
|
5
|
+
A set of vitals for one patient, at one point in time. Each populated
|
|
6
|
+
field becomes a separate FHIR Observation on submission — this is a
|
|
7
|
+
convenience envelope, not a single FHIR resource. Shared by the Vitals
|
|
8
|
+
API and the FieldAgent onboarding workflow (fieldagent.onboardPatient).
|
|
9
|
+
|
|
10
|
+
Type: `object`
|
|
11
|
+
|
|
12
|
+
## Fields
|
|
13
|
+
|
|
14
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
15
|
+
|---|---|---:|---|---|---|---:|---|
|
|
16
|
+
| `activity` | [`ActivitySummary`](./ActivitySummary.md) | No | | | | Yes | Daily activity totals, optional. |
|
|
17
|
+
| `blood_pressure` | [`provider.BloodPressure`](./provider.BloodPressure.md) | No | | | | Yes | Blood pressure reading, optional. |
|
|
18
|
+
| `device` | [`MeasurementDevice`](./MeasurementDevice.md) | No | | | | Yes | Device used to take the measurement(s), optional. |
|
|
19
|
+
| `effective_date` | `string|null` | No | | | | Yes | ISO 8601 date the vitals were captured, when time-of-day is not tracked. |
|
|
20
|
+
| `effective_datetime` | `string|null` | No | | | | Yes | ISO 8601 datetime the vitals were captured, optional. |
|
|
21
|
+
| `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter ID these vitals were captured during, optional. |
|
|
22
|
+
| `glucose` | [`GlucoseReading`](./GlucoseReading.md) | No | | | | Yes | Blood glucose reading, optional. |
|
|
23
|
+
| `head_circumference` | [`HeadCircumference`](./HeadCircumference.md) | No | | | | Yes | Head circumference reading, optional. |
|
|
24
|
+
| `heart_rate` | [`provider.HeartRate`](./provider.HeartRate.md) | No | | | | Yes | Heart rate reading, optional. |
|
|
25
|
+
| `height` | [`BodyHeight`](./BodyHeight.md) | No | | | | Yes | Body height reading, optional. |
|
|
26
|
+
| `iop` | [`IntraocularPressure`](./IntraocularPressure.md) | No | | | | Yes | Intraocular pressure reading, optional. |
|
|
27
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text notes, optional. |
|
|
28
|
+
| `pain` | [`PainScore`](./PainScore.md) | No | | | | Yes | Pain assessment, optional. |
|
|
29
|
+
| `patient_id` | `string` | Yes | uuid | | | No | Patient this record belongs to. |
|
|
30
|
+
| `peak_flow` | [`PeakFlowReading`](./PeakFlowReading.md) | No | | | | Yes | Peak expiratory flow reading, optional. |
|
|
31
|
+
| `practitioner_name` | `string|null` | No | | | | Yes | Name of the practitioner who captured the vitals, optional. |
|
|
32
|
+
| `pulse_oximetry` | [`provider.PulseOximetry`](./provider.PulseOximetry.md) | No | | | | Yes | SpO2 reading, optional. |
|
|
33
|
+
| `respiratory_rate` | [`RespiratoryRate`](./RespiratoryRate.md) | No | | | | Yes | Respiratory rate reading, optional. |
|
|
34
|
+
| `status` | [`VitalsStatus`](./VitalsStatus.md) | No | | | `"final"` | No | Observation lifecycle status applied to every Observation generated from this record. |
|
|
35
|
+
| `temperature` | [`BodyTemperature`](./BodyTemperature.md) | No | | | | Yes | Body temperature reading, optional. |
|
|
36
|
+
| `vitals_id` | `string` | No | uuid | | | No | Internal identifier for this set of readings. |
|
|
37
|
+
| `weight` | [`BodyWeight`](./BodyWeight.md) | No | | | | Yes | Body weight reading, optional. |
|
|
38
|
+
|
|
39
|
+
## Example
|
|
40
|
+
|
|
41
|
+
None declared in canonical OpenAPI.
|
|
@@ -10,6 +10,7 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `code` | `string|null` | No | | | | Yes | Machine-readable booking coordination error code, when applicable. |
|
|
13
14
|
| `error` | `string` | Yes | | | | No | Human-readable explanation of why the request failed. |
|
|
14
15
|
| `outcome` | `object|null` | No | | | | Yes | Downstream FHIR OperationOutcome payload, when the failure originated in FHIR. |
|
|
15
16
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Coding
|
|
2
|
+
|
|
3
|
+
Model ID: `diagnostics.Coding`
|
|
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` | `string|null` | No | | | | Yes | Code within the system. |
|
|
14
|
+
| `display` | `string|null` | No | | | | Yes | Human-readable label. |
|
|
15
|
+
| `system` | `string|null` | No | | | | Yes | Code system URI. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -19,7 +19,7 @@ Type: `object`
|
|
|
19
19
|
| `reference_range` | [`diagnostics.ReferenceRange`](./diagnostics.ReferenceRange.md) | No | | | | Yes | The normal/expected range for this result, optional. |
|
|
20
20
|
| `status` | [`ObservationStatus`](./ObservationStatus.md) | No | | | `"final"` | No | Observation lifecycle status. |
|
|
21
21
|
| `value_boolean` | `boolean|null` | No | | | | Yes | Boolean result value, when applicable. |
|
|
22
|
-
| `value_coding` | `
|
|
22
|
+
| `value_coding` | [`diagnostics.Coding`](./diagnostics.Coding.md) | No | | | | Yes | Coded result value, when applicable. |
|
|
23
23
|
| `value_quantity` | `number|null` | No | | | | Yes | Numeric result value, when the result is quantitative. Requires value_unit. |
|
|
24
24
|
| `value_string` | `string|null` | No | | | | Yes | Free-text result value, when the result is not quantitative. |
|
|
25
25
|
| `value_unit` | `string|null` | No | | | | Yes | Unit of measure for value_quantity, optional. |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Coding
|
|
2
|
+
|
|
3
|
+
Model ID: `ehr.Coding`
|
|
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` | `string|null` | No | | | `null` | Yes | Code within the system. |
|
|
14
|
+
| `display` | `string|null` | No | | | `null` | Yes | Human-readable label. |
|
|
15
|
+
| `system` | `string|null` | No | | | `null` | Yes | Code system URI. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Quantity
|
|
2
|
+
|
|
3
|
+
Model ID: `ehr.Quantity`
|
|
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` | `string|null` | No | | | `null` | Yes | Unit code within the system. |
|
|
14
|
+
| `system` | `string|null` | No | | | `null` | Yes | Unit code system URI. |
|
|
15
|
+
| `unit` | `string|null` | No | | | `null` | Yes | Unit of measure, for display. |
|
|
16
|
+
| `value` | `number|null` | No | | | `null` | Yes | Numeric value. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|