@healthcloudai/hc-sdk 3.17.0 → 3.18.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 (108) hide show
  1. package/dist/index.cjs +3 -0
  2. package/dist/index.d.cts +21 -0
  3. package/dist/index.d.ts +21 -0
  4. package/dist/index.js +3 -0
  5. package/docs/docs-manifest.json +71 -11
  6. package/docs/models/AlcoholFrequency.md +15 -0
  7. package/docs/models/AlcoholUse.md +20 -0
  8. package/docs/models/BodyHeight.md +17 -0
  9. package/docs/models/BodyTemperature.md +18 -0
  10. package/docs/models/BodyWeight.md +18 -0
  11. package/docs/models/BookAppointmentRequest.md +2 -0
  12. package/docs/models/DietCategory.md +19 -0
  13. package/docs/models/EducationLevel.md +15 -0
  14. package/docs/models/ExerciseFrequency.md +15 -0
  15. package/docs/models/FunctionalLevel.md +15 -0
  16. package/docs/models/FunctionalStatus.md +40 -0
  17. package/docs/models/GetPractitionerResponse.md +8 -2
  18. package/docs/models/LicenseVerification.md +19 -0
  19. package/docs/models/ListAllergiesResponse.md +1 -1
  20. package/docs/models/ListConditionsResponse.md +1 -1
  21. package/docs/models/ListDirectivesResponse.md +1 -1
  22. package/docs/models/ListFamilyHistoryResponse.md +1 -1
  23. package/docs/models/ListImmunizationsResponse.md +1 -1
  24. package/docs/models/ListProceduresResponse.md +1 -1
  25. package/docs/models/ListQuestionnaireResponsesResponse.md +1 -1
  26. package/docs/models/LivingSituation.md +15 -0
  27. package/docs/models/NpiVerification.md +21 -0
  28. package/docs/models/OnboardingProgressRequest.md +18 -0
  29. package/docs/models/PortalRole.md +18 -0
  30. package/docs/models/Practitioner.md +9 -2
  31. package/docs/models/ProviderCredential.md +19 -0
  32. package/docs/models/ProviderEducationCredential.md +6 -2
  33. package/docs/models/ProviderEncounterListResponse.md +1 -1
  34. package/docs/models/ProviderEncounterRecord.md +49 -0
  35. package/docs/models/ProviderEncounterResponse.md +1 -1
  36. package/docs/models/ProviderLanguage.md +3 -2
  37. package/docs/models/ProviderOnboardingStatus.md +19 -0
  38. package/docs/models/ProviderPatientRecordResources.md +32 -0
  39. package/docs/models/ProviderPatientRecordResponse.md +1 -1
  40. package/docs/models/ProviderPostgraduateTraining.md +22 -0
  41. package/docs/models/ProviderProfessionalLiability.md +19 -0
  42. package/docs/models/ProviderSpecialty.md +1 -1
  43. package/docs/models/ProviderStateLicense.md +9 -2
  44. package/docs/models/SexualOrientation.md +15 -0
  45. package/docs/models/SmokingStatus.md +15 -0
  46. package/docs/models/SocialHistory.md +35 -0
  47. package/docs/models/SubstanceStatus.md +15 -0
  48. package/docs/models/SubstanceUse.md +23 -0
  49. package/docs/models/TobaccoUse.md +22 -0
  50. package/docs/models/UpdateEncounterClinicalNoteResponse.md +1 -1
  51. package/docs/models/UpdateEncounterStatusResponse.md +1 -1
  52. package/docs/models/UpdatePractitionerRequest.md +5 -0
  53. package/docs/models/UpdatePractitionerResponse.md +8 -2
  54. package/docs/models/VitalsRecord.md +41 -0
  55. package/docs/models/appointments.ErrorResponse.md +1 -0
  56. package/docs/models/diagnostics.Coding.md +19 -0
  57. package/docs/models/diagnostics.LabObservation.md +1 -1
  58. package/docs/models/{AdvanceDirective.md → ehr.AdvanceDirective.md} +1 -1
  59. package/docs/models/{Allergy.md → ehr.Allergy.md} +1 -1
  60. package/docs/models/ehr.Coding.md +19 -0
  61. package/docs/models/{FamilyHistoryEntry.md → ehr.FamilyHistoryEntry.md} +1 -1
  62. package/docs/models/{Immunization.md → ehr.Immunization.md} +1 -1
  63. package/docs/models/{Problem.md → ehr.Problem.md} +1 -1
  64. package/docs/models/{Procedure.md → ehr.Procedure.md} +1 -1
  65. package/docs/models/ehr.Quantity.md +20 -0
  66. package/docs/models/{QuestionnaireResponse.md → ehr.QuestionnaireResponse.md} +2 -2
  67. package/docs/models/{ResponseAnswer.md → ehr.ResponseAnswer.md} +4 -4
  68. package/docs/models/{ResponseItem.md → ehr.ResponseItem.md} +3 -3
  69. package/docs/models/index.md +69 -9
  70. package/docs/models/provider.AdvanceDirective.md +31 -0
  71. package/docs/models/provider.Allergy.md +31 -0
  72. package/docs/models/provider.AllergyReaction.md +21 -0
  73. package/docs/models/provider.BloodPressure.md +20 -0
  74. package/docs/models/provider.CodedConcept.md +19 -0
  75. package/docs/models/provider.Coding.md +19 -0
  76. package/docs/models/provider.Dosage.md +24 -0
  77. package/docs/models/provider.Encounter.md +48 -0
  78. package/docs/models/provider.EncounterDiagnosis.md +20 -0
  79. package/docs/models/provider.EncounterHospitalization.md +22 -0
  80. package/docs/models/provider.EncounterLocation.md +21 -0
  81. package/docs/models/provider.EncounterParticipant.md +21 -0
  82. package/docs/models/provider.FamilyCondition.md +22 -0
  83. package/docs/models/provider.FamilyHistoryEntry.md +30 -0
  84. package/docs/models/provider.GynHistory.md +25 -0
  85. package/docs/models/provider.HeartRate.md +18 -0
  86. package/docs/models/provider.Immunization.md +40 -0
  87. package/docs/models/provider.ImmunizationReaction.md +20 -0
  88. package/docs/models/provider.LabObservation.md +29 -0
  89. package/docs/models/provider.Medication.md +41 -0
  90. package/docs/models/provider.PerinatalHistory.md +25 -0
  91. package/docs/models/provider.Problem.md +37 -0
  92. package/docs/models/provider.Procedure.md +37 -0
  93. package/docs/models/provider.PulseOximetry.md +20 -0
  94. package/docs/models/provider.Quantity.md +20 -0
  95. package/docs/models/provider.QuestionnaireResponse.md +27 -0
  96. package/docs/models/provider.ReferenceRange.md +20 -0
  97. package/docs/models/provider.ResponseAnswer.md +27 -0
  98. package/docs/models/provider.ResponseItem.md +21 -0
  99. package/docs/operations/appointments.book.md +34 -1
  100. package/docs/operations/provider.getEncounter.md +84 -1
  101. package/docs/operations/provider.getPatientRecord.md +516 -1
  102. package/docs/operations/provider.getPractitioner.md +92 -53
  103. package/docs/operations/provider.listEncounters.md +84 -1
  104. package/docs/operations/provider.register.md +25 -3
  105. package/docs/operations/provider.updateEncounterClinicalNote.md +84 -1
  106. package/docs/operations/provider.updateEncounterStatus.md +84 -1
  107. package/docs/operations/provider.updatePractitioner.md +256 -150
  108. package/package.json +1 -1
@@ -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
+ # 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,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` | `object` | Yes | | | | No | Resources grouped by type (conditions, allergies, medications, procedures, immunizations, family_history, consents, social_history, functional_status, gyn_history, perinatal_history, encounters, vitals, questionnaire_responses, diagnostics, intake_submissions) — every section is a serialized domain model, never a raw FHIR resource. Vitals is the latest-reading VitalsRecord summary per LOINC code. A resource type with a failed downstream fetch appears as an empty list, not an error. |
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 | | | `true` | No | True if this is the practitioner's primary specialty. |
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
- | `state` | `string` | Yes | | | | No | Two-letter US state code |
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,15 @@
1
+ # SexualOrientation
2
+
3
+ Model ID: `SexualOrientation`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # SmokingStatus
2
+
3
+ Model ID: `SmokingStatus`
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,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,15 @@
1
+ # SubstanceStatus
2
+
3
+ Model ID: `SubstanceStatus`
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,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` | `object` | Yes | | | | No | Updated FHIR 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` | `object` | Yes | | | | No | Updated FHIR 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