Skip to content

Data Model List

Please refer to the public data objects. Core Resources

NameEntityEntity TypeDataSource CodeDescription
Familyfamilywks_familycc-familyFamily Entity
Family Memberfamily_memberwks_family_membercc-family-memberParent, Child, Contact
Family Incomefamily_incomewks_family_extensionscc-family-income
Family Needfamily_needwks_family_extensionscc-family-need
Family Casefamily_casewks_casecc-family-caseFamily case
Family Invoicefamily_invoicewks_billingcc-family-invoiceFamily Fee
Providerproviderwks_providercc-providerSite, FCCH, School
Provider Holidayprovider_holidaywks_provider_extensionscc-provider-holiday
Provider Paymentprovider_paymentwks_billingcc-provider-paymentProvider payment
Care Servicecarewks_servicecc-service-careCare and Schedule
Claimclaimwks_claimcc-claimClaim
Claim Attendanceclaim_attendancewks_attendancecc-claim-attendanceAttendance and Submission
Documentdocumentwks_documentcc-documentTimesheet ,EOP
Notenotewks_notecc-noteNote
NameEntityEntity TypeDataSource CodeDescription
Family Applicationapplicationwks_casecw-family-applicationSubsidy application
Providerproviderwks_providercw-providerLicensed Provider
Referralreferralwks_referralcw-referralReferral
  1. Case Sensitivity: MongoDB field names are case-sensitive. It’s important to maintain consistent casing (like camelCase or snake_case) throughout the data model to avoid discrepancies.

  2. Special Characters: Avoid using special characters in field names. Characters like $ and . are reserved and have specific uses in MongoDB. Including them in field names can lead to unexpected behavior or errors.

  3. Leading Underscores: While MongoDB allows field names to start with an underscore (_), it’s generally reserved for system fields. It’s advisable to use underscores cautiously and avoid them as leading characters unless for system-specific purposes.

  4. Length Limitation: There’s no strict length limit for MongoDB field names. However, considering the overall size limitations for BSON documents, it’s practical to keep field names concise to optimize storage and query performance.

  5. Clarity and Descriptiveness: Field names should be clear and descriptive, accurately reflecting the data they represent. This practice aids in understanding the data model and ensures easier maintenance and scalability.

  6. Avoid Reserved Words: While MongoDB doesn’t restrict the use of reserved words, it’s a good practice to avoid using them as field names. This helps in preventing conflicts and confusion, especially when integrating with other systems or technologies.

By following these basic standards, the data model will be well-structured, compliant with MongoDB’s conventions, and more likely to integrate seamlessly with CareCloud and other systems. This approach not only enhances data integrity but also facilitates easier data management and querying.