Circle V2 API Docs
Preparing search index...
@repo/legacy
LegacyApiClient
Class LegacyApiClient
Index
Constructors
constructor
Methods
full
Sync
modify
Ai
Note
run
Chart
Review
send
Case
Review
Chat
Message
sync
Admissions
sync
Patient
Constructors
constructor
new
LegacyApiClient
(
options
:
LegacyApiClientOptions
)
:
LegacyApiClient
Parameters
options
:
LegacyApiClientOptions
Returns
LegacyApiClient
Methods
full
Sync
fullSync
(
input
:
{
dry_run
:
boolean
;
integration_id
:
string
}
,
)
:
Promise
<
{
chart_reviews_enqueued
:
number
;
patients_enqueued
:
number
;
success
:
true
;
}
,
>
Parameters
input
:
{
dry_run
:
boolean
;
integration_id
:
string
}
Returns
Promise
<
{
chart_reviews_enqueued
:
number
;
patients_enqueued
:
number
;
success
:
true
;
}
,
>
modify
Ai
Note
modifyAiNote
(
input
:
{
customPrompt
?:
string
;
optionId
:
|
"custom"
|
"shorten"
|
"lengthen"
|
"remove_name"
|
"remove_sensitive"
|
"regenerate"
;
sessionId
:
number
;
}
,
)
:
Promise
<
{
error
:
null
;
success
:
true
}
|
{
error
:
string
;
success
:
false
}
,
>
Parameters
input
:
{
customPrompt
?:
string
;
optionId
:
|
"custom"
|
"shorten"
|
"lengthen"
|
"remove_name"
|
"remove_sensitive"
|
"regenerate"
;
sessionId
:
number
;
}
Returns
Promise
<
{
error
:
null
;
success
:
true
}
|
{
error
:
string
;
success
:
false
}
>
run
Chart
Review
runChartReview
(
input
:
{
auditSource
?:
"manual"
|
"queue"
|
"api"
;
patientId
:
PatientId
;
sessionId
?:
SessionId
;
templateIds
:
AuditTemplateId
[]
;
treatmentEpisodeId
?:
TreatmentEpisodeId
;
trigger
?:
string
;
triggeredAt
?:
string
;
}
,
)
:
Promise
<
unknown
>
Parameters
input
:
{
auditSource
?:
"manual"
|
"queue"
|
"api"
;
patientId
:
PatientId
;
sessionId
?:
SessionId
;
templateIds
:
AuditTemplateId
[]
;
treatmentEpisodeId
?:
TreatmentEpisodeId
;
trigger
?:
string
;
triggeredAt
?:
string
;
}
Returns
Promise
<
unknown
>
send
Case
Review
Chat
Message
sendCaseReviewChatMessage
(
input
:
{
caseId
:
number
;
messages
:
{
content
:
string
;
id
:
string
;
role
:
"user"
|
"assistant"
}
[]
;
}
,
)
:
Promise
<
{
citations
?:
{
quote
?:
string
|
null
;
source
?:
{
name
:
string
;
page
?:
string
|
null
}
;
[
key
:
string
]:
unknown
;
}
[]
;
content
:
string
;
id
:
string
;
role
:
"assistant"
;
}
,
>
Parameters
input
:
{
caseId
:
number
;
messages
:
{
content
:
string
;
id
:
string
;
role
:
"user"
|
"assistant"
}
[]
;
}
Returns
Promise
<
{
citations
?:
{
quote
?:
string
|
null
;
source
?:
{
name
:
string
;
page
?:
string
|
null
}
;
[
key
:
string
]:
unknown
;
}
[]
;
content
:
string
;
id
:
string
;
role
:
"assistant"
;
}
,
>
sync
Admissions
syncAdmissions
(
input
:
{
dry_run
:
boolean
;
end_date
?:
string
;
integration_id
:
string
;
start_date
?:
string
;
}
,
)
:
Promise
<
|
{
error
:
null
;
patients
?:
{
first_name
:
string
;
id
:
number
;
last_name
:
string
}
[]
;
stats
?:
{
date_range
?:
{
end
?:
string
;
start
?:
string
}
;
records_fetched
:
number
;
records_upserted
?:
number
;
}
;
success
:
true
;
}
|
{
details
?:
string
;
error
:
string
;
success
:
false
}
,
>
Parameters
input
:
{
dry_run
:
boolean
;
end_date
?:
string
;
integration_id
:
string
;
start_date
?:
string
;
}
Returns
Promise
<
|
{
error
:
null
;
patients
?:
{
first_name
:
string
;
id
:
number
;
last_name
:
string
}
[]
;
stats
?:
{
date_range
?:
{
end
?:
string
;
start
?:
string
}
;
records_fetched
:
number
;
records_upserted
?:
number
;
}
;
success
:
true
;
}
|
{
details
?:
string
;
error
:
string
;
success
:
false
}
,
>
sync
Patient
syncPatient
(
input
:
{
dry_run
:
boolean
;
patient_id
:
number
;
sync_documents
:
boolean
}
,
)
:
Promise
<
{
success
:
true
}
>
Parameters
input
:
{
dry_run
:
boolean
;
patient_id
:
number
;
sync_documents
:
boolean
}
Returns
Promise
<
{
success
:
true
}
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
full
Sync
modify
Ai
Note
run
Chart
Review
send
Case
Review
Chat
Message
sync
Admissions
sync
Patient
Circle V2 API Docs
Loading...