@healthcloudai/hc-sdk 2.6.2 → 2.8.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 (112) hide show
  1. package/dist/index.cjs +173 -0
  2. package/dist/index.d.cts +5950 -5764
  3. package/dist/index.d.ts +5950 -5764
  4. package/dist/index.js +173 -0
  5. package/docs/clients/EhrClient.md +15 -0
  6. package/docs/clients/PatientClient.md +3 -0
  7. package/docs/docs-manifest.json +62 -5
  8. package/docs/examples/index.md +18 -0
  9. package/docs/index.md +18 -0
  10. package/docs/models/AddInsuranceRequest.md +1 -0
  11. package/docs/models/AddInsuranceResponse.md +2 -0
  12. package/docs/models/Allergy.md +31 -0
  13. package/docs/models/AllergyCategory.md +15 -0
  14. package/docs/models/AllergyCriticality.md +15 -0
  15. package/docs/models/AllergyReaction.md +21 -0
  16. package/docs/models/AllergyStatus.md +15 -0
  17. package/docs/models/AllergyVerificationStatus.md +15 -0
  18. package/docs/models/Appointment.md +1 -0
  19. package/docs/models/AthenaAppointment.md +1 -0
  20. package/docs/models/BookAppointmentRequest.md +1 -0
  21. package/docs/models/CheckEncounterRequest.md +17 -0
  22. package/docs/models/CheckInEncounterRequest.md +17 -0
  23. package/docs/models/CodedConcept.md +19 -0
  24. package/docs/models/FamilyCondition.md +21 -0
  25. package/docs/models/FamilyHistoryEntry.md +30 -0
  26. package/docs/models/FamilyHistoryStatus.md +15 -0
  27. package/docs/models/FamilyRelationship.md +15 -0
  28. package/docs/models/GS1LookupResponse.md +3 -2
  29. package/docs/models/GetEncounterResponse.md +3 -0
  30. package/docs/models/GetHealthRecordResponse.md +19 -0
  31. package/docs/models/GetLatestEncounterResponse.md +17 -0
  32. package/docs/models/GetPatientResponse.md +2 -0
  33. package/docs/models/GetScanUploadUrlRequest.md +3 -2
  34. package/docs/models/GetTestResultResponse.md +20 -0
  35. package/docs/models/IntoleranceType.md +15 -0
  36. package/docs/models/ListAllergiesResponse.md +19 -0
  37. package/docs/models/ListConditionsResponse.md +19 -0
  38. package/docs/models/ListDirectivesResponse.md +19 -0
  39. package/docs/models/ListFamilyHistoryResponse.md +19 -0
  40. package/docs/models/ListFunctionalStatusResponse.md +19 -0
  41. package/docs/models/ListImmunizationsResponse.md +19 -0
  42. package/docs/models/ListObservationsResponse.md +19 -0
  43. package/docs/models/ListProceduresResponse.md +19 -0
  44. package/docs/models/ListQuestionnaireResponsesResponse.md +19 -0
  45. package/docs/models/ListSocialHistoryResponse.md +19 -0
  46. package/docs/models/ListVitalsResponse.md +19 -0
  47. package/docs/models/PatientDemographics.md +2 -0
  48. package/docs/models/Problem.md +37 -0
  49. package/docs/models/ProblemCategory.md +15 -0
  50. package/docs/models/ProblemClinicalStatus.md +15 -0
  51. package/docs/models/ProblemSeverity.md +15 -0
  52. package/docs/models/ProblemVerificationStatus.md +15 -0
  53. package/docs/models/QuestionnaireResponse.md +27 -0
  54. package/docs/models/QuestionnaireResponseStatus.md +15 -0
  55. package/docs/models/ReactionSeverity.md +15 -0
  56. package/docs/models/ResponseAnswer.md +27 -0
  57. package/docs/models/ResponseItem.md +21 -0
  58. package/docs/models/ScanUploadResponse.md +4 -4
  59. package/docs/models/Slot.md +1 -0
  60. package/docs/models/ehr.ListDiagnosticsResponse.md +19 -0
  61. package/docs/models/ehr.ListEncountersResponse.md +19 -0
  62. package/docs/models/ehr.ListMedicationsResponse.md +19 -0
  63. package/docs/models/fieldagent.Encounter.md +3 -0
  64. package/docs/models/index.md +41 -2
  65. package/docs/models/patient.Encounter.md +3 -0
  66. package/docs/operations/appointments.book.md +18 -15
  67. package/docs/operations/appointments.cancel.md +12 -11
  68. package/docs/operations/appointments.createSlot.md +44 -9
  69. package/docs/operations/appointments.listPatientAppointments.md +13 -12
  70. package/docs/operations/appointments.listSlots.md +9 -8
  71. package/docs/operations/appointments.reschedule.md +11 -10
  72. package/docs/operations/connectors.athenaBookAppointment.md +1 -0
  73. package/docs/operations/connectors.athenaCreateInsurancePackage.md +1 -1
  74. package/docs/operations/connectors.athenaGetAppointmentDetails.md +1 -0
  75. package/docs/operations/connectors.athenaGetBookedAppointments.md +1 -0
  76. package/docs/operations/connectors.athenaGetEncounter.md +1 -0
  77. package/docs/operations/connectors.athenaListAppointments.md +1 -0
  78. package/docs/operations/connectors.athenaListPatientAppointments.md +1 -0
  79. package/docs/operations/diagnostics.getScanUploadUrl.md +7 -5
  80. package/docs/operations/diagnostics.getTestResult.md +5 -23
  81. package/docs/operations/diagnostics.lookupTestByGs1.md +12 -6
  82. package/docs/operations/ehr.getHealthRecord.md +122 -0
  83. package/docs/operations/ehr.listAllergies.md +156 -0
  84. package/docs/operations/ehr.listConditions.md +152 -0
  85. package/docs/operations/ehr.listDiagnostics.md +147 -0
  86. package/docs/operations/ehr.listDirectives.md +122 -0
  87. package/docs/operations/ehr.listEncounters.md +178 -0
  88. package/docs/operations/ehr.listFamilyHistory.md +147 -0
  89. package/docs/operations/ehr.listFunctionalStatus.md +122 -0
  90. package/docs/operations/ehr.listImmunizations.md +122 -0
  91. package/docs/operations/ehr.listMedications.md +163 -0
  92. package/docs/operations/ehr.listObservations.md +126 -0
  93. package/docs/operations/ehr.listProcedures.md +122 -0
  94. package/docs/operations/ehr.listQuestionnaireResponses.md +162 -0
  95. package/docs/operations/ehr.listSocialHistory.md +122 -0
  96. package/docs/operations/ehr.listVitals.md +132 -0
  97. package/docs/operations/fieldagent.listEncounters.md +42 -39
  98. package/docs/operations/fieldagent.listPatients.md +60 -95
  99. package/docs/operations/patient.addInsurance.md +14 -10
  100. package/docs/operations/patient.checkEncounter.md +110 -0
  101. package/docs/operations/patient.checkInEncounter.md +173 -0
  102. package/docs/operations/patient.createEncounter.md +40 -37
  103. package/docs/operations/patient.getCheckinCheckin.md +41 -38
  104. package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +43 -40
  105. package/docs/operations/patient.getEncounter.md +40 -37
  106. package/docs/operations/patient.getLatestEncounter.md +162 -0
  107. package/docs/operations/patient.getPatient.md +57 -92
  108. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +97 -129
  109. package/docs/operations/patient.listEncounters.md +41 -38
  110. package/package.json +1 -1
  111. package/docs/models/PanelResult.md +0 -24
  112. package/docs/models/SingleTestResultResponse.md +0 -28
@@ -56,189 +56,157 @@ None declared in canonical OpenAPI.
56
56
 
57
57
  ```json
58
58
  {
59
- "asOf": "2026-08-10T23:35:55Z",
59
+ "asOf": "string",
60
60
  "ok": true,
61
61
  "sidebar": {
62
62
  "patient": {
63
63
  "active": true,
64
- "addresses": [
65
- {
66
- "city": "Testville",
67
- "country": "US",
68
- "is_primary": true,
69
- "state": "CA",
70
- "street1": "123 Example Street",
71
- "street2": "Apartment 4B",
72
- "type": "home",
73
- "zip_code": "94102"
74
- }
75
- ],
64
+ "addresses": [],
65
+ "athena_patient_id": "string",
66
+ "athena_practice_id": "string",
76
67
  "attributes": {},
77
68
  "communications": [
78
69
  {
79
- "language": "en",
80
- "preferred": true
70
+ "language": "string",
71
+ "preferred": false
81
72
  }
82
73
  ],
83
74
  "created_by": "self",
84
- "created_date": "2026-08-10T23:34:21Z",
85
- "date_of_birth": "1990-05-15",
75
+ "created_date": "2026-01-01T09:00:00Z",
76
+ "date_of_birth": "2026-01-01",
86
77
  "deceased": false,
87
- "deceased_cause": null,
88
- "deceased_date": null,
89
- "email": "test.user@example.com",
90
- "emergency_contacts": [
91
- {
92
- "email": "emergency.contact@example.com",
93
- "first_name": "Jamie",
94
- "is_primary": true,
95
- "last_name": "Smith",
96
- "phones": [
97
- {
98
- "extension": "101",
99
- "is_primary": true,
100
- "number": "+15550100003",
101
- "sms_enabled": true,
102
- "type": "mobile"
103
- }
104
- ],
105
- "relationship": "Spouse",
106
- "relationship_v2_code": "SPS"
107
- }
108
- ],
109
- "ethnicity": "not_hispanic_or_latino",
110
- "fhir_id": "patient-example-001",
78
+ "deceased_cause": "string",
79
+ "deceased_date": "2026-01-01",
80
+ "email": "user@example.com",
81
+ "emergency_contacts": [],
82
+ "ethnicity": "hispanic_or_latino",
83
+ "fhir_id": "string",
111
84
  "flags": {},
112
- "gender": "unknown",
85
+ "gender": "male",
113
86
  "gender_identity": "man",
114
87
  "insurance": [
115
88
  {
116
- "copay": 25,
117
- "deductible": 1000,
89
+ "copay": 0,
90
+ "deductible": 0,
118
91
  "effective_date": "2026-01-01",
119
- "group_number": "GRP-example-001",
120
- "member_id": "MEM-example-001",
121
- "payer_id": "60054",
122
- "payer_name": "Example Health Plan",
123
- "plan_name": "Example Gold Plan",
124
- "plan_type": "PPO",
92
+ "group_number": "string",
93
+ "member_id": "string",
94
+ "payer_id": "string",
95
+ "payer_name": "string",
96
+ "plan_name": "string",
97
+ "plan_type": "string",
125
98
  "priority": "primary",
126
- "subscriber_date_of_birth": "1990-05-15",
127
- "subscriber_first_name": "Test",
128
- "subscriber_id": "SUB-example-001",
129
- "subscriber_last_name": "User",
99
+ "subscriber_date_of_birth": "2026-01-01",
100
+ "subscriber_first_name": "string",
101
+ "subscriber_id": "string",
102
+ "subscriber_last_name": "string",
130
103
  "subscriber_relationship": "self",
131
- "termination_date": "2026-12-31"
104
+ "termination_date": "2026-01-01"
132
105
  }
133
106
  ],
134
107
  "links": [
135
108
  {
136
- "other_patient_fhir_id": "patient-example-previous",
137
- "type": "replaces"
109
+ "other_patient_fhir_id": "string",
110
+ "type": "seealso"
138
111
  }
139
112
  ],
140
- "managing_organization_id": "organization-example-001",
141
- "marital_status": "married",
142
- "mrn": "MRN-EXAMPLE-001",
113
+ "managing_organization_id": "string",
114
+ "marital_status": "single",
115
+ "mrn": "string",
143
116
  "name": {
144
- "first_name": "Test",
145
- "last_name": "User",
146
- "middle_name": "Alex",
147
- "preferred_name": "Test",
148
- "prefix": "Mr.",
149
- "suffix": "Jr.",
117
+ "first_name": "string",
118
+ "last_name": "string",
119
+ "middle_name": "string",
120
+ "preferred_name": "string",
121
+ "prefix": "string",
122
+ "suffix": "string",
150
123
  "use": "official"
151
124
  },
152
- "nationality": "US",
153
- "patient_id": "11111111-2222-4333-8444-555555555555",
154
- "phones": [
155
- {
156
- "extension": "101",
157
- "is_primary": true,
158
- "number": "+15550100000",
159
- "sms_enabled": true,
160
- "type": "mobile"
161
- }
162
- ],
163
- "photo_binary_id": "photo-example-001",
125
+ "nationality": "st",
126
+ "patient_id": "00000000-0000-0000-0000-000000000000",
127
+ "phones": [],
128
+ "photo_binary_id": "string",
164
129
  "preferred_language": "en",
165
130
  "preferred_pharmacy": {
166
- "address_city": "Testville",
167
- "address_state": "CA",
168
- "address_street1": "456 Pharmacy Avenue",
169
- "address_street2": "Suite 100",
170
- "address_zip": "94102",
171
- "fax": "+15550100005",
131
+ "address_city": "string",
132
+ "address_state": "string",
133
+ "address_street1": "string",
134
+ "address_street2": "string",
135
+ "address_zip": "string",
136
+ "fax": "string",
172
137
  "is_mail_order": false,
173
- "name": "Example Community Pharmacy",
174
- "ncpdp_id": "1234567",
175
- "notes": "Open daily from 08:00 to 20:00.",
176
- "npi": "1234567890",
177
- "pharmacy_id": "pharmacy-example-001",
178
- "phone": "+15550100004"
138
+ "name": "string",
139
+ "ncpdp_id": "string",
140
+ "notes": "string",
141
+ "npi": "string",
142
+ "pharmacy_id": "string",
143
+ "phone": "string"
179
144
  },
180
145
  "race": [
181
- "white"
146
+ "american_indian_or_alaska_native"
182
147
  ],
183
- "sex_at_birth": "unknown"
148
+ "sex_at_birth": "male"
184
149
  },
185
150
  "recent_encounters": [
186
151
  {
187
- "appointment_id": "appointment-example-001",
152
+ "appointment_id": "string",
153
+ "athena_appointment_id": "string",
154
+ "athena_encounter_id": "string",
188
155
  "created_by": "self",
189
- "created_date": "2026-08-10T23:36:57Z",
156
+ "created_date": "2026-01-01T09:00:00Z",
190
157
  "diagnoses": [
191
158
  {
192
- "condition_display": "Acute upper respiratory infection",
193
- "condition_id": "condition-example-001",
159
+ "condition_display": "string",
160
+ "condition_id": "string",
194
161
  "rank": 1,
195
- "use_code": "AD"
162
+ "use_code": "CC"
196
163
  }
197
164
  ],
198
165
  "encounter_class": "AMB",
199
- "encounter_id": "167dd34e-1833-4260-a8b1-ea0b38229a1b",
200
- "fhir_id": "6e0d484f-4f8b-4025-b6ef-abedf69f0f91",
166
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
167
+ "fhir_id": "string",
201
168
  "hospitalization": {
202
- "admit_source_code": "physician-referral",
203
- "destination_id": "location-example-002",
169
+ "admit_source_code": "string",
170
+ "destination_id": "string",
204
171
  "discharge_disposition": "home",
205
- "origin_id": "location-example-001",
206
- "pre_admission_id": "encounter-example-prior",
207
- "re_admission_code": "N"
172
+ "origin_id": "string",
173
+ "pre_admission_id": "string",
174
+ "re_admission_code": "string"
208
175
  },
209
- "length_minutes": 30,
176
+ "length_minutes": 0,
210
177
  "locations": [
211
178
  {
212
- "location_display": "Example Clinic, Room 101",
213
- "location_id": "location-example-001",
214
- "period_end": "2026-08-10T10:30:00Z",
215
- "period_start": "2026-08-10T10:00:00Z",
216
- "status": "completed"
179
+ "location_display": "string",
180
+ "location_id": "string",
181
+ "period_end": "2026-01-01T09:00:00Z",
182
+ "period_start": "2026-01-01T09:00:00Z",
183
+ "status": "active"
217
184
  }
218
185
  ],
186
+ "notes": "string",
219
187
  "participants": [
220
188
  {
221
- "participant_type": "ATND",
222
- "period_end": "2026-08-10T10:30:00Z",
223
- "period_start": "2026-08-10T10:00:00Z",
224
- "practitioner_display": "Dr. Alex Smith",
225
- "practitioner_id": "provider-example-001"
189
+ "participant_type": "PPRF",
190
+ "period_end": "2026-01-01T09:00:00Z",
191
+ "period_start": "2026-01-01T09:00:00Z",
192
+ "practitioner_display": "string",
193
+ "practitioner_id": "string"
226
194
  }
227
195
  ],
228
- "patient_id": "patient-example-001",
229
- "period_end": "2026-08-10T10:30:00Z",
230
- "period_start": "2026-08-10T10:00:00Z",
231
- "priority_code": "R",
232
- "priority_display": "Routine",
233
- "reason_code": "386661006",
234
- "reason_display": "Fever",
235
- "service_provider_display": "Example Health Clinic",
236
- "service_provider_id": "organization-example-001",
237
- "service_type_code": "124",
238
- "service_type_display": "General practice",
239
- "status": "finished",
240
- "type_code": "99213",
241
- "type_display": "Office outpatient visit"
196
+ "patient_id": "string",
197
+ "period_end": "2026-01-01T09:00:00Z",
198
+ "period_start": "2026-01-01T09:00:00Z",
199
+ "priority_code": "string",
200
+ "priority_display": "string",
201
+ "reason_code": "string",
202
+ "reason_display": "string",
203
+ "service_provider_display": "string",
204
+ "service_provider_id": "string",
205
+ "service_type_code": "string",
206
+ "service_type_display": "string",
207
+ "status": "planned",
208
+ "type_code": "string",
209
+ "type_display": "string"
242
210
  }
243
211
  ]
244
212
  }
@@ -62,64 +62,67 @@ None declared in canonical OpenAPI.
62
62
  {
63
63
  "encounters": [
64
64
  {
65
- "appointment_id": "appointment-example-001",
65
+ "appointment_id": "string",
66
+ "athena_appointment_id": "string",
67
+ "athena_encounter_id": "string",
66
68
  "created_by": "self",
67
- "created_date": "2026-08-10T23:36:57Z",
69
+ "created_date": "2026-01-01T09:00:00Z",
68
70
  "diagnoses": [
69
71
  {
70
- "condition_display": "Acute upper respiratory infection",
71
- "condition_id": "condition-example-001",
72
+ "condition_display": "string",
73
+ "condition_id": "string",
72
74
  "rank": 1,
73
- "use_code": "AD"
75
+ "use_code": "CC"
74
76
  }
75
77
  ],
76
78
  "encounter_class": "AMB",
77
- "encounter_id": "167dd34e-1833-4260-a8b1-ea0b38229a1b",
78
- "fhir_id": "6e0d484f-4f8b-4025-b6ef-abedf69f0f91",
79
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
80
+ "fhir_id": "string",
79
81
  "hospitalization": {
80
- "admit_source_code": "physician-referral",
81
- "destination_id": "location-example-002",
82
+ "admit_source_code": "string",
83
+ "destination_id": "string",
82
84
  "discharge_disposition": "home",
83
- "origin_id": "location-example-001",
84
- "pre_admission_id": "encounter-example-prior",
85
- "re_admission_code": "N"
85
+ "origin_id": "string",
86
+ "pre_admission_id": "string",
87
+ "re_admission_code": "string"
86
88
  },
87
- "length_minutes": 30,
89
+ "length_minutes": 0,
88
90
  "locations": [
89
91
  {
90
- "location_display": "Example Clinic, Room 101",
91
- "location_id": "location-example-001",
92
- "period_end": "2026-08-10T10:30:00Z",
93
- "period_start": "2026-08-10T10:00:00Z",
94
- "status": "completed"
92
+ "location_display": "string",
93
+ "location_id": "string",
94
+ "period_end": "2026-01-01T09:00:00Z",
95
+ "period_start": "2026-01-01T09:00:00Z",
96
+ "status": "active"
95
97
  }
96
98
  ],
99
+ "notes": "string",
97
100
  "participants": [
98
101
  {
99
- "participant_type": "ATND",
100
- "period_end": "2026-08-10T10:30:00Z",
101
- "period_start": "2026-08-10T10:00:00Z",
102
- "practitioner_display": "Dr. Alex Smith",
103
- "practitioner_id": "provider-example-001"
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"
104
107
  }
105
108
  ],
106
- "patient_id": "patient-example-001",
107
- "period_end": "2026-08-10T10:30:00Z",
108
- "period_start": "2026-08-10T10:00:00Z",
109
- "priority_code": "R",
110
- "priority_display": "Routine",
111
- "reason_code": "386661006",
112
- "reason_display": "Fever",
113
- "service_provider_display": "Example Health Clinic",
114
- "service_provider_id": "organization-example-001",
115
- "service_type_code": "124",
116
- "service_type_display": "General practice",
117
- "status": "finished",
118
- "type_code": "99213",
119
- "type_display": "Office outpatient visit"
109
+ "patient_id": "string",
110
+ "period_end": "2026-01-01T09:00:00Z",
111
+ "period_start": "2026-01-01T09:00:00Z",
112
+ "priority_code": "string",
113
+ "priority_display": "string",
114
+ "reason_code": "string",
115
+ "reason_display": "string",
116
+ "service_provider_display": "string",
117
+ "service_provider_id": "string",
118
+ "service_type_code": "string",
119
+ "service_type_display": "string",
120
+ "status": "planned",
121
+ "type_code": "string",
122
+ "type_display": "string"
120
123
  }
121
124
  ],
122
- "total": 1
125
+ "total": 0
123
126
  }
124
127
  ```
125
128
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "2.6.2",
3
+ "version": "2.8.0",
4
4
  "description": "All-in-one HealthCloud SDK with typed platform APIs and secure connector clients.",
5
5
  "author": "Healthcheck Systems Inc",
6
6
  "license": "MIT",
@@ -1,24 +0,0 @@
1
- # PanelResult
2
-
3
- Model ID: `PanelResult`
4
-
5
- A single panel/analyte result within a (possibly multi-panel) test.
6
-
7
- Type: `object`
8
-
9
- ## Fields
10
-
11
- | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
- |---|---|---:|---|---|---|---:|---|
13
- | `interpretation` | `string|null` | No | | | | Yes | Clinical interpretation flag, optional. |
14
- | `loinc_code` | `string` | Yes | | | | No | LOINC code for this panel/analyte. |
15
- | `loinc_display` | `string` | Yes | | | | No | Display text for loinc_code. |
16
- | `panel_name` | `string` | Yes | | | | No | Name of this panel/analyte. |
17
- | `quantitative_unit` | `string|null` | No | | | | Yes | Unit of measure for quantitative_value, optional. |
18
- | `quantitative_value` | `number|null` | No | | | | Yes | Numeric result value, for quantitative panels. Requires quantitative_unit. |
19
- | `result` | `string` | Yes | | | | No | The result value for this panel. |
20
- | `result_type` | `string` | No | | | `"qualitative"` | No | 'qualitative' or 'quantitative'. Defaults to qualitative. |
21
-
22
- ## Example
23
-
24
- None declared in canonical OpenAPI.
@@ -1,28 +0,0 @@
1
- # SingleTestResultResponse
2
-
3
- Model ID: `SingleTestResultResponse`
4
-
5
- Response for GET /patients/{patient_id}/diagnostics/{test_id}. Supports
6
- both single-panel and multi-panel tests via the panels list.
7
-
8
- Type: `object`
9
-
10
- ## Fields
11
-
12
- | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
13
- |---|---|---:|---|---|---|---:|---|
14
- | `device_name` | `string|null` | No | | | | Yes | CLIA-waived device make/model, optional. |
15
- | `is_multi_panel` | `boolean` | Yes | | | | No | True if this test reports more than one panel/analyte result. |
16
- | `lot_number` | `string|null` | No | | | | Yes | Test kit lot number, optional. |
17
- | `panels` | array of [`PanelResult`](./PanelResult.md) | Yes | | | | No | One or more panel/analyte results for this test. |
18
- | `patient_id` | `string` | Yes | | | | No | FHIR Patient ID this test result belongs to. |
19
- | `performed_by` | `string|null` | No | | | | Yes | Name of the person who performed the test, optional. |
20
- | `performed_datetime` | `string|null` | No | | | | Yes | ISO 8601 datetime the test was performed, optional. |
21
- | `scan_url` | `string|null` | No | | | | Yes | URL of an uploaded scan image, when one was captured via the scan-upload-url flow. |
22
- | `status` | `string` | Yes | | | | No | Observation lifecycle status. |
23
- | `test_id` | `string` | Yes | uuid | | | No | Domain UUID of the test. |
24
- | `test_type` | `string` | Yes | | | | No | Which test kit was used. |
25
-
26
- ## Example
27
-
28
- None declared in canonical OpenAPI.