@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
@@ -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
- | `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,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` | `object|null` | No | | | | Yes | Coded result value (raw FHIR CodeableConcept), when applicable. |
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. |
@@ -1,6 +1,6 @@
1
1
  # AdvanceDirective
2
2
 
3
- Model ID: `AdvanceDirective`
3
+ Model ID: `ehr.AdvanceDirective`
4
4
 
5
5
  No description.
6
6
 
@@ -1,6 +1,6 @@
1
1
  # Allergy
2
2
 
3
- Model ID: `Allergy`
3
+ Model ID: `ehr.Allergy`
4
4
 
5
5
  No description.
6
6
 
@@ -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.
@@ -1,6 +1,6 @@
1
1
  # FamilyHistoryEntry
2
2
 
3
- Model ID: `FamilyHistoryEntry`
3
+ Model ID: `ehr.FamilyHistoryEntry`
4
4
 
5
5
  No description.
6
6
 
@@ -1,6 +1,6 @@
1
1
  # Immunization
2
2
 
3
- Model ID: `Immunization`
3
+ Model ID: `ehr.Immunization`
4
4
 
5
5
  No description.
6
6
 
@@ -1,6 +1,6 @@
1
1
  # Problem
2
2
 
3
- Model ID: `Problem`
3
+ Model ID: `ehr.Problem`
4
4
 
5
5
  No description.
6
6
 
@@ -1,6 +1,6 @@
1
1
  # Procedure
2
2
 
3
- Model ID: `Procedure`
3
+ Model ID: `ehr.Procedure`
4
4
 
5
5
  No description.
6
6
 
@@ -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.
@@ -1,6 +1,6 @@
1
1
  # QuestionnaireResponse
2
2
 
3
- Model ID: `QuestionnaireResponse`
3
+ Model ID: `ehr.QuestionnaireResponse`
4
4
 
5
5
  No description.
6
6
 
@@ -15,7 +15,7 @@ Type: `object`
15
15
  | `authored_by_patient` | `boolean` | No | | | `true` | No | Whether the response was authored by the patient (true) or a practitioner (false). |
16
16
  | `encounter_id` | `string|null` | No | | | `null` | Yes | FHIR Encounter id during which the response was collected, when linked. |
17
17
  | `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR QuestionnaireResponse resource id, when stored. |
18
- | `items` | array of [`ResponseItem`](./ResponseItem.md) | No | | | | No | Response items (answers), one per Questionnaire item linkId. |
18
+ | `items` | array of [`ehr.ResponseItem`](./ehr.ResponseItem.md) | No | | | | No | Response items (answers), one per Questionnaire item linkId. |
19
19
  | `patient_fhir_id` | `string|null` | No | | | `null` | Yes | FHIR Patient id who is the subject of the response, when linked. |
20
20
  | `questionnaire_fhir_id` | `string|null` | No | | | `null` | Yes | FHIR Questionnaire id this response answers, when linked. |
21
21
  | `questionnaire_url` | `string|null` | No | | | `null` | Yes | Canonical URL of the Questionnaire |
@@ -1,6 +1,6 @@
1
1
  # ResponseAnswer
2
2
 
3
- Model ID: `ResponseAnswer`
3
+ Model ID: `ehr.ResponseAnswer`
4
4
 
5
5
  No description.
6
6
 
@@ -10,14 +10,14 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `sub_items` | array of [`ResponseItem`](./ResponseItem.md) | No | | | | No | Nested sub-items under this answer, for grouped questions. |
13
+ | `sub_items` | array of [`ehr.ResponseItem`](./ehr.ResponseItem.md) | No | | | | No | Nested sub-items under this answer, for grouped questions. |
14
14
  | `value_boolean` | `boolean|null` | No | | | `null` | Yes | Boolean answer value, when the question type is boolean. |
15
- | `value_coding` | `object|null` | No | | | `null` | Yes | Coded answer value (system/code/display), when the question type is choice or open-choice. |
15
+ | `value_coding` | [`ehr.Coding`](./ehr.Coding.md) | No | | | `null` | Yes | Coded answer value (system/code/display), when the question type is choice or open-choice. |
16
16
  | `value_date` | `string|null` | No | | | `null` | Yes | Date answer value (ISO date), when the question type is date. |
17
17
  | `value_date_time` | `string|null` | No | | | `null` | Yes | DateTime answer value (ISO dateTime), when the question type is dateTime. |
18
18
  | `value_decimal` | `number|null` | No | | | `null` | Yes | Decimal answer value, when the question type is decimal. |
19
19
  | `value_integer` | `integer|null` | No | | | `null` | Yes | Integer answer value, when the question type is integer. |
20
- | `value_quantity` | `object|null` | No | | | `null` | Yes | Quantity answer value (value/unit/system), when the question type is quantity. |
20
+ | `value_quantity` | [`ehr.Quantity`](./ehr.Quantity.md) | No | | | `null` | Yes | Quantity answer value (value/unit/system), when the question type is quantity. |
21
21
  | `value_string` | `string|null` | No | | | `null` | Yes | String answer value, when the question type is string. |
22
22
  | `value_time` | `string|null` | No | | | `null` | Yes | Time answer value, when the question type is time. |
23
23
  | `value_uri` | `string|null` | No | | | `null` | Yes | URI answer value, when the question type is uri. |
@@ -1,6 +1,6 @@
1
1
  # ResponseItem
2
2
 
3
- Model ID: `ResponseItem`
3
+ Model ID: `ehr.ResponseItem`
4
4
 
5
5
  No description.
6
6
 
@@ -10,10 +10,10 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `answers` | array of [`ResponseAnswer`](./ResponseAnswer.md) | No | | | | No | Answers given for this item. |
13
+ | `answers` | array of [`ehr.ResponseAnswer`](./ehr.ResponseAnswer.md) | No | | | | No | Answers given for this item. |
14
14
  | `definition` | `string|null` | No | | | `null` | Yes | Canonical URI of the element this item collects, when defined. |
15
15
  | `link_id` | `string` | Yes | | | | No | Stable linkId matching the corresponding Questionnaire.item.linkId. |
16
- | `sub_items` | array of [`ResponseItem`](./ResponseItem.md) | No | | | | No | Nested sub-items, for grouped questions. |
16
+ | `sub_items` | array of [`ehr.ResponseItem`](./ehr.ResponseItem.md) | No | | | | No | Nested sub-items, for grouped questions. |
17
17
  | `text` | `string|null` | No | | | `null` | Yes | Display text of the question, when present. |
18
18
 
19
19
  ## Example
@@ -14,10 +14,10 @@
14
14
  - [AddPatientIntakeResponse](AddPatientIntakeResponse.md)
15
15
  - [Address](Address.md)
16
16
  - [AddressType](AddressType.md)
17
- - [AdvanceDirective](AdvanceDirective.md)
18
17
  - [AdvanceDirectiveType](AdvanceDirectiveType.md)
19
18
  - [AgentDashboardResponse](AgentDashboardResponse.md)
20
- - [Allergy](Allergy.md)
19
+ - [AlcoholFrequency](AlcoholFrequency.md)
20
+ - [AlcoholUse](AlcoholUse.md)
21
21
  - [AllergyCategory](AllergyCategory.md)
22
22
  - [AllergyCriticality](AllergyCriticality.md)
23
23
  - [AllergyStatus](AllergyStatus.md)
@@ -352,8 +352,11 @@
352
352
  - [AthenaVitalFailedReading](AthenaVitalFailedReading.md)
353
353
  - [AthenaVitalsMirrorResult](AthenaVitalsMirrorResult.md)
354
354
  - [BloodPressureVital](BloodPressureVital.md)
355
+ - [BodyHeight](BodyHeight.md)
355
356
  - [BodyHeightVital](BodyHeightVital.md)
357
+ - [BodyTemperature](BodyTemperature.md)
356
358
  - [BodyTemperatureVital](BodyTemperatureVital.md)
359
+ - [BodyWeight](BodyWeight.md)
357
360
  - [BodyWeightVital](BodyWeightVital.md)
358
361
  - [BookAppointmentRequest](BookAppointmentRequest.md)
359
362
  - [CalAssignScheduleToEventTypeRequest](CalAssignScheduleToEventTypeRequest.md)
@@ -474,6 +477,7 @@
474
477
  - [DeliveryPharmacy](DeliveryPharmacy.md)
475
478
  - [DemographicsMatch](DemographicsMatch.md)
476
479
  - [DependentResponse](DependentResponse.md)
480
+ - [Coding](diagnostics.Coding.md)
477
481
  - [diagnostics.ConnectResponse](diagnostics.ConnectResponse.md)
478
482
  - [ErrorResponse](diagnostics.ErrorResponse.md)
479
483
  - [LabObservation](diagnostics.LabObservation.md)
@@ -481,6 +485,7 @@
481
485
  - [ReferenceRange](diagnostics.ReferenceRange.md)
482
486
  - [DiagnosticTest](DiagnosticTest.md)
483
487
  - [DiagnosticTestRelationship](DiagnosticTestRelationship.md)
488
+ - [DietCategory](DietCategory.md)
484
489
  - [DirectiveScope](DirectiveScope.md)
485
490
  - [DirectiveStatus](DirectiveStatus.md)
486
491
  - [DischargeDisposition](DischargeDisposition.md)
@@ -489,14 +494,26 @@
489
494
  - [DocumentSummarySearchResponse](DocumentSummarySearchResponse.md)
490
495
  - [DriversLicense](DriversLicense.md)
491
496
  - [DriversLicenseSubmission](DriversLicenseSubmission.md)
497
+ - [EducationLevel](EducationLevel.md)
498
+ - [AdvanceDirective](ehr.AdvanceDirective.md)
499
+ - [Allergy](ehr.Allergy.md)
492
500
  - [AllergyReaction](ehr.AllergyReaction.md)
493
501
  - [CodedConcept](ehr.CodedConcept.md)
502
+ - [Coding](ehr.Coding.md)
494
503
  - [ehr.ConnectResponse](ehr.ConnectResponse.md)
495
504
  - [FamilyCondition](ehr.FamilyCondition.md)
505
+ - [FamilyHistoryEntry](ehr.FamilyHistoryEntry.md)
506
+ - [Immunization](ehr.Immunization.md)
496
507
  - [ImmunizationReaction](ehr.ImmunizationReaction.md)
497
508
  - [DiagnosticsListResponse](ehr.ListDiagnosticsResponse.md)
498
509
  - [EncounterListResponse](ehr.ListEncountersResponse.md)
499
510
  - [MedicationListResponse](ehr.ListMedicationsResponse.md)
511
+ - [Problem](ehr.Problem.md)
512
+ - [Procedure](ehr.Procedure.md)
513
+ - [Quantity](ehr.Quantity.md)
514
+ - [QuestionnaireResponse](ehr.QuestionnaireResponse.md)
515
+ - [ResponseAnswer](ehr.ResponseAnswer.md)
516
+ - [ResponseItem](ehr.ResponseItem.md)
500
517
  - [ElevenLabsAccessInfo](ElevenLabsAccessInfo.md)
501
518
  - [ElevenLabsAgent](ElevenLabsAgent.md)
502
519
  - [ElevenLabsAgentSettings](ElevenLabsAgentSettings.md)
@@ -541,9 +558,9 @@
541
558
  - [EncounterClass](EncounterClass.md)
542
559
  - [EncounterStatus](EncounterStatus.md)
543
560
  - [Ethnicity](Ethnicity.md)
561
+ - [ExerciseFrequency](ExerciseFrequency.md)
544
562
  - [FaceMatchRequest](FaceMatchRequest.md)
545
563
  - [FaceMatchResponse](FaceMatchResponse.md)
546
- - [FamilyHistoryEntry](FamilyHistoryEntry.md)
547
564
  - [FamilyHistoryStatus](FamilyHistoryStatus.md)
548
565
  - [FamilyRelationship](FamilyRelationship.md)
549
566
  - [FedexCreateShipmentRequest](FedexCreateShipmentRequest.md)
@@ -578,6 +595,8 @@
578
595
  - [FieldAgentProfileResponse](FieldAgentProfileResponse.md)
579
596
  - [FlagOperationError](FlagOperationError.md)
580
597
  - [FlagOperationReceipt](FlagOperationReceipt.md)
598
+ - [FunctionalLevel](FunctionalLevel.md)
599
+ - [FunctionalStatus](FunctionalStatus.md)
581
600
  - [Gender](Gender.md)
582
601
  - [GenderIdentity](GenderIdentity.md)
583
602
  - [GetAgentAgentResponse](GetAgentAgentResponse.md)
@@ -1081,7 +1100,6 @@
1081
1100
  - [HealthPlanSearchResponse](HealthPlanSearchResponse.md)
1082
1101
  - [HealthPlanSummary](HealthPlanSummary.md)
1083
1102
  - [HeartRateVital](HeartRateVital.md)
1084
- - [Immunization](Immunization.md)
1085
1103
  - [ImmunizationRoute](ImmunizationRoute.md)
1086
1104
  - [ImmunizationStatus](ImmunizationStatus.md)
1087
1105
  - [ImpiloAddress](ImpiloAddress.md)
@@ -1216,6 +1234,7 @@
1216
1234
  - [KnowledgeCollection](KnowledgeCollection.md)
1217
1235
  - [KnowledgeEntrySummary](KnowledgeEntrySummary.md)
1218
1236
  - [KnowledgeSearchResult](KnowledgeSearchResult.md)
1237
+ - [LicenseVerification](LicenseVerification.md)
1219
1238
  - [ListActionsResponse](ListActionsResponse.md)
1220
1239
  - [ListActivityResponse](ListActivityResponse.md)
1221
1240
  - [ListAllergiesResponse](ListAllergiesResponse.md)
@@ -1243,6 +1262,7 @@
1243
1262
  - [ListTestOrdersResponse](ListTestOrdersResponse.md)
1244
1263
  - [ListVectorCollectionsResponse](ListVectorCollectionsResponse.md)
1245
1264
  - [ListVitalsResponse](ListVitalsResponse.md)
1265
+ - [LivingSituation](LivingSituation.md)
1246
1266
  - [LocationStatus](LocationStatus.md)
1247
1267
  - [MaritalStatus](MaritalStatus.md)
1248
1268
  - [mcp.ConnectResponse](mcp.ConnectResponse.md)
@@ -1270,6 +1290,7 @@
1270
1290
  - [NearestLocationsResponse](NearestLocationsResponse.md)
1271
1291
  - [NotificationResponse](NotificationResponse.md)
1272
1292
  - [NotificationUpsertRequest](NotificationUpsertRequest.md)
1293
+ - [NpiVerification](NpiVerification.md)
1273
1294
  - [NPPESBasic](NPPESBasic.md)
1274
1295
  - [NppesGetProviderRequest](NppesGetProviderRequest.md)
1275
1296
  - [NPPESProvider](NPPESProvider.md)
@@ -1281,6 +1302,7 @@
1281
1302
  - [ObservationStatus](ObservationStatus.md)
1282
1303
  - [OnboardEncounterPayload](OnboardEncounterPayload.md)
1283
1304
  - [OnboardEncounterStepResult](OnboardEncounterStepResult.md)
1305
+ - [OnboardingProgressRequest](OnboardingProgressRequest.md)
1284
1306
  - [OnboardPatientAttributes](OnboardPatientAttributes.md)
1285
1307
  - [OnboardPatientFlags](OnboardPatientFlags.md)
1286
1308
  - [OnboardPatientPayload](OnboardPatientPayload.md)
@@ -1432,33 +1454,61 @@
1432
1454
  - [PlaidListIdentityVerificationsRequest](PlaidListIdentityVerificationsRequest.md)
1433
1455
  - [PlaidListIdentityVerificationsResponse](PlaidListIdentityVerificationsResponse.md)
1434
1456
  - [PolicyDocument](PolicyDocument.md)
1457
+ - [PortalRole](PortalRole.md)
1435
1458
  - [PositionCode](PositionCode.md)
1436
1459
  - [Practitioner](Practitioner.md)
1437
1460
  - [PreferredPharmacy](PreferredPharmacy.md)
1438
1461
  - [PresenceRecord](PresenceRecord.md)
1439
1462
  - [PresenceStatus](PresenceStatus.md)
1440
- - [Problem](Problem.md)
1441
1463
  - [ProblemCategory](ProblemCategory.md)
1442
1464
  - [ProblemClinicalStatus](ProblemClinicalStatus.md)
1443
1465
  - [ProblemSeverity](ProblemSeverity.md)
1444
1466
  - [ProblemVerificationStatus](ProblemVerificationStatus.md)
1445
- - [Procedure](Procedure.md)
1446
1467
  - [ProcedureLaterality](ProcedureLaterality.md)
1447
1468
  - [ProcedureStatus](ProcedureStatus.md)
1469
+ - [AdvanceDirective](provider.AdvanceDirective.md)
1470
+ - [Allergy](provider.Allergy.md)
1471
+ - [AllergyReaction](provider.AllergyReaction.md)
1472
+ - [BloodPressure](provider.BloodPressure.md)
1473
+ - [CodedConcept](provider.CodedConcept.md)
1474
+ - [Coding](provider.Coding.md)
1448
1475
  - [ProviderConfirmResetPasswordRequest](provider.ConfirmResetPasswordRequest.md)
1449
1476
  - [ProviderConfirmResetPasswordResponse](provider.ConfirmResetPasswordResponse.md)
1450
1477
  - [provider.ConnectResponse](provider.ConnectResponse.md)
1478
+ - [Dosage](provider.Dosage.md)
1479
+ - [Encounter](provider.Encounter.md)
1480
+ - [EncounterDiagnosis](provider.EncounterDiagnosis.md)
1481
+ - [EncounterHospitalization](provider.EncounterHospitalization.md)
1482
+ - [EncounterLocation](provider.EncounterLocation.md)
1483
+ - [EncounterParticipant](provider.EncounterParticipant.md)
1451
1484
  - [ErrorResponse](provider.ErrorResponse.md)
1485
+ - [FamilyCondition](provider.FamilyCondition.md)
1486
+ - [FamilyHistoryEntry](provider.FamilyHistoryEntry.md)
1452
1487
  - [ProviderGetPhotoResponse](provider.GetPhotoResponse.md)
1453
1488
  - [PhotoUploadUrlResponse](provider.GetPhotoUploadUrlResponse.md)
1489
+ - [GynHistory](provider.GynHistory.md)
1490
+ - [HeartRate](provider.HeartRate.md)
1491
+ - [Immunization](provider.Immunization.md)
1492
+ - [ImmunizationReaction](provider.ImmunizationReaction.md)
1493
+ - [LabObservation](provider.LabObservation.md)
1454
1494
  - [ProviderLoginRequest](provider.LoginRequest.md)
1455
1495
  - [ProviderLoginResponse](provider.LoginResponse.md)
1496
+ - [Medication](provider.Medication.md)
1497
+ - [PerinatalHistory](provider.PerinatalHistory.md)
1498
+ - [Problem](provider.Problem.md)
1499
+ - [Procedure](provider.Procedure.md)
1500
+ - [PulseOximetry](provider.PulseOximetry.md)
1501
+ - [Quantity](provider.Quantity.md)
1502
+ - [QuestionnaireResponse](provider.QuestionnaireResponse.md)
1503
+ - [ReferenceRange](provider.ReferenceRange.md)
1456
1504
  - [ProviderRefreshTokenRequest](provider.RefreshTokenRequest.md)
1457
1505
  - [ProviderRefreshTokenResponse](provider.RefreshTokenResponse.md)
1458
1506
  - [ProviderRegisterRequest](provider.RegisterRequest.md)
1459
1507
  - [ProviderRegisterResponse](provider.RegisterResponse.md)
1460
1508
  - [ProviderResetPasswordRequest](provider.ResetPasswordRequest.md)
1461
1509
  - [ProviderResetPasswordResponse](provider.ResetPasswordResponse.md)
1510
+ - [ResponseAnswer](provider.ResponseAnswer.md)
1511
+ - [ResponseItem](provider.ResponseItem.md)
1462
1512
  - [ProviderUpdatePhoneRequest](provider.UpdatePhoneRequest.md)
1463
1513
  - [ProviderUpdatePhoneResponse](provider.UpdatePhoneResponse.md)
1464
1514
  - [ProviderUploadPhotoRequest](provider.UploadPhotoRequest.md)
@@ -1472,17 +1522,23 @@
1472
1522
  - [ProviderAppointmentResponse](ProviderAppointmentResponse.md)
1473
1523
  - [ProviderAppointmentsResponse](ProviderAppointmentsResponse.md)
1474
1524
  - [ProviderContactPoint](ProviderContactPoint.md)
1525
+ - [ProviderCredential](ProviderCredential.md)
1475
1526
  - [ProviderEducationCredential](ProviderEducationCredential.md)
1476
1527
  - [ProviderEncounterListResponse](ProviderEncounterListResponse.md)
1528
+ - [ProviderEncounterRecord](ProviderEncounterRecord.md)
1477
1529
  - [ProviderEncounterResponse](ProviderEncounterResponse.md)
1478
1530
  - [ProviderGender](ProviderGender.md)
1479
1531
  - [ProviderIdentifier](ProviderIdentifier.md)
1480
1532
  - [ProviderIdentifierType](ProviderIdentifierType.md)
1481
1533
  - [ProviderLanguage](ProviderLanguage.md)
1534
+ - [ProviderOnboardingStatus](ProviderOnboardingStatus.md)
1482
1535
  - [ProviderPatientAddress](ProviderPatientAddress.md)
1483
1536
  - [ProviderPatientPhone](ProviderPatientPhone.md)
1537
+ - [ProviderPatientRecordResources](ProviderPatientRecordResources.md)
1484
1538
  - [ProviderPatientRecordResponse](ProviderPatientRecordResponse.md)
1485
1539
  - [ProviderPatientSummary](ProviderPatientSummary.md)
1540
+ - [ProviderPostgraduateTraining](ProviderPostgraduateTraining.md)
1541
+ - [ProviderProfessionalLiability](ProviderProfessionalLiability.md)
1486
1542
  - [ProviderRole](ProviderRole.md)
1487
1543
  - [ProviderSearchRequest](ProviderSearchRequest.md)
1488
1544
  - [ProviderSearchResponse](ProviderSearchResponse.md)
@@ -1516,7 +1572,6 @@
1516
1572
  - [QuestHL7MessageContent](QuestHL7MessageContent.md)
1517
1573
  - [QuestionItemType](QuestionItemType.md)
1518
1574
  - [QuestionnaireItemInput](QuestionnaireItemInput.md)
1519
- - [QuestionnaireResponse](QuestionnaireResponse.md)
1520
1575
  - [QuestionnaireResponseStatus](QuestionnaireResponseStatus.md)
1521
1576
  - [QuestListTestCatalogRequest](QuestListTestCatalogRequest.md)
1522
1577
  - [QuestOrderDocument](QuestOrderDocument.md)
@@ -1546,8 +1601,6 @@
1546
1601
  - [ReplaceInsuranceResponse](ReplaceInsuranceResponse.md)
1547
1602
  - [RescheduleAppointmentRequest](RescheduleAppointmentRequest.md)
1548
1603
  - [RespiratoryRate](RespiratoryRate.md)
1549
- - [ResponseAnswer](ResponseAnswer.md)
1550
- - [ResponseItem](ResponseItem.md)
1551
1604
  - [RetireInsuranceRequest](RetireInsuranceRequest.md)
1552
1605
  - [RetireInsuranceResponse](RetireInsuranceResponse.md)
1553
1606
  - [rppg.ConnectResponse](rppg.ConnectResponse.md)
@@ -1741,8 +1794,11 @@
1741
1794
  - [SetPreferredPharmacyRequest](SetPreferredPharmacyRequest.md)
1742
1795
  - [SetPreferredPharmacyResponse](SetPreferredPharmacyResponse.md)
1743
1796
  - [SexAtBirth](SexAtBirth.md)
1797
+ - [SexualOrientation](SexualOrientation.md)
1744
1798
  - [Slot](Slot.md)
1745
1799
  - [SlotStatus](SlotStatus.md)
1800
+ - [SmokingStatus](SmokingStatus.md)
1801
+ - [SocialHistory](SocialHistory.md)
1746
1802
  - [Specimen](Specimen.md)
1747
1803
  - [SpecimenStatus](SpecimenStatus.md)
1748
1804
  - [SpecimenType](SpecimenType.md)
@@ -1854,11 +1910,14 @@
1854
1910
  - [SubmitCurrentSymptomsResponse](SubmitCurrentSymptomsScreeningsCurrentSymptomsResponse.md)
1855
1911
  - [SubmitSummaryRequest](SubmitSummaryRequest.md)
1856
1912
  - [SubscriberRelationship](SubscriberRelationship.md)
1913
+ - [SubstanceStatus](SubstanceStatus.md)
1914
+ - [SubstanceUse](SubstanceUse.md)
1857
1915
  - [telehealth.ConnectResponse](telehealth.ConnectResponse.md)
1858
1916
  - [ErrorResponse](telehealth.ErrorResponse.md)
1859
1917
  - [TelehealthToken](TelehealthToken.md)
1860
1918
  - [TemperatureRoute](TemperatureRoute.md)
1861
1919
  - [TestOrder](TestOrder.md)
1920
+ - [TobaccoUse](TobaccoUse.md)
1862
1921
  - [TwilioGetMessageRequest](TwilioGetMessageRequest.md)
1863
1922
  - [TwilioListMessagesRequest](TwilioListMessagesRequest.md)
1864
1923
  - [TwilioListMessagesResponse](TwilioListMessagesResponse.md)
@@ -1924,6 +1983,7 @@
1924
1983
  - [VisionFaceCompareResponse](VisionFaceCompareResponse.md)
1925
1984
  - [VitalReading](VitalReading.md)
1926
1985
  - [vitals.ConnectResponse](vitals.ConnectResponse.md)
1986
+ - [VitalsRecord](VitalsRecord.md)
1927
1987
  - [VitalsRecordRequest](VitalsRecordRequest.md)
1928
1988
  - [VitalsStatus](VitalsStatus.md)
1929
1989
  - [WhoopActivityIdMappingResponse](WhoopActivityIdMappingResponse.md)
@@ -0,0 +1,31 @@
1
+ # AdvanceDirective
2
+
3
+ Model ID: `provider.AdvanceDirective`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `directive_id` | `string` | No | uuid | | | No | |
14
+ | `document_location` | `string|null` | No | | | | Yes | |
15
+ | `effective_date` | `string|null` | No | | | | Yes | |
16
+ | `expiration_date` | `string|null` | No | | | | Yes | |
17
+ | `fhir_id` | `string|null` | No | | | | Yes | |
18
+ | `instructions` | `string|null` | No | | | | Yes | |
19
+ | `on_file` | `boolean` | No | | | `false` | No | |
20
+ | `proxy_name` | `string|null` | No | | | | Yes | |
21
+ | `proxy_phone` | `string|null` | No | | | | Yes | |
22
+ | `proxy_relationship` | `string|null` | No | | | | Yes | |
23
+ | `scope` | [`DirectiveScope`](./DirectiveScope.md) | No | | | `"adr"` | No | |
24
+ | `status` | [`DirectiveStatus`](./DirectiveStatus.md) | No | | | `"active"` | No | |
25
+ | `type` | [`AdvanceDirectiveType`](./AdvanceDirectiveType.md) | Yes | | | | No | |
26
+ | `verified_by` | `string|null` | No | | | | Yes | |
27
+ | `verified_date` | `string|null` | No | | | | Yes | |
28
+
29
+ ## Example
30
+
31
+ None declared in canonical OpenAPI.
@@ -0,0 +1,31 @@
1
+ # Allergy
2
+
3
+ Model ID: `provider.Allergy`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `allergen` | `string` | Yes | | | | No | Substance name (e.g. Penicillin, Peanut, Latex) |
14
+ | `allergen_code` | [`provider.CodedConcept`](./provider.CodedConcept.md) | No | | | | Yes | Coded allergen concept (SNOMED CT), when available. |
15
+ | `allergy_id` | `string` | No | uuid | | | No | HealthCloud allergy identifier (UUID). |
16
+ | `asserted_by` | `string|null` | No | | | | Yes | Patient self-reported or provider name |
17
+ | `asserted_date` | `string|null` | No | | | | Yes | Date the allergy was asserted/recorded, when known. |
18
+ | `category` | [`AllergyCategory`](./AllergyCategory.md) | Yes | | | | No | Allergy category: food, medication, environment, biologic, other, or unknown. |
19
+ | `criticality` | [`AllergyCriticality`](./AllergyCriticality.md) | No | | | `"unable-to-assess"` | No | Clinical criticality: low, high, or unable-to-assess. |
20
+ | `fhir_id` | `string|null` | No | | | | Yes | FHIR AllergyIntolerance resource id, when stored. |
21
+ | `intolerance_type` | [`IntoleranceType`](./IntoleranceType.md) | No | | | `"allergy"` | No | Whether this is an allergy or an intolerance. |
22
+ | `notes` | `string|null` | No | | | | Yes | Free-text notes about the allergy, when present. |
23
+ | `onset_date` | `string|null` | No | | | | Yes | Date the allergy first onset, when known. |
24
+ | `reactions` | array of [`provider.AllergyReaction`](./provider.AllergyReaction.md) | No | | | | No | Adverse reactions associated with the allergy. |
25
+ | `resolved_date` | `string|null` | No | | | | Yes | Date the allergy was resolved, when applicable. |
26
+ | `status` | [`AllergyStatus`](./AllergyStatus.md) | No | | | `"active"` | No | Clinical status: active, inactive, resolved, or entered-in-error. |
27
+ | `verification_status` | [`AllergyVerificationStatus`](./AllergyVerificationStatus.md) | No | | | `"confirmed"` | No | Verification status: unconfirmed, presumed, confirmed, refuted, or entered-in-error. |
28
+
29
+ ## Example
30
+
31
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # AllergyReaction
2
+
3
+ Model ID: `provider.AllergyReaction`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `manifestation` | `string` | Yes | | | | No | e.g. Hives, Anaphylaxis, Nausea |
14
+ | `manifestation_code` | [`provider.CodedConcept`](./provider.CodedConcept.md) | No | | | | Yes | SNOMED-CT coded manifestation for FHIR |
15
+ | `notes` | `string|null` | No | | | | Yes | Free-text notes about the reaction, when present. |
16
+ | `onset` | `string|null` | No | | | | Yes | Date the reaction first occurred, when known. |
17
+ | `severity` | [`ReactionSeverity`](./ReactionSeverity.md) | No | | | | Yes | Severity of the reaction: mild, moderate, severe, or life_threatening. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.