@healthcloudai/hc-sdk 3.17.0 → 3.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +37 -0
- package/dist/index.d.cts +9261 -2031
- package/dist/index.d.ts +9261 -2031
- package/dist/index.js +37 -0
- package/docs/clients/ProviderClient.md +8 -0
- package/docs/docs-manifest.json +90 -12
- package/docs/examples/index.md +8 -0
- package/docs/index.md +8 -0
- package/docs/models/AlcoholFrequency.md +15 -0
- package/docs/models/AlcoholUse.md +20 -0
- package/docs/models/BodyHeight.md +17 -0
- package/docs/models/BodyTemperature.md +18 -0
- package/docs/models/BodyWeight.md +18 -0
- package/docs/models/BookAppointmentRequest.md +2 -0
- package/docs/models/DietCategory.md +19 -0
- package/docs/models/EducationLevel.md +15 -0
- package/docs/models/ExerciseFrequency.md +15 -0
- package/docs/models/FunctionalLevel.md +15 -0
- package/docs/models/FunctionalStatus.md +40 -0
- package/docs/models/GetPractitionerResponse.md +8 -2
- package/docs/models/LicenseVerification.md +19 -0
- package/docs/models/ListAllergiesResponse.md +1 -1
- package/docs/models/ListConditionsResponse.md +1 -1
- package/docs/models/ListDirectivesResponse.md +1 -1
- package/docs/models/ListFamilyHistoryResponse.md +1 -1
- package/docs/models/ListImmunizationsResponse.md +1 -1
- package/docs/models/ListProceduresResponse.md +1 -1
- package/docs/models/ListQuestionnaireResponsesResponse.md +1 -1
- package/docs/models/LivingSituation.md +15 -0
- package/docs/models/LocationAddress.md +21 -0
- package/docs/models/LocationHours.md +19 -0
- package/docs/models/NpiVerification.md +21 -0
- package/docs/models/OnboardingProgressRequest.md +18 -0
- package/docs/models/PortalRole.md +18 -0
- package/docs/models/Practitioner.md +9 -2
- package/docs/models/ProviderCredential.md +19 -0
- package/docs/models/ProviderEducationCredential.md +6 -2
- package/docs/models/ProviderEncounterListResponse.md +1 -1
- package/docs/models/ProviderEncounterRecord.md +49 -0
- package/docs/models/ProviderEncounterResponse.md +1 -1
- package/docs/models/ProviderLanguage.md +3 -2
- package/docs/models/ProviderLocation.md +63 -0
- package/docs/models/ProviderLocationAddressRequest.md +21 -0
- package/docs/models/ProviderLocationDeletedResponse.md +18 -0
- package/docs/models/ProviderLocationHoursRequest.md +19 -0
- package/docs/models/ProviderLocationListResponse.md +18 -0
- package/docs/models/ProviderLocationPatchRequest.md +28 -0
- package/docs/models/ProviderLocationRequest.md +57 -0
- package/docs/models/ProviderOnboardingStatus.md +19 -0
- package/docs/models/ProviderPatientRecordResources.md +32 -0
- package/docs/models/ProviderPatientRecordResponse.md +1 -1
- package/docs/models/ProviderPostgraduateTraining.md +22 -0
- package/docs/models/ProviderProfessionalLiability.md +19 -0
- package/docs/models/ProviderSpecialty.md +1 -1
- package/docs/models/ProviderStateLicense.md +9 -2
- package/docs/models/SetPortalRolesRequest.md +17 -0
- package/docs/models/SexualOrientation.md +15 -0
- package/docs/models/SmokingStatus.md +15 -0
- package/docs/models/SocialHistory.md +35 -0
- package/docs/models/SubstanceStatus.md +15 -0
- package/docs/models/SubstanceUse.md +23 -0
- package/docs/models/TobaccoUse.md +22 -0
- package/docs/models/UpdateEncounterClinicalNoteResponse.md +1 -1
- package/docs/models/UpdateEncounterStatusResponse.md +1 -1
- package/docs/models/UpdatePractitionerRequest.md +5 -0
- package/docs/models/UpdatePractitionerResponse.md +8 -2
- package/docs/models/VitalsRecord.md +41 -0
- package/docs/models/appointments.ErrorResponse.md +1 -0
- package/docs/models/diagnostics.Coding.md +19 -0
- package/docs/models/diagnostics.LabObservation.md +1 -1
- package/docs/models/{AdvanceDirective.md → ehr.AdvanceDirective.md} +1 -1
- package/docs/models/{Allergy.md → ehr.Allergy.md} +1 -1
- package/docs/models/ehr.Coding.md +19 -0
- package/docs/models/{FamilyHistoryEntry.md → ehr.FamilyHistoryEntry.md} +1 -1
- package/docs/models/{Immunization.md → ehr.Immunization.md} +1 -1
- package/docs/models/{Problem.md → ehr.Problem.md} +1 -1
- package/docs/models/{Procedure.md → ehr.Procedure.md} +1 -1
- package/docs/models/ehr.Quantity.md +20 -0
- package/docs/models/{QuestionnaireResponse.md → ehr.QuestionnaireResponse.md} +2 -2
- package/docs/models/{ResponseAnswer.md → ehr.ResponseAnswer.md} +4 -4
- package/docs/models/{ResponseItem.md → ehr.ResponseItem.md} +3 -3
- package/docs/models/index.md +79 -9
- package/docs/models/provider.AdvanceDirective.md +31 -0
- package/docs/models/provider.Allergy.md +31 -0
- package/docs/models/provider.AllergyReaction.md +21 -0
- package/docs/models/provider.BloodPressure.md +20 -0
- package/docs/models/provider.CodedConcept.md +19 -0
- package/docs/models/provider.Coding.md +19 -0
- package/docs/models/provider.Dosage.md +24 -0
- package/docs/models/provider.Encounter.md +48 -0
- package/docs/models/provider.EncounterDiagnosis.md +20 -0
- package/docs/models/provider.EncounterHospitalization.md +22 -0
- package/docs/models/provider.EncounterLocation.md +21 -0
- package/docs/models/provider.EncounterParticipant.md +21 -0
- package/docs/models/provider.FamilyCondition.md +22 -0
- package/docs/models/provider.FamilyHistoryEntry.md +30 -0
- package/docs/models/provider.GynHistory.md +25 -0
- package/docs/models/provider.HeartRate.md +18 -0
- package/docs/models/provider.Immunization.md +40 -0
- package/docs/models/provider.ImmunizationReaction.md +20 -0
- package/docs/models/provider.LabObservation.md +29 -0
- package/docs/models/provider.Medication.md +41 -0
- package/docs/models/provider.PerinatalHistory.md +25 -0
- package/docs/models/provider.Problem.md +37 -0
- package/docs/models/provider.Procedure.md +37 -0
- package/docs/models/provider.PulseOximetry.md +20 -0
- package/docs/models/provider.Quantity.md +20 -0
- package/docs/models/provider.QuestionnaireResponse.md +27 -0
- package/docs/models/provider.ReferenceRange.md +20 -0
- package/docs/models/provider.ResponseAnswer.md +27 -0
- package/docs/models/provider.ResponseItem.md +21 -0
- package/docs/operations/appointments.book.md +34 -1
- package/docs/operations/provider.completePractitionerOnboarding.md +264 -0
- package/docs/operations/provider.createPractitionerLocation.md +221 -0
- package/docs/operations/provider.deletePractitionerLocation.md +133 -0
- package/docs/operations/provider.getEncounter.md +84 -1
- package/docs/operations/provider.getPatientRecord.md +516 -1
- package/docs/operations/provider.getPractitioner.md +92 -53
- package/docs/operations/provider.getPractitionerLocation.md +162 -0
- package/docs/operations/provider.listEncounters.md +84 -1
- package/docs/operations/provider.listPractitionerLocations.md +130 -0
- package/docs/operations/provider.register.md +25 -3
- package/docs/operations/provider.setPractitionerPortalRoles.md +271 -0
- package/docs/operations/provider.updateEncounterClinicalNote.md +84 -1
- package/docs/operations/provider.updateEncounterStatus.md +84 -1
- package/docs/operations/provider.updatePractitioner.md +256 -150
- package/docs/operations/provider.updatePractitionerLocation.md +233 -0
- package/docs/operations/provider.verifyPractitionerNpi.md +273 -0
- package/package.json +1 -1
|
@@ -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` | `
|
|
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` | `
|
|
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
|
package/docs/models/index.md
CHANGED
|
@@ -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
|
-
- [
|
|
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,9 @@
|
|
|
1243
1262
|
- [ListTestOrdersResponse](ListTestOrdersResponse.md)
|
|
1244
1263
|
- [ListVectorCollectionsResponse](ListVectorCollectionsResponse.md)
|
|
1245
1264
|
- [ListVitalsResponse](ListVitalsResponse.md)
|
|
1265
|
+
- [LivingSituation](LivingSituation.md)
|
|
1266
|
+
- [LocationAddress](LocationAddress.md)
|
|
1267
|
+
- [LocationHours](LocationHours.md)
|
|
1246
1268
|
- [LocationStatus](LocationStatus.md)
|
|
1247
1269
|
- [MaritalStatus](MaritalStatus.md)
|
|
1248
1270
|
- [mcp.ConnectResponse](mcp.ConnectResponse.md)
|
|
@@ -1270,6 +1292,7 @@
|
|
|
1270
1292
|
- [NearestLocationsResponse](NearestLocationsResponse.md)
|
|
1271
1293
|
- [NotificationResponse](NotificationResponse.md)
|
|
1272
1294
|
- [NotificationUpsertRequest](NotificationUpsertRequest.md)
|
|
1295
|
+
- [NpiVerification](NpiVerification.md)
|
|
1273
1296
|
- [NPPESBasic](NPPESBasic.md)
|
|
1274
1297
|
- [NppesGetProviderRequest](NppesGetProviderRequest.md)
|
|
1275
1298
|
- [NPPESProvider](NPPESProvider.md)
|
|
@@ -1281,6 +1304,7 @@
|
|
|
1281
1304
|
- [ObservationStatus](ObservationStatus.md)
|
|
1282
1305
|
- [OnboardEncounterPayload](OnboardEncounterPayload.md)
|
|
1283
1306
|
- [OnboardEncounterStepResult](OnboardEncounterStepResult.md)
|
|
1307
|
+
- [OnboardingProgressRequest](OnboardingProgressRequest.md)
|
|
1284
1308
|
- [OnboardPatientAttributes](OnboardPatientAttributes.md)
|
|
1285
1309
|
- [OnboardPatientFlags](OnboardPatientFlags.md)
|
|
1286
1310
|
- [OnboardPatientPayload](OnboardPatientPayload.md)
|
|
@@ -1432,33 +1456,61 @@
|
|
|
1432
1456
|
- [PlaidListIdentityVerificationsRequest](PlaidListIdentityVerificationsRequest.md)
|
|
1433
1457
|
- [PlaidListIdentityVerificationsResponse](PlaidListIdentityVerificationsResponse.md)
|
|
1434
1458
|
- [PolicyDocument](PolicyDocument.md)
|
|
1459
|
+
- [PortalRole](PortalRole.md)
|
|
1435
1460
|
- [PositionCode](PositionCode.md)
|
|
1436
1461
|
- [Practitioner](Practitioner.md)
|
|
1437
1462
|
- [PreferredPharmacy](PreferredPharmacy.md)
|
|
1438
1463
|
- [PresenceRecord](PresenceRecord.md)
|
|
1439
1464
|
- [PresenceStatus](PresenceStatus.md)
|
|
1440
|
-
- [Problem](Problem.md)
|
|
1441
1465
|
- [ProblemCategory](ProblemCategory.md)
|
|
1442
1466
|
- [ProblemClinicalStatus](ProblemClinicalStatus.md)
|
|
1443
1467
|
- [ProblemSeverity](ProblemSeverity.md)
|
|
1444
1468
|
- [ProblemVerificationStatus](ProblemVerificationStatus.md)
|
|
1445
|
-
- [Procedure](Procedure.md)
|
|
1446
1469
|
- [ProcedureLaterality](ProcedureLaterality.md)
|
|
1447
1470
|
- [ProcedureStatus](ProcedureStatus.md)
|
|
1471
|
+
- [AdvanceDirective](provider.AdvanceDirective.md)
|
|
1472
|
+
- [Allergy](provider.Allergy.md)
|
|
1473
|
+
- [AllergyReaction](provider.AllergyReaction.md)
|
|
1474
|
+
- [BloodPressure](provider.BloodPressure.md)
|
|
1475
|
+
- [CodedConcept](provider.CodedConcept.md)
|
|
1476
|
+
- [Coding](provider.Coding.md)
|
|
1448
1477
|
- [ProviderConfirmResetPasswordRequest](provider.ConfirmResetPasswordRequest.md)
|
|
1449
1478
|
- [ProviderConfirmResetPasswordResponse](provider.ConfirmResetPasswordResponse.md)
|
|
1450
1479
|
- [provider.ConnectResponse](provider.ConnectResponse.md)
|
|
1480
|
+
- [Dosage](provider.Dosage.md)
|
|
1481
|
+
- [Encounter](provider.Encounter.md)
|
|
1482
|
+
- [EncounterDiagnosis](provider.EncounterDiagnosis.md)
|
|
1483
|
+
- [EncounterHospitalization](provider.EncounterHospitalization.md)
|
|
1484
|
+
- [EncounterLocation](provider.EncounterLocation.md)
|
|
1485
|
+
- [EncounterParticipant](provider.EncounterParticipant.md)
|
|
1451
1486
|
- [ErrorResponse](provider.ErrorResponse.md)
|
|
1487
|
+
- [FamilyCondition](provider.FamilyCondition.md)
|
|
1488
|
+
- [FamilyHistoryEntry](provider.FamilyHistoryEntry.md)
|
|
1452
1489
|
- [ProviderGetPhotoResponse](provider.GetPhotoResponse.md)
|
|
1453
1490
|
- [PhotoUploadUrlResponse](provider.GetPhotoUploadUrlResponse.md)
|
|
1491
|
+
- [GynHistory](provider.GynHistory.md)
|
|
1492
|
+
- [HeartRate](provider.HeartRate.md)
|
|
1493
|
+
- [Immunization](provider.Immunization.md)
|
|
1494
|
+
- [ImmunizationReaction](provider.ImmunizationReaction.md)
|
|
1495
|
+
- [LabObservation](provider.LabObservation.md)
|
|
1454
1496
|
- [ProviderLoginRequest](provider.LoginRequest.md)
|
|
1455
1497
|
- [ProviderLoginResponse](provider.LoginResponse.md)
|
|
1498
|
+
- [Medication](provider.Medication.md)
|
|
1499
|
+
- [PerinatalHistory](provider.PerinatalHistory.md)
|
|
1500
|
+
- [Problem](provider.Problem.md)
|
|
1501
|
+
- [Procedure](provider.Procedure.md)
|
|
1502
|
+
- [PulseOximetry](provider.PulseOximetry.md)
|
|
1503
|
+
- [Quantity](provider.Quantity.md)
|
|
1504
|
+
- [QuestionnaireResponse](provider.QuestionnaireResponse.md)
|
|
1505
|
+
- [ReferenceRange](provider.ReferenceRange.md)
|
|
1456
1506
|
- [ProviderRefreshTokenRequest](provider.RefreshTokenRequest.md)
|
|
1457
1507
|
- [ProviderRefreshTokenResponse](provider.RefreshTokenResponse.md)
|
|
1458
1508
|
- [ProviderRegisterRequest](provider.RegisterRequest.md)
|
|
1459
1509
|
- [ProviderRegisterResponse](provider.RegisterResponse.md)
|
|
1460
1510
|
- [ProviderResetPasswordRequest](provider.ResetPasswordRequest.md)
|
|
1461
1511
|
- [ProviderResetPasswordResponse](provider.ResetPasswordResponse.md)
|
|
1512
|
+
- [ResponseAnswer](provider.ResponseAnswer.md)
|
|
1513
|
+
- [ResponseItem](provider.ResponseItem.md)
|
|
1462
1514
|
- [ProviderUpdatePhoneRequest](provider.UpdatePhoneRequest.md)
|
|
1463
1515
|
- [ProviderUpdatePhoneResponse](provider.UpdatePhoneResponse.md)
|
|
1464
1516
|
- [ProviderUploadPhotoRequest](provider.UploadPhotoRequest.md)
|
|
@@ -1472,17 +1524,30 @@
|
|
|
1472
1524
|
- [ProviderAppointmentResponse](ProviderAppointmentResponse.md)
|
|
1473
1525
|
- [ProviderAppointmentsResponse](ProviderAppointmentsResponse.md)
|
|
1474
1526
|
- [ProviderContactPoint](ProviderContactPoint.md)
|
|
1527
|
+
- [ProviderCredential](ProviderCredential.md)
|
|
1475
1528
|
- [ProviderEducationCredential](ProviderEducationCredential.md)
|
|
1476
1529
|
- [ProviderEncounterListResponse](ProviderEncounterListResponse.md)
|
|
1530
|
+
- [ProviderEncounterRecord](ProviderEncounterRecord.md)
|
|
1477
1531
|
- [ProviderEncounterResponse](ProviderEncounterResponse.md)
|
|
1478
1532
|
- [ProviderGender](ProviderGender.md)
|
|
1479
1533
|
- [ProviderIdentifier](ProviderIdentifier.md)
|
|
1480
1534
|
- [ProviderIdentifierType](ProviderIdentifierType.md)
|
|
1481
1535
|
- [ProviderLanguage](ProviderLanguage.md)
|
|
1536
|
+
- [ProviderLocation](ProviderLocation.md)
|
|
1537
|
+
- [ProviderLocationAddressRequest](ProviderLocationAddressRequest.md)
|
|
1538
|
+
- [ProviderLocationDeletedResponse](ProviderLocationDeletedResponse.md)
|
|
1539
|
+
- [ProviderLocationHoursRequest](ProviderLocationHoursRequest.md)
|
|
1540
|
+
- [ProviderLocationListResponse](ProviderLocationListResponse.md)
|
|
1541
|
+
- [ProviderLocationPatchRequest](ProviderLocationPatchRequest.md)
|
|
1542
|
+
- [ProviderLocationRequest](ProviderLocationRequest.md)
|
|
1543
|
+
- [ProviderOnboardingStatus](ProviderOnboardingStatus.md)
|
|
1482
1544
|
- [ProviderPatientAddress](ProviderPatientAddress.md)
|
|
1483
1545
|
- [ProviderPatientPhone](ProviderPatientPhone.md)
|
|
1546
|
+
- [ProviderPatientRecordResources](ProviderPatientRecordResources.md)
|
|
1484
1547
|
- [ProviderPatientRecordResponse](ProviderPatientRecordResponse.md)
|
|
1485
1548
|
- [ProviderPatientSummary](ProviderPatientSummary.md)
|
|
1549
|
+
- [ProviderPostgraduateTraining](ProviderPostgraduateTraining.md)
|
|
1550
|
+
- [ProviderProfessionalLiability](ProviderProfessionalLiability.md)
|
|
1486
1551
|
- [ProviderRole](ProviderRole.md)
|
|
1487
1552
|
- [ProviderSearchRequest](ProviderSearchRequest.md)
|
|
1488
1553
|
- [ProviderSearchResponse](ProviderSearchResponse.md)
|
|
@@ -1516,7 +1581,6 @@
|
|
|
1516
1581
|
- [QuestHL7MessageContent](QuestHL7MessageContent.md)
|
|
1517
1582
|
- [QuestionItemType](QuestionItemType.md)
|
|
1518
1583
|
- [QuestionnaireItemInput](QuestionnaireItemInput.md)
|
|
1519
|
-
- [QuestionnaireResponse](QuestionnaireResponse.md)
|
|
1520
1584
|
- [QuestionnaireResponseStatus](QuestionnaireResponseStatus.md)
|
|
1521
1585
|
- [QuestListTestCatalogRequest](QuestListTestCatalogRequest.md)
|
|
1522
1586
|
- [QuestOrderDocument](QuestOrderDocument.md)
|
|
@@ -1546,8 +1610,6 @@
|
|
|
1546
1610
|
- [ReplaceInsuranceResponse](ReplaceInsuranceResponse.md)
|
|
1547
1611
|
- [RescheduleAppointmentRequest](RescheduleAppointmentRequest.md)
|
|
1548
1612
|
- [RespiratoryRate](RespiratoryRate.md)
|
|
1549
|
-
- [ResponseAnswer](ResponseAnswer.md)
|
|
1550
|
-
- [ResponseItem](ResponseItem.md)
|
|
1551
1613
|
- [RetireInsuranceRequest](RetireInsuranceRequest.md)
|
|
1552
1614
|
- [RetireInsuranceResponse](RetireInsuranceResponse.md)
|
|
1553
1615
|
- [rppg.ConnectResponse](rppg.ConnectResponse.md)
|
|
@@ -1738,11 +1800,15 @@
|
|
|
1738
1800
|
- [SendGridSendResult](SendGridSendResult.md)
|
|
1739
1801
|
- [SendGridTemplate](SendGridTemplate.md)
|
|
1740
1802
|
- [session.ConnectResponse](session.ConnectResponse.md)
|
|
1803
|
+
- [SetPortalRolesRequest](SetPortalRolesRequest.md)
|
|
1741
1804
|
- [SetPreferredPharmacyRequest](SetPreferredPharmacyRequest.md)
|
|
1742
1805
|
- [SetPreferredPharmacyResponse](SetPreferredPharmacyResponse.md)
|
|
1743
1806
|
- [SexAtBirth](SexAtBirth.md)
|
|
1807
|
+
- [SexualOrientation](SexualOrientation.md)
|
|
1744
1808
|
- [Slot](Slot.md)
|
|
1745
1809
|
- [SlotStatus](SlotStatus.md)
|
|
1810
|
+
- [SmokingStatus](SmokingStatus.md)
|
|
1811
|
+
- [SocialHistory](SocialHistory.md)
|
|
1746
1812
|
- [Specimen](Specimen.md)
|
|
1747
1813
|
- [SpecimenStatus](SpecimenStatus.md)
|
|
1748
1814
|
- [SpecimenType](SpecimenType.md)
|
|
@@ -1854,11 +1920,14 @@
|
|
|
1854
1920
|
- [SubmitCurrentSymptomsResponse](SubmitCurrentSymptomsScreeningsCurrentSymptomsResponse.md)
|
|
1855
1921
|
- [SubmitSummaryRequest](SubmitSummaryRequest.md)
|
|
1856
1922
|
- [SubscriberRelationship](SubscriberRelationship.md)
|
|
1923
|
+
- [SubstanceStatus](SubstanceStatus.md)
|
|
1924
|
+
- [SubstanceUse](SubstanceUse.md)
|
|
1857
1925
|
- [telehealth.ConnectResponse](telehealth.ConnectResponse.md)
|
|
1858
1926
|
- [ErrorResponse](telehealth.ErrorResponse.md)
|
|
1859
1927
|
- [TelehealthToken](TelehealthToken.md)
|
|
1860
1928
|
- [TemperatureRoute](TemperatureRoute.md)
|
|
1861
1929
|
- [TestOrder](TestOrder.md)
|
|
1930
|
+
- [TobaccoUse](TobaccoUse.md)
|
|
1862
1931
|
- [TwilioGetMessageRequest](TwilioGetMessageRequest.md)
|
|
1863
1932
|
- [TwilioListMessagesRequest](TwilioListMessagesRequest.md)
|
|
1864
1933
|
- [TwilioListMessagesResponse](TwilioListMessagesResponse.md)
|
|
@@ -1924,6 +1993,7 @@
|
|
|
1924
1993
|
- [VisionFaceCompareResponse](VisionFaceCompareResponse.md)
|
|
1925
1994
|
- [VitalReading](VitalReading.md)
|
|
1926
1995
|
- [vitals.ConnectResponse](vitals.ConnectResponse.md)
|
|
1996
|
+
- [VitalsRecord](VitalsRecord.md)
|
|
1927
1997
|
- [VitalsRecordRequest](VitalsRecordRequest.md)
|
|
1928
1998
|
- [VitalsStatus](VitalsStatus.md)
|
|
1929
1999
|
- [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.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# BloodPressure
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.BloodPressure`
|
|
4
|
+
|
|
5
|
+
A blood pressure reading.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `arm` | `string|null` | No | | | | Yes | Left, Right, Either |
|
|
14
|
+
| `diastolic` | `number` | Yes | | | | No | mmHg |
|
|
15
|
+
| `position` | [`PositionCode`](./PositionCode.md) | No | | | | Yes | Patient position during the reading, optional. |
|
|
16
|
+
| `systolic` | `number` | Yes | | | | No | mmHg |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CodedConcept
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.CodedConcept`
|
|
4
|
+
|
|
5
|
+
A clinical concept identified by one or more coding systems.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `code` | `string` | Yes | | | | No | Code value from the coding system (e.g. an ICD-10 or SNOMED CT code). |
|
|
14
|
+
| `display` | `string` | Yes | | | | No | Human-readable display text for the code. |
|
|
15
|
+
| `system` | `string|null` | No | | | | Yes | e.g. ICD-10, SNOMED-CT, CPT, CVX, RxNorm, NDC |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Coding
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.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.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Dosage
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.Dosage`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `duration_days` | `integer|null` | No | | | | Yes | Number of days the medication should be taken, for a finite course. |
|
|
14
|
+
| `frequency` | [`MedicationFrequency`](./MedicationFrequency.md) | Yes | | | | No | How often the dose is taken (e.g. once_daily, twice_daily, as_needed). |
|
|
15
|
+
| `frequency_details` | `string|null` | No | | | | Yes | Free-text frequency details when frequency is 'other' or needs clarification. |
|
|
16
|
+
| `instructions` | `string|null` | No | | | | Yes | Free-text patient instructions for taking the dose, when present. |
|
|
17
|
+
| `max_daily_dose` | `number|null` | No | | | | Yes | Maximum dose allowed per day, when specified. |
|
|
18
|
+
| `max_daily_dose_unit` | `string|null` | No | | | | Yes | Unit for max_daily_dose (e.g. mg, mcg), when specified. |
|
|
19
|
+
| `unit` | `string` | Yes | | | | No | mg, mcg, mL, units, puffs, drops, etc. |
|
|
20
|
+
| `value` | `number` | Yes | | | | No | Dose amount per administration. |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Encounter
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.Encounter`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
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_id` | `string` | Yes | | | | No | FHIR Patient id who is the subject of the encounter. |
|
|
30
|
+
| `period_end` | `string|null` | No | | | | Yes | When the encounter ended, when recorded. |
|
|
31
|
+
| `period_start` | `string|null` | No | | | | Yes | When the encounter started, when recorded. |
|
|
32
|
+
| `priority_code` | `string|null` | No | | | | Yes | Code for the encounter priority (e.g. routine, urgent, emergent), when coded. |
|
|
33
|
+
| `priority_display` | `string|null` | No | | | | Yes | Display text for the encounter priority, when available. |
|
|
34
|
+
| `reason_code` | `string|null` | No | | | | Yes | SNOMED CT code for the reason for the encounter, when coded. |
|
|
35
|
+
| `reason_display` | `string|null` | No | | | | Yes | Display text for the reason for the encounter, when available. |
|
|
36
|
+
| `service_provider_display` | `string|null` | No | | | | Yes | Display name of the service provider organization, when available. |
|
|
37
|
+
| `service_provider_id` | `string|null` | No | | | | Yes | FHIR Organization id of the service provider, when linked. |
|
|
38
|
+
| `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
|
|
39
|
+
| `service_type_display` | `string|null` | No | | | | Yes | Display text for the service type, when available. |
|
|
40
|
+
| `status` | [`EncounterStatus`](./EncounterStatus.md) | No | | | `"planned"` | No | Encounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error, or unknown. |
|
|
41
|
+
| `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. |
|
|
42
|
+
| `steadymd_episode_guid` | `string|null` | No | | | | Yes | SteadyMD episode guid this encounter is linked to, when checked in via SteadyMD. |
|
|
43
|
+
| `type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the encounter type (e.g. office visit, follow-up), when coded. |
|
|
44
|
+
| `type_display` | `string|null` | No | | | | Yes | Display text for the encounter type, when available. |
|
|
45
|
+
|
|
46
|
+
## Example
|
|
47
|
+
|
|
48
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EncounterDiagnosis
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.EncounterDiagnosis`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `condition_display` | `string|null` | No | | | | Yes | Display text for the diagnosis, when available. |
|
|
14
|
+
| `condition_id` | `string` | Yes | | | | No | FHIR Condition id referenced by this diagnosis. |
|
|
15
|
+
| `rank` | `integer` | No | | | `1` | No | Ranking of this diagnosis relative to others in the encounter (1 = primary). |
|
|
16
|
+
| `use_code` | `string` | No | | | `"CC"` | No | Diagnosis use code (e.g. CC chief complaint, AD admission diagnosis). |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EncounterHospitalization
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.EncounterHospitalization`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `admit_source_code` | `string|null` | No | | | | Yes | Code for the patient's admission source (e.g. emergency, referral), when recorded. |
|
|
14
|
+
| `destination_id` | `string|null` | No | | | | Yes | FHIR Location id the patient was discharged to, when applicable. |
|
|
15
|
+
| `discharge_disposition` | [`DischargeDisposition`](./DischargeDisposition.md) | No | | | | Yes | Discharge disposition (e.g. home, skilled nursing, expired), when recorded. |
|
|
16
|
+
| `origin_id` | `string|null` | No | | | | Yes | FHIR Location id the patient came from before admission, when applicable. |
|
|
17
|
+
| `pre_admission_id` | `string|null` | No | | | | Yes | Identifier of any pre-admission encounter, when applicable. |
|
|
18
|
+
| `re_admission_code` | `string|null` | No | | | | Yes | Code indicating this is a readmission, when applicable. |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# EncounterLocation
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.EncounterLocation`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `location_display` | `string|null` | No | | | | Yes | Display name of the location, when available. |
|
|
14
|
+
| `location_id` | `string` | Yes | | | | No | FHIR Location id where the encounter takes place. |
|
|
15
|
+
| `period_end` | `string|null` | No | | | | Yes | When the patient was at this location, end, when recorded. |
|
|
16
|
+
| `period_start` | `string|null` | No | | | | Yes | When the patient was at this location, start, when recorded. |
|
|
17
|
+
| `status` | [`LocationStatus`](./LocationStatus.md) | No | | | `"active"` | No | Location status during the encounter: planned, active, reserved, or completed. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# EncounterParticipant
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.EncounterParticipant`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `participant_type` | [`ParticipantType`](./ParticipantType.md) | No | | | `"PPRF"` | No | Role of the participant in the encounter (e.g. PPRF primary performer, ATND attender, ADM admitter). |
|
|
14
|
+
| `period_end` | `string|null` | No | | | | Yes | When the participant's involvement ended, when recorded. |
|
|
15
|
+
| `period_start` | `string|null` | No | | | | Yes | When the participant's involvement started, when recorded. |
|
|
16
|
+
| `practitioner_display` | `string|null` | No | | | | Yes | Display name of the practitioner, when known. |
|
|
17
|
+
| `practitioner_id` | `string` | Yes | | | | No | FHIR Practitioner id of the participant. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|