Circle V2 API Docs
    Preparing search index...

    Module schema

    Type Aliases

    AuditQuestionId
    AuditQuestionInsertParams
    AuditQuestionRow
    AuditQuestionType
    AuditQuestionUpdateParams
    AuditResponseId
    AuditResponseInsertParams
    AuditResponseRow
    AuditResponseTrailId
    AuditResponseTrailInsertParams
    AuditResponseTrailMarkedAsStatus
    AuditResponseTrailRow
    AuditResponseTrailUpdateParams
    AuditResponseUpdateParams
    AuditRunId
    AuditRunInsertParams
    AuditRunRow
    AuditRunUpdateParams
    AuditStatus
    AuditTemplateId
    AuditTemplateInsertParams
    AuditTemplateLabel
    AuditTemplateRow
    AuditTemplateUpdateParams
    BaseUserRole
    CaseDocumentInsertParams
    CaseDocumentRow
    CaseDocumentUpdateParams
    CaseId
    CaseRow
    ChartReviewTemplateTriggersInsertParams
    ChartReviewTemplateTriggersRow
    ChartReviewTemplateTriggersUpdateParams
    ChartReviewTriggerAuditTemplateId
    ChartReviewTriggerAuditTemplatesInsertParams
    ChartReviewTriggerAuditTemplatesRow
    ChartReviewTriggerId
    ChartReviewTriggerType
    CircleDocumentMetadata
    ContactId
    ContactTypeFieldId
    ContactTypeId
    CreateAuditResponseTrailParams
    DiscriminatedIntegrationClientCredentials
    EmbeddingStatus
    EntityId
    EntityInsertParams
    EntityLevelOfCareId
    EntityLevelOfCareRow
    EntityLevelsOfCareInsertParams
    EntityLevelsOfCareUpdateParams
    EntityRow
    EntitySettingId
    EntitySettingInsertParams
    EntitySettingRow
    EntitySettingUpdateParams
    EntityUpdateParams
    ExternalDocumentType
    FacilityId
    FacilityInsertParams
    FacilityLevelOfCareId
    FacilityLevelOfCareInsertParams
    FacilityLevelOfCareRow
    FacilityLevelOfCareUpdateParams
    FacilityProgramId
    FacilityProgramInsertParams
    FacilityProgramRow
    FacilityProgramUpdateParams
    FacilityRow
    FacilityUpdateParams
    FormAnnotationType
    FormId
    FormInsertParams
    FormRow
    FormRunId
    FormRunInsertParams
    FormRunRow
    FormRunUpdateParams
    FormType
    FormUpdateParams
    IcdCodeType
    IntegrationClientCredentials
    IntegrationCredentials
    IntegrationId
    IntegrationInsertParams
    IntegrationRow
    IntegrationStatus
    IntegrationType
    IntegrationUpdateParams
    JobExecutionId
    JobExecutionInsertParams
    JobExecutionRow
    JobExecutionStatus
    JobExecutionUpdateParams
    KipuClientCredentials
    KipuCredentials
    LegacyPatientSummary
    LegacySelectedTemplate
    LevelOfCareType
    LightningStepCredentials
    OrgMemberStatus
    OrgSettingDefinition
    OrgSettingKey
    OrgSettingValue
    PatientAdmissionId
    PatientAdmissionInsertParams
    PatientAdmissionRow
    PatientAdmissionUpdateParams
    PatientChartId
    PatientContext
    PatientId
    PatientInsertParams
    PatientInsuranceId
    PatientInsuranceInsertParams
    PatientInsuranceRow
    PatientInsuranceUpdateParams
    PatientRow
    PatientUpdateParams
    PatientUtilizationReviewId
    PatientUtilizationReviewInsertParams
    PatientUtilizationReviewRow
    PatientUtilizationReviewUpdateParams
    PayorId
    PendingInviteId
    PreLocationCredentials
    ProfileId
    ProfileInsertParams
    ProfileRow
    ProfileType
    ProfileUpdateParams
    ProgramStayId
    ProgramStayInsertParams
    ProgramStayRow
    ProgramStayUpdateParams
    QualifactsInsyncCredentials
    ResolvedOrgSettings
    RoleId
    SavedFilterId
    SavedFilterInsertParams
    SavedFilterRow
    SavedFilterUpdateParams
    SavedFilterViewMode
    Schedule
    ScheduleEntry
    SectionId
    SectionInsertParams
    SectionRow
    SectionUpdateParams
    SessionCodeAssignments
    SessionCodeEntry
    SessionCodeStatus
    SessionCodeType
    SessionId
    SessionInsertParams
    SessionProgressStatus
    SessionRow
    SessionUpdateParams
    SubscriptionStatus
    SunwaveCredentials
    SuperadminSessionId
    SuperadminSessionInsertParams
    SuperadminSessionRow
    SuperadminSessionUpdateParams
    TeamId
    TemplateId
    TemplateInsertParams
    TemplateRow
    TemplateUpdateParams
    TreatmentEpisodeId
    TreatmentEpisodeInsertParams
    TreatmentEpisodeRow
    TreatmentEpisodeUpdateParams
    TriggerFilters
    TriggerFiltersStored
    UserAction
    UserEntityId
    UserEntityInsertParams
    UserEntityRow
    UserEntityUpdateParams
    UserId
    UserPromptId
    UserPromptInsertParams
    UserPromptRow
    UserPromptUpdateParams
    UserRole
    UserTeamId

    Variables

    annotationsContactFieldsRelations
    annotationsContactFieldsTable
    annotationsRelations
    annotationsTable
    ASSIGNABLE_ROLES
    AUDIT_QUESTION_TYPES
    AUDIT_RESPONSE_TRAIL_MARKED_AS_STATUSES
    AUDIT_STATUSES
    auditQuestionRelations
    auditQuestionsTable
    auditQuestionType
    auditResponseRelations
    auditResponseTable
    auditResponseTrailMarkedAsStatus
    auditResponseTrailsRelations
    auditResponseTrailsTable
    auditRunsRelations
    auditRunsTable
    auditStatus
    auditTemplateRelations
    auditTemplateTable
    BASE_USER_ROLES
    caseDocumentsRelations
    caseDocumentsTable
    casesRelations
    casesTable
    CHART_REVIEW_TRIGGER_TYPES
    chartReviewTemplateTriggersRelations
    chartReviewTemplateTriggersTable
    chartReviewTriggerAuditTemplatesTable
    chartReviewTriggerType
    circleDocumentMetadataSchema
    contactFieldValuesRelations
    contactFieldValuesTable
    contactsRelations
    contactsTable
    contactTypeFieldsRelations
    contactTypeFieldsTable
    contactTypesRelations
    contactTypesTable
    coordinatesRelations
    coordinatesTable
    discriminatedIntegrationClientCredentialsSchema
    EMBEDDING_STATUSES
    embeddingStatus
    entitiesTable
    entityEntityIdSeq1
    entityLevelsOfCareRelations
    entityLevelsOfCareTable
    entityRelations
    entitySettingsRelations
    entitySettingsTable
    EXTERNAL_DOCUMENT_TYPES
    externalDocumentType
    facilitiesRelations
    facilitiesTable
    facilityFilterWriteSchema
    facilityLevelsOfCareRelations
    facilityLevelsOfCareTable
    facilityProgramsRelations
    facilityProgramsTable
    FORM_ANNOTATION_TYPES
    FORM_TYPES
    formAnnotationTypes
    formAnswersRelations
    formAnswersTable
    formRunFilesRelations
    formRunFilesTable
    formRunsRelations
    formRunsTable
    formsContactTypesRelations
    formsContactTypesTable
    formsRelations
    formsTable
    formTypes
    ICD_CODE_TYPES
    icdCodesRelations
    icdCodesTable
    icdCodeType
    insuranceStatus
    INTEGRATION_STATUSES
    INTEGRATION_TYPES
    integrationClientCredentialsSchema
    integrationCredentialsSchema
    integrationsRelations
    integrationsTable
    integrationStatus
    integrationType
    JOB_EXECUTION_STATUS
    jobExecutionsTable
    jobExecutionStatusSchema
    kipuClientCredentialsSchema
    kipuCredentialsSchema
    LEVEL_OF_CARE_TYPES
    levelOfCareType
    lightningStepCredentialsSchema
    ORG_MEMBER_STATUSES
    ORG_SETTING_KEYS
    ORG_SETTINGS
    orgMemberStatus
    parseAuditQuestionId
    parseAuditResponseId
    parseAuditResponseTrailId
    parseAuditRunId
    parseAuditTemplateId
    parseCaseDocumentId
    parseCaseId
    parseChartReviewTriggerAuditTemplateId
    parseChartReviewTriggerId
    parseContactId
    parseContactTypeFieldId
    parseContactTypeId
    parseEntityId
    parseEntityLevelOfCareId
    parseEntitySettingId
    parseFacilityId
    parseFacilityLevelOfCareId
    parseFacilityProgramId
    parseFormId
    parseFormRunId
    parseIntegrationId
    parseJobExecutionId
    parsePatientAdmissionId
    parsePatientChartId
    parsePatientId
    parsePatientInsuranceId
    parsePatientUtilizationReviewId
    parsePayorId
    parsePendingInviteId
    parseProfileId
    parseProgramStayId
    parseRoleId
    parseSavedFilterId
    parseSectionId
    parseSessionId
    parseSuperadminSessionId
    parseTeamId
    parseTemplateId
    parseTreatmentEpisodeId
    parseUserEntityId
    parseUserPromptId
    parseUserTeamId
    patientAdmissions
    patientAdmissionsRelations
    patientChartsContactsRelations
    patientChartsContactsTable
    patientChartsRelations
    patientChartsTable
    patientContextSchema
    patientInsurancesTable
    patientRelations
    patientsTable
    patientUtilizationReviewsRelations
    patientUtilizationReviewsTable
    payorsTable
    pendingInvitesRelations
    pendingInvitesTable
    permissionsRelations
    permissionsTable
    PROFILE_TYPES
    profileRelations
    profilesRelations
    profilesTable
    profileType
    programStaysRelations
    programStaysTable
    qualifactsInsyncCredentialsSchema
    relations
    ROLE_ID_TO_ROLE
    ROLE_RANK
    ROLE_TO_ROLE_ID
    rolePermissionsRelations
    rolePermissionsTable
    rolesRelations
    rolesTable
    SAVED_FILTER_VIEW_MODES
    savedFiltersRelations
    savedFiltersTable
    scheduleEntrySchema
    scheduleSchema
    sectionsRelations
    sectionsTable
    SESSION_CODE_STATUSES
    SESSION_CODE_TYPES
    SESSION_PROGRESS_STATUS
    SESSION_PROGRESS_STATUSES
    sessionRelations
    sessionsTable
    SUBSCRIPTION_STATUSES
    subscriptionStatus
    sunwaveCredentialsSchema
    superadminSessionsRelations
    superadminSessionsTable
    teamsRelations
    teamsTable
    templateAuditTemplatesRelations
    templateAuditTemplatesTable
    templatesRelations
    templatesTable
    treatmentEpisodesRelations
    treatmentEpisodesTable
    treatmentPlanSessionsRelations
    treatmentPlanSessionsTable
    treatmentPlansRelations
    treatmentPlansTable
    triggerFilterReadSchema
    triggerFilterWriteSchema
    USER_ACTIONS
    USER_ROLES
    userActions
    userEntitiesRelations
    userEntitiesTable
    userPromptsTable
    userTeamsRelations
    userTeamsTable
    zAuditQuestionId
    zAuditQuestionType
    zAuditResponseId
    zAuditResponseTrailId
    zAuditResponseTrailMarkedAsStatus
    zAuditRunId
    zAuditStatus
    zAuditTemplateId
    zBaseUserRole
    zCaseId
    zChartReviewTriggerAuditTemplateId
    zChartReviewTriggerId
    zChartReviewTriggerType
    zContactId
    zContactTypeFieldId
    zContactTypeId
    zEmbeddingStatus
    zEntityId
    zEntityLevelOfCareId
    zEntitySettingId
    zExternalDocumentType
    zFacilityId
    zFacilityLevelOfCareId
    zFacilityProgramId
    zFormAnnotationType
    zFormId
    zFormRunId
    zFormType
    zIcdCodeType
    zIntegrationId
    zIntegrationStatus
    zIntegrationType
    zJobExecutionId
    zLegacySelectedTemplate
    zLevelOfCareType
    zOrgMemberStatus
    zOrgSettingKey
    zPatientAdmissionId
    zPatientChartId
    zPatientId
    zPatientInsuranceId
    zPatientUtilizationReviewId
    zPayorId
    zPendingInviteId
    zProfileId
    zProfileType
    zProgramStayId
    zRoleId
    zSavedFilterId
    zSavedFilterViewMode
    zSectionId
    zSessionCodeAssignments
    zSessionCodeEntry
    zSessionCodeStatus
    zSessionCodeType
    zSessionId
    zSessionProgressStatus
    zSubscriptionStatus
    zSuperadminSessionId
    zTeamId
    zTemplateId
    zTreatmentEpisodeId
    zUserAction
    zUserEntityId
    zUserId
    zUserPromptId
    zUserRole
    zUserTeamId

    Functions

    canAssignRole
    isAuditQuestionType
    isAuditResponseTrailMarkedAsStatus
    isAuditStatus
    isChartReviewTriggerType
    isEmbeddingStatus
    isExternalDocumentType
    isFormAnnotationType
    isFormType
    isIcdCodeType
    isIntegrationStatus
    isIntegrationType
    isLevelOfCareType
    isOrgMemberStatus
    isProfileType
    isSessionProgressStatus
    isSubscriptionStatus
    isTerminalSessionProgressStatus
    isUserAction
    parseAuditQuestionType
    parseAuditResponseTrailMarkedAsStatus
    parseAuditStatus
    parseChartReviewTriggerType
    parseEmbeddingStatus
    parseExternalDocumentType
    parseFormAnnotationType
    parseFormType
    parseIcdCodeType
    parseIntegrationStatus
    parseIntegrationType
    parseLevelOfCareType
    parseOrgMemberStatus
    parseProfileType
    parseSessionProgressStatus
    parseSubscriptionStatus
    parseUserAction
    roleAtLeast
    roleFromId
    validateAndBuildIntegrationCredentials