@healthcloudai/hc-sdk 3.16.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 (122) hide show
  1. package/dist/index.cjs +23 -0
  2. package/dist/index.d.cts +314 -2
  3. package/dist/index.d.ts +314 -2
  4. package/dist/index.js +23 -0
  5. package/docs/clients/PatientClient.md +2 -0
  6. package/docs/docs-manifest.json +78 -12
  7. package/docs/examples/index.md +2 -0
  8. package/docs/index.md +2 -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/Insurance.md +2 -0
  22. package/docs/models/LicenseVerification.md +19 -0
  23. package/docs/models/ListAllergiesResponse.md +1 -1
  24. package/docs/models/ListConditionsResponse.md +1 -1
  25. package/docs/models/ListDirectivesResponse.md +1 -1
  26. package/docs/models/ListFamilyHistoryResponse.md +1 -1
  27. package/docs/models/ListImmunizationsResponse.md +1 -1
  28. package/docs/models/ListProceduresResponse.md +1 -1
  29. package/docs/models/ListQuestionnaireResponsesResponse.md +1 -1
  30. package/docs/models/LivingSituation.md +15 -0
  31. package/docs/models/NpiVerification.md +21 -0
  32. package/docs/models/OnboardingProgressRequest.md +18 -0
  33. package/docs/models/PortalRole.md +18 -0
  34. package/docs/models/Practitioner.md +9 -2
  35. package/docs/models/ProviderCredential.md +19 -0
  36. package/docs/models/ProviderEducationCredential.md +6 -2
  37. package/docs/models/ProviderEncounterListResponse.md +1 -1
  38. package/docs/models/ProviderEncounterRecord.md +49 -0
  39. package/docs/models/ProviderEncounterResponse.md +1 -1
  40. package/docs/models/ProviderLanguage.md +3 -2
  41. package/docs/models/ProviderOnboardingStatus.md +19 -0
  42. package/docs/models/ProviderPatientRecordResources.md +32 -0
  43. package/docs/models/ProviderPatientRecordResponse.md +1 -1
  44. package/docs/models/ProviderPostgraduateTraining.md +22 -0
  45. package/docs/models/ProviderProfessionalLiability.md +19 -0
  46. package/docs/models/ProviderSpecialty.md +1 -1
  47. package/docs/models/ProviderStateLicense.md +9 -2
  48. package/docs/models/ReplaceInsuranceRequest.md +25 -0
  49. package/docs/models/ReplaceInsuranceResponse.md +20 -0
  50. package/docs/models/RetireInsuranceRequest.md +17 -0
  51. package/docs/models/RetireInsuranceResponse.md +19 -0
  52. package/docs/models/SexualOrientation.md +15 -0
  53. package/docs/models/SmokingStatus.md +15 -0
  54. package/docs/models/SocialHistory.md +35 -0
  55. package/docs/models/SubstanceStatus.md +15 -0
  56. package/docs/models/SubstanceUse.md +23 -0
  57. package/docs/models/TobaccoUse.md +22 -0
  58. package/docs/models/UpdateEncounterClinicalNoteResponse.md +1 -1
  59. package/docs/models/UpdateEncounterStatusResponse.md +1 -1
  60. package/docs/models/UpdatePractitionerRequest.md +5 -0
  61. package/docs/models/UpdatePractitionerResponse.md +8 -2
  62. package/docs/models/VitalsRecord.md +41 -0
  63. package/docs/models/appointments.ErrorResponse.md +1 -0
  64. package/docs/models/diagnostics.Coding.md +19 -0
  65. package/docs/models/diagnostics.LabObservation.md +1 -1
  66. package/docs/models/{AdvanceDirective.md → ehr.AdvanceDirective.md} +1 -1
  67. package/docs/models/{Allergy.md → ehr.Allergy.md} +1 -1
  68. package/docs/models/ehr.Coding.md +19 -0
  69. package/docs/models/{FamilyHistoryEntry.md → ehr.FamilyHistoryEntry.md} +1 -1
  70. package/docs/models/{Immunization.md → ehr.Immunization.md} +1 -1
  71. package/docs/models/{Problem.md → ehr.Problem.md} +1 -1
  72. package/docs/models/{Procedure.md → ehr.Procedure.md} +1 -1
  73. package/docs/models/ehr.Quantity.md +20 -0
  74. package/docs/models/{QuestionnaireResponse.md → ehr.QuestionnaireResponse.md} +2 -2
  75. package/docs/models/{ResponseAnswer.md → ehr.ResponseAnswer.md} +4 -4
  76. package/docs/models/{ResponseItem.md → ehr.ResponseItem.md} +3 -3
  77. package/docs/models/index.md +73 -9
  78. package/docs/models/provider.AdvanceDirective.md +31 -0
  79. package/docs/models/provider.Allergy.md +31 -0
  80. package/docs/models/provider.AllergyReaction.md +21 -0
  81. package/docs/models/provider.BloodPressure.md +20 -0
  82. package/docs/models/provider.CodedConcept.md +19 -0
  83. package/docs/models/provider.Coding.md +19 -0
  84. package/docs/models/provider.Dosage.md +24 -0
  85. package/docs/models/provider.Encounter.md +48 -0
  86. package/docs/models/provider.EncounterDiagnosis.md +20 -0
  87. package/docs/models/provider.EncounterHospitalization.md +22 -0
  88. package/docs/models/provider.EncounterLocation.md +21 -0
  89. package/docs/models/provider.EncounterParticipant.md +21 -0
  90. package/docs/models/provider.FamilyCondition.md +22 -0
  91. package/docs/models/provider.FamilyHistoryEntry.md +30 -0
  92. package/docs/models/provider.GynHistory.md +25 -0
  93. package/docs/models/provider.HeartRate.md +18 -0
  94. package/docs/models/provider.Immunization.md +40 -0
  95. package/docs/models/provider.ImmunizationReaction.md +20 -0
  96. package/docs/models/provider.LabObservation.md +29 -0
  97. package/docs/models/provider.Medication.md +41 -0
  98. package/docs/models/provider.PerinatalHistory.md +25 -0
  99. package/docs/models/provider.Problem.md +37 -0
  100. package/docs/models/provider.Procedure.md +37 -0
  101. package/docs/models/provider.PulseOximetry.md +20 -0
  102. package/docs/models/provider.Quantity.md +20 -0
  103. package/docs/models/provider.QuestionnaireResponse.md +27 -0
  104. package/docs/models/provider.ReferenceRange.md +20 -0
  105. package/docs/models/provider.ResponseAnswer.md +27 -0
  106. package/docs/models/provider.ResponseItem.md +21 -0
  107. package/docs/operations/appointments.book.md +34 -1
  108. package/docs/operations/fieldagent.listPatients.md +2 -0
  109. package/docs/operations/patient.getInsurance.md +17 -15
  110. package/docs/operations/patient.getPatient.md +2 -0
  111. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +2 -0
  112. package/docs/operations/patient.replaceInsurance.md +124 -0
  113. package/docs/operations/patient.retireInsurance.md +129 -0
  114. package/docs/operations/provider.getEncounter.md +84 -1
  115. package/docs/operations/provider.getPatientRecord.md +516 -1
  116. package/docs/operations/provider.getPractitioner.md +92 -53
  117. package/docs/operations/provider.listEncounters.md +84 -1
  118. package/docs/operations/provider.register.md +25 -3
  119. package/docs/operations/provider.updateEncounterClinicalNote.md +84 -1
  120. package/docs/operations/provider.updateEncounterStatus.md +84 -1
  121. package/docs/operations/provider.updatePractitioner.md +256 -150
  122. package/package.json +1 -1
@@ -59,95 +59,134 @@ None declared in canonical OpenAPI.
59
59
  ```json
60
60
  {
61
61
  "active": true,
62
- "address": {
63
- "city": "Boston",
64
- "country": "US",
65
- "is_primary": true,
66
- "state": "MA",
67
- "street1": "200 Medical Plaza",
68
- "street2": "Suite 300",
69
- "type": "work",
70
- "zip_code": "02108"
71
- },
72
- "birth_date": "1980-05-12",
62
+ "birth_date": "string",
73
63
  "board_certifications": [
74
- "Cardiovascular Disease"
64
+ "string"
65
+ ],
66
+ "credential": "string",
67
+ "credentials": [
68
+ {
69
+ "code": "string",
70
+ "primary": false,
71
+ "system": "http://terminology.hl7.org/CodeSystem/v2-0360"
72
+ }
75
73
  ],
76
- "credential": "MD",
77
- "department": "Cardiology",
74
+ "department": "string",
78
75
  "education_credentials": [
79
76
  {
80
- "credential": "MD",
81
- "graduation_year": 2006,
82
- "institution": "Example University School of Medicine"
77
+ "credential": "string",
78
+ "graduation_year": 1900,
79
+ "id": "string",
80
+ "institution": "string",
81
+ "level": "undergraduate",
82
+ "program": "string",
83
+ "start_year": 1900
83
84
  }
84
85
  ],
85
- "email": "provider.user@example.com",
86
- "fhir_id": "practitioner-example-001",
87
- "first_name": "Alex",
88
- "gender": "female",
89
- "graduation_year": 2006,
86
+ "email": "user@example.com",
87
+ "first_name": "string",
88
+ "gender": "unknown",
89
+ "graduation_year": 0,
90
90
  "identifiers": [
91
91
  {
92
- "expiration_date": "2028-12-31",
93
- "state": "MA",
94
- "type": "DEA",
95
- "value": "EXAMPLE123"
92
+ "expiration_date": "string",
93
+ "state": "string",
94
+ "type": "NPI",
95
+ "value": "string"
96
96
  }
97
97
  ],
98
98
  "insurances_accepted": [
99
99
  {
100
- "payer_id": "payer-example-001",
101
- "payer_name": "Example Health Plan"
100
+ "payer_id": "string",
101
+ "payer_name": "string"
102
102
  }
103
103
  ],
104
- "languages_spoken": [
104
+ "languages_spoken": [],
105
+ "last_name": "string",
106
+ "medical_school": "string",
107
+ "middle_name": "string",
108
+ "notes": "string",
109
+ "npi": "string",
110
+ "npi_verification": {
111
+ "registry_first_name": "string",
112
+ "registry_last_name": "string",
113
+ "source": "string",
114
+ "status": "unverified",
115
+ "verified_at": "2026-01-01T09:00:00Z"
116
+ },
117
+ "onboarding": {
118
+ "completed_at": "2026-01-01T09:00:00Z",
119
+ "completed_steps": [
120
+ "string"
121
+ ],
122
+ "flow": "virtual-practice"
123
+ },
124
+ "organization_id": "string",
125
+ "organization_name": "string",
126
+ "photo_binary_id": "string",
127
+ "portal_roles": [
128
+ "provider_applicant"
129
+ ],
130
+ "postgraduate_training": [
105
131
  {
106
- "code": "en",
107
- "display": "English"
132
+ "end_year": 1900,
133
+ "id": "string",
134
+ "institution": "string",
135
+ "specialty": "string",
136
+ "start_year": 1900,
137
+ "type": "residency"
108
138
  }
109
139
  ],
110
- "last_name": "Smith",
111
- "medical_school": "Example University School of Medicine",
112
- "middle_name": "Jordan",
113
- "notes": "Accepting new cardiology patients.",
114
- "npi": "1234567890",
115
- "organization_id": "organization-example-001",
116
- "organization_name": "Example Health Organization",
117
- "photo_binary_id": "photo-example-001",
118
- "practitioner_id": "00000000-0000-4000-8000-000000000000",
119
- "prefix": "Dr.",
140
+ "practitioner_id": "string",
141
+ "prefix": "string",
142
+ "professional_display_name": "string",
143
+ "professional_liability": {
144
+ "carrier": "string",
145
+ "coverage_expiration": "string",
146
+ "policy_number": "string"
147
+ },
120
148
  "race": [
121
- "white"
149
+ "american_indian_or_alaska_native"
122
150
  ],
123
151
  "roles": [
124
152
  "physician"
125
153
  ],
126
154
  "specialty": [
127
155
  {
128
- "board_certified": true,
129
- "code": "207RC0000X",
130
- "display": "Cardiovascular Disease Physician",
131
- "primary": true,
156
+ "board_certified": false,
157
+ "code": "string",
158
+ "display": "string",
159
+ "primary": false,
132
160
  "system": "http://nucc.org/provider-taxonomy"
133
161
  }
134
162
  ],
135
163
  "state_licenses": [
136
164
  {
137
- "expiration_date": "2028-12-31",
138
- "license_number": "MA-EXAMPLE-12345",
139
- "state": "MA"
165
+ "compact": false,
166
+ "expiration_date": "string",
167
+ "id": "string",
168
+ "issued_date": "string",
169
+ "license_number": "string",
170
+ "license_type": "string",
171
+ "primary": false,
172
+ "state": "st",
173
+ "status": "active",
174
+ "verification": {
175
+ "source": "string",
176
+ "status": "self-attested",
177
+ "verified_at": "2026-01-01T09:00:00Z"
178
+ }
140
179
  }
141
180
  ],
142
- "suffix": "Jr.",
181
+ "suffix": "string",
143
182
  "telecom": [
144
183
  {
145
- "system": "phone",
184
+ "system": "string",
146
185
  "use": "work",
147
- "value": "+15550100000"
186
+ "value": "string"
148
187
  }
149
188
  ],
150
- "telehealth_id": "1700000000"
189
+ "telehealth_id": "string"
151
190
  }
152
191
  ```
153
192
 
@@ -59,7 +59,90 @@ None declared in canonical OpenAPI.
59
59
  ```json
60
60
  {
61
61
  "encounters": [
62
- {}
62
+ {
63
+ "appointment_id": "string",
64
+ "athena_appointment_id": "string",
65
+ "athena_encounter_id": "string",
66
+ "created_by": "self",
67
+ "created_date": "2026-01-01T09:00:00Z",
68
+ "diagnoses": [
69
+ {
70
+ "condition_display": "string",
71
+ "condition_id": "string",
72
+ "rank": 1,
73
+ "use_code": "CC"
74
+ }
75
+ ],
76
+ "encounter_class": "AMB",
77
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
78
+ "fhir_id": "string",
79
+ "hospitalization": {
80
+ "admit_source_code": "string",
81
+ "destination_id": "string",
82
+ "discharge_disposition": "home",
83
+ "origin_id": "string",
84
+ "pre_admission_id": "string",
85
+ "re_admission_code": "string"
86
+ },
87
+ "length_minutes": 0,
88
+ "locations": [
89
+ {
90
+ "location_display": "string",
91
+ "location_id": "string",
92
+ "period_end": "2026-01-01T09:00:00Z",
93
+ "period_start": "2026-01-01T09:00:00Z",
94
+ "status": "active"
95
+ }
96
+ ],
97
+ "notes": "string",
98
+ "openloop_appointment_id": "string",
99
+ "openloop_encounter_id": "string",
100
+ "participants": [
101
+ {
102
+ "participant_type": "PPRF",
103
+ "period_end": "2026-01-01T09:00:00Z",
104
+ "period_start": "2026-01-01T09:00:00Z",
105
+ "practitioner_display": "string",
106
+ "practitioner_id": "string"
107
+ }
108
+ ],
109
+ "patient": {
110
+ "address": {
111
+ "city": "string",
112
+ "country": "string",
113
+ "state": "string",
114
+ "street1": "string",
115
+ "street2": "string",
116
+ "zip_code": "string"
117
+ },
118
+ "date_of_birth": "string",
119
+ "first_name": "string",
120
+ "gender": "string",
121
+ "last_name": "string",
122
+ "patient_id": "string",
123
+ "phone": {
124
+ "extension": "string",
125
+ "number": "string",
126
+ "type": "string"
127
+ }
128
+ },
129
+ "patient_id": "string",
130
+ "period_end": "2026-01-01T09:00:00Z",
131
+ "period_start": "2026-01-01T09:00:00Z",
132
+ "priority_code": "string",
133
+ "priority_display": "string",
134
+ "reason_code": "string",
135
+ "reason_display": "string",
136
+ "service_provider_display": "string",
137
+ "service_provider_id": "string",
138
+ "service_type_code": "string",
139
+ "service_type_display": "string",
140
+ "status": "planned",
141
+ "steadymd_consult_guid": "string",
142
+ "steadymd_episode_guid": "string",
143
+ "type_code": "string",
144
+ "type_display": "string"
145
+ }
63
146
  ],
64
147
  "total": 0
65
148
  }
@@ -73,9 +73,20 @@ Request model: [`provider.RegisterRequest`](../models/provider.RegisterRequest.m
73
73
  ],
74
74
  "state_licenses": [
75
75
  {
76
+ "compact": false,
76
77
  "expiration_date": "string",
78
+ "id": "string",
79
+ "issued_date": "string",
77
80
  "license_number": "string",
78
- "state": "st"
81
+ "license_type": "string",
82
+ "primary": false,
83
+ "state": "st",
84
+ "status": "active",
85
+ "verification": {
86
+ "source": "string",
87
+ "status": "self-attested",
88
+ "verified_at": "2026-01-01T09:00:00Z"
89
+ }
79
90
  }
80
91
  ],
81
92
  "tenant_id": "string"
@@ -166,9 +177,20 @@ const request = {
166
177
  ],
167
178
  "state_licenses": [
168
179
  {
180
+ "compact": false,
169
181
  "expiration_date": "string",
182
+ "id": "string",
183
+ "issued_date": "string",
170
184
  "license_number": "string",
171
- "state": "st"
185
+ "license_type": "string",
186
+ "primary": false,
187
+ "state": "st",
188
+ "status": "active",
189
+ "verification": {
190
+ "source": "string",
191
+ "status": "self-attested",
192
+ "verified_at": "2026-01-01T09:00:00Z"
193
+ }
172
194
  }
173
195
  ],
174
196
  "tenant_id": "string"
@@ -182,7 +204,7 @@ const result = await provider.register(request);
182
204
  ```bash
183
205
  curl -X POST \
184
206
  -H 'Content-Type: application/json' \
185
- -d '{"address":{},"date_of_birth":"string","department":"string","education_credentials":["string"],"email":"user@example.com","first_name":"string","gender":"male","insurances_accepted":[{"payer_id":"string","payer_name":"string"}],"languages_spoken":["string"],"last_name":"string","npi":"string","organization":"string","password":"stringxx","phone":"string","race":"string","specialty":["string"],"state_licenses":[{"expiration_date":"string","license_number":"string","state":"st"}],"tenant_id":"string"}' \
207
+ -d '{"address":{},"date_of_birth":"string","department":"string","education_credentials":["string"],"email":"user@example.com","first_name":"string","gender":"male","insurances_accepted":[{"payer_id":"string","payer_name":"string"}],"languages_spoken":["string"],"last_name":"string","npi":"string","organization":"string","password":"stringxx","phone":"string","race":"string","specialty":["string"],"state_licenses":[{"compact":false,"expiration_date":"string","id":"string","issued_date":"string","license_number":"string","license_type":"string","primary":false,"state":"st","status":"active","verification":{"source":"string","status":"self-attested","verified_at":"2026-01-01T09:00:00Z"}}],"tenant_id":"string"}' \
186
208
  'https://dev-api-provider.health.cloud/auth/register'
187
209
  ```
188
210
 
@@ -66,7 +66,90 @@ Request model: [`UpdateEncounterClinicalNoteRequest`](../models/UpdateEncounterC
66
66
  ```json
67
67
  {
68
68
  "ehr_status": "updated",
69
- "encounter": {},
69
+ "encounter": {
70
+ "appointment_id": "string",
71
+ "athena_appointment_id": "string",
72
+ "athena_encounter_id": "string",
73
+ "created_by": "self",
74
+ "created_date": "2026-01-01T09:00:00Z",
75
+ "diagnoses": [
76
+ {
77
+ "condition_display": "string",
78
+ "condition_id": "string",
79
+ "rank": 1,
80
+ "use_code": "CC"
81
+ }
82
+ ],
83
+ "encounter_class": "AMB",
84
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
85
+ "fhir_id": "string",
86
+ "hospitalization": {
87
+ "admit_source_code": "string",
88
+ "destination_id": "string",
89
+ "discharge_disposition": "home",
90
+ "origin_id": "string",
91
+ "pre_admission_id": "string",
92
+ "re_admission_code": "string"
93
+ },
94
+ "length_minutes": 0,
95
+ "locations": [
96
+ {
97
+ "location_display": "string",
98
+ "location_id": "string",
99
+ "period_end": "2026-01-01T09:00:00Z",
100
+ "period_start": "2026-01-01T09:00:00Z",
101
+ "status": "active"
102
+ }
103
+ ],
104
+ "notes": "string",
105
+ "openloop_appointment_id": "string",
106
+ "openloop_encounter_id": "string",
107
+ "participants": [
108
+ {
109
+ "participant_type": "PPRF",
110
+ "period_end": "2026-01-01T09:00:00Z",
111
+ "period_start": "2026-01-01T09:00:00Z",
112
+ "practitioner_display": "string",
113
+ "practitioner_id": "string"
114
+ }
115
+ ],
116
+ "patient": {
117
+ "address": {
118
+ "city": "string",
119
+ "country": "string",
120
+ "state": "string",
121
+ "street1": "string",
122
+ "street2": "string",
123
+ "zip_code": "string"
124
+ },
125
+ "date_of_birth": "string",
126
+ "first_name": "string",
127
+ "gender": "string",
128
+ "last_name": "string",
129
+ "patient_id": "string",
130
+ "phone": {
131
+ "extension": "string",
132
+ "number": "string",
133
+ "type": "string"
134
+ }
135
+ },
136
+ "patient_id": "string",
137
+ "period_end": "2026-01-01T09:00:00Z",
138
+ "period_start": "2026-01-01T09:00:00Z",
139
+ "priority_code": "string",
140
+ "priority_display": "string",
141
+ "reason_code": "string",
142
+ "reason_display": "string",
143
+ "service_provider_display": "string",
144
+ "service_provider_id": "string",
145
+ "service_type_code": "string",
146
+ "service_type_display": "string",
147
+ "status": "planned",
148
+ "steadymd_consult_guid": "string",
149
+ "steadymd_episode_guid": "string",
150
+ "type_code": "string",
151
+ "type_display": "string"
152
+ },
70
153
  "fhir_status": "updated"
71
154
  }
72
155
  ```
@@ -65,7 +65,90 @@ Request model: [`UpdateEncounterStatusRequest`](../models/UpdateEncounterStatusR
65
65
  ```json
66
66
  {
67
67
  "ehr_status": "updated",
68
- "encounter": {},
68
+ "encounter": {
69
+ "appointment_id": "string",
70
+ "athena_appointment_id": "string",
71
+ "athena_encounter_id": "string",
72
+ "created_by": "self",
73
+ "created_date": "2026-01-01T09:00:00Z",
74
+ "diagnoses": [
75
+ {
76
+ "condition_display": "string",
77
+ "condition_id": "string",
78
+ "rank": 1,
79
+ "use_code": "CC"
80
+ }
81
+ ],
82
+ "encounter_class": "AMB",
83
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
84
+ "fhir_id": "string",
85
+ "hospitalization": {
86
+ "admit_source_code": "string",
87
+ "destination_id": "string",
88
+ "discharge_disposition": "home",
89
+ "origin_id": "string",
90
+ "pre_admission_id": "string",
91
+ "re_admission_code": "string"
92
+ },
93
+ "length_minutes": 0,
94
+ "locations": [
95
+ {
96
+ "location_display": "string",
97
+ "location_id": "string",
98
+ "period_end": "2026-01-01T09:00:00Z",
99
+ "period_start": "2026-01-01T09:00:00Z",
100
+ "status": "active"
101
+ }
102
+ ],
103
+ "notes": "string",
104
+ "openloop_appointment_id": "string",
105
+ "openloop_encounter_id": "string",
106
+ "participants": [
107
+ {
108
+ "participant_type": "PPRF",
109
+ "period_end": "2026-01-01T09:00:00Z",
110
+ "period_start": "2026-01-01T09:00:00Z",
111
+ "practitioner_display": "string",
112
+ "practitioner_id": "string"
113
+ }
114
+ ],
115
+ "patient": {
116
+ "address": {
117
+ "city": "string",
118
+ "country": "string",
119
+ "state": "string",
120
+ "street1": "string",
121
+ "street2": "string",
122
+ "zip_code": "string"
123
+ },
124
+ "date_of_birth": "string",
125
+ "first_name": "string",
126
+ "gender": "string",
127
+ "last_name": "string",
128
+ "patient_id": "string",
129
+ "phone": {
130
+ "extension": "string",
131
+ "number": "string",
132
+ "type": "string"
133
+ }
134
+ },
135
+ "patient_id": "string",
136
+ "period_end": "2026-01-01T09:00:00Z",
137
+ "period_start": "2026-01-01T09:00:00Z",
138
+ "priority_code": "string",
139
+ "priority_display": "string",
140
+ "reason_code": "string",
141
+ "reason_display": "string",
142
+ "service_provider_display": "string",
143
+ "service_provider_id": "string",
144
+ "service_type_code": "string",
145
+ "service_type_display": "string",
146
+ "status": "planned",
147
+ "steadymd_consult_guid": "string",
148
+ "steadymd_episode_guid": "string",
149
+ "type_code": "string",
150
+ "type_display": "string"
151
+ },
69
152
  "fhir_status": "updated"
70
153
  }
71
154
  ```