Circle V2 API Docs
Preparing search index...
@repo/trpc
routers/dictionary/index
dictionaryRouter
Variable dictionaryRouter
Const
dictionaryRouter
:
BuiltRouter
<
{
ctx
:
TRPCContext
;
errorShape
:
DefaultErrorShape
;
meta
:
object
;
transformer
:
false
;
}
,
DecorateCreateRouterOptions
<
{
createConcept
:
MutationProcedure
<
{
input
:
{
name
:
string
;
subject
:
"document"
|
"level_of_care"
|
"credential"
;
}
;
meta
:
object
;
output
:
{
id
:
DictionaryConceptId
;
name
:
string
}
;
}
,
>
;
listChartTitleLocations
:
QueryProcedure
<
{
input
:
{
cursor
?:
number
;
limit
?:
number
;
offset
?:
number
;
patientSearch
?:
string
;
title
:
string
;
}
;
meta
:
object
;
output
:
PaginatedResponse
<
{
documents
:
number
;
facilityName
:
string
;
patientFirstName
:
string
|
null
;
patientId
:
PatientId
;
patientLastName
:
string
|
null
;
}
,
>
;
}
,
>
;
listChartTitlePatterns
:
QueryProcedure
<
{
input
:
{
conceptIds
?:
string
[]
;
cursor
?:
number
;
facilityIds
?:
string
[]
;
includeMapped
:
boolean
;
kind
?:
"pattern"
|
"exactTitle"
;
limit
?:
number
;
offset
?:
number
;
search
?:
string
;
sort
?:
"title"
|
"mostSeen"
|
"mapsTo"
;
sortOrder
?:
"asc"
|
"desc"
;
}
;
meta
:
object
;
output
:
PaginatedResponse
<
{
documents
:
number
;
isMapped
:
boolean
;
kind
:
ChartTitleKind
;
label
:
string
;
mapsTo
:
ChartTitleMapping
[]
;
parts
:
TitlePatternPart
[]
;
patternId
:
ChartTitlePatternId
;
titleCount
:
number
;
titles
:
ChartTitleCounts
[]
;
}
,
>
;
}
,
>
;
listChartTitlePatternTitles
:
QueryProcedure
<
{
input
:
{
cursor
?:
number
;
limit
?:
number
;
offset
?:
number
;
patternId
:
string
;
titleSearch
?:
string
;
}
;
meta
:
object
;
output
:
PaginatedResponse
<
{
documents
:
number
;
facilities
:
number
;
mappedDocuments
:
number
;
patients
:
number
;
title
:
string
;
}
,
>
;
}
,
>
;
listConcepts
:
QueryProcedure
<
{
input
:
{
subject
:
"document"
|
"level_of_care"
|
"credential"
}
;
meta
:
object
;
output
:
{
id
:
DictionaryConceptId
;
name
:
string
;
updated_at
:
DbDate
}
[]
;
}
,
>
;
listConceptsWithRules
:
QueryProcedure
<
{
input
:
{
cursor
?:
number
;
limit
?:
number
;
offset
?:
number
;
search
?:
string
;
sort
?:
"name"
|
"updated"
;
sortOrder
?:
"asc"
|
"desc"
;
subject
:
"document"
|
"level_of_care"
|
"credential"
;
}
;
meta
:
object
;
output
:
PaginatedResponse
<
{
conceptId
:
DictionaryConceptId
;
name
:
string
;
rules
:
{
externalDocumentType
:
|
"kipu_evaluation"
|
"kipu_consent_form"
|
"kipu_ciwa_ar"
|
"kipu_ciwa_b"
|
"kipu_group_session"
|
"lightningstep_formdata"
|
"lightningstep_txplan"
|
"kipu_vital_signs"
|
"kipu_orthostatic_vital_signs"
|
"kipu_patient_orders"
|
"kipu_glucose_logs"
|
"kipu_program_history"
|
"kipu_diagnosis_history"
|
"kipu_appointment"
|
"lightningstep_admissions"
|
"kipu_episode_outcome"
|
"sunwave_form"
|
"sunwave_diagnosis"
|
"sunwave_group_note"
|
"sunwave_program"
|
"sunwave_lab_result"
|
"sunwave_assessment"
|
"emr_insurance_information"
|
"insync_episode_summary"
|
"insync_condition"
|
"insync_vital_signs"
|
"insync_lab_result"
|
"insync_observation"
|
"insync_allergy"
|
"insync_immunization"
|
"insync_medication_request"
|
"insync_diagnostic_report"
|
"insync_procedure"
|
"insync_rpa_locadtr"
|
"insync_rpa_treatment_plan"
|
"insync_rpa_biopsychosocial"
|
"synthetic_biopsychosocial"
|
"synthetic_asam"
|
"synthetic_consent"
|
"synthetic_nursing_intake"
|
"synthetic_diagnosis"
|
"synthetic_treatment_plan"
|
"synthetic_group_note"
|
"synthetic_progress_note"
|
"synthetic_ur_review"
|
"synthetic_discharge_summary"
|
"insync_rpa_encounter_note"
|
"insync_rpa_consent_form"
|
"insync_rpa_lab_result"
|
"insync_rpa_insurance"
|
"insync_rpa_document"
|
null
;
externalFormId
:
string
|
null
;
patternLabel
:
string
|
null
;
}
[]
;
updatedAt
:
DbDate
;
}
,
>
;
}
,
>
;
listConceptTitleRules
:
QueryProcedure
<
{
input
:
{
conceptId
:
string
}
;
meta
:
object
;
output
:
ConceptTitleRules
;
}
,
>
;
listCredentialEntries
:
QueryProcedure
<
{
input
:
{
search
?:
string
}
;
meta
:
object
;
output
:
{
conceptId
:
DictionaryConceptId
;
matchers
:
{
credential
:
string
;
matcherId
:
DictionaryCredentialMatcherId
;
}
[]
;
name
:
string
;
staffCount
:
number
;
updatedAt
:
DbDate
;
}
[]
;
}
,
>
;
listCredentialEntriesPage
:
QueryProcedure
<
{
input
:
{
cursor
?:
number
;
limit
?:
number
;
offset
?:
number
;
search
?:
string
;
}
;
meta
:
object
;
output
:
PaginatedResponse
<
{
conceptId
:
DictionaryConceptId
;
matchers
:
{
credential
:
string
;
matcherId
:
DictionaryCredentialMatcherId
;
}
[]
;
name
:
string
;
staffCount
:
number
;
updatedAt
:
DbDate
;
}
,
>
;
}
,
>
;
listCredentialProviders
:
QueryProcedure
<
{
input
:
{
credential
:
string
;
cursor
?:
number
;
limit
?:
number
;
offset
?:
number
;
providerSearch
?:
string
;
}
;
meta
:
object
;
output
:
{
items
:
{
facilityName
:
string
|
null
;
firstName
:
string
|
null
;
lastName
:
string
|
null
;
}
[]
;
nextCursor
:
number
|
null
;
summary
:
{
facilities
:
number
;
providers
:
number
}
;
total
:
number
;
}
;
}
,
>
;
listCredentials
:
QueryProcedure
<
{
input
:
{
includeMapped
:
boolean
;
search
?:
string
}
;
meta
:
object
;
output
:
{
credential
:
string
;
entries
:
{
conceptId
:
DictionaryConceptId
;
name
:
string
}
[]
;
providerCount
:
number
;
}
[]
;
}
,
>
;
listCredentialsPage
:
QueryProcedure
<
{
input
:
{
cursor
?:
number
;
includeMapped
:
boolean
;
limit
?:
number
;
offset
?:
number
;
search
?:
string
;
}
;
meta
:
object
;
output
:
PaginatedResponse
<
{
credential
:
string
;
entries
:
{
conceptId
:
DictionaryConceptId
;
name
:
string
}
[]
;
providerCount
:
number
;
}
,
>
;
}
,
>
;
listLevelOfCareEntries
:
QueryProcedure
<
{
input
:
{
search
?:
string
}
;
meta
:
object
;
output
:
{
conceptId
:
DictionaryConceptId
;
matchers
:
{
facilityNames
:
string
[]
;
kind
:
"level_of_care"
|
"program"
;
matcherIds
:
DictionaryLevelOfCareMatcherId
[]
;
name
:
string
;
}
[]
;
name
:
string
;
updatedAt
:
DbDate
;
}
[]
;
}
,
>
;
listUnmappedLevelOfCareNames
:
QueryProcedure
<
{
input
:
{
search
?:
string
}
;
meta
:
object
;
output
:
UnmappedLevelOfCareName
[]
;
}
,
>
;
mapChartTitlesToConcept
:
MutationProcedure
<
{
input
:
{
conceptId
:
string
;
exactTitles
:
string
[]
;
patterns
:
(
{
kind
:
"literal"
;
text
:
string
}
|
{
kind
:
"date"
}
)
[]
[]
;
}
;
meta
:
object
;
output
:
{
taggingError
:
string
|
null
}
;
}
,
>
;
mapCredentials
:
MutationProcedure
<
{
input
:
{
conceptId
:
string
;
credentials
:
string
[]
}
;
meta
:
object
;
output
:
void
;
}
,
>
;
mapLevelOfCareNames
:
MutationProcedure
<
{
input
:
{
conceptId
:
string
;
levelOfCareIds
:
string
[]
;
programIds
:
string
[]
;
}
;
meta
:
object
;
output
:
void
;
}
,
>
;
saveCircleMatchers
:
MutationProcedure
<
{
input
:
{
conceptId
:
string
;
matchers
:
{
externalDocumentType
:
|
"kipu_evaluation"
|
"kipu_consent_form"
|
"kipu_ciwa_ar"
|
"kipu_ciwa_b"
|
"kipu_group_session"
|
"lightningstep_formdata"
|
"lightningstep_txplan"
|
"kipu_vital_signs"
|
"kipu_orthostatic_vital_signs"
|
"kipu_patient_orders"
|
"kipu_glucose_logs"
|
"kipu_program_history"
|
"kipu_diagnosis_history"
|
"kipu_appointment"
|
"lightningstep_admissions"
|
"kipu_episode_outcome"
|
"sunwave_form"
|
"sunwave_diagnosis"
|
"sunwave_group_note"
|
"sunwave_program"
|
"sunwave_lab_result"
|
"sunwave_assessment"
|
"emr_insurance_information"
|
"insync_episode_summary"
|
"insync_condition"
|
"insync_vital_signs"
|
"insync_lab_result"
|
"insync_observation"
|
"insync_allergy"
|
"insync_immunization"
|
"insync_medication_request"
|
"insync_diagnostic_report"
|
"insync_procedure"
|
"insync_rpa_locadtr"
|
"insync_rpa_treatment_plan"
|
"insync_rpa_biopsychosocial"
|
"synthetic_biopsychosocial"
|
"synthetic_asam"
|
"synthetic_consent"
|
"synthetic_nursing_intake"
|
"synthetic_diagnosis"
|
"synthetic_treatment_plan"
|
"synthetic_group_note"
|
"synthetic_progress_note"
|
"synthetic_ur_review"
|
"synthetic_discharge_summary"
|
"insync_rpa_encounter_note"
|
"insync_rpa_consent_form"
|
"insync_rpa_lab_result"
|
"insync_rpa_insurance"
|
"insync_rpa_document"
|
null
;
externalFormId
:
string
|
null
;
}
[]
;
}
;
meta
:
object
;
output
:
{
taggingError
:
string
|
null
}
;
}
,
>
;
saveConceptExactTitles
:
MutationProcedure
<
{
input
:
{
conceptId
:
string
;
titles
:
string
[]
}
;
meta
:
object
;
output
:
{
taggingError
:
string
|
null
}
;
}
,
>
;
unmapCredentials
:
MutationProcedure
<
{
input
:
{
conceptId
:
string
;
matcherIds
:
string
[]
}
;
meta
:
object
;
output
:
void
;
}
,
>
;
unmapLevelOfCareNames
:
MutationProcedure
<
{
input
:
{
conceptId
:
string
;
matcherIds
:
string
[]
}
;
meta
:
object
;
output
:
void
;
}
,
>
;
unmapTitlePattern
:
MutationProcedure
<
{
input
:
{
conceptId
:
string
;
ruleId
:
string
}
;
meta
:
object
;
output
:
{
taggingError
:
string
|
null
}
;
}
,
>
;
}
,
>
,
>
= ...
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Circle V2 API Docs
Loading...