Knowledge Base
⌘
Ctrl
k
GitBook Assistant
Ask
Welcome and Getting Started
Care
Designer
Admin
Partners Integrations
Developer Guide
Product Updates
Help Center
Support
For the complete documentation index, see
llms.txt
. This page is also available as
Markdown
.
GitBook Assistant
Ask
On this page
Developer Guide
Models
CareTeamMember
Show properties
PatientTerritory
Show properties
PatientRequest
Show properties
BulkUpdateRow
Show properties
SortInfo
Show properties
PageableInfo
Show properties
PaginatedResponse
Show properties
FaxParty
Show properties
FaxSender
Show properties
FaxReceiver
Show properties
FaxFile
Show properties
FaxDocument
Show properties
FaxPatient
Show properties
Fax
Show properties
FaxListResponse
Show properties
TokenResponse
Show properties
PatientGender
Show properties
PatientType
Show properties
PatientLanguage
Show properties
MaritalStatus
Show properties
PhoneCapability
Show properties
PatientCadencePriority
Show properties
DayOfWeek
Show properties
SimpleRole
Show properties
PatientTeamMember
Show properties
CadenceSchedule
Show properties
PatientCadence
Show properties
PatientUpdateRequest
Show properties
PatientBulkUpdateRequest
Show properties
PatientResponse
Show properties
PatientPage
Show properties
PatientFilterRequest
Show properties
ContactRequest
Show properties
ContactUpdateRequest
Show properties
Contact
Show properties
ContactPage
Show properties
PatientProgramStatus
Show properties
PatientPhase
Show properties
PatientProgram
Show properties
PatientProgramUpdateRequest
Show properties
PatientProgramPhaseNavigateRequest
Show properties
FieldTypeEnum
Show properties
DtType
Show properties
DtFieldValueType
Show properties
DtFieldDisplayType
Show properties
CdtRelation
Show properties
OptionItem
Show properties
FieldMask
Show properties
DtFieldMeta
Show properties
DtField
Show properties
Cdt
Show properties
CdtRecord
Show properties
CdtRecordList
Show properties
BulkUpdateRequest
Show properties
PdtSourceType
Show properties
Pdt
Show properties
PdtRecord
Show properties
PdtRecordPage
Show properties
DictionaryField
Show properties
Dictionary
Show properties
DictionaryRecord
Show properties
DictionaryRecordBatch
Show properties
EncounterStatus
Show properties
ResponsibleParty
Show properties
EncounterPaymentStatus
Show properties
EncounterVisitService
Show properties
EncounterPaymentInfo
Show properties
EncounterPatientInfo
Show properties
EncounterRequest
Show properties
EncounterUpdateRequest
Show properties
EncounterComment
Show properties
FullEncounter
Show properties
PageMetaInfo
Show properties
EncounterPage
Show properties
FullEncounterPage
Show properties
EncounterAssessmentRequest
Show properties
EncounterAssessmentUpdateRequest
Show properties
EncounterTemplate
Show properties
AssessmentDisplayType
Show properties
AssessmentSectionField
Show properties
AssessmentSection
Show properties
AssessmentScoringField
Show properties
AssessmentScoringGroup
Show properties
AssessmentScoring
Show properties
AssessmentProgramRelation
Show properties
Assessment
Show properties
AssessmentStatus
Show properties
AssessmentRecord
Show properties
AssessmentRecordRequest
Show properties
AssessmentRecordPage
Show properties
CalendarEventIdType
Show properties
CalendarEventStatus
Show properties
CalendarEventType
Show properties
CalendarEventRepeat
Show properties
DeliveryMethod
Show properties
ParticipationStatus
Show properties
CalendarParticipantRole
Show properties
CalendarWorkHoursType
Show properties
CalendarWorkHoursRuleType
Show properties
CalendarProvider
Show properties
CalendarParticipant
Show properties
CalendarEventEncounterInfo
Show properties
ExternalEventParticipant
Show properties
ExternalEventMetadata
Show properties
CalendarEvent
Show properties
CalendarEventUpdateRequest
Show properties
CalendarInvitationResponseRequest
Show properties
CalendarEventPage
Show properties
CalendarDaysInfo
Show properties
WorkHoursDetails
Show properties
CalendarWorkHours
Show properties
CalendarWorkHoursRequest
Show properties
CalendarScheduleEvent
Show properties
CalendarPSMSchedule
Show properties
CalendarSummaryItem
Show properties
CalendarPSMEventSummary
Show properties
GoalPriority
Show properties
GoalStatus
Show properties
TaskStatus
Show properties
TaskPriority
Show properties
TaskSourceType
Show properties
TaskCreatedType
Show properties
PatientOverview
Show properties
CarePlan
Show properties
CreateGoalRequest
Show properties
GoalDetails
Show properties
GoalComment
Show properties
IndexedNamed
Show properties
TaskUser
Show properties
TaskComment
Show properties
Task
Show properties
Goal
Show properties
GoalsPage
Show properties
WatchersType
Show properties
TaskUpdateRequest
Show properties
TaskPartialUpdateRequest
Show properties
TaskBulkUpdateRequest
Show properties
TaskPage
Show properties
File
Show properties
SignedFile
Show properties
DocumentTypeName
Show properties
Direction
Show properties
MessageType
Show properties
ActorType
Show properties
ClientType
Show properties
VoiceCallStatus
Show properties
SmsStatus
Show properties
EmailStatus
Show properties
EmailBodyType
Show properties
DraftsPriority
Show properties
DraftsStatus
Show properties
EmailDraftSource
Show properties
TemplateResolverServiceType
Show properties
MessageTemplateType
Show properties
ContentType
Show properties
VoiceCall
Show properties
VoiceCallPage
Show properties
Sms
Show properties
SmsPage
Show properties
Email
Show properties
EmailPage
Show properties
EmailDraft
Show properties
EmailDraftPage
Show properties
ChatUser
Show properties
ChatMessage
Show properties
ChatInboundRequest
Show properties
ChatPageTokens
Show properties
ChatMessagePageMeta
Show properties
ChatMessagePage
Show properties
ChatSearchMessage
Show properties
ChatSearchPage
Show properties
MessageTemplateContent
Show properties
MessageTemplateResolveResult
Show properties
CreateFaxRequest
Show properties
UpdateFaxRequest
Show properties
AssignFaxRequest
Show properties
UserLocale
Show properties
UserState
Show properties
LicenseSeatType
Show properties
PermissionType
Show properties
ClientTerritory
Show properties
Permission
Show properties
InstanceAccess
Show properties
UserAppAccess
Show properties
User
Show properties
UserUpdateRequest
Show properties
UserPoliciesUpdateRequest
Show properties
UserTerritory
Show properties
UserPage
Show properties
EventEntity
Show properties
WebhookStatus
Show properties
AuditRecord
Show properties
AuditRecordPage
Show properties
AuditWebhookRecord
Show properties
AuditWebhookPage
Show properties
PhaseType
Show properties
PhaseNavigation
Show properties
Phase
Show properties
Program
Show properties
DateCursor
Show properties
AssessmentExportRecord
Show properties
CarePlanExportRecord
Show properties
InvoiceStatus
Show properties
BillingType
Show properties
InvoiceItem
Show properties
Invoice
Show properties
InvoicePage
Show properties
SubscriptionStatus
Show properties
PauseCollectionDetails
Show properties
Subscription
Show properties
AttachPaymentMethodRequest
Show properties
AttachPaymentMethodResponse
Show properties
Channel
Show properties
CreateCommunicationIdRequest
Show properties
CreateCommunicationIdResponse
Show properties
SmsMessageRequest
Show properties
EmailMessageRequest
Show properties
VoiceCallMessageRequest
Show properties
SmsMessageMultipartRequest
Show properties
EmailMessageMultipartRequest
Show properties
CommunicationErrorDetails
Show properties
CommunicationError
Show properties
Previous
Fax
Last updated
18 days ago
Was this helpful?
CareTeamMember
PatientTerritory
PatientRequest
BulkUpdateRow
SortInfo
PageableInfo
PaginatedResponse
FaxParty
FaxSender
FaxReceiver
FaxFile
FaxDocument
FaxPatient
Fax
FaxListResponse
TokenResponse
PatientGender
PatientType
PatientLanguage
MaritalStatus
PhoneCapability
PatientCadencePriority
DayOfWeek
SimpleRole
PatientTeamMember
CadenceSchedule
PatientCadence
PatientUpdateRequest
PatientBulkUpdateRequest
PatientResponse
PatientPage
PatientFilterRequest
ContactRequest
ContactUpdateRequest
Contact
ContactPage
PatientProgramStatus
PatientPhase
PatientProgram
PatientProgramUpdateRequest
PatientProgramPhaseNavigateRequest
FieldTypeEnum
DtType
DtFieldValueType
DtFieldDisplayType
CdtRelation
OptionItem
FieldMask
DtFieldMeta
DtField
Cdt
CdtRecord
CdtRecordList
BulkUpdateRequest
PdtSourceType
Pdt
PdtRecord
PdtRecordPage
DictionaryField
Dictionary
DictionaryRecord
DictionaryRecordBatch
EncounterStatus
ResponsibleParty
EncounterPaymentStatus
EncounterVisitService
EncounterPaymentInfo
EncounterPatientInfo
EncounterRequest
EncounterUpdateRequest
EncounterComment
FullEncounter
PageMetaInfo
EncounterPage
FullEncounterPage
EncounterAssessmentRequest
EncounterAssessmentUpdateRequest
EncounterTemplate
AssessmentDisplayType
AssessmentSectionField
AssessmentSection
AssessmentScoringField
AssessmentScoringGroup
AssessmentScoring
AssessmentProgramRelation
Assessment
AssessmentStatus
AssessmentRecord
AssessmentRecordRequest
AssessmentRecordPage
CalendarEventIdType
CalendarEventStatus
CalendarEventType
CalendarEventRepeat
DeliveryMethod
ParticipationStatus
CalendarParticipantRole
CalendarWorkHoursType
CalendarWorkHoursRuleType
CalendarProvider
CalendarParticipant
CalendarEventEncounterInfo
ExternalEventParticipant
ExternalEventMetadata
CalendarEvent
CalendarEventUpdateRequest
CalendarInvitationResponseRequest
CalendarEventPage
CalendarDaysInfo
WorkHoursDetails
CalendarWorkHours
CalendarWorkHoursRequest
CalendarScheduleEvent
CalendarPSMSchedule
CalendarSummaryItem
CalendarPSMEventSummary
GoalPriority
GoalStatus
TaskStatus
TaskPriority
TaskSourceType
TaskCreatedType
PatientOverview
CarePlan
CreateGoalRequest
GoalDetails
GoalComment
IndexedNamed
TaskUser
TaskComment
Task
Goal
GoalsPage
WatchersType
TaskUpdateRequest
TaskPartialUpdateRequest
TaskBulkUpdateRequest
TaskPage
File
SignedFile
DocumentTypeName
Direction
MessageType
ActorType
ClientType
VoiceCallStatus
SmsStatus
EmailStatus
EmailBodyType
DraftsPriority
DraftsStatus
EmailDraftSource
TemplateResolverServiceType
MessageTemplateType
ContentType
VoiceCall
VoiceCallPage
Sms
SmsPage
Email
EmailPage
EmailDraft
EmailDraftPage
ChatUser
ChatMessage
ChatInboundRequest
ChatPageTokens
ChatMessagePageMeta
ChatMessagePage
ChatSearchMessage
ChatSearchPage
MessageTemplateContent
MessageTemplateResolveResult
CreateFaxRequest
UpdateFaxRequest
AssignFaxRequest
UserLocale
UserState
LicenseSeatType
PermissionType
ClientTerritory
Permission
InstanceAccess
UserAppAccess
User
UserUpdateRequest
UserPoliciesUpdateRequest
UserTerritory
UserPage
EventEntity
WebhookStatus
AuditRecord
AuditRecordPage
AuditWebhookRecord
AuditWebhookPage
PhaseType
PhaseNavigation
Phase
Program
DateCursor
AssessmentExportRecord
CarePlanExportRecord
InvoiceStatus
BillingType
InvoiceItem
Invoice
InvoicePage
SubscriptionStatus
PauseCollectionDetails
Subscription
AttachPaymentMethodRequest
AttachPaymentMethodResponse
Channel
CreateCommunicationIdRequest
CreateCommunicationIdResponse
SmsMessageRequest
EmailMessageRequest
VoiceCallMessageRequest
SmsMessageMultipartRequest
EmailMessageMultipartRequest
CommunicationErrorDetails
CommunicationError
Was this helpful?
