Circle V2 API Docs
Preparing search index...
@repo/db
Module
Type Aliases
AccessibleFormRow
ActionItemKey
AddCredentialMatchersParams
AddTeamMemberParams
AddTeamMembersParams
AiFeedbackTicketContextRow
AuditRunResultStatusFilter
AuditTemplatesListInScopeParams
AuditTemplatesListParams
BulkQuestionInput
BulkSectionInput
CensusEntityParams
CensusFacilityParams
CensusProgramMembersParams
ChartPreprocessingKey
CircleMatcher
ConceptDocument
ConceptsWithRulesFilter
ConceptsWithRulesSort
ConceptsWithRulesSortOrder
ContactDetailRow
ContactListRow
ContactTypeDetailRow
ContactTypeListRow
CoordinateSnapshotElement
CreateConceptParams
CreateContactParams
CreateContactTypeParams
CreatedFormRunRow
CreatedFormRunWithChart
CreateExtendRunParams
CreateFacilityWithIntegrationParams
CreateFormParams
CreateFormRunParams
CreateFormRunWithChartParams
CreatePatientChartParams
CreatePendingInviteParams
CreateRpaRunParams
CreateRuleParams
CreateTeamParams
CreateTrailByQuestionParams
CreateTrailByResponseIdParams
CreateTriggerParams
CreateVersionParams
CredentialEntriesFilter
CredentialsFilter
DecodeContext
DecodedAnswerValue
DecodedNullAnswer
DecodedSimpleAnswer
DecodedSubfieldAnswer
DecodedUnknownAnswer
DecodeIssueTally
DocumentMatcherConditions
EncodedContextSource
EncodedNoAnswerReason
ExtendRunDetail
ExtendUsageWindow
FacilityLevelOfCare
FacilityWithLevelsOfCare
FormAnswerForAnnotationRow
FormAnswerForRunRow
FormAnswerStatus
FormDetailRow
FormEditabilityParams
FormRowPermissions
FormRunChosenContact
FormRunDetail
FormRunRetrievalScope
FormVisibilityParams
GeneratedFormChartRow
GetFormByIdEditableParams
GetFormByIdParams
GetOrCreatePatientCaseParams
GetPatientChartByIdRow
KipuUtilizationFacilityParams
KipuUtilizationRangeParams
KipuUtilizationScope
KipuUtilizationSessionsParams
ListAccessibleFormsParams
ListAiFeedbackForSuperadminParams
ListAuditQuestionsByTemplateIdOptions
ListAuditRunsForPatientParams
ListAuditRunsForPatientRow
ListConceptDocumentsParams
ListConceptsWithRulesParams
ListContactsParams
ListEmrProfilesParams
ListEntitiesParams
ListEntityTeamIdsParams
ListExtendRunRow
ListExtendRunsParams
ListFacilitiesInOrganizationParams
ListForPatientWithPayorNameRow
ListOrgPendingInvitesOutput
ListOrgPendingInvitesParams
ListOrgUsersOutput
ListOrgUsersParams
ListPatientChartsForPatientParams
ListPatientChartsForPatientRow
ListPatientGeneratedFormsForPatientParams
ListPatientGeneratedFormsForPatientRow
ListPatientsInOrganizationParams
ListPatientsInOrganizationRow
ListPatientUtilizationReviewsParams
ListProfilesInOrganizationParams
ListProgramStaysForPatientParams
ListQuestionRunHistoryParams
ListRolesParams
ListRpaRunRow
ListRpaRunsParams
ListSessionsForCurrentUserParams
ListSessionsForCurrentUserRow
ListSessionsForPatientParams
ListSessionsForPatientRow
ListStuckRunsOptions
ListSuperadminAuditRunRow
ListSuperadminAuditRunsParams
ListTeamsParams
ListTeamsWithMembersOutput
ListUserPromptsByUserIdOptions
ListUserTeamIdsParams
ListUserTeammatesParams
LoadedTemplateSnapshot
MapLevelOfCareNamesParams
MarkChartPreprocessingFailedParams
MarkChartPreprocessingSkippedParams
MarkedReadyGeneratedFormChartRow
MarkStaleAsFailedParams
MarkStaleSessionsAsFailedParams
MergePatientCaseRowsForPatientMergeParams
NewRuleEvaluation
NoAnswerReasonCode
NormalizedContextSource
PacketPieceInput
PacketPieceListRow
PatientCaseMergeStats
PatientChartConcept
PatientChartSinceCutoff
PatientChartTitle
ProfilesByCredentialFilter
RemoveTeamMemberParams
RenameFormParams
ReplaceCircleMatchersParams
ReplaceConceptTitleRulesParams
ReplacePacketPiecesParams
RequiredContactTypeForFormRow
RpaRunDetail
RuleProgramStay
RuleSubjectFacts
RuleVersionInput
RuleWithVersion
SavedTemplate
SavedTemplateAnnotation
SaveQuestionResponseParams
SaveTemplateAnnotationInput
SaveTemplateCoordinateInput
SaveTemplateParams
SearchUsersForSuperadminParams
ServicesSyncCounts
SessionNoteEvidenceOptionRow
SessionNoteEvidenceRow
SetAuditTemplateQuestionsParams
SetFormOrgSharingParams
SoftDeleteAuditRunsByIdsParams
StampExtendSubmissionResult
StartSuperadminSessionParams
StoredPatternsFilter
StoredPatternSort
StoredPatternSortOrder
StoredPatternTitlesFilter
StuckFormRunRow
SuperadminAiFeedbackRow
SyncChangedChartsParams
TemplateFilterParams
TemplatesListInScopeParams
TemplateSnapshot
TemplateSnapshotAnnotation
TemplateSnapshotContactLink
TemplateSnapshotCoordinate
TemplateSnapshotForm
TemplateSnapshotRequiredContactType
UpdateConditionalRulesParams
UpdateContactParams
UpdateContactTypeParams
UpdatedFormAnswerRow
UpdateEmbeddingStatusParams
UpdateExtendRunFromWebhookParams
UpdateExtendRunSubmissionParams
UpdateFacilityParams
UpdateFormAnswerValueOptions
UpdateFormRunStatusOptions
UpdateOrgMemberByProfileIdParams
UpdateParsedContentParams
UpdateRpaRunFromWebhookParams
UpdateRpaRunProgressParams
UpdateTriggerParams
UpsertActionItemValues
UpsertAiFeedbackParams
UpsertCompletedChartPreprocessingParams
UpsertedFormAnswerRow
UpsertedGeneratedFormChartRow
UpsertEntitySettingParams
UpsertExternalDocumentRow
UpsertFormAnswerRow
UpsertGeneratedFormChartParams
UtilizationServicesCursor
WritableAnswerValue
Variables
aiFeedbackCommentsRepo
aiFeedbackRepo
auditQuestionsRepo
auditResponsesRepo
auditResponseTrailsRepo
auditRunsRepo
auditTemplatesRepo
authUsersRepo
casesRepo
censusRepo
chartReviewTriggersRepo
chartTitlePatternsRepo
contactsRepo
contactTypesRepo
db
DEFAULT_CONTACT_TYPE_NAME
dictionaryCredentialRepo
dictionaryLevelOfCareRepo
dictionaryRepo
entitiesRepo
entityLevelsOfCareRepo
entitySettingsRepo
extendRunsRepo
facilitiesRepo
facilityLevelsOfCareRepo
facilityProgramsRepo
FORM_EDITOR_ROLE_IDS
formAnswersRepo
formRunsRepo
formsRepo
formTemplatesRepo
integrationsRepo
jobExecutionsRepo
NO_ANSWER_REASON_CODE
orgMembersRepo
patientActionItemsRepo
patientAdmissionsRepo
patientChartConceptsRepo
patientChartPreprocessingRepo
patientChartsRepo
patientGeneratedFormsRepo
patientInsurancesRepo
patientSessionsRepo
patientsRepo
patientUtilizationReviewsRepo
payorsRepo
profilesRepo
programStaysRepo
rpaRunsRepo
ruleEvaluationsRepo
rulesRepo
savedFiltersRepo
sectionsRepo
STANDARD_FIELD_KEYS
superadminSessionsRepo
teamsRepo
TEMPLATE_SNAPSHOT_VERSION
templateAuditTemplatesRepo
templatesRepo
treatmentEpisodesRepo
userEntitiesRepo
userPromptsRepo
UTILIZATION_SERVICE_SOURCES
utilizationServicesRepo
zExtendUsageWindow
Functions
contactDisplayName
createDb
createDecodeIssueTally
createEvalBranchDb
decodeAnswerValue
decodeNoAnswerReason
encodeAnswerValue
encodeCitationsCell
encodeContextSources
formDeletablePredicate
formEditablePredicate
formLivePredicate
normalizeContextSources
normalizePayorName
simpleAnswerValue
subfieldAnswerValue
toSeededAnswerRows
References
DbConflictError
 →Â
DbConflictError
DbConnectionError
 →Â
DbConnectionError
DbNotFoundError
 →Â
DbNotFoundError
FormAccessSubject
 →Â
FormAccessSubject
isFormAccessibleToUser
 →Â
isFormAccessibleToUser
metricsAnalytics
 →Â
metricsAnalytics
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Type Aliases
Accessible
Form
Row
Action
Item
Key
Add
Credential
Matchers
Params
Add
Team
Member
Params
Add
Team
Members
Params
Ai
Feedback
Ticket
Context
Row
Audit
Run
Result
Status
Filter
Audit
Templates
List
In
Scope
Params
Audit
Templates
List
Params
Bulk
Question
Input
Bulk
Section
Input
Census
Entity
Params
Census
Facility
Params
Census
Program
Members
Params
Chart
Preprocessing
Key
Circle
Matcher
Concept
Document
Concepts
With
Rules
Filter
Concepts
With
Rules
Sort
Concepts
With
Rules
Sort
Order
Contact
Detail
Row
Contact
List
Row
Contact
Type
Detail
Row
Contact
Type
List
Row
Coordinate
Snapshot
Element
Create
Concept
Params
Create
Contact
Params
Create
Contact
Type
Params
Created
Form
Run
Row
Created
Form
Run
With
Chart
Create
Extend
Run
Params
Create
Facility
With
Integration
Params
Create
Form
Params
Create
Form
Run
Params
Create
Form
Run
With
Chart
Params
Create
Patient
Chart
Params
Create
Pending
Invite
Params
Create
Rpa
Run
Params
Create
Rule
Params
Create
Team
Params
Create
Trail
By
Question
Params
Create
Trail
By
Response
Id
Params
Create
Trigger
Params
Create
Version
Params
Credential
Entries
Filter
Credentials
Filter
Decode
Context
Decoded
Answer
Value
Decoded
Null
Answer
Decoded
Simple
Answer
Decoded
Subfield
Answer
Decoded
Unknown
Answer
Decode
Issue
Tally
Document
Matcher
Conditions
Encoded
Context
Source
Encoded
No
Answer
Reason
Extend
Run
Detail
Extend
Usage
Window
Facility
Level
Of
Care
Facility
With
Levels
Of
Care
Form
Answer
For
Annotation
Row
Form
Answer
For
Run
Row
Form
Answer
Status
Form
Detail
Row
Form
Editability
Params
Form
Row
Permissions
Form
Run
Chosen
Contact
Form
Run
Detail
Form
Run
Retrieval
Scope
Form
Visibility
Params
Generated
Form
Chart
Row
Get
Form
By
Id
Editable
Params
Get
Form
By
Id
Params
Get
Or
Create
Patient
Case
Params
Get
Patient
Chart
By
Id
Row
Kipu
Utilization
Facility
Params
Kipu
Utilization
Range
Params
Kipu
Utilization
Scope
Kipu
Utilization
Sessions
Params
List
Accessible
Forms
Params
List
Ai
Feedback
For
Superadmin
Params
List
Audit
Questions
By
Template
Id
Options
List
Audit
Runs
For
Patient
Params
List
Audit
Runs
For
Patient
Row
List
Concept
Documents
Params
List
Concepts
With
Rules
Params
List
Contacts
Params
List
Emr
Profiles
Params
List
Entities
Params
List
Entity
Team
Ids
Params
List
Extend
Run
Row
List
Extend
Runs
Params
List
Facilities
In
Organization
Params
List
For
Patient
With
Payor
Name
Row
List
Org
Pending
Invites
Output
List
Org
Pending
Invites
Params
List
Org
Users
Output
List
Org
Users
Params
List
Patient
Charts
For
Patient
Params
List
Patient
Charts
For
Patient
Row
List
Patient
Generated
Forms
For
Patient
Params
List
Patient
Generated
Forms
For
Patient
Row
List
Patients
In
Organization
Params
List
Patients
In
Organization
Row
List
Patient
Utilization
Reviews
Params
List
Profiles
In
Organization
Params
List
Program
Stays
For
Patient
Params
List
Question
Run
History
Params
List
Roles
Params
List
Rpa
Run
Row
List
Rpa
Runs
Params
List
Sessions
For
Current
User
Params
List
Sessions
For
Current
User
Row
List
Sessions
For
Patient
Params
List
Sessions
For
Patient
Row
List
Stuck
Runs
Options
List
Superadmin
Audit
Run
Row
List
Superadmin
Audit
Runs
Params
List
Teams
Params
List
Teams
With
Members
Output
List
User
Prompts
By
User
Id
Options
List
User
Team
Ids
Params
List
User
Teammates
Params
Loaded
Template
Snapshot
Map
Level
Of
Care
Names
Params
Mark
Chart
Preprocessing
Failed
Params
Mark
Chart
Preprocessing
Skipped
Params
Marked
Ready
Generated
Form
Chart
Row
Mark
Stale
As
Failed
Params
Mark
Stale
Sessions
As
Failed
Params
Merge
Patient
Case
Rows
For
Patient
Merge
Params
New
Rule
Evaluation
No
Answer
Reason
Code
Normalized
Context
Source
Packet
Piece
Input
Packet
Piece
List
Row
Patient
Case
Merge
Stats
Patient
Chart
Concept
Patient
Chart
Since
Cutoff
Patient
Chart
Title
Profiles
By
Credential
Filter
Remove
Team
Member
Params
Rename
Form
Params
Replace
Circle
Matchers
Params
Replace
Concept
Title
Rules
Params
Replace
Packet
Pieces
Params
Required
Contact
Type
For
Form
Row
Rpa
Run
Detail
Rule
Program
Stay
Rule
Subject
Facts
Rule
Version
Input
Rule
With
Version
Saved
Template
Saved
Template
Annotation
Save
Question
Response
Params
Save
Template
Annotation
Input
Save
Template
Coordinate
Input
Save
Template
Params
Search
Users
For
Superadmin
Params
Services
Sync
Counts
Session
Note
Evidence
Option
Row
Session
Note
Evidence
Row
Set
Audit
Template
Questions
Params
Set
Form
Org
Sharing
Params
Soft
Delete
Audit
Runs
By
Ids
Params
Stamp
Extend
Submission
Result
Start
Superadmin
Session
Params
Stored
Patterns
Filter
Stored
Pattern
Sort
Stored
Pattern
Sort
Order
Stored
Pattern
Titles
Filter
Stuck
Form
Run
Row
Superadmin
Ai
Feedback
Row
Sync
Changed
Charts
Params
Template
Filter
Params
Templates
List
In
Scope
Params
Template
Snapshot
Template
Snapshot
Annotation
Template
Snapshot
Contact
Link
Template
Snapshot
Coordinate
Template
Snapshot
Form
Template
Snapshot
Required
Contact
Type
Update
Conditional
Rules
Params
Update
Contact
Params
Update
Contact
Type
Params
Updated
Form
Answer
Row
Update
Embedding
Status
Params
Update
Extend
Run
From
Webhook
Params
Update
Extend
Run
Submission
Params
Update
Facility
Params
Update
Form
Answer
Value
Options
Update
Form
Run
Status
Options
Update
Org
Member
By
Profile
Id
Params
Update
Parsed
Content
Params
Update
Rpa
Run
From
Webhook
Params
Update
Rpa
Run
Progress
Params
Update
Trigger
Params
Upsert
Action
Item
Values
Upsert
Ai
Feedback
Params
Upsert
Completed
Chart
Preprocessing
Params
Upserted
Form
Answer
Row
Upserted
Generated
Form
Chart
Row
Upsert
Entity
Setting
Params
Upsert
External
Document
Row
Upsert
Form
Answer
Row
Upsert
Generated
Form
Chart
Params
Utilization
Services
Cursor
Writable
Answer
Value
Variables
ai
Feedback
Comments
Repo
ai
Feedback
Repo
audit
Questions
Repo
audit
Responses
Repo
audit
Response
Trails
Repo
audit
Runs
Repo
audit
Templates
Repo
auth
Users
Repo
cases
Repo
census
Repo
chart
Review
Triggers
Repo
chart
Title
Patterns
Repo
contacts
Repo
contact
Types
Repo
db
DEFAULT_
CONTACT_
TYPE_
NAME
dictionary
Credential
Repo
dictionary
Level
Of
Care
Repo
dictionary
Repo
entities
Repo
entity
Levels
Of
Care
Repo
entity
Settings
Repo
extend
Runs
Repo
facilities
Repo
facility
Levels
Of
Care
Repo
facility
Programs
Repo
FORM_
EDITOR_
ROLE_
IDS
form
Answers
Repo
form
Runs
Repo
forms
Repo
form
Templates
Repo
integrations
Repo
job
Executions
Repo
NO_
ANSWER_
REASON_
CODE
org
Members
Repo
patient
Action
Items
Repo
patient
Admissions
Repo
patient
Chart
Concepts
Repo
patient
Chart
Preprocessing
Repo
patient
Charts
Repo
patient
Generated
Forms
Repo
patient
Insurances
Repo
patient
Sessions
Repo
patients
Repo
patient
Utilization
Reviews
Repo
payors
Repo
profiles
Repo
program
Stays
Repo
rpa
Runs
Repo
rule
Evaluations
Repo
rules
Repo
saved
Filters
Repo
sections
Repo
STANDARD_
FIELD_
KEYS
superadmin
Sessions
Repo
teams
Repo
TEMPLATE_
SNAPSHOT_
VERSION
template
Audit
Templates
Repo
templates
Repo
treatment
Episodes
Repo
user
Entities
Repo
user
Prompts
Repo
UTILIZATION_
SERVICE_
SOURCES
utilization
Services
Repo
z
Extend
Usage
Window
Functions
contact
Display
Name
create
Db
create
Decode
Issue
Tally
create
Eval
Branch
Db
decode
Answer
Value
decode
No
Answer
Reason
encode
Answer
Value
encode
Citations
Cell
encode
Context
Sources
form
Deletable
Predicate
form
Editable
Predicate
form
Live
Predicate
normalize
Context
Sources
normalize
Payor
Name
simple
Answer
Value
subfield
Answer
Value
to
Seeded
Answer
Rows
References
Db
Conflict
Error
Db
Connection
Error
Db
Not
Found
Error
Form
Access
Subject
is
Form
Accessible
To
User
metrics
Analytics
Circle V2 API Docs
Loading...