Fields

To view the fields for an object, navigate to Tools and select Data in the left navigation bar. Click the Objects tab. Select the object you want to access in the list, and click the Fields tab at the top of that object’s detail view on the right.

The list of fields includes all of the data fields that are related to that object. A tag on the right of each field name displays what kind of field it is, such as Reference, ValueSet, Text, Lookup, Currency, etc.

You can search for a specific field in the search bar at the top of the Fields list.

See more about each of the fields by clicking the chevron to the left of each field's name. An accordion will expand to display information about the field.

Creating a Custom Field

To create a new field, click on the + icon. An Add Field modal displays.

Input information for the following attributes:

• Name - Field names must be camel case (i.e., appointmentType) with a maximum of 40 characters input. If more characters are used, the system will throw an error after the Add button is clicked. There can be spaces, underscores or other non alpha numeric characters in the name. The first letter must be lower case, and cannot be a number. The name is the same as that of the field (case insensitive). This field is required.
• Label - The label is the field’s label as it will appear in the Patient Care Journey app. This is required.
• Description - This field is optional, but helpful to other users who may reference the field. It should describe the field’s purpose.
• Field Type - Click on the dropdown menu and select the field type. When you choose a type, the modal adjusts based on your choice to include more options that you can choose. The following field types are used:
  • Attachment - Field that allows a user to attach one or more files directly to a record.
  • Checkbox/Boolean - A data type that can only have one of two values - true or false - to represent binary conditions and decisions. 
  • Currency (USD only) - A numeric field type that formats a number as a currency value.
  • Date - Accepts numerals that are written as dates in a MM/DD/YYYY format.
  • Datetime - Used for fields that contain both date and time.
  • Email - Field in which users can input a valid email address.
  • Lookup - A field in a table whose value is retrieved from another table or query. Lookup field on M:1 object.
  • LongText - Useful for storing large amounts of information, such as notes, comments, and descriptions.
  • Number - Numerical field.
  • Object - Contains objects attached to a task or associated with a resource.
  • Phone - Field in which the user can input their phone number.
  • Reference - Implements a foreign key. Used to establish a relationship between entities.
  • Text (encrypted)- Field in which the user can input text.
  • Url - Field in which the user can input a url.
  • ValueSet - Field that contains a set of valid values that can be used in a specific context.

If required fields are missing, the Add button will be disabled until you fill in the required fields.

When you have input the information, click Add. The new field will appear in the list under the Fields tab with a tag that indicates that it is a custom field. The field’s name will include the suffix __c, which means that it is a custom field.

Each custom object has custom fields that appear in the UI and define the data that will be brought into Tendo’s system. You need to define what fields and types of data will be loaded to Tendo’s system as part of this object.

For example, for a Social Determinants Form, specific fields need to be included, such as a patient Id, which you can give the label of Patient. This is a patient reference, so in the Field Type dropdown, choose Reference.

Create another field which is completedDate, for the date when a patient will complete a form. This would be designated a Date type form.

If the next field were about food insecurity, it would be a boolean field because on the form when the patient is asked if they have food insecurity, they could select Yes or No.

To ask a question about the patient’s income level, you can add a field and create a custom value set - IncomeLevels.

You can add other fields such as distance to care, which you would want to add a custom value set for.

You may want to add another field that is a text type so that patients can input a description of their obstacles to care.

Once you have created the object, you can navigate to Tendo Admin > Object Records, and search for and view the object in Object Records.

Loading Data for New Custom Fields

The new object has the fields that are needed, but it doesn’t have any data associated with it. To load data, navigate back to Tools, then choose Data on the left main navigation bar, and the Loader tab at the top. The loader allows you to load data against any object or update the data.

Choose Load Data. A modal appears. Choose Create for the operation, then the object you want. You can download a CSV template to use for the data. Once you have the template populated with the correct data, you can drop the template onto the modal and click Create. The data will be loaded.

After you do that, you can look back in Admin > Object Record for your Social Determinants Form, and the object will be filled with your uploaded data for individual patients.

Fields can be created in the same way on a standard object.

Editing a Custom Field

Once you have created an object and custom fields for it, you can edit them by clicking on the object in the objects list view, then on the Fields tabs in the object’s detail view to the right.

Some fields in the Fields list have a … dropdown menu on the right of those fields' rows with an Edit option, while others don’t. This indicates whether a field is editable or not, as some fields are read only. If the field you want to edit has this feature, click Edit.

In the Edit Field modal that displays, different editable attributes will appear depending on the type of field. Input the choices that reflect the way you want the field to behave and click Save.

When editing field definitions, data within their associated object is not edited, so changing some attributes could cause existing data to be out of sync with the new field definition. The modification could cause record updates of preexisting records to fail unless the data for the field is also modified to conform to your changes. See Loading Data for New Custom Fields.

Deleting a Custom Field

To delete a custom field, navigate to the Fields tab in the detail view of an object, and click the … dropdown menu on the right of the field you want to delete. Note that the … dropdown menu will not appear for all fields because some fields cannot be deleted.

Selecting Delete will bring up a modal alerting you that if you delete the field, data could be lost, and asking if you want to proceed. Clicking the Delete button will remove all data that is stored in the field, and remove the field definition.