@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.
Files changed (129) hide show
  1. package/dist/index.cjs +37 -0
  2. package/dist/index.d.cts +9261 -2031
  3. package/dist/index.d.ts +9261 -2031
  4. package/dist/index.js +37 -0
  5. package/docs/clients/ProviderClient.md +8 -0
  6. package/docs/docs-manifest.json +90 -12
  7. package/docs/examples/index.md +8 -0
  8. package/docs/index.md +8 -0
  9. package/docs/models/AlcoholFrequency.md +15 -0
  10. package/docs/models/AlcoholUse.md +20 -0
  11. package/docs/models/BodyHeight.md +17 -0
  12. package/docs/models/BodyTemperature.md +18 -0
  13. package/docs/models/BodyWeight.md +18 -0
  14. package/docs/models/BookAppointmentRequest.md +2 -0
  15. package/docs/models/DietCategory.md +19 -0
  16. package/docs/models/EducationLevel.md +15 -0
  17. package/docs/models/ExerciseFrequency.md +15 -0
  18. package/docs/models/FunctionalLevel.md +15 -0
  19. package/docs/models/FunctionalStatus.md +40 -0
  20. package/docs/models/GetPractitionerResponse.md +8 -2
  21. package/docs/models/LicenseVerification.md +19 -0
  22. package/docs/models/ListAllergiesResponse.md +1 -1
  23. package/docs/models/ListConditionsResponse.md +1 -1
  24. package/docs/models/ListDirectivesResponse.md +1 -1
  25. package/docs/models/ListFamilyHistoryResponse.md +1 -1
  26. package/docs/models/ListImmunizationsResponse.md +1 -1
  27. package/docs/models/ListProceduresResponse.md +1 -1
  28. package/docs/models/ListQuestionnaireResponsesResponse.md +1 -1
  29. package/docs/models/LivingSituation.md +15 -0
  30. package/docs/models/LocationAddress.md +21 -0
  31. package/docs/models/LocationHours.md +19 -0
  32. package/docs/models/NpiVerification.md +21 -0
  33. package/docs/models/OnboardingProgressRequest.md +18 -0
  34. package/docs/models/PortalRole.md +18 -0
  35. package/docs/models/Practitioner.md +9 -2
  36. package/docs/models/ProviderCredential.md +19 -0
  37. package/docs/models/ProviderEducationCredential.md +6 -2
  38. package/docs/models/ProviderEncounterListResponse.md +1 -1
  39. package/docs/models/ProviderEncounterRecord.md +49 -0
  40. package/docs/models/ProviderEncounterResponse.md +1 -1
  41. package/docs/models/ProviderLanguage.md +3 -2
  42. package/docs/models/ProviderLocation.md +63 -0
  43. package/docs/models/ProviderLocationAddressRequest.md +21 -0
  44. package/docs/models/ProviderLocationDeletedResponse.md +18 -0
  45. package/docs/models/ProviderLocationHoursRequest.md +19 -0
  46. package/docs/models/ProviderLocationListResponse.md +18 -0
  47. package/docs/models/ProviderLocationPatchRequest.md +28 -0
  48. package/docs/models/ProviderLocationRequest.md +57 -0
  49. package/docs/models/ProviderOnboardingStatus.md +19 -0
  50. package/docs/models/ProviderPatientRecordResources.md +32 -0
  51. package/docs/models/ProviderPatientRecordResponse.md +1 -1
  52. package/docs/models/ProviderPostgraduateTraining.md +22 -0
  53. package/docs/models/ProviderProfessionalLiability.md +19 -0
  54. package/docs/models/ProviderSpecialty.md +1 -1
  55. package/docs/models/ProviderStateLicense.md +9 -2
  56. package/docs/models/SetPortalRolesRequest.md +17 -0
  57. package/docs/models/SexualOrientation.md +15 -0
  58. package/docs/models/SmokingStatus.md +15 -0
  59. package/docs/models/SocialHistory.md +35 -0
  60. package/docs/models/SubstanceStatus.md +15 -0
  61. package/docs/models/SubstanceUse.md +23 -0
  62. package/docs/models/TobaccoUse.md +22 -0
  63. package/docs/models/UpdateEncounterClinicalNoteResponse.md +1 -1
  64. package/docs/models/UpdateEncounterStatusResponse.md +1 -1
  65. package/docs/models/UpdatePractitionerRequest.md +5 -0
  66. package/docs/models/UpdatePractitionerResponse.md +8 -2
  67. package/docs/models/VitalsRecord.md +41 -0
  68. package/docs/models/appointments.ErrorResponse.md +1 -0
  69. package/docs/models/diagnostics.Coding.md +19 -0
  70. package/docs/models/diagnostics.LabObservation.md +1 -1
  71. package/docs/models/{AdvanceDirective.md → ehr.AdvanceDirective.md} +1 -1
  72. package/docs/models/{Allergy.md → ehr.Allergy.md} +1 -1
  73. package/docs/models/ehr.Coding.md +19 -0
  74. package/docs/models/{FamilyHistoryEntry.md → ehr.FamilyHistoryEntry.md} +1 -1
  75. package/docs/models/{Immunization.md → ehr.Immunization.md} +1 -1
  76. package/docs/models/{Problem.md → ehr.Problem.md} +1 -1
  77. package/docs/models/{Procedure.md → ehr.Procedure.md} +1 -1
  78. package/docs/models/ehr.Quantity.md +20 -0
  79. package/docs/models/{QuestionnaireResponse.md → ehr.QuestionnaireResponse.md} +2 -2
  80. package/docs/models/{ResponseAnswer.md → ehr.ResponseAnswer.md} +4 -4
  81. package/docs/models/{ResponseItem.md → ehr.ResponseItem.md} +3 -3
  82. package/docs/models/index.md +79 -9
  83. package/docs/models/provider.AdvanceDirective.md +31 -0
  84. package/docs/models/provider.Allergy.md +31 -0
  85. package/docs/models/provider.AllergyReaction.md +21 -0
  86. package/docs/models/provider.BloodPressure.md +20 -0
  87. package/docs/models/provider.CodedConcept.md +19 -0
  88. package/docs/models/provider.Coding.md +19 -0
  89. package/docs/models/provider.Dosage.md +24 -0
  90. package/docs/models/provider.Encounter.md +48 -0
  91. package/docs/models/provider.EncounterDiagnosis.md +20 -0
  92. package/docs/models/provider.EncounterHospitalization.md +22 -0
  93. package/docs/models/provider.EncounterLocation.md +21 -0
  94. package/docs/models/provider.EncounterParticipant.md +21 -0
  95. package/docs/models/provider.FamilyCondition.md +22 -0
  96. package/docs/models/provider.FamilyHistoryEntry.md +30 -0
  97. package/docs/models/provider.GynHistory.md +25 -0
  98. package/docs/models/provider.HeartRate.md +18 -0
  99. package/docs/models/provider.Immunization.md +40 -0
  100. package/docs/models/provider.ImmunizationReaction.md +20 -0
  101. package/docs/models/provider.LabObservation.md +29 -0
  102. package/docs/models/provider.Medication.md +41 -0
  103. package/docs/models/provider.PerinatalHistory.md +25 -0
  104. package/docs/models/provider.Problem.md +37 -0
  105. package/docs/models/provider.Procedure.md +37 -0
  106. package/docs/models/provider.PulseOximetry.md +20 -0
  107. package/docs/models/provider.Quantity.md +20 -0
  108. package/docs/models/provider.QuestionnaireResponse.md +27 -0
  109. package/docs/models/provider.ReferenceRange.md +20 -0
  110. package/docs/models/provider.ResponseAnswer.md +27 -0
  111. package/docs/models/provider.ResponseItem.md +21 -0
  112. package/docs/operations/appointments.book.md +34 -1
  113. package/docs/operations/provider.completePractitionerOnboarding.md +264 -0
  114. package/docs/operations/provider.createPractitionerLocation.md +221 -0
  115. package/docs/operations/provider.deletePractitionerLocation.md +133 -0
  116. package/docs/operations/provider.getEncounter.md +84 -1
  117. package/docs/operations/provider.getPatientRecord.md +516 -1
  118. package/docs/operations/provider.getPractitioner.md +92 -53
  119. package/docs/operations/provider.getPractitionerLocation.md +162 -0
  120. package/docs/operations/provider.listEncounters.md +84 -1
  121. package/docs/operations/provider.listPractitionerLocations.md +130 -0
  122. package/docs/operations/provider.register.md +25 -3
  123. package/docs/operations/provider.setPractitionerPortalRoles.md +271 -0
  124. package/docs/operations/provider.updateEncounterClinicalNote.md +84 -1
  125. package/docs/operations/provider.updateEncounterStatus.md +84 -1
  126. package/docs/operations/provider.updatePractitioner.md +256 -150
  127. package/docs/operations/provider.updatePractitionerLocation.md +233 -0
  128. package/docs/operations/provider.verifyPractitionerNpi.md +273 -0
  129. package/package.json +1 -1
@@ -0,0 +1,15 @@
1
+ # FunctionalLevel
2
+
3
+ Model ID: `FunctionalLevel`
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,40 @@
1
+ # FunctionalStatus
2
+
3
+ Model ID: `FunctionalStatus`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `ambulation` | `string|null` | No | | | | Yes | |
14
+ | `assessed_by` | `string|null` | No | | | | Yes | |
15
+ | `assessed_date` | `string|null` | No | | | | Yes | |
16
+ | `assistive_devices` | `array` | No | | | | No | |
17
+ | `bathing` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
18
+ | `cognitive_status` | `string|null` | No | | | | Yes | |
19
+ | `continence` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
20
+ | `dressing` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
21
+ | `fall_count_past_year` | `integer|null` | No | | | | Yes | |
22
+ | `fall_risk` | `string|null` | No | | | | Yes | |
23
+ | `feeding` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
24
+ | `financial_management` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
25
+ | `housekeeping` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
26
+ | `laundry` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
27
+ | `meal_preparation` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
28
+ | `medication_management` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
29
+ | `mmse_score` | `integer|null` | No | | | | Yes | |
30
+ | `moca_score` | `integer|null` | No | | | | Yes | |
31
+ | `notes` | `string|null` | No | | | | Yes | |
32
+ | `shopping` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
33
+ | `telephone_use` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
34
+ | `toileting` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
35
+ | `transferring` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
36
+ | `transportation` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
37
+
38
+ ## Example
39
+
40
+ None declared in canonical OpenAPI.
@@ -16,10 +16,10 @@ Type: `object`
16
16
  | `birth_date` | `string|null` | No | | | | Yes | ISO 8601 date of birth, optional. |
17
17
  | `board_certifications` | `array` | No | | | | No | Board certification names, optional. |
18
18
  | `credential` | `string|null` | No | | | | Yes | MD, DO, NP, PA, RN, etc. |
19
+ | `credentials` | array of [`ProviderCredential`](./ProviderCredential.md) | No | | | | No | Professional credentials. At most one primary. |
19
20
  | `department` | `string|null` | No | | | | Yes | Department within the organization, optional. |
20
21
  | `education_credentials` | array of [`ProviderEducationCredential`](./ProviderEducationCredential.md) | No | | | | No | Degrees and education credentials held by this practitioner. |
21
22
  | `email` | `string|null` | No | | | | Yes | Email address, optional. |
22
- | `fhir_id` | `string|null` | No | | | | Yes | FHIR Practitioner resource ID; set once the record has been persisted. |
23
23
  | `first_name` | `string` | Yes | | | | No | Given name. |
24
24
  | `gender` | [`ProviderGender`](./ProviderGender.md) | No | | | `"unknown"` | No | Administrative gender. |
25
25
  | `graduation_year` | `integer|null` | No | | | | Yes | Graduation year, optional. |
@@ -31,11 +31,17 @@ Type: `object`
31
31
  | `middle_name` | `string|null` | No | | | | Yes | Middle name, optional. |
32
32
  | `notes` | `string|null` | No | | | | Yes | Free-text internal notes, optional. |
33
33
  | `npi` | `string|null` | No | | | | Yes | 10-digit NPI |
34
+ | `npi_verification` | [`NpiVerification`](./NpiVerification.md) | No | | | | No | NPI registry check. Server-written. |
35
+ | `onboarding` | [`ProviderOnboardingStatus`](./ProviderOnboardingStatus.md) | No | | | | No | Onboarding progress. |
34
36
  | `organization_id` | `string|null` | No | | | | Yes | Identifier of the affiliated organization, optional. |
35
37
  | `organization_name` | `string|null` | No | | | | Yes | Display name of the affiliated organization, optional. |
36
38
  | `photo_binary_id` | `string|null` | No | | | | Yes | FHIR Binary resource ID of this practitioner's stored photo, when one has been uploaded via provider.uploadPhoto. Pass to provider.getPhoto as ?binary_id=, or omit it there — it is auto-discovered. |
37
- | `practitioner_id` | `string` | No | uuid | | | No | Internal identifier generated at construction time; the FHIR resource id (fhir_id) is the one used on the wire as {practitioner_id}. |
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,19 @@
1
+ # LicenseVerification
2
+
3
+ Model ID: `LicenseVerification`
4
+
5
+ How a license was verified. Stays self-attested until a state-board check records otherwise.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `source` | `string|null` | No | | | | Yes | Verification source, e.g. a state board. |
14
+ | `status` | `string` | No | | self-attested, verified, failed | `"self-attested"` | No | Verification state. |
15
+ | `verified_at` | `string|null` | No | | | | Yes | When the verification was recorded. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -10,7 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `allergies` | array of [`Allergy`](./Allergy.md) | Yes | | | | No | |
13
+ | `allergies` | array of [`ehr.Allergy`](./ehr.Allergy.md) | Yes | | | | No | |
14
14
  | `patient_id` | `string` | Yes | | | | No | |
15
15
  | `total` | `integer` | Yes | | | | No | |
16
16
 
@@ -10,7 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `conditions` | array of [`Problem`](./Problem.md) | Yes | | | | No | |
13
+ | `conditions` | array of [`ehr.Problem`](./ehr.Problem.md) | Yes | | | | No | |
14
14
  | `patient_id` | `string` | Yes | | | | No | |
15
15
  | `total` | `integer` | Yes | | | | No | |
16
16
 
@@ -10,7 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `directives` | array of [`AdvanceDirective`](./AdvanceDirective.md) | Yes | | | | No | |
13
+ | `directives` | array of [`ehr.AdvanceDirective`](./ehr.AdvanceDirective.md) | Yes | | | | No | |
14
14
  | `patient_id` | `string` | Yes | | | | No | |
15
15
  | `total` | `integer` | Yes | | | | No | |
16
16
 
@@ -10,7 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `family_history` | array of [`FamilyHistoryEntry`](./FamilyHistoryEntry.md) | Yes | | | | No | |
13
+ | `family_history` | array of [`ehr.FamilyHistoryEntry`](./ehr.FamilyHistoryEntry.md) | Yes | | | | No | |
14
14
  | `patient_id` | `string` | Yes | | | | No | |
15
15
  | `total` | `integer` | Yes | | | | No | |
16
16
 
@@ -10,7 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `immunizations` | array of [`Immunization`](./Immunization.md) | Yes | | | | No | |
13
+ | `immunizations` | array of [`ehr.Immunization`](./ehr.Immunization.md) | Yes | | | | No | |
14
14
  | `patient_id` | `string` | Yes | | | | No | |
15
15
  | `total` | `integer` | Yes | | | | No | |
16
16
 
@@ -11,7 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `patient_id` | `string` | Yes | | | | No | |
14
- | `procedures` | array of [`Procedure`](./Procedure.md) | Yes | | | | No | |
14
+ | `procedures` | array of [`ehr.Procedure`](./ehr.Procedure.md) | Yes | | | | No | |
15
15
  | `total` | `integer` | Yes | | | | No | |
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
  | `patient_id` | `string` | Yes | | | | No | |
14
- | `questionnaire_responses` | array of [`QuestionnaireResponse`](./QuestionnaireResponse.md) | Yes | | | | No | |
14
+ | `questionnaire_responses` | array of [`ehr.QuestionnaireResponse`](./ehr.QuestionnaireResponse.md) | Yes | | | | No | |
15
15
  | `total` | `integer` | Yes | | | | No | |
16
16
 
17
17
  ## Example
@@ -0,0 +1,15 @@
1
+ # LivingSituation
2
+
3
+ Model ID: `LivingSituation`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # LocationAddress
2
+
3
+ Model ID: `LocationAddress`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `city` | `string` | Yes | | | | No | |
14
+ | `state` | `string` | Yes | | | | No | Two-letter US state code. |
15
+ | `street` | `string` | Yes | | | | No | Street address. |
16
+ | `suite` | `string|null` | No | | | | Yes | Suite or unit, optional. |
17
+ | `zip_code` | `string` | Yes | | | | No | US ZIP code. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # LocationHours
2
+
3
+ Model ID: `LocationHours`
4
+
5
+ Opening hours for one or more weekdays. Times are 24-hour HH:MM.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `close` | `string` | Yes | | | | No | Closing time, HH:MM. |
14
+ | `days` | `array` | Yes | | | | No | Weekdays this entry applies to. |
15
+ | `open` | `string` | Yes | | | | No | Opening time, HH:MM. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # NpiVerification
2
+
3
+ Model ID: `NpiVerification`
4
+
5
+ NPI check against the NPPES registry. Written only by the server.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `registry_first_name` | `string|null` | No | | | | Yes | First name in the registry record. |
14
+ | `registry_last_name` | `string|null` | No | | | | Yes | Last name in the registry record. |
15
+ | `source` | `string|null` | No | | | | Yes | Registry used, e.g. nppes. |
16
+ | `status` | `string` | No | | unverified, matched, not-found, name-mismatch, error | `"unverified"` | No | Result. |
17
+ | `verified_at` | `string|null` | No | | | | Yes | When the check ran. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # OnboardingProgressRequest
2
+
3
+ Model ID: `OnboardingProgressRequest`
4
+
5
+ Onboarding progress the practitioner may write. Completion time is set by the server.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `completed_steps` | `array` | No | | | | No | Step ids completed so far. |
14
+ | `flow` | `string|null` | No | | | | Yes | Onboarding flow. |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # PortalRole
2
+
3
+ Model ID: `PortalRole`
4
+
5
+ Provider-portal access role. Separate from the NUCC clinical ProviderRole.
6
+
7
+ Stored as a FHIR extension on the Practitioner. Assigned by the platform,
8
+ never by the practitioner (see hc/services/practitioner/access.py).
9
+
10
+ Type: `string`
11
+
12
+ ## Fields
13
+
14
+ No fields.
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -15,10 +15,11 @@ Type: `object`
15
15
  | `birth_date` | `string|null` | No | | | `null` | Yes | ISO 8601 date of birth, optional. |
16
16
  | `board_certifications` | `array` | No | | | | No | Board certification names, optional. |
17
17
  | `credential` | `string|null` | No | | | `null` | Yes | MD, DO, NP, PA, RN, etc. |
18
+ | `credentials` | array of [`ProviderCredential`](./ProviderCredential.md) | No | | | | No | Professional credentials. At most one primary. |
18
19
  | `department` | `string|null` | No | | | `null` | Yes | Department within the organization, optional. |
19
20
  | `education_credentials` | array of [`ProviderEducationCredential`](./ProviderEducationCredential.md) | No | | | | No | Degrees and education credentials held by this practitioner. |
20
21
  | `email` | `string|null` | No | | | `null` | Yes | Email address, optional. |
21
- | `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR Practitioner resource ID; set once the record has been persisted. |
22
+ | `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR Practitioner resource ID; set once the record has been persisted. Not serialized. |
22
23
  | `first_name` | `string` | Yes | | | | No | Given name. |
23
24
  | `gender` | [`ProviderGender`](./ProviderGender.md) | No | | | `"unknown"` | No | Administrative gender. |
24
25
  | `graduation_year` | `integer|null` | No | | | `null` | Yes | Graduation year, optional. |
@@ -30,10 +31,16 @@ Type: `object`
30
31
  | `middle_name` | `string|null` | No | | | `null` | Yes | Middle name, optional. |
31
32
  | `notes` | `string|null` | No | | | `null` | Yes | Free-text internal notes, optional. |
32
33
  | `npi` | `string|null` | No | | | `null` | Yes | 10-digit NPI |
34
+ | `npi_verification` | [`NpiVerification`](./NpiVerification.md) | No | | | | No | NPI registry check. Server-written. |
35
+ | `onboarding` | [`ProviderOnboardingStatus`](./ProviderOnboardingStatus.md) | No | | | | No | Onboarding progress. |
33
36
  | `organization_id` | `string|null` | No | | | `null` | Yes | Identifier of the affiliated organization, optional. |
34
37
  | `organization_name` | `string|null` | No | | | `null` | Yes | Display name of the affiliated organization, optional. |
35
- | `practitioner_id` | `string` | No | uuid | | | No | Internal identifier generated at construction time; the FHIR resource id (fhir_id) is the one used on the wire as {practitioner_id}. |
38
+ | `portal_roles` | array of [`PortalRole`](./PortalRole.md) | No | | | | No | Provider-portal access roles, assigned by the platform. Not writable through profile updates. |
39
+ | `postgraduate_training` | array of [`ProviderPostgraduateTraining`](./ProviderPostgraduateTraining.md) | No | | | | No | Residency and fellowship training. |
40
+ | `practitioner_id` | `string` | No | | | | No | Practitioner identifier used in API paths. Equals the stored resource id once persisted. |
36
41
  | `prefix` | `string|null` | No | | | `null` | Yes | Name prefix, e.g. 'Dr.'. |
42
+ | `professional_display_name` | `string|null` | No | | | `null` | Yes | Patient-facing name, e.g. 'Dr. Elena Chen'. |
43
+ | `professional_liability` | [`ProviderProfessionalLiability`](./ProviderProfessionalLiability.md) | No | | | `null` | Yes | Professional liability coverage. |
37
44
  | `race` | array of [`Race`](./Race.md) | No | | | | No | One or more race values, optional. |
38
45
  | `roles` | array of [`ProviderRole`](./ProviderRole.md) | No | | | | No | NUCC provider taxonomy high-level categories this practitioner practices under. |
39
46
  | `specialties` | 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,19 @@
1
+ # ProviderCredential
2
+
3
+ Model ID: `ProviderCredential`
4
+
5
+ A professional credential, e.g. MD or NP, coded to HL7 v2-0360. Several are allowed; one is primary.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `code` | `string` | Yes | | | | No | Credential code, e.g. MD, DO, NP. |
14
+ | `primary` | `boolean` | No | | | `false` | No | True for the credential shown first. At most one. |
15
+ | `system` | `string` | No | | | `"http://terminology.hl7.org/CodeSystem/v2-0360"` | No | Code system. Defaults to HL7 v2-0360. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `ProviderEducationCredential`
4
4
 
5
- A degree or education credential held by this practitioner.
5
+ A degree or education credential held by this practitioner. Several are allowed.
6
6
 
7
7
  Type: `object`
8
8
 
@@ -10,9 +10,13 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `credential` | `string` | Yes | | | | No | Degree or education credential, e.g. MD, DO, MSN |
13
+ | `credential` | `string` | Yes | | | | No | Degree code (HL7 v2-0360), e.g. MD, DO, MSN. |
14
14
  | `graduation_year` | `integer|null` | No | | | | Yes | Year the credential was earned, optional. |
15
+ | `id` | `string` | No | | | | No | Record identifier. |
15
16
  | `institution` | `string|null` | No | | | | Yes | Institution that issued the credential, optional. |
17
+ | `level` | `string|null` | No | | | | Yes | Education level. |
18
+ | `program` | `string|null` | No | | | | Yes | Program or field of study, optional. |
19
+ | `start_year` | `integer|null` | No | | | | Yes | Year the program started, optional. |
16
20
 
17
21
  ## Example
18
22
 
@@ -10,7 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `encounters` | `array` | Yes | | | | No | FHIR-backed encounter records in the caller's tenant; the first 20 items also carry a patient demographic summary under the 'patient' key when the tenant's FHIR Patient record is readable. |
13
+ | `encounters` | array of [`ProviderEncounterRecord`](./ProviderEncounterRecord.md) | Yes | | | | No | Encounters in the caller's tenant. Each carries a 'patient' summary when the patient record is readable. |
14
14
  | `total` | `integer` | Yes | | | | No | Number of encounter records returned. |
15
15
 
16
16
  ## Example
@@ -0,0 +1,49 @@
1
+ # ProviderEncounterRecord
2
+
3
+ Model ID: `ProviderEncounterRecord`
4
+
5
+ Domain encounter shape returned to providers. Storage is FHIR; the wire format is not.
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 | FHIR Appointment id this encounter fulfills, when linked. |
14
+ | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id this encounter was checked in from, when checked in via Athena. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
15
+ | `athena_encounter_id` | `string|null` | No | | | | Yes | Athena Health encounter id this encounter is linked to, when checked in via Athena. |
16
+ | `created_by` | `string` | No | | | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
17
+ | `created_date` | `string|null` | No | | | | Yes | UTC datetime when the encounter was created |
18
+ | `diagnoses` | array of [`provider.EncounterDiagnosis`](./provider.EncounterDiagnosis.md) | No | | | | No | Diagnoses recorded for this encounter, ranked by rank. |
19
+ | `encounter_class` | [`EncounterClass`](./EncounterClass.md) | No | | | `"AMB"` | No | Encounter class: AMB (ambulatory), EMER (emergency), FLD (field), HH (home health), ACUTE, NONAC, OBSENC, PRENC, SS, or VR (virtual). |
20
+ | `encounter_id` | `string` | No | uuid | | | No | HealthCloud encounter identifier (UUID). |
21
+ | `fhir_id` | `string|null` | No | | | | Yes | FHIR Encounter resource id, when stored. |
22
+ | `hospitalization` | [`provider.EncounterHospitalization`](./provider.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
23
+ | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
24
+ | `locations` | array of [`provider.EncounterLocation`](./provider.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
26
+ | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
27
+ | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
28
+ | `participants` | array of [`provider.EncounterParticipant`](./provider.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
29
+ | `patient` | [`ProviderPatientSummary`](./ProviderPatientSummary.md) | No | | | | Yes | Patient demographic summary, present when the tenant's patient record is readable. |
30
+ | `patient_id` | `string` | Yes | | | | No | FHIR Patient id who is the subject of the encounter. |
31
+ | `period_end` | `string|null` | No | | | | Yes | When the encounter ended, when recorded. |
32
+ | `period_start` | `string|null` | No | | | | Yes | When the encounter started, when recorded. |
33
+ | `priority_code` | `string|null` | No | | | | Yes | Code for the encounter priority (e.g. routine, urgent, emergent), when coded. |
34
+ | `priority_display` | `string|null` | No | | | | Yes | Display text for the encounter priority, when available. |
35
+ | `reason_code` | `string|null` | No | | | | Yes | SNOMED CT code for the reason for the encounter, when coded. |
36
+ | `reason_display` | `string|null` | No | | | | Yes | Display text for the reason for the encounter, when available. |
37
+ | `service_provider_display` | `string|null` | No | | | | Yes | Display name of the service provider organization, when available. |
38
+ | `service_provider_id` | `string|null` | No | | | | Yes | FHIR Organization id of the service provider, when linked. |
39
+ | `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
40
+ | `service_type_display` | `string|null` | No | | | | Yes | Display text for the service type, when available. |
41
+ | `status` | [`EncounterStatus`](./EncounterStatus.md) | No | | | `"planned"` | No | Encounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error, or unknown. |
42
+ | `steadymd_consult_guid` | `string|null` | No | | | | Yes | SteadyMD consult guid this encounter was checked in from, when checked in via SteadyMD. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
43
+ | `steadymd_episode_guid` | `string|null` | No | | | | Yes | SteadyMD episode guid this encounter is linked to, when checked in via SteadyMD. |
44
+ | `type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the encounter type (e.g. office visit, follow-up), when coded. |
45
+ | `type_display` | `string|null` | No | | | | Yes | Display text for the encounter type, when available. |
46
+
47
+ ## Example
48
+
49
+ None declared in canonical OpenAPI.
@@ -10,7 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `encounter` | `object` | Yes | | | | No | FHIR-backed encounter record with a patient demographic summary under the 'patient' key when the tenant's FHIR Patient record is readable. |
13
+ | `encounter` | [`ProviderEncounterRecord`](./ProviderEncounterRecord.md) | Yes | | | | No | The encounter, with a 'patient' summary when the patient record is readable. |
14
14
 
15
15
  ## Example
16
16
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `ProviderLanguage`
4
4
 
5
- A language this practitioner can communicate with patients in.
5
+ A language this practitioner can communicate with patients in. Code is a BCP-47 tag.
6
6
 
7
7
  Type: `object`
8
8
 
@@ -10,8 +10,9 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `code` | `string` | Yes | | | | No | BCP-47 language tag, e.g. en, es, sr |
13
+ | `code` | `string` | Yes | | | | No | BCP-47 language tag, e.g. en, es, sr-Latn. |
14
14
  | `display` | `string|null` | No | | | | Yes | Human-readable language name, optional. |
15
+ | `primary` | `boolean` | No | | | `false` | No | True for the preferred language. At most one. |
15
16
 
16
17
  ## Example
17
18
 
@@ -0,0 +1,63 @@
1
+ # ProviderLocation
2
+
3
+ Model ID: `ProviderLocation`
4
+
5
+ One practice location. Several per practitioner are allowed.
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` | [`LocationAddress`](./LocationAddress.md) | Yes | | | | No | |
15
+ | `hours` | array of [`LocationHours`](./LocationHours.md) | No | | | | No | |
16
+ | `id` | `string` | No | | | | No | Location identifier. |
17
+ | `location_type` | `string` | No | | office, clinic, hospital, telehealth, other | `"office"` | No | |
18
+ | `name` | `string` | Yes | | | | No | Site name, e.g. 'San Francisco office'. |
19
+ | `organization_name` | `string|null` | No | | | | Yes | Facility or organization name. |
20
+ | `organization_npi` | `string|null` | No | | | | Yes | Organization NPI (type 2), optional. |
21
+ | `primary` | `boolean` | No | | | `false` | No | True for the main location. At most one per practitioner. |
22
+ | `status` | `string` | No | | active, inactive | `"active"` | No | |
23
+ | `telehealth` | `boolean` | No | | | `false` | No | True if this location offers telehealth visits. |
24
+ | `telephone` | `string|null` | No | | | | Yes | E.164 telephone number. |
25
+ | `tin_on_file` | `boolean` | No | | | `false` | No | True when a TIN is stored for this location's organization. |
26
+
27
+ ## Example
28
+
29
+ ```json
30
+ {
31
+ "accepts_new_patients": true,
32
+ "address": {
33
+ "city": "San Francisco",
34
+ "state": "CA",
35
+ "street": "220 Montgomery St",
36
+ "suite": null,
37
+ "zip_code": "94104"
38
+ },
39
+ "hours": [
40
+ {
41
+ "close": "17:00",
42
+ "days": [
43
+ "mon",
44
+ "tue",
45
+ "wed",
46
+ "thu",
47
+ "fri"
48
+ ],
49
+ "open": "08:00"
50
+ }
51
+ ],
52
+ "id": "7f1c2a9e-3b4d-4e5f-8a6b-9c0d1e2f3a4b",
53
+ "location_type": "office",
54
+ "name": "San Francisco office",
55
+ "organization_name": "Chen Primary Care",
56
+ "organization_npi": "1234567890",
57
+ "primary": true,
58
+ "status": "active",
59
+ "telehealth": false,
60
+ "telephone": "+14155550184",
61
+ "tin_on_file": true
62
+ }
63
+ ```
@@ -0,0 +1,21 @@
1
+ # ProviderLocationAddressRequest
2
+
3
+ Model ID: `ProviderLocationAddressRequest`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `city` | `string` | Yes | | | | No | City. |
14
+ | `state` | `string` | Yes | | | | No | Two-letter US state code. |
15
+ | `street` | `string` | Yes | | | | No | Street address. |
16
+ | `suite` | `string|null` | No | | | | Yes | Suite or unit, optional. |
17
+ | `zip_code` | `string` | Yes | | | | No | US ZIP code, 5 or 9 digits (NNNNN or NNNNN-NNNN). |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # ProviderLocationDeletedResponse
2
+
3
+ Model ID: `ProviderLocationDeletedResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `deleted` | `boolean` | Yes | | | | No | True when the location was removed. |
14
+ | `location_id` | `string` | Yes | | | | No | The removed location's identifier. |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # ProviderLocationHoursRequest
2
+
3
+ Model ID: `ProviderLocationHoursRequest`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `close` | `string` | Yes | | | | No | Closing time, HH:MM (24-hour). |
14
+ | `days` | `array` | Yes | | | | No | |
15
+ | `open` | `string` | Yes | | | | No | Opening time, HH:MM (24-hour). |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # ProviderLocationListResponse
2
+
3
+ Model ID: `ProviderLocationListResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `locations` | array of [`ProviderLocation`](./ProviderLocation.md) | Yes | | | | No | The practitioner's practice locations. |
14
+ | `total` | `integer` | Yes | | | | No | Number of locations returned. |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.