@healthcloudai/hc-sdk 3.27.0 → 3.28.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 +10 -3
- package/dist/index.d.cts +481 -338
- package/dist/index.d.ts +481 -338
- package/dist/index.js +10 -3
- package/docs/docs-manifest.json +4 -2
- package/docs/models/CheckInEncounterResponse.md +1 -1
- package/docs/models/GetEncounterResponse.md +1 -1
- package/docs/models/ProviderEncounterRecord.md +3 -1
- package/docs/models/ProviderIntakeContent.md +25 -0
- package/docs/models/ProviderIntakeSubmission.md +29 -0
- package/docs/models/ProviderPatientRecordResources.md +1 -1
- package/docs/models/ProviderQueueEncounter.md +1 -0
- package/docs/models/UpdateEncounterClinicalNoteRequest.md +2 -1
- package/docs/models/fieldagent.Encounter.md +1 -1
- package/docs/models/index.md +2 -0
- package/docs/models/patient.Encounter.md +1 -1
- package/docs/models/provider.Encounter.md +1 -1
- package/docs/operations/provider.claimEncounter.md +2 -0
- package/docs/operations/provider.getEncounter.md +2 -0
- package/docs/operations/provider.getEncounterQueue.md +1 -0
- package/docs/operations/provider.getPatientRecord.md +54 -0
- package/docs/operations/provider.listEncounters.md +2 -0
- package/docs/operations/provider.signEncounter.md +2 -0
- package/docs/operations/provider.updateEncounterClinicalNote.md +2 -0
- package/docs/operations/provider.updateEncounterDiagnoses.md +2 -0
- package/docs/operations/provider.updateEncounterStatus.md +2 -0
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -3819,7 +3819,8 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
3819
3819
|
}
|
|
3820
3820
|
/**
|
|
3821
3821
|
* The queue (GET /encounters/queue): the newest 10 encounters in the tenant that no provider has taken, newest created
|
|
3822
|
-
* first, each with a minimal patient summary
|
|
3822
|
+
* first, each with a minimal patient summary and `reported_symptoms` (what the patient reported, cut to 300 characters).
|
|
3823
|
+
* Use the item's `fhir_id` with claimEncounter.
|
|
3823
3824
|
*/
|
|
3824
3825
|
getEncounterQueue() {
|
|
3825
3826
|
return this.send("GET", "/encounters/queue", {});
|
|
@@ -3859,7 +3860,10 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
3859
3860
|
getEncounter(encounterId) {
|
|
3860
3861
|
return this.send("GET", "/encounters/{encounter_id}", { pathParams: { encounter_id: encounterId } });
|
|
3861
3862
|
}
|
|
3862
|
-
/**
|
|
3863
|
+
/**
|
|
3864
|
+
* Update the clinical note and assessment for one encounter. This saves the provider's own note (`provider_notes` on the
|
|
3865
|
+
* encounter) and mirrors it to a linked EHR; the patient's `reported_symptoms` / `notes` are never changed.
|
|
3866
|
+
*/
|
|
3863
3867
|
updateEncounterClinicalNote(encounterId, request) {
|
|
3864
3868
|
return this.send("PATCH", "/encounters/{encounter_id}/clinical-note", {
|
|
3865
3869
|
pathParams: { encounter_id: encounterId },
|
|
@@ -3966,7 +3970,10 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
3966
3970
|
body: request != null ? request : {}
|
|
3967
3971
|
});
|
|
3968
3972
|
}
|
|
3969
|
-
/**
|
|
3973
|
+
/**
|
|
3974
|
+
* Get a patient's consolidated health record (provider tenant scope). Each of `intake_submissions` carries what the patient
|
|
3975
|
+
* submitted: `sections` and `content` (the records it created, grouped like the record's own sections).
|
|
3976
|
+
*/
|
|
3970
3977
|
getPatientRecord(patientId) {
|
|
3971
3978
|
return this.send("GET", "/patients/{patient_id}/record", { pathParams: { patient_id: patientId } });
|
|
3972
3979
|
}
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:ad1609cfb5b80159a75b462ee589f7f3a637bc80aaa3bf2d3275f4382182f033",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -1466,6 +1466,8 @@
|
|
|
1466
1466
|
"models/ProviderHomeSummaryResponse.md",
|
|
1467
1467
|
"models/ProviderIdentifier.md",
|
|
1468
1468
|
"models/ProviderIdentifierType.md",
|
|
1469
|
+
"models/ProviderIntakeContent.md",
|
|
1470
|
+
"models/ProviderIntakeSubmission.md",
|
|
1469
1471
|
"models/ProviderLanguage.md",
|
|
1470
1472
|
"models/ProviderLocation.md",
|
|
1471
1473
|
"models/ProviderLocationAddressRequest.md",
|
|
@@ -3319,7 +3321,7 @@
|
|
|
3319
3321
|
"operations/vitals.recordVitals.md"
|
|
3320
3322
|
],
|
|
3321
3323
|
"language": "nodejs",
|
|
3322
|
-
"modelCount":
|
|
3324
|
+
"modelCount": 2190,
|
|
3323
3325
|
"operationCount": 1074,
|
|
3324
3326
|
"schemaVersion": 1
|
|
3325
3327
|
}
|
|
@@ -23,7 +23,7 @@ Type: `object`
|
|
|
23
23
|
| `hospitalization` | [`patient.EncounterHospitalization`](./patient.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
|
|
24
24
|
| `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
|
|
25
25
|
| `locations` | array of [`patient.EncounterLocation`](./patient.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
|
|
26
|
-
| `notes` | `string|null` | No | | | | Yes | Free-text encounter notes,
|
|
26
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
|
|
27
27
|
| `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. |
|
|
28
28
|
| `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
|
|
29
29
|
| `openloop_encounter_status` | `string|null` | No | | | | Yes | `linked` when the OpenLoop appointment and encounter were linked successfully. |
|
|
@@ -22,7 +22,7 @@ Type: `object`
|
|
|
22
22
|
| `hospitalization` | [`patient.EncounterHospitalization`](./patient.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
|
|
23
23
|
| `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
|
|
24
24
|
| `locations` | array of [`patient.EncounterLocation`](./patient.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
|
|
25
|
-
| `notes` | `string|null` | No | | | | Yes | Free-text encounter notes,
|
|
25
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
|
|
26
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
27
|
| `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
|
|
28
28
|
| `participants` | array of [`patient.EncounterParticipant`](./patient.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
|
|
@@ -22,7 +22,7 @@ Type: `object`
|
|
|
22
22
|
| `hospitalization` | [`provider.EncounterHospitalization`](./provider.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
|
|
23
23
|
| `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
|
|
24
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,
|
|
25
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
|
|
26
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
27
|
| `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
|
|
28
28
|
| `participants` | array of [`provider.EncounterParticipant`](./provider.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
|
|
@@ -32,8 +32,10 @@ Type: `object`
|
|
|
32
32
|
| `period_start` | `string|null` | No | | | | Yes | When the encounter started, when recorded. |
|
|
33
33
|
| `priority_code` | `string|null` | No | | | | Yes | Code for the encounter priority (e.g. routine, urgent, emergent), when coded. |
|
|
34
34
|
| `priority_display` | `string|null` | No | | | | Yes | Display text for the encounter priority, when available. |
|
|
35
|
+
| `provider_notes` | `string|null` | No | | | | Yes | The provider's own clinical note, written with PATCH /encounters/{id}/clinical-note. Kept apart from the patient-reported text and not shown by the patient, EHR or field-agent APIs. Notes a provider wrote before this field existed are in `notes`, not here. |
|
|
35
36
|
| `reason_code` | `string|null` | No | | | | Yes | SNOMED CT code for the reason for the encounter, when coded. |
|
|
36
37
|
| `reason_display` | `string|null` | No | | | | Yes | Display text for the reason for the encounter, when available. |
|
|
38
|
+
| `reported_symptoms` | `string|null` | No | | | | Yes | What the patient reported for this visit: the symptom report and intake summaries collected in the patient app. Same text as `notes`, named for what it is. Null when the patient reported nothing. Never changed by a provider's clinical note. |
|
|
37
39
|
| `service_provider_display` | `string|null` | No | | | | Yes | Display name of the service provider organization, when available. |
|
|
38
40
|
| `service_provider_id` | `string|null` | No | | | | Yes | FHIR Organization id of the service provider, when linked. |
|
|
39
41
|
| `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ProviderIntakeContent
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderIntakeContent`
|
|
4
|
+
|
|
5
|
+
The records an intake submission created, grouped like the health record's own sections.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `allergies` | array of [`provider.Allergy`](./provider.Allergy.md) | No | | | | No | |
|
|
14
|
+
| `conditions` | array of [`provider.Problem`](./provider.Problem.md) | No | | | | No | |
|
|
15
|
+
| `family_history` | array of [`provider.FamilyHistoryEntry`](./provider.FamilyHistoryEntry.md) | No | | | | No | |
|
|
16
|
+
| `gyn_history` | array of [`provider.GynHistory`](./provider.GynHistory.md) | No | | | | No | |
|
|
17
|
+
| `immunizations` | array of [`provider.Immunization`](./provider.Immunization.md) | No | | | | No | |
|
|
18
|
+
| `medications` | array of [`provider.Medication`](./provider.Medication.md) | No | | | | No | |
|
|
19
|
+
| `perinatal_history` | array of [`provider.PerinatalHistory`](./provider.PerinatalHistory.md) | No | | | | No | |
|
|
20
|
+
| `procedures` | array of [`provider.Procedure`](./provider.Procedure.md) | No | | | | No | |
|
|
21
|
+
| `social_history` | array of [`SocialHistory`](./SocialHistory.md) | No | | | | No | |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# ProviderIntakeSubmission
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderIntakeSubmission`
|
|
4
|
+
|
|
5
|
+
An intake the patient submitted, with what they submitted.
|
|
6
|
+
|
|
7
|
+
The delivery metadata is the patient intake response. `content` holds the submitted answers as the health record's own
|
|
8
|
+
sections (allergies, conditions, medications, immunizations, family_history, social_history, procedures, ...), because
|
|
9
|
+
intake answers are stored as FHIR records and the submissions table keeps metadata only.
|
|
10
|
+
|
|
11
|
+
Type: `object`
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
16
|
+
|---|---|---:|---|---|---|---:|---|
|
|
17
|
+
| `content` | [`ProviderIntakeContent`](./ProviderIntakeContent.md) | No | | | | No | The records this submission created, grouped by health-record section, in the record's domain shape. |
|
|
18
|
+
| `content_complete` | `boolean` | No | | | `true` | No | False when some records this submission created could not be found in the record (for example a partial save), so `content` is not everything submitted. |
|
|
19
|
+
| `created_at` | `string` | Yes | date-time | | | No | |
|
|
20
|
+
| `invalid_entries` | `object|null` | No | | | | Yes | |
|
|
21
|
+
| `sections` | `array` | No | | | | No | The intake sections this submission carried, for example allergies or problems. |
|
|
22
|
+
| `storage_status` | `string` | Yes | | pending, saved, partial, failed | | No | |
|
|
23
|
+
| `submission_id` | `string` | Yes | uuid | | | No | |
|
|
24
|
+
| `unknown_fields` | `array|null` | No | | | | Yes | |
|
|
25
|
+
| `vendors` | `object` | Yes | | | | No | |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
None declared in canonical OpenAPI.
|
|
@@ -19,7 +19,7 @@ Type: `object`
|
|
|
19
19
|
| `functional_status` | array of [`FunctionalStatus`](./FunctionalStatus.md) | No | | | | No | |
|
|
20
20
|
| `gyn_history` | array of [`provider.GynHistory`](./provider.GynHistory.md) | No | | | | No | |
|
|
21
21
|
| `immunizations` | array of [`provider.Immunization`](./provider.Immunization.md) | No | | | | No | |
|
|
22
|
-
| `intake_submissions` | array of [`
|
|
22
|
+
| `intake_submissions` | array of [`ProviderIntakeSubmission`](./ProviderIntakeSubmission.md) | No | | | | No | |
|
|
23
23
|
| `medications` | array of [`provider.Medication`](./provider.Medication.md) | No | | | | No | |
|
|
24
24
|
| `perinatal_history` | array of [`provider.PerinatalHistory`](./provider.PerinatalHistory.md) | No | | | | No | |
|
|
25
25
|
| `procedures` | array of [`provider.Procedure`](./provider.Procedure.md) | No | | | | No | |
|
|
@@ -19,6 +19,7 @@ Type: `object`
|
|
|
19
19
|
| `priority_display` | `string|null` | No | | | | Yes | Priority text, when available. |
|
|
20
20
|
| `reason_code` | `string|null` | No | | | | Yes | Reason-for-visit code, when coded. |
|
|
21
21
|
| `reason_display` | `string|null` | No | | | | Yes | Reason-for-visit text, when available. |
|
|
22
|
+
| `reported_symptoms` | `string|null` | No | | | | Yes | What the patient reported for this visit, cut to at most 300 characters and ending in an ellipsis when longer. Null when the patient reported nothing. The full text comes with the encounter once taken. |
|
|
22
23
|
| `status` | `string` | Yes | | | | No | Encounter status, for example planned, arrived or triaged. |
|
|
23
24
|
| `type_code` | `string|null` | No | | | | Yes | SNOMED CT encounter type code, when coded. |
|
|
24
25
|
| `type_display` | `string|null` | No | | | | Yes | Encounter type text, when available. |
|
|
@@ -4,7 +4,8 @@ Model ID: `UpdateEncounterClinicalNoteRequest`
|
|
|
4
4
|
|
|
5
5
|
FHIR notes and/or clinical assessment for one encounter.
|
|
6
6
|
|
|
7
|
-
The FHIR Encounter stores the submitted content in its notes extension
|
|
7
|
+
The FHIR Encounter stores the submitted content in its own provider-notes extension (`provider_notes`); the
|
|
8
|
+
patient-reported `notes` are never changed.
|
|
8
9
|
When the encounter is linked to the configured EHR, ``notes`` is written
|
|
9
10
|
to the EHR SOAP subjective field and ``assessment`` to its SOAP assessment
|
|
10
11
|
field. At least one field must be supplied; the handler enforces that
|
|
@@ -22,7 +22,7 @@ Type: `object`
|
|
|
22
22
|
| `hospitalization` | [`fieldagent.EncounterHospitalization`](./fieldagent.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
|
|
23
23
|
| `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
|
|
24
24
|
| `locations` | array of [`fieldagent.EncounterLocation`](./fieldagent.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
|
|
25
|
-
| `notes` | `string|null` | No | | | | Yes | Free-text encounter notes,
|
|
25
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
|
|
26
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
27
|
| `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
|
|
28
28
|
| `participants` | array of [`fieldagent.EncounterParticipant`](./fieldagent.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
|
package/docs/models/index.md
CHANGED
|
@@ -1577,6 +1577,8 @@
|
|
|
1577
1577
|
- [ProviderHomeSummaryResponse](ProviderHomeSummaryResponse.md)
|
|
1578
1578
|
- [ProviderIdentifier](ProviderIdentifier.md)
|
|
1579
1579
|
- [ProviderIdentifierType](ProviderIdentifierType.md)
|
|
1580
|
+
- [ProviderIntakeContent](ProviderIntakeContent.md)
|
|
1581
|
+
- [ProviderIntakeSubmission](ProviderIntakeSubmission.md)
|
|
1580
1582
|
- [ProviderLanguage](ProviderLanguage.md)
|
|
1581
1583
|
- [ProviderLocation](ProviderLocation.md)
|
|
1582
1584
|
- [ProviderLocationAddressRequest](ProviderLocationAddressRequest.md)
|
|
@@ -22,7 +22,7 @@ Type: `object`
|
|
|
22
22
|
| `hospitalization` | [`patient.EncounterHospitalization`](./patient.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
|
|
23
23
|
| `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
|
|
24
24
|
| `locations` | array of [`patient.EncounterLocation`](./patient.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
|
|
25
|
-
| `notes` | `string|null` | No | | | | Yes | Free-text encounter notes,
|
|
25
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
|
|
26
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
27
|
| `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
|
|
28
28
|
| `participants` | array of [`patient.EncounterParticipant`](./patient.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
|
|
@@ -22,7 +22,7 @@ Type: `object`
|
|
|
22
22
|
| `hospitalization` | [`provider.EncounterHospitalization`](./provider.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
|
|
23
23
|
| `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
|
|
24
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,
|
|
25
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
|
|
26
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
27
|
| `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
|
|
28
28
|
| `participants` | array of [`provider.EncounterParticipant`](./provider.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
|
|
@@ -132,8 +132,10 @@ None declared in canonical OpenAPI.
|
|
|
132
132
|
"period_start": "2026-01-01T09:00:00Z",
|
|
133
133
|
"priority_code": "string",
|
|
134
134
|
"priority_display": "string",
|
|
135
|
+
"provider_notes": "string",
|
|
135
136
|
"reason_code": "string",
|
|
136
137
|
"reason_display": "string",
|
|
138
|
+
"reported_symptoms": "string",
|
|
137
139
|
"service_provider_display": "string",
|
|
138
140
|
"service_provider_id": "string",
|
|
139
141
|
"service_type_code": "string",
|
|
@@ -130,8 +130,10 @@ None declared in canonical OpenAPI.
|
|
|
130
130
|
"period_start": "2026-01-01T09:00:00Z",
|
|
131
131
|
"priority_code": "string",
|
|
132
132
|
"priority_display": "string",
|
|
133
|
+
"provider_notes": "string",
|
|
133
134
|
"reason_code": "string",
|
|
134
135
|
"reason_display": "string",
|
|
136
|
+
"reported_symptoms": "string",
|
|
135
137
|
"service_provider_display": "string",
|
|
136
138
|
"service_provider_id": "string",
|
|
137
139
|
"service_type_code": "string",
|
|
@@ -339,8 +339,62 @@ None declared in canonical OpenAPI.
|
|
|
339
339
|
],
|
|
340
340
|
"intake_submissions": [
|
|
341
341
|
{
|
|
342
|
+
"content": {
|
|
343
|
+
"allergies": [],
|
|
344
|
+
"conditions": [
|
|
345
|
+
{
|
|
346
|
+
"categories": [],
|
|
347
|
+
"clinical_status": "active",
|
|
348
|
+
"description": "string",
|
|
349
|
+
"problem_id": "00000000-0000-0000-0000-000000000000",
|
|
350
|
+
"verification_status": "confirmed"
|
|
351
|
+
}
|
|
352
|
+
],
|
|
353
|
+
"family_history": [],
|
|
354
|
+
"gyn_history": [
|
|
355
|
+
{
|
|
356
|
+
"history_id": "00000000-0000-0000-0000-000000000000"
|
|
357
|
+
}
|
|
358
|
+
],
|
|
359
|
+
"immunizations": [
|
|
360
|
+
{
|
|
361
|
+
"immunization_id": "00000000-0000-0000-0000-000000000000",
|
|
362
|
+
"reactions": [],
|
|
363
|
+
"reason_codes": [],
|
|
364
|
+
"status": "completed",
|
|
365
|
+
"vaccine_name": "string"
|
|
366
|
+
}
|
|
367
|
+
],
|
|
368
|
+
"medications": [],
|
|
369
|
+
"perinatal_history": [
|
|
370
|
+
{
|
|
371
|
+
"history_id": "00000000-0000-0000-0000-000000000000"
|
|
372
|
+
}
|
|
373
|
+
],
|
|
374
|
+
"procedures": [
|
|
375
|
+
{
|
|
376
|
+
"body_sites": [],
|
|
377
|
+
"complications": [],
|
|
378
|
+
"description": "string",
|
|
379
|
+
"procedure_id": "00000000-0000-0000-0000-000000000000",
|
|
380
|
+
"reported": false,
|
|
381
|
+
"status": "completed"
|
|
382
|
+
}
|
|
383
|
+
],
|
|
384
|
+
"social_history": [
|
|
385
|
+
{
|
|
386
|
+
"occupational_exposures": [],
|
|
387
|
+
"substances": [],
|
|
388
|
+
"travel_history": []
|
|
389
|
+
}
|
|
390
|
+
]
|
|
391
|
+
},
|
|
392
|
+
"content_complete": true,
|
|
342
393
|
"created_at": "2026-01-01T09:00:00Z",
|
|
343
394
|
"invalid_entries": {},
|
|
395
|
+
"sections": [
|
|
396
|
+
"string"
|
|
397
|
+
],
|
|
344
398
|
"storage_status": "pending",
|
|
345
399
|
"submission_id": "00000000-0000-0000-0000-000000000000",
|
|
346
400
|
"unknown_fields": [
|
|
@@ -132,8 +132,10 @@ None declared in canonical OpenAPI.
|
|
|
132
132
|
"period_start": "2026-01-01T09:00:00Z",
|
|
133
133
|
"priority_code": "string",
|
|
134
134
|
"priority_display": "string",
|
|
135
|
+
"provider_notes": "string",
|
|
135
136
|
"reason_code": "string",
|
|
136
137
|
"reason_display": "string",
|
|
138
|
+
"reported_symptoms": "string",
|
|
137
139
|
"service_provider_display": "string",
|
|
138
140
|
"service_provider_id": "string",
|
|
139
141
|
"service_type_code": "string",
|
|
@@ -131,8 +131,10 @@ None declared in canonical OpenAPI.
|
|
|
131
131
|
"period_start": "2026-01-01T09:00:00Z",
|
|
132
132
|
"priority_code": "string",
|
|
133
133
|
"priority_display": "string",
|
|
134
|
+
"provider_notes": "string",
|
|
134
135
|
"reason_code": "string",
|
|
135
136
|
"reason_display": "string",
|
|
137
|
+
"reported_symptoms": "string",
|
|
136
138
|
"service_provider_display": "string",
|
|
137
139
|
"service_provider_id": "string",
|
|
138
140
|
"service_type_code": "string",
|
|
@@ -138,8 +138,10 @@ Request model: [`UpdateEncounterClinicalNoteRequest`](../models/UpdateEncounterC
|
|
|
138
138
|
"period_start": "2026-01-01T09:00:00Z",
|
|
139
139
|
"priority_code": "string",
|
|
140
140
|
"priority_display": "string",
|
|
141
|
+
"provider_notes": "string",
|
|
141
142
|
"reason_code": "string",
|
|
142
143
|
"reason_display": "string",
|
|
144
|
+
"reported_symptoms": "string",
|
|
143
145
|
"service_provider_display": "string",
|
|
144
146
|
"service_provider_id": "string",
|
|
145
147
|
"service_type_code": "string",
|
|
@@ -143,8 +143,10 @@ Request model: [`UpdateEncounterDiagnosesRequest`](../models/UpdateEncounterDiag
|
|
|
143
143
|
"period_start": "2026-01-01T09:00:00Z",
|
|
144
144
|
"priority_code": "string",
|
|
145
145
|
"priority_display": "string",
|
|
146
|
+
"provider_notes": "string",
|
|
146
147
|
"reason_code": "string",
|
|
147
148
|
"reason_display": "string",
|
|
149
|
+
"reported_symptoms": "string",
|
|
148
150
|
"service_provider_display": "string",
|
|
149
151
|
"service_provider_id": "string",
|
|
150
152
|
"service_type_code": "string",
|
|
@@ -137,8 +137,10 @@ Request model: [`UpdateEncounterStatusRequest`](../models/UpdateEncounterStatusR
|
|
|
137
137
|
"period_start": "2026-01-01T09:00:00Z",
|
|
138
138
|
"priority_code": "string",
|
|
139
139
|
"priority_display": "string",
|
|
140
|
+
"provider_notes": "string",
|
|
140
141
|
"reason_code": "string",
|
|
141
142
|
"reason_display": "string",
|
|
143
|
+
"reported_symptoms": "string",
|
|
142
144
|
"service_provider_display": "string",
|
|
143
145
|
"service_provider_id": "string",
|
|
144
146
|
"service_type_code": "string",
|
package/package.json
CHANGED