Circle V2 API Docs
    Preparing search index...

    Variable relationsConst

    relations: {
        annotations: Relations<
            "annotations",
            {
                annotationsContactFields: Many<"annotations_contact_fields">;
                coordinates: Many<"coordinates">;
                form: One<"forms", false>;
                formAnswers: Many<"form_answers">;
            },
        >;
        annotationsContactFields: Relations<
            "annotations_contact_fields",
            {
                annotation: One<"annotations", true>;
                contactType: One<"contact_types", true>;
                contactTypeField: One<"contact_type_fields", true>;
            },
        >;
        auditQuestion: Relations<
            "audit_question",
            {
                auditResponses: Many<"audit_response">;
                auditTemplate: One<"audit_template", false>;
                entity: One<"entity", false>;
            },
        >;
        auditResponse: Relations<
            "audit_response",
            {
                auditQuestion: One<"audit_question", false>;
                auditResponseTrails: Many<"audit_response_trails">;
                auditRun: One<"audit_runs", false>;
                session: One<"session", false>;
            },
        >;
        auditResponseTrails: Relations<
            "audit_response_trails",
            { auditResponse: One<"audit_response", true>; user: One<"users", false> },
        >;
        auditRuns: Relations<
            "audit_runs",
            {
                auditResponses: Many<"audit_response">;
                auditTemplate: One<"audit_template", false>;
                case: One<"cases", false>;
                chartReviewTemplateTrigger: One<"chart_review_template_triggers", false>;
                sessions: Many<"session">;
            },
        >;
        auditTemplate: Relations<
            "audit_template",
            {
                auditQuestions: Many<"audit_question">;
                auditRuns: Many<"audit_runs">;
                chartReviewTemplateTriggers: Many<"chart_review_template_triggers">;
                entity: One<"entity", false>;
                templateAuditTemplates: Many<"template_audit_templates">;
            },
        >;
        caseDocuments: Relations<
            "case_documents",
            {
                case: One<"cases", false>;
                patient: One<"patient", false>;
                session: One<"session", false>;
            },
        >;
        cases: Relations<
            "cases",
            {
                auditRuns: Many<"audit_runs">;
                caseDocuments: Many<"case_documents">;
                patient: One<"patient", false>;
                sessions: Many<"session">;
            },
        >;
        chartReviewTemplateTriggers: Relations<
            "chart_review_template_triggers",
            {
                auditRuns: Many<"audit_runs">;
                auditTemplate: One<"audit_template", true>;
                entity: One<"entity", true>;
            },
        >;
        contactFieldValues: Relations<
            "contact_field_values",
            {
                contact: One<"contacts", true>;
                contactTypeField: One<"contact_type_fields", true>;
            },
        >;
        contacts: Relations<
            "contacts",
            {
                contactFieldValues: Many<"contact_field_values">;
                contactType: One<"contact_types", true>;
                entity: One<"entity", true>;
                patientChartsContacts: Many<"patient_charts_contacts">;
            },
        >;
        contactTypeFields: Relations<
            "contact_type_fields",
            {
                annotationsContactFields: Many<"annotations_contact_fields">;
                contactFieldValues: Many<"contact_field_values">;
                contactType: One<"contact_types", true>;
            },
        >;
        contactTypes: Relations<
            "contact_types",
            {
                annotationsContactFields: Many<"annotations_contact_fields">;
                contacts: Many<"contacts">;
                contactTypeFields: Many<"contact_type_fields">;
                entity: One<"entity", false>;
                formsContactTypes: Many<"forms_contact_types">;
                patientChartsContacts: Many<"patient_charts_contacts">;
            },
        >;
        coordinates: Relations<
            "coordinates",
            { annotation: One<"annotations", false> },
        >;
        entity: Relations<
            "entity",
            {
                auditQuestions: Many<"audit_question">;
                auditTemplates: Many<"audit_template">;
                chartReviewTemplateTriggers: Many<"chart_review_template_triggers">;
                contacts: Many<"contacts">;
                contactTypes: Many<"contact_types">;
                entityLevelsOfCares: Many<"entity_levels_of_care">;
                facilities: Many<"facilities">;
                forms: Many<"forms">;
                integrations: Many<"integrations">;
                patientCharts: Many<"patient_charts">;
                patients: Many<"patient">;
                patientUtilizationReviews: Many<"patient_utilization_reviews">;
                pendingInvites: Many<"pending_invites">;
                savedFilters: Many<"saved_filters">;
                teams: Many<"teams">;
                templates: Many<"templates">;
                userEntities: Many<"user_entities">;
            },
        >;
        entityLevelsOfCare: Relations<
            "entity_levels_of_care",
            {
                entity: One<"entity", true>;
                entityLevelsOfCare: One<"entity_levels_of_care", false>;
                entityLevelsOfCares: Many<"entity_levels_of_care">;
                facility: One<"facilities", false>;
                patientAdmissions: Many<"patient_admissions">;
                patientUtilizationReviews: Many<"patient_utilization_reviews">;
            },
        >;
        facilities: Relations<
            "facilities",
            {
                entity: One<"entity", true>;
                entityLevelsOfCares: Many<"entity_levels_of_care">;
                integrations: Many<"integrations">;
                patients: Many<"patient">;
            },
        >;
        formAnswers: Relations<
            "form_answers",
            { annotation: One<"annotations", true>; formRun: One<"form_runs", true> },
        >;
        formRunFiles: Relations<
            "form_run_files",
            { formRun: One<"form_runs", true> },
        >;
        formRuns: Relations<
            "form_runs",
            {
                form: One<"forms", true>;
                formAnswers: Many<"form_answers">;
                formRunFiles: Many<"form_run_files">;
                patientCharts: Many<"patient_charts">;
            },
        >;
        forms: Relations<
            "forms",
            {
                annotations: Many<"annotations">;
                entity: One<"entity", false>;
                formRuns: Many<"form_runs">;
                formsContactTypes: Many<"forms_contact_types">;
            },
        >;
        formsContactTypes: Relations<
            "forms_contact_types",
            { contactType: One<"contact_types", true>; form: One<"forms", true> },
        >;
        icdCodes: Relations<
            "icd_codes",
            {
                icdCode: One<"icd_codes", false>;
                icdCodes: Many<"icd_codes">;
                treatmentPlans: Many<"treatment_plans">;
            },
        >;
        integrations: Relations<
            "integrations",
            {
                entity: One<"entity", true>;
                facility: One<"facilities", false>;
                patientAdmissions: Many<"patient_admissions">;
                patientCharts: Many<"patient_charts">;
                patientUtilizationReviews: Many<"patient_utilization_reviews">;
                user: One<"users", false>;
            },
        >;
        patient: Relations<
            "patient",
            {
                caseDocuments: Many<"case_documents">;
                cases: Many<"cases">;
                entity: One<"entity", false>;
                facility: One<"facilities", false>;
                patientAdmissions: Many<"patient_admissions">;
                patientCharts: Many<"patient_charts">;
                patientUtilizationReviews: Many<"patient_utilization_reviews">;
                profile: One<"profiles", false>;
                sessions: Many<"session">;
                treatmentPlans: Many<"treatment_plans">;
            },
        >;
        patientAdmissions: Relations<
            "patient_admissions",
            {
                entityLevelsOfCare: One<"entity_levels_of_care", false>;
                integration: One<"integrations", false>;
                patient: One<"patient", false>;
                patientUtilizationReviews: Many<"patient_utilization_reviews">;
            },
        >;
        patientCharts: Relations<
            "patient_charts",
            {
                entity: One<"entity", false>;
                formRun: One<"form_runs", false>;
                integration: One<"integrations", false>;
                patient: One<"patient", false>;
                patientChartsContacts: Many<"patient_charts_contacts">;
            },
        >;
        patientChartsContacts: Relations<
            "patient_charts_contacts",
            {
                contact: One<"contacts", true>;
                contactType: One<"contact_types", true>;
                patientChart: One<"patient_charts", true>;
            },
        >;
        patientUtilizationReviews: Relations<
            "patient_utilization_reviews",
            {
                entity: One<"entity", true>;
                entityLevelsOfCare: One<"entity_levels_of_care", false>;
                integration: One<"integrations", true>;
                patient: One<"patient", true>;
                patientAdmission: One<"patient_admissions", true>;
            },
        >;
        pendingInvites: Relations<
            "pending_invites",
            { entity: One<"entity", true>; user: One<"users", true> },
        >;
        permissions: Relations<
            "permissions",
            { rolePermissions: Many<"role_permissions"> },
        >;
        profiles: Relations<
            "profiles",
            {
                patients: Many<"patient">;
                sessions: Many<"session">;
                user: One<"users", false>;
                userTeams: Many<"user_teams">;
            },
        >;
        rolePermissions: Relations<
            "role_permissions",
            { permission: One<"permissions", true>; role: One<"roles", true> },
        >;
        roles: Relations<
            "roles",
            {
                rolePermissions: Many<"role_permissions">;
                userEntities: Many<"user_entities">;
            },
        >;
        savedFilters: Relations<
            "saved_filters",
            { entity: One<"entity", true>; user: One<"users", true> },
        >;
        sections: Relations<"sections", { template: One<"templates", false> }>;
        session: Relations<
            "session",
            {
                auditResponses: Many<"audit_response">;
                auditRun: One<"audit_runs", false>;
                case: One<"cases", false>;
                caseDocuments: Many<"case_documents">;
                patient: One<"patient", false>;
                profile: One<"profiles", false>;
                treatmentPlanSessions: Many<"treatment_plan_sessions">;
            },
        >;
        teams: Relations<
            "teams",
            { entity: One<"entity", false>; userTeams: Many<"user_teams"> },
        >;
        templateAuditTemplates: Relations<
            "template_audit_templates",
            {
                auditTemplate: One<"audit_template", true>;
                template: One<"templates", true>;
            },
        >;
        templates: Relations<
            "templates",
            {
                entity: One<"entity", false>;
                sections: Many<"sections">;
                template: One<"templates", false>;
                templateAuditTemplates: Many<"template_audit_templates">;
                templates: Many<"templates">;
            },
        >;
        treatmentPlans: Relations<
            "treatment_plans",
            {
                icdCode: One<"icd_codes", false>;
                patient: One<"patient", false>;
                treatmentPlanSessions: Many<"treatment_plan_sessions">;
            },
        >;
        treatmentPlanSessions: Relations<
            "treatment_plan_sessions",
            {
                session: One<"session", true>;
                treatmentPlan: One<"treatment_plans", true>;
            },
        >;
        userEntities: Relations<
            "user_entities",
            {
                entity: One<"entity", true>;
                role: One<"roles", true>;
                user: One<"users", true>;
                userTeams: Many<"user_teams">;
            },
        >;
        users: Relations<
            "users",
            {
                auditResponseTrails: Many<"audit_response_trails">;
                integrations: Many<"integrations">;
                pendingInvites: Many<"pending_invites">;
                profiles_userId: Many<"profiles">;
                savedFilters: Many<"saved_filters">;
                userEntities: Many<"user_entities">;
            },
        >;
        userTeams: Relations<
            "user_teams",
            {
                profile: One<"profiles", true>;
                team: One<"teams", true>;
                userEntity: One<"user_entities", false>;
            },
        >;
    } = ...

    Type Declaration

    • annotations: Relations<
          "annotations",
          {
              annotationsContactFields: Many<"annotations_contact_fields">;
              coordinates: Many<"coordinates">;
              form: One<"forms", false>;
              formAnswers: Many<"form_answers">;
          },
      >
    • annotationsContactFields: Relations<
          "annotations_contact_fields",
          {
              annotation: One<"annotations", true>;
              contactType: One<"contact_types", true>;
              contactTypeField: One<"contact_type_fields", true>;
          },
      >
    • auditQuestion: Relations<
          "audit_question",
          {
              auditResponses: Many<"audit_response">;
              auditTemplate: One<"audit_template", false>;
              entity: One<"entity", false>;
          },
      >
    • auditResponse: Relations<
          "audit_response",
          {
              auditQuestion: One<"audit_question", false>;
              auditResponseTrails: Many<"audit_response_trails">;
              auditRun: One<"audit_runs", false>;
              session: One<"session", false>;
          },
      >
    • auditResponseTrails: Relations<
          "audit_response_trails",
          { auditResponse: One<"audit_response", true>; user: One<"users", false> },
      >
    • auditRuns: Relations<
          "audit_runs",
          {
              auditResponses: Many<"audit_response">;
              auditTemplate: One<"audit_template", false>;
              case: One<"cases", false>;
              chartReviewTemplateTrigger: One<"chart_review_template_triggers", false>;
              sessions: Many<"session">;
          },
      >
    • auditTemplate: Relations<
          "audit_template",
          {
              auditQuestions: Many<"audit_question">;
              auditRuns: Many<"audit_runs">;
              chartReviewTemplateTriggers: Many<"chart_review_template_triggers">;
              entity: One<"entity", false>;
              templateAuditTemplates: Many<"template_audit_templates">;
          },
      >
    • caseDocuments: Relations<
          "case_documents",
          {
              case: One<"cases", false>;
              patient: One<"patient", false>;
              session: One<"session", false>;
          },
      >
    • cases: Relations<
          "cases",
          {
              auditRuns: Many<"audit_runs">;
              caseDocuments: Many<"case_documents">;
              patient: One<"patient", false>;
              sessions: Many<"session">;
          },
      >
    • chartReviewTemplateTriggers: Relations<
          "chart_review_template_triggers",
          {
              auditRuns: Many<"audit_runs">;
              auditTemplate: One<"audit_template", true>;
              entity: One<"entity", true>;
          },
      >
    • contactFieldValues: Relations<
          "contact_field_values",
          {
              contact: One<"contacts", true>;
              contactTypeField: One<"contact_type_fields", true>;
          },
      >
    • contacts: Relations<
          "contacts",
          {
              contactFieldValues: Many<"contact_field_values">;
              contactType: One<"contact_types", true>;
              entity: One<"entity", true>;
              patientChartsContacts: Many<"patient_charts_contacts">;
          },
      >
    • contactTypeFields: Relations<
          "contact_type_fields",
          {
              annotationsContactFields: Many<"annotations_contact_fields">;
              contactFieldValues: Many<"contact_field_values">;
              contactType: One<"contact_types", true>;
          },
      >
    • contactTypes: Relations<
          "contact_types",
          {
              annotationsContactFields: Many<"annotations_contact_fields">;
              contacts: Many<"contacts">;
              contactTypeFields: Many<"contact_type_fields">;
              entity: One<"entity", false>;
              formsContactTypes: Many<"forms_contact_types">;
              patientChartsContacts: Many<"patient_charts_contacts">;
          },
      >
    • coordinates: Relations<"coordinates", { annotation: One<"annotations", false> }>
    • entity: Relations<
          "entity",
          {
              auditQuestions: Many<"audit_question">;
              auditTemplates: Many<"audit_template">;
              chartReviewTemplateTriggers: Many<"chart_review_template_triggers">;
              contacts: Many<"contacts">;
              contactTypes: Many<"contact_types">;
              entityLevelsOfCares: Many<"entity_levels_of_care">;
              facilities: Many<"facilities">;
              forms: Many<"forms">;
              integrations: Many<"integrations">;
              patientCharts: Many<"patient_charts">;
              patients: Many<"patient">;
              patientUtilizationReviews: Many<"patient_utilization_reviews">;
              pendingInvites: Many<"pending_invites">;
              savedFilters: Many<"saved_filters">;
              teams: Many<"teams">;
              templates: Many<"templates">;
              userEntities: Many<"user_entities">;
          },
      >
    • entityLevelsOfCare: Relations<
          "entity_levels_of_care",
          {
              entity: One<"entity", true>;
              entityLevelsOfCare: One<"entity_levels_of_care", false>;
              entityLevelsOfCares: Many<"entity_levels_of_care">;
              facility: One<"facilities", false>;
              patientAdmissions: Many<"patient_admissions">;
              patientUtilizationReviews: Many<"patient_utilization_reviews">;
          },
      >
    • facilities: Relations<
          "facilities",
          {
              entity: One<"entity", true>;
              entityLevelsOfCares: Many<"entity_levels_of_care">;
              integrations: Many<"integrations">;
              patients: Many<"patient">;
          },
      >
    • formAnswers: Relations<
          "form_answers",
          { annotation: One<"annotations", true>; formRun: One<"form_runs", true> },
      >
    • formRunFiles: Relations<"form_run_files", { formRun: One<"form_runs", true> }>
    • formRuns: Relations<
          "form_runs",
          {
              form: One<"forms", true>;
              formAnswers: Many<"form_answers">;
              formRunFiles: Many<"form_run_files">;
              patientCharts: Many<"patient_charts">;
          },
      >
    • forms: Relations<
          "forms",
          {
              annotations: Many<"annotations">;
              entity: One<"entity", false>;
              formRuns: Many<"form_runs">;
              formsContactTypes: Many<"forms_contact_types">;
          },
      >
    • formsContactTypes: Relations<
          "forms_contact_types",
          { contactType: One<"contact_types", true>; form: One<"forms", true> },
      >
    • icdCodes: Relations<
          "icd_codes",
          {
              icdCode: One<"icd_codes", false>;
              icdCodes: Many<"icd_codes">;
              treatmentPlans: Many<"treatment_plans">;
          },
      >
    • integrations: Relations<
          "integrations",
          {
              entity: One<"entity", true>;
              facility: One<"facilities", false>;
              patientAdmissions: Many<"patient_admissions">;
              patientCharts: Many<"patient_charts">;
              patientUtilizationReviews: Many<"patient_utilization_reviews">;
              user: One<"users", false>;
          },
      >
    • patient: Relations<
          "patient",
          {
              caseDocuments: Many<"case_documents">;
              cases: Many<"cases">;
              entity: One<"entity", false>;
              facility: One<"facilities", false>;
              patientAdmissions: Many<"patient_admissions">;
              patientCharts: Many<"patient_charts">;
              patientUtilizationReviews: Many<"patient_utilization_reviews">;
              profile: One<"profiles", false>;
              sessions: Many<"session">;
              treatmentPlans: Many<"treatment_plans">;
          },
      >
    • patientAdmissions: Relations<
          "patient_admissions",
          {
              entityLevelsOfCare: One<"entity_levels_of_care", false>;
              integration: One<"integrations", false>;
              patient: One<"patient", false>;
              patientUtilizationReviews: Many<"patient_utilization_reviews">;
          },
      >
    • patientCharts: Relations<
          "patient_charts",
          {
              entity: One<"entity", false>;
              formRun: One<"form_runs", false>;
              integration: One<"integrations", false>;
              patient: One<"patient", false>;
              patientChartsContacts: Many<"patient_charts_contacts">;
          },
      >
    • patientChartsContacts: Relations<
          "patient_charts_contacts",
          {
              contact: One<"contacts", true>;
              contactType: One<"contact_types", true>;
              patientChart: One<"patient_charts", true>;
          },
      >
    • patientUtilizationReviews: Relations<
          "patient_utilization_reviews",
          {
              entity: One<"entity", true>;
              entityLevelsOfCare: One<"entity_levels_of_care", false>;
              integration: One<"integrations", true>;
              patient: One<"patient", true>;
              patientAdmission: One<"patient_admissions", true>;
          },
      >
    • pendingInvites: Relations<
          "pending_invites",
          { entity: One<"entity", true>; user: One<"users", true> },
      >
    • permissions: Relations<"permissions", { rolePermissions: Many<"role_permissions"> }>
    • profiles: Relations<
          "profiles",
          {
              patients: Many<"patient">;
              sessions: Many<"session">;
              user: One<"users", false>;
              userTeams: Many<"user_teams">;
          },
      >
    • rolePermissions: Relations<
          "role_permissions",
          { permission: One<"permissions", true>; role: One<"roles", true> },
      >
    • roles: Relations<
          "roles",
          {
              rolePermissions: Many<"role_permissions">;
              userEntities: Many<"user_entities">;
          },
      >
    • savedFilters: Relations<
          "saved_filters",
          { entity: One<"entity", true>; user: One<"users", true> },
      >
    • sections: Relations<"sections", { template: One<"templates", false> }>
    • session: Relations<
          "session",
          {
              auditResponses: Many<"audit_response">;
              auditRun: One<"audit_runs", false>;
              case: One<"cases", false>;
              caseDocuments: Many<"case_documents">;
              patient: One<"patient", false>;
              profile: One<"profiles", false>;
              treatmentPlanSessions: Many<"treatment_plan_sessions">;
          },
      >
    • teams: Relations<
          "teams",
          { entity: One<"entity", false>; userTeams: Many<"user_teams"> },
      >
    • templateAuditTemplates: Relations<
          "template_audit_templates",
          {
              auditTemplate: One<"audit_template", true>;
              template: One<"templates", true>;
          },
      >
    • templates: Relations<
          "templates",
          {
              entity: One<"entity", false>;
              sections: Many<"sections">;
              template: One<"templates", false>;
              templateAuditTemplates: Many<"template_audit_templates">;
              templates: Many<"templates">;
          },
      >
    • treatmentPlans: Relations<
          "treatment_plans",
          {
              icdCode: One<"icd_codes", false>;
              patient: One<"patient", false>;
              treatmentPlanSessions: Many<"treatment_plan_sessions">;
          },
      >
    • treatmentPlanSessions: Relations<
          "treatment_plan_sessions",
          {
              session: One<"session", true>;
              treatmentPlan: One<"treatment_plans", true>;
          },
      >
    • userEntities: Relations<
          "user_entities",
          {
              entity: One<"entity", true>;
              role: One<"roles", true>;
              user: One<"users", true>;
              userTeams: Many<"user_teams">;
          },
      >
    • users: Relations<
          "users",
          {
              auditResponseTrails: Many<"audit_response_trails">;
              integrations: Many<"integrations">;
              pendingInvites: Many<"pending_invites">;
              profiles_userId: Many<"profiles">;
              savedFilters: Many<"saved_filters">;
              userEntities: Many<"user_entities">;
          },
      >
    • userTeams: Relations<
          "user_teams",
          {
              profile: One<"profiles", true>;
              team: One<"teams", true>;
              userEntity: One<"user_entities", false>;
          },
      >