@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,22 @@
1
+ # FamilyCondition
2
+
3
+ Model ID: `provider.FamilyCondition`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `age_at_death` | `integer|null` | No | | | | Yes | Age of the family member at death, when known. |
14
+ | `age_at_onset` | `integer|null` | No | | | | Yes | Age of the family member at onset of the condition, when known. |
15
+ | `condition` | `string` | Yes | | | | No | Name/description of the family member's condition. |
16
+ | `icd10_code` | `string|null` | No | | | | Yes | ICD-10-CM code for the condition, when coded. |
17
+ | `notes` | `string|null` | No | | | | Yes | Free-text notes about the condition, when present. |
18
+ | `snomed_code` | `string|null` | No | | | | Yes | SNOMED CT code for the family member's condition, when known. |
19
+
20
+ ## Example
21
+
22
+ None declared in canonical OpenAPI.
@@ -0,0 +1,30 @@
1
+ # FamilyHistoryEntry
2
+
3
+ Model ID: `provider.FamilyHistoryEntry`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `age_at_death` | `integer|null` | No | | | | Yes | Age of the family member at death, when known. |
14
+ | `biological` | `boolean` | No | | | `true` | No | Whether the family member is a biological relative. |
15
+ | `born_date` | `string|null` | No | | | | Yes | Birth date of the family member, when known. |
16
+ | `cause_of_death` | `string|null` | No | | | | Yes | Cause of death of the family member, when recorded. |
17
+ | `conditions` | array of [`provider.FamilyCondition`](./provider.FamilyCondition.md) | No | | | | No | Conditions recorded for this family member. |
18
+ | `deceased` | `boolean|null` | No | | | | Yes | Whether the family member is deceased, when known. |
19
+ | `entry_id` | `string` | No | uuid | | | No | HealthCloud family-history entry identifier (UUID). |
20
+ | `fhir_id` | `string|null` | No | | | | Yes | FHIR FamilyMemberHistory resource id, when stored. |
21
+ | `member_name` | `string|null` | No | | | | Yes | Name of the family member, when known (FHIR FamilyMemberHistory.name). |
22
+ | `notes` | `string|null` | No | | | | Yes | Free-text notes about the family member, when present. |
23
+ | `recorded_date` | `string|null` | No | | | | Yes | Date the family-history entry was recorded, when known. |
24
+ | `relationship` | [`FamilyRelationship`](./FamilyRelationship.md) | Yes | | | | No | Relationship of the family member to the patient (e.g. mother, father, sibling). |
25
+ | `sex` | `string|null` | No | | | | Yes | Sex of the family member, when known. |
26
+ | `status` | [`FamilyHistoryStatus`](./FamilyHistoryStatus.md) | No | | | `"completed"` | No | Status of the family-history entry (required in FHIR): partial, completed, entered-in-error, or health-unknown. |
27
+
28
+ ## Example
29
+
30
+ None declared in canonical OpenAPI.
@@ -0,0 +1,25 @@
1
+ # GynHistory
2
+
3
+ Model ID: `provider.GynHistory`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `cervical_screening_history` | `string|null` | No | | | | Yes | |
14
+ | `contraception` | `string|null` | No | | | | Yes | |
15
+ | `history_id` | `string` | No | uuid | | | No | |
16
+ | `last_menstrual_period` | `string|null` | No | | | | Yes | |
17
+ | `menarche_age` | `integer|null` | No | | | | Yes | |
18
+ | `menopause_age` | `integer|null` | No | | | | Yes | |
19
+ | `menstrual_history` | `string|null` | No | | | | Yes | |
20
+ | `notes` | `string|null` | No | | | | Yes | |
21
+ | `pregnancy_history` | `string|null` | No | | | | Yes | |
22
+
23
+ ## Example
24
+
25
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # HeartRate
2
+
3
+ Model ID: `provider.HeartRate`
4
+
5
+ A heart rate reading.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `rate` | `number` | Yes | | | | No | beats/min |
14
+ | `rhythm` | `string|null` | No | | | | Yes | Regular, Irregular, etc. |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -0,0 +1,40 @@
1
+ # Immunization
2
+
3
+ Model ID: `provider.Immunization`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `administered_by` | `string|null` | No | | | | Yes | |
14
+ | `administered_date` | `string|null` | No | | | | Yes | |
15
+ | `administered_datetime` | `string|null` | No | | | | Yes | |
16
+ | `cvx_code` | `string|null` | No | | | | Yes | |
17
+ | `dose_number` | `integer|null` | No | | | | Yes | |
18
+ | `dose_quantity` | `number|null` | No | | | | Yes | |
19
+ | `dose_unit` | `string|null` | No | | | | Yes | |
20
+ | `expiration_date` | `string|null` | No | | | | Yes | |
21
+ | `fhir_id` | `string|null` | No | | | | Yes | |
22
+ | `immunization_id` | `string` | No | uuid | | | No | |
23
+ | `lot_number` | `string|null` | No | | | | Yes | |
24
+ | `manufacturer` | `string|null` | No | | | | Yes | |
25
+ | `mvx_code` | `string|null` | No | | | | Yes | |
26
+ | `not_done_reason` | `string|null` | No | | | | Yes | |
27
+ | `notes` | `string|null` | No | | | | Yes | |
28
+ | `reactions` | array of [`provider.ImmunizationReaction`](./provider.ImmunizationReaction.md) | No | | | | No | |
29
+ | `reason_codes` | `array` | No | | | | No | |
30
+ | `route` | [`ImmunizationRoute`](./ImmunizationRoute.md) | No | | | | Yes | |
31
+ | `series_doses` | `integer|null` | No | | | | Yes | |
32
+ | `series_name` | `string|null` | No | | | | Yes | |
33
+ | `site` | [`VaccinationSite`](./VaccinationSite.md) | No | | | | Yes | |
34
+ | `status` | [`ImmunizationStatus`](./ImmunizationStatus.md) | No | | | `"completed"` | No | |
35
+ | `vaccine_name` | `string` | Yes | | | | No | |
36
+ | `vis_document_date` | `string|null` | No | | | | Yes | |
37
+
38
+ ## Example
39
+
40
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # ImmunizationReaction
2
+
3
+ Model ID: `provider.ImmunizationReaction`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `notes` | `string|null` | No | | | | Yes | |
14
+ | `onset_date` | `string|null` | No | | | | Yes | |
15
+ | `reaction` | `string` | Yes | | | | No | |
16
+ | `severity` | [`ReactionSeverity`](./ReactionSeverity.md) | No | | | | Yes | |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -0,0 +1,29 @@
1
+ # LabObservation
2
+
3
+ Model ID: `provider.LabObservation`
4
+
5
+ A single lab result line item, mapped to/from a FHIR Observation.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `display` | `string` | Yes | | | | No | Human-readable name of the measured analyte. |
14
+ | `effective_datetime` | `string|null` | No | | | | Yes | ISO 8601 datetime the observation was effective, optional. |
15
+ | `interpretation` | [`InterpretationCode`](./InterpretationCode.md) | No | | | | Yes | Clinical interpretation flag, e.g. high/low/critical/positive/negative. |
16
+ | `loinc_code` | `string` | Yes | | | | No | LOINC code identifying the measured analyte. |
17
+ | `notes` | `string|null` | No | | | | Yes | Free-text notes, optional. |
18
+ | `observation_id` | `string|null` | No | | | | Yes | FHIR Observation resource ID; auto-generated if omitted. |
19
+ | `reference_range` | [`provider.ReferenceRange`](./provider.ReferenceRange.md) | No | | | | Yes | The normal/expected range for this result, optional. |
20
+ | `status` | [`ObservationStatus`](./ObservationStatus.md) | No | | | `"final"` | No | Observation lifecycle status. |
21
+ | `value_boolean` | `boolean|null` | No | | | | Yes | Boolean result value, when applicable. |
22
+ | `value_coding` | [`provider.Coding`](./provider.Coding.md) | No | | | | Yes | Coded result value, when applicable. |
23
+ | `value_quantity` | `number|null` | No | | | | Yes | Numeric result value, when the result is quantitative. Requires value_unit. |
24
+ | `value_string` | `string|null` | No | | | | Yes | Free-text result value, when the result is not quantitative. |
25
+ | `value_unit` | `string|null` | No | | | | Yes | Unit of measure for value_quantity, optional. |
26
+
27
+ ## Example
28
+
29
+ None declared in canonical OpenAPI.
@@ -0,0 +1,41 @@
1
+ # Medication
2
+
3
+ Model ID: `provider.Medication`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `authored_on` | `string|null` | No | | | | Yes | Date the prescription was authored, when recorded. |
14
+ | `brand_name` | `string|null` | No | | | | Yes | Brand name of the medication, when known. |
15
+ | `discontinued_reason` | `string|null` | No | | | | Yes | Reason the medication was discontinued, when applicable. |
16
+ | `dosage` | [`provider.Dosage`](./provider.Dosage.md) | Yes | | | | No | Dose, frequency, and instructions for the medication. |
17
+ | `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter id during which the medication was ordered, when linked. |
18
+ | `end_date` | `string|null` | No | | | | Yes | Date the medication therapy ends, when specified. |
19
+ | `fhir_id` | `string|null` | No | | | | Yes | FHIR MedicationRequest/MedicationStatement resource id, when stored. |
20
+ | `generic_name` | `string|null` | No | | | | Yes | Generic name of the medication, when known. |
21
+ | `indication` | `string|null` | No | | | | Yes | Reason/indication for the medication, when recorded. |
22
+ | `intent` | [`MedicationIntent`](./MedicationIntent.md) | No | | | `"order"` | No | Request intent: proposal, plan, order, or original-order (required for MedicationRequest). |
23
+ | `medication_id` | `string` | No | uuid | | | No | HealthCloud medication identifier (UUID). |
24
+ | `name` | `string` | Yes | | | | No | Generic or brand name |
25
+ | `ndc_code` | `string|null` | No | | | | Yes | National Drug Code (NDC) for the medication, when available. |
26
+ | `notes` | `string|null` | No | | | | Yes | Free-text notes about the medication, when present. |
27
+ | `pharmacy` | `string|null` | No | | | | Yes | Dispensing pharmacy name or reference, when recorded. |
28
+ | `prescriber_id` | `string|null` | No | | | | Yes | FHIR Practitioner id of the prescriber, when known. |
29
+ | `prescriber_name` | `string|null` | No | | | | Yes | Display name of the prescriber, when known. |
30
+ | `problem_reference` | `string|null` | No | | | | Yes | UUID of the Condition (problem) this medication treats, when linked. |
31
+ | `refills_authorized` | `integer|null` | No | | | | Yes | Number of refills authorized on the prescription, when applicable. |
32
+ | `refills_remaining` | `integer|null` | No | | | | Yes | Number of refills remaining, when tracked. |
33
+ | `resource_type` | [`MedicationResourceType`](./MedicationResourceType.md) | No | | | `"MedicationRequest"` | No | Which FHIR resource this maps to: MedicationStatement (historical use) or MedicationRequest (prescription/order). |
34
+ | `route` | [`MedicationRoute`](./MedicationRoute.md) | Yes | | | | No | Administration route: oral, intravenous, intramuscular, topical, etc. |
35
+ | `rxnorm_code` | `string|null` | No | | | | Yes | RxNorm code for the medication, when available. |
36
+ | `start_date` | `string|null` | No | | | | Yes | Date the medication therapy starts, when specified. |
37
+ | `status` | [`MedicationStatus`](./MedicationStatus.md) | No | | | `"active"` | No | Medication status: active, on-hold, completed, stopped, or entered-in-error. |
38
+
39
+ ## Example
40
+
41
+ None declared in canonical OpenAPI.
@@ -0,0 +1,25 @@
1
+ # PerinatalHistory
2
+
3
+ Model ID: `provider.PerinatalHistory`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `delivery_date` | `string|null` | No | | | | Yes | |
14
+ | `delivery_method` | `string|null` | No | | | | Yes | |
15
+ | `gestational_age_weeks` | `number|null` | No | | | | Yes | |
16
+ | `history_id` | `string` | No | uuid | | | No | |
17
+ | `maternal_complications` | `string|null` | No | | | | Yes | |
18
+ | `neonatal_complications` | `string|null` | No | | | | Yes | |
19
+ | `notes` | `string|null` | No | | | | Yes | |
20
+ | `outcome` | `string|null` | No | | | | Yes | |
21
+ | `pregnancy_year` | `integer|null` | No | | | | Yes | |
22
+
23
+ ## Example
24
+
25
+ None declared in canonical OpenAPI.
@@ -0,0 +1,37 @@
1
+ # Problem
2
+
3
+ Model ID: `provider.Problem`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `asserted_date` | `string|null` | No | | | | Yes | Date the problem was asserted, when recorded. |
14
+ | `asserter_name` | `string|null` | No | | | | Yes | Name of the person who asserted the problem, when recorded. |
15
+ | `asserter_type` | `string|null` | No | | | | Yes | Type of asserter (e.g. patient, practitioner), when recorded. |
16
+ | `body_site` | `string|null` | No | | | | Yes | Body site affected, when specified. |
17
+ | `categories` | array of [`ProblemCategory`](./ProblemCategory.md) | No | | | | No | Condition categories (e.g. problem-list-item, encounter-diagnosis). |
18
+ | `clinical_status` | [`ProblemClinicalStatus`](./ProblemClinicalStatus.md) | No | | | `"active"` | No | Clinical status: active, recurrence, relapse, inactive, remission, or resolved. |
19
+ | `description` | `string` | Yes | | | | No | Human-readable description of the problem/condition. |
20
+ | `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter id during which the problem was recorded, when linked. |
21
+ | `fhir_id` | `string|null` | No | | | | Yes | FHIR Condition resource id, when stored. |
22
+ | `icd10_code` | `string|null` | No | | | | Yes | ICD-10-CM code for the condition, when coded. |
23
+ | `laterality` | `string|null` | No | | | | Yes | Left, Right, Bilateral |
24
+ | `notes` | `string|null` | No | | | | Yes | Free-text notes about the problem, when present. |
25
+ | `onset_age` | `integer|null` | No | | | | Yes | Age at onset in years |
26
+ | `onset_date` | `string|null` | No | | | | Yes | Date the problem first onset, when known. |
27
+ | `problem_id` | `string` | No | uuid | | | No | HealthCloud problem/condition identifier (UUID). |
28
+ | `recorded_date` | `string|null` | No | | | | Yes | Datetime the problem was recorded, when known. |
29
+ | `recorder_name` | `string|null` | No | | | | Yes | Name of the person who recorded the problem, when known. |
30
+ | `resolved_date` | `string|null` | No | | | | Yes | Date the problem was resolved/abated, when applicable. |
31
+ | `severity` | [`ProblemSeverity`](./ProblemSeverity.md) | No | | | | Yes | Severity: mild, moderate, or severe, when assessed. |
32
+ | `snomed_code` | `string|null` | No | | | | Yes | SNOMED CT code for the condition, when coded. |
33
+ | `verification_status` | [`ProblemVerificationStatus`](./ProblemVerificationStatus.md) | No | | | `"confirmed"` | No | Verification status: unconfirmed, provisional, differential, confirmed, refuted, or entered-in-error. |
34
+
35
+ ## Example
36
+
37
+ None declared in canonical OpenAPI.
@@ -0,0 +1,37 @@
1
+ # Procedure
2
+
3
+ Model ID: `provider.Procedure`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `anesthesia_type` | `string|null` | No | | | | Yes | |
14
+ | `body_sites` | `array` | No | | | | No | |
15
+ | `complications` | `array` | No | | | | No | |
16
+ | `cpt_code` | `string|null` | No | | | | Yes | |
17
+ | `description` | `string` | Yes | | | | No | |
18
+ | `encounter_id` | `string|null` | No | | | | Yes | |
19
+ | `facility` | `string|null` | No | | | | Yes | |
20
+ | `fhir_id` | `string|null` | No | | | | Yes | |
21
+ | `indication` | `string|null` | No | | | | Yes | |
22
+ | `laterality` | [`ProcedureLaterality`](./ProcedureLaterality.md) | No | | | | Yes | |
23
+ | `notes` | `string|null` | No | | | | Yes | |
24
+ | `outcome` | `string|null` | No | | | | Yes | |
25
+ | `performed_date` | `string|null` | No | | | | Yes | |
26
+ | `performed_date_end` | `string|null` | No | | | | Yes | |
27
+ | `performer_id` | `string|null` | No | | | | Yes | |
28
+ | `performer_name` | `string|null` | No | | | | Yes | |
29
+ | `problem_reference` | `string|null` | No | | | | Yes | |
30
+ | `procedure_id` | `string` | No | uuid | | | No | |
31
+ | `reported` | `boolean` | No | | | `false` | No | |
32
+ | `snomed_code` | `string|null` | No | | | | Yes | |
33
+ | `status` | [`ProcedureStatus`](./ProcedureStatus.md) | No | | | `"completed"` | No | |
34
+
35
+ ## Example
36
+
37
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # PulseOximetry
2
+
3
+ Model ID: `provider.PulseOximetry`
4
+
5
+ An SpO2 (blood oxygen saturation) reading.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `fio2` | `number|null` | No | | | | Yes | FiO2 % |
14
+ | `flow_rate` | `number|null` | No | | | | Yes | O2 flow rate L/min |
15
+ | `on_supplemental_oxygen` | `boolean` | No | | | `false` | No | True if the patient was on supplemental oxygen during the reading. |
16
+ | `spo2` | `number` | Yes | | | | No | SpO2 percentage |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # Quantity
2
+
3
+ Model ID: `provider.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 | | | | Yes | Unit code within the system. |
14
+ | `system` | `string|null` | No | | | | Yes | Unit code system URI. |
15
+ | `unit` | `string|null` | No | | | | Yes | Unit of measure, for display. |
16
+ | `value` | `number|null` | No | | | | Yes | Numeric value. |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -0,0 +1,27 @@
1
+ # QuestionnaireResponse
2
+
3
+ Model ID: `provider.QuestionnaireResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `authored` | `string|null` | No | | | | Yes | ISO 8601 dateTime |
14
+ | `authored_by_name` | `string|null` | No | | | | Yes | Display name of the author, when known. |
15
+ | `authored_by_patient` | `boolean` | No | | | `true` | No | Whether the response was authored by the patient (true) or a practitioner (false). |
16
+ | `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter id during which the response was collected, when linked. |
17
+ | `fhir_id` | `string|null` | No | | | | Yes | FHIR QuestionnaireResponse resource id, when stored. |
18
+ | `items` | array of [`provider.ResponseItem`](./provider.ResponseItem.md) | No | | | | No | Response items (answers), one per Questionnaire item linkId. |
19
+ | `patient_fhir_id` | `string|null` | No | | | | Yes | FHIR Patient id who is the subject of the response, when linked. |
20
+ | `questionnaire_fhir_id` | `string|null` | No | | | | Yes | FHIR Questionnaire id this response answers, when linked. |
21
+ | `questionnaire_url` | `string|null` | No | | | | Yes | Canonical URL of the Questionnaire |
22
+ | `response_id` | `string` | No | uuid | | | No | HealthCloud questionnaire-response identifier (UUID). |
23
+ | `status` | [`QuestionnaireResponseStatus`](./QuestionnaireResponseStatus.md) | No | | | `"completed"` | No | Response status: in-progress, completed, amended, entered-in-error, or stopped. |
24
+
25
+ ## Example
26
+
27
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # ReferenceRange
2
+
3
+ Model ID: `provider.ReferenceRange`
4
+
5
+ The normal/expected range for a lab observation's value.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `high` | `number|null` | No | | | | Yes | Upper bound of the normal range, optional. |
14
+ | `low` | `number|null` | No | | | | Yes | Lower bound of the normal range, optional. |
15
+ | `text` | `string|null` | No | | | | Yes | Free-text range description, e.g. 'Negative', optional. |
16
+ | `unit` | `string|null` | No | | | | Yes | Unit of measure for low/high, optional. |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -0,0 +1,27 @@
1
+ # ResponseAnswer
2
+
3
+ Model ID: `provider.ResponseAnswer`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `sub_items` | array of [`provider.ResponseItem`](./provider.ResponseItem.md) | No | | | | No | Nested sub-items under this answer, for grouped questions. |
14
+ | `value_boolean` | `boolean|null` | No | | | | Yes | Boolean answer value, when the question type is boolean. |
15
+ | `value_coding` | [`provider.Coding`](./provider.Coding.md) | No | | | | Yes | Coded answer value (system/code/display), when the question type is choice or open-choice. |
16
+ | `value_date` | `string|null` | No | | | | Yes | Date answer value (ISO date), when the question type is date. |
17
+ | `value_date_time` | `string|null` | No | | | | Yes | DateTime answer value (ISO dateTime), when the question type is dateTime. |
18
+ | `value_decimal` | `number|null` | No | | | | Yes | Decimal answer value, when the question type is decimal. |
19
+ | `value_integer` | `integer|null` | No | | | | Yes | Integer answer value, when the question type is integer. |
20
+ | `value_quantity` | [`provider.Quantity`](./provider.Quantity.md) | No | | | | Yes | Quantity answer value (value/unit/system), when the question type is quantity. |
21
+ | `value_string` | `string|null` | No | | | | Yes | String answer value, when the question type is string. |
22
+ | `value_time` | `string|null` | No | | | | Yes | Time answer value, when the question type is time. |
23
+ | `value_uri` | `string|null` | No | | | | Yes | URI answer value, when the question type is uri. |
24
+
25
+ ## Example
26
+
27
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # ResponseItem
2
+
3
+ Model ID: `provider.ResponseItem`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `answers` | array of [`provider.ResponseAnswer`](./provider.ResponseAnswer.md) | No | | | | No | Answers given for this item. |
14
+ | `definition` | `string|null` | No | | | | Yes | Canonical URI of the element this item collects, when defined. |
15
+ | `link_id` | `string` | Yes | | | | No | Stable linkId matching the corresponding Questionnaire.item.linkId. |
16
+ | `sub_items` | array of [`provider.ResponseItem`](./provider.ResponseItem.md) | No | | | | No | Nested sub-items, for grouped questions. |
17
+ | `text` | `string|null` | No | | | | Yes | Display text of the question, when present. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -47,6 +47,7 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
47
47
  ```json
48
48
  {
49
49
  "athena_appointment_id": "string",
50
+ "note": "string",
50
51
  "patient_id": "string",
51
52
  "slot_id": "string",
52
53
  "start": "string",
@@ -94,7 +95,10 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
94
95
  | `401` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
95
96
  | `404` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | The requested slot was not found |
96
97
  | `409` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Conflict — slot not available |
98
+ | `410` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | |
97
99
  | `500` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Internal server error |
100
+ | `502` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | |
101
+ | `503` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Athena rate limited the upstream request; Retry-After is forwarded when valid |
98
102
 
99
103
  ## Error examples
100
104
 
@@ -130,6 +134,16 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
130
134
  }
131
135
  ```
132
136
 
137
+ ### 410
138
+
139
+ ```json
140
+ {
141
+ "code": "string",
142
+ "error": "string",
143
+ "outcome": {}
144
+ }
145
+ ```
146
+
133
147
  ### 500 — Unexpected service failure (sanitized example)
134
148
 
135
149
  ```json
@@ -138,6 +152,24 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
138
152
  }
139
153
  ```
140
154
 
155
+ ### 502
156
+
157
+ ```json
158
+ {
159
+ "code": "string",
160
+ "error": "string",
161
+ "outcome": {}
162
+ }
163
+ ```
164
+
165
+ ### 503 — Athena temporarily rate limited this read
166
+
167
+ ```json
168
+ {
169
+ "error": "Appointments are temporarily unavailable because the upstream service is rate limited"
170
+ }
171
+ ```
172
+
141
173
  ## NodeJS / TypeScript implementation
142
174
 
143
175
  ```ts
@@ -148,6 +180,7 @@ import type { BookAppointmentRequest } from "@healthcloudai/hc-sdk";
148
180
  ```ts
149
181
  const request = {
150
182
  "athena_appointment_id": "string",
183
+ "note": "string",
151
184
  "patient_id": "string",
152
185
  "slot_id": "string",
153
186
  "start": "string",
@@ -163,7 +196,7 @@ const result = await appointments.book(request);
163
196
  curl -X POST \
164
197
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
165
198
  -H 'Content-Type: application/json' \
166
- -d '{"athena_appointment_id":"string","patient_id":"string","slot_id":"string","start":"string","steadymd_clinician_guid":"string"}' \
199
+ -d '{"athena_appointment_id":"string","note":"string","patient_id":"string","slot_id":"string","start":"string","steadymd_clinician_guid":"string"}' \
167
200
  'https://dev-api-appointments.health.cloud/appointments/book'
168
201
  ```
169
202