Custom Field Metadata Dataset Specification
Custom Field Metadata Dataset Specification
The "Custom Field Metadata Dataset Specification" contains metadata for the custom fields in ACM. Template_Key is its unique key. It is referenced from custom fields usages by Custom_Field_ID. Key components include:
Custom Field Metadata
Overview
Custom Field Metadata Log: This table records every change and update applied to the metadata of custom fields. It offers a historical perspective on the modifications, usage, and administration of these fields, providing a comprehensive audit trail that enhances data management practices.
Custom Field Metadata Raw Data: This table holds the unprocessed, detailed information about the custom fields, including field definitions, settings, and characteristics. It captures the intricate aspects of each field, providing a granular view essential for deep analysis and system customization. This dataset is indispensable for managing custom field configurations effectively, allowing organizations to tailor data handling to meet specific operational needs and enhance reporting accuracy.
Table: Custom_Field_Metadata
Column Name | Is Nullable | Data Type | Description |
Custom_Field_Key | YES | INT64 | Unique identifier for the custom field within the dataset. |
Custom_Field_ID | YES | STRING | A string identifier associated with the custom field. |
Title | YES | STRING | The title or label of the custom field as it appears in the user interface. |
Access_Point | YES | STRING | Indicates where the custom field is accessible within the system. |
All_Customer_Categories_Indicator | YES | BOOL | Boolean indicator specifying if the custom field is applicable to all customer categories. |
All_Roles_Indicator | YES | BOOL | Boolean indicator denoting whether the custom field is available to all user roles. |
All_Mapping_Indicator | YES | BOOL | Boolean indicator showing if the custom field is mapped across all relevant entities. |
Extracted | YES | BOOL | Boolean value indicating whether the custom field is included in data extractions. |
Read_Only | YES | BOOL | Specifies if the custom field is read-only. |
Required | YES | BOOL | Boolean flag indicating whether the custom field is mandatory. |
Available_to_AWF | YES | BOOL | Boolean value denoting availability of the custom field within the Automated Workflow (AWF). |
Available_to_Letters | YES | BOOL | Indicates if the custom field can be referenced in automated letter templates. |
Available_to_Links | YES | BOOL | Shows whether the custom field is available for linking to other system components. |
Help_Text | YES | STRING | Descriptive text providing assistance on the usage of the custom field. |
Use | YES | STRING | Describes the intended use or application of the custom field within the system. |
Format_Type | YES | STRING | Specifies the data format type of the custom field. |
Entry_Max_Length | YES | INT64 | Maximum length of data entry allowed for the custom field. |
Created_Timestamp | YES | TIMESTAMP | Timestamp marking when the custom field was created. |
Last_Modified_Timestamp | YES | TIMESTAMP | Timestamp of the last modification made to the custom field. |
Custom Field Metadata Customer Categories
Table: Custom_Field_Metadata_Customer_Categories
Column Name | Is Nullable | Data Type | Description |
Customer_Category_Key | YES | INT64 | Unique identifier for the customer category associated with the custom field. |
Custom_Field_Key | YES | INT64 | Identifier linking to the specific custom field within the metadata dataset. |
Category_Template_Key | YES | INT64 | Unique key associated with the category template, defining the structure for the customer category. |
Category_Template_Name | YES | STRING | Name of the category template, providing a descriptive label for the type of customer category. |
Created_Timestamp | YES | TIMESTAMP | Timestamp marking when the customer category association with the custom field was created. |
Last_Modified_Timestamp | YES | TIMESTAMP | Timestamp indicating the last time the customer category association with the custom field was updated. |
Custom Field Metadata Select Items
Table: Custom_Field_Metadata_Select_Items
Column Name | Is Nullable | Data Type | Description |
Select_Item_Key | YES | INT64 | Unique identifier for the select item within the custom field. |
Custom_Field_Key | YES | INT64 | Identifier linking to the specific custom field that includes this select item. |
Code | YES | STRING | Code representing the select item, used for identification and processing within systems. |
Description | YES | STRING | Descriptive text explaining the purpose and usage of the select item. |
Position | YES | INT64 | Numeric position indicating the order of this item among other select items within the same custom field. |
Created_Timestamp | YES | TIMESTAMP | Timestamp marking when this select item was initially created. |
Last_Modified_Timestamp | YES | TIMESTAMP | Timestamp indicating the last time this select item was updated. |
Custom Field Metadata Status Reasons
Table: Custom_Field_Metadata_Status_Reasons
Column Name | Is Nullable | Data Type | Description |
Status_Reason_Key | YES | INT64 | Unique identifier for the status reason entry within the custom field metadata. |
Custom_Field_Key | YES | INT64 | Identifier linking this status reason to its corresponding custom field. |
Custom Field Metadata Dataset Specification
Reasons Review Outcome Reason Mapping Key
us_Reasons Review_Outcome_Reason_Mapping_Key
Is Nullable: YES
Data Type: INT64
Description: Key that maps the review outcome reason to specific criteria or conditions in the system.
Custom Field Metadata Status Reasons
Review_Outcome_Reason
Is Nullable: YES
Data Type: STRING
Description: Code or identifier for the review outcome reason associated with a specific status in the healthcare process.
Review_Outcome_Reason_Description
Is Nullable: YES
Data Type: STRING
Description: Detailed explanation of what the review outcome reason represents within the healthcare context.
Review_Outcome_Status
Is Nullable: YES
Data Type: STRING
Description: Code or identifier for the review outcome status linked with this reason.
Review_Outcome_Status_Description
Is Nullable: YES
Data Type: STRING
Description: Description providing further details about the review outcome status and its implications.
Created_Timestamp
Is Nullable: YES
Data Type: TIMESTAMP
Description: Timestamp marking when this status reason entry was initially created.
Last_Modified_Timestamp
Is Nullable: YES
Data Type: TIMESTAMP
Description: Timestamp indicating the last time this status reason entry was updated.
Custom Field Metadata User Roles
User_Role_Key
Is Nullable: YES
Data Type: INT64
Description: Unique identifier for the user role entry within the custom field metadata.
Custom_Field_Key
Is Nullable: YES
Data Type: INT64
Description: Identifier linking this user role to its corresponding custom field.
Role_Code
Is Nullable: YES
Data Type: STRING
Description: Code that identifies a specific role which can access or interact with the associated custom field.
Role_Description
Is Nullable: YES
Data Type: STRING
Description: Detailed explanation of the user role, outlining the responsibilities and permissions associated with it.
Created_Timestamp
Is Nullable: YES
Data Type: TIMESTAMP
Description: Timestamp marking when this user role entry was initially created.
Last_Modified_Timestamp
Is Nullable: YES
Data Type: TIMESTAMP
Description: Timestamp indicating the last time this user role entry was updated.
Custom Field Metadata Log
Custom_Field_Key
Is Nullable: YES
Data Type: INT64
Description: Unique identifier for the custom field template.
Custom_Field_ID
Is Nullable: YES
Data Type: STRING
Description: ID that links custom fields with their templates.
Title
Is Nullable: YES
Data Type: STRING
Description: Title or label of the custom field displayed in the UI.
Access_Point
Is Nullable: YES
Data Type: STRING
Description: Indicates where the custom field is used (e.g., program, request, member). This indicates the context in which the custom field is applied, such as PROGRAM for program-related data, RQST for request-specific information, and MEMBER for member details.
All_Customer_Categories_Indicator
Is Nullable: YES
Data Type: BOOL
Description: Flag indicating if the field is applicable to all customer categories.
All_Roles_Indicator
Is Nullable: YES
Data Type: BOOL
Description: Flag indicating if the field is applicable to all user roles.
All_Mapping_Indicator
Is Nullable: YES
Data Type: BOOL
Description: Flag indicating if the field is applicable to all mappings.
Extracted
Is Nullable: YES
Data Type: BOOL
Description: Indicates if the field is extracted for reporting or other purposes.
Read_Only
Is Nullable: YES
Data Type: BOOL
Description: Indicates if the custom field is read-only and cannot be modified by users.
Required
Is Nullable: YES
Data Type: BOOL
Description: Indicates if the custom field is mandatory for completion.
Available_to_AWF
Is Nullable: YES
Data Type: BOOL
Description: Flag indicating if the custom field is available within the Automated Workflow (AWF).
Available_to_Letters
Is Nullable: YES
Data Type: BOOL
Description: Flag indicating if the custom field is available for use in letter templates.
Available_to_Links
Is Nullable: YES
Data Type: BOOL
Description: Flag indicating if the custom field is available for use in link templates.
Help_Text
Is Nullable: YES
Data Type: STRING
Description: Provides guidance or instructions related to the custom field.
Use
Is Nullable: YES
Data Type: STRING
Description: Specifies the type of the custom field, such as ENTRY or SELECT.
Format_Type
Is Nullable: YES
Data Type: STRING
Description: Defines the entry format type like DATE, TEXT, NUMERIC, SELECT, or MULTISELECT.
Entry_Max_Length
Is Nullable: YES
Data Type: INT64
Description: Contains selectable items for the custom field (applicable for SELECT type).
Select_Items (For Type = SELECT Only)
Key
Data Type: INT64
Description: A unique identifier for each entry within the dataset, ensuring distinct traceability of select item metadata.
Code
Data Type: STRING
Description: The code associated with the select item, used as an identifier in dropdown menus or forms.
Description
Data Type: STRING
Description: A detailed description of what the select item represents, providing context to users.
Position
Data Type: INT64
Description: The position of the item within its respective list or dropdown menu, used for ordering purposes.
Created_Timestamp
Data Type: TIMESTAMP
Description: Timestamp indicating when the metadata record was first created, marking the initial setup time.
Last_Modified_Timestamp
Data Type: TIMESTAMP
Description: Timestamp indicating when the metadata record was last updated, useful for tracking changes and updates.
Customer_Categories
Key
Data Type: INT64
Description: A unique identifier for each entry in the customer categories log, ensuring distinct traceability of records.
Category_Template_Key
Data Type: INT64
Description: A unique identifier linking to a specific category template, facilitating categorization and data management.
Category_Template_Name
Data Type: STRING
Description: The name of the category template associated with this entry, providing a clear label for the category type.
Created_Timestamp
Data Type: TIMESTAMP
Description: Timestamp indicating when the category metadata record was first created, marking the initial setup time.
Last_Modified_Timestamp
Data Type: TIMESTAMP
Description: Timestamp indicating when the category metadata record was last updated.
Custom Field Metadata Dataset Specification
Custom Field Metadata Log
Status Reasons
Status_Reasons: NO ARRAY\ Specifies the user roles associated with this custom field.
Key: INT64\ A unique identifier for each entry in the status reasons log, ensuring distinct traceability of records.
Review_Outcome_Reason_Mapping_Key: INT64\ A unique identifier linking to a specific review outcome reason, facilitating detailed categorization.
Review_Outcome_Reason: STRING\ The specific reason associated with a review outcome, used to classify decisions within the review process.
Review_Outcome_Reason_Description: STRING\ A detailed description of the review outcome reason, providing context and clarity for the reason's application.
Review_Outcome_Status: STRING\ The status linked to the review outcome reason, indicating the current or resulting state of the review.
Review_Outcome_Status_Description: STRING\ A detailed description of the review outcome status, explaining the implications and context of the status.
Created_Timestamp: TIMESTAMP\ Timestamp indicating when the status reason record was first created, marking the initial setup time.
Last_Modified_Timestamp: TIMESTAMP\ Timestamp indicating when the status reason record was last updated, useful for tracking changes and updates.
User Roles
User_Roles: NO ARRAY\ Timestamp when the custom field template was created.
Key: INT64\ A unique identifier for each user role entry within the dataset, ensuring distinct traceability and management of roles.
Role_Code: STRING\ The code that uniquely identifies a specific role within the healthcare system, used for role assignment and permissions.
Role_Description: STRING\ A detailed description of what the role entails, including its responsibilities and scope within the healthcare environment.
Created_Timestamp: TIMESTAMP\ Timestamp indicating when the user role record was first created, marking the initial setup or revision of the role.
Last_Modified_Timestamp: TIMESTAMP\ Timestamp indicating when the user role record was last updated, useful for tracking changes and ensuring current data.
General Metadata Fields
Created_Timestamp: YES TIMESTAMP\ Timestamp when the custom field template was last modified.
Last_Modified_Timestamp: YES TIMESTAMP\ Timestamp indicating the last modification of the record.
Record_Last_Modified_Timestamp: YES TIMESTAMP\ ID of the user who last modified the entity.
Transaction_User_ID: YES STRING\ User ID who did the last entity change.
Deleted_Indicator: YES BOOL\ Indicates whether the custom field has been marked as deleted.
Type: YES STRING\ The type or category of the custom field.
Tenant: YES STRING\ Identifier for the tenant or domain to which the custom field belongs.
Active_Version: YES BOOL\ Indicates if this version of the custom field is the active one.
Date: YES DATE\ The date associated with the log entry.
Sequence: YES INT64\ Sequence number indicating the order or version of the log entry.
Source_System_Name: YES STRING\ Name of the system from which the custom field data originated.
Source_Timestamp: YES STRING\ Timestamp from the source system when the log entry was made.
Source_File_Name: YES STRING\ File name in the source system where the custom field data is stored.
Schema_Version: YES FLOAT64\ Version of the data schema used for the custom field.
Action: YES STRING\ The action taken in the log, such as create, update, or delete.
Transaction_Actor_Type: YES STRING\ Type of the actor performing the transaction.
Custom Field Metadata Raw
Metadata Fields
Custom_Field_Key: YES INT64\ Key of the custom field template.
Custom_Field_ID: YES STRING\ ID linking custom fields with their template.
Title: YES STRING\ Custom field UI title.
Access_Point: YES STRING\ Specifies the application of custom fields across different areas, including PROGRAM for programs, RQST for requests, and MEMBER for member-related data.
All_Customer_Categories_Indicator: YES BOOL\ Indicator whether the custom field is applicable to all customer categories.
All_Roles_Indicator: YES BOOL\ Indicator whether the custom field is applicable to all roles.
All_Mapping_Indicator: YES BOOL\ Indicator whether the custom field is applicable to all mappings.
Extracted: YES BOOL\ Indicator whether the custom field is extracted for use outside its original context.
Read_Only: YES BOOL\ Indicator whether the custom field is read-only.
Required: YES BOOL\ Indicator whether the custom field is required to be filled.
Available_to_AWF: YES BOOL\ Indicator whether the custom field is available to Automated Workflow.
Available_to_Letters: YES BOOL\ Indicator whether the custom field is available to be included in letters.
Available_to_Links: YES BOOL\ Indicator whether the custom field is available to be included in links.
Help_Text: YES STRING\ Help text providing guidance on the custom field's use.
Use: YES STRING\ Type of the custom field: ENTRY or SELECT.
Format_Type: YES STRING\ Entry format type: DATE, TEXT, NUMERIC, SELECT, or MULT.
Custom Field Metadata Dataset Specification
Custom Field Metadata Raw
Entry_Max_Length
Required: YES
Type: INT64
Description: Max length for the entry value (for Type = ENTRY only).
Select_Items
Required: NO
Type: ARRAY
Description: List of selectable items (for SELECT type only).
Key: INT64
A unique identifier for each entry in the select items log, ensuring distinct traceability of selectable items.
Code: STRING
The code that uniquely identifies a specific selectable item, used in dropdown menus or forms.
Description: STRING
A detailed description of what the selectable item represents, providing context to users and system designers.
Position: INT64
The ordinal position of the item within its respective list or dropdown menu, used for ordering and display purposes.
Created_Timestamp: TIMESTAMP
Timestamp indicating when the select item metadata record was first created, marking the initial setup time.
Last_Modified_Timestamp: TIMESTAMP
Timestamp indicating when the select item metadata record was last updated, useful for tracking changes and updates.
Customer_Categories
Required: NO
Type: ARRAY
Description: List of customer categories associated with the custom field.
Key: INT64
A unique identifier for each entry in the customer categories log, ensuring distinct traceability and management of records.
Category_Template_Key: INT64
A unique identifier linking to a specific category template, facilitating categorization and structured data management.
Category_Template_Name: STRING
The name of the category template associated with this entry, providing a clear label for categorization purposes.
Created_Timestamp: TIMESTAMP
Timestamp indicating when the customer category metadata record was first created, marking the initial setup time.
Last_Modified_Timestamp: TIMESTAMP
Timestamp indicating when the customer category metadata record was last updated, useful for tracking changes and updates.
Status_Reasons
Required: NO
Type: ARRAY
Description: List of status reasons associated with the custom field.
Key: INT64
A unique identifier for each entry in the status reasons log, ensuring distinct traceability of records.
Review_Outcome_Reason_Mapping_Key: INT64
A unique identifier linking to a specific review outcome reason, facilitating detailed categorization and management.
Review_Outcome_Reason: STRING
The specific reason associated with a review outcome, used to classify and detail decisions within the review process.
Review_Outcome_Reason_Description: STRING
A detailed description of the review outcome reason, providing context and clarity for the reason's application in reviews.
Review_Outcome_Status: STRING
The status linked to the review outcome reason, indicating the current or resulting state of the review or process.
Review_Outcome_Status_Description: STRING
A detailed description of the review outcome status, explaining the implications and context of the status within the review.
Created_Timestamp: TIMESTAMP
Timestamp indicating when the status reason record was first created, marking the initial setup time for tracking purposes.
Last_Modified_Timestamp: TIMESTAMP
Timestamp indicating when the status reason record was last updated, useful for tracking changes and ensuring current data.
User_Roles
Required: NO
Type: ARRAY
Description: List of user roles associated with the custom field.
Key: INT64
A unique identifier for each user role entry within the dataset, ensuring distinct traceability of role records.
Role_Code: STRING
The code that uniquely identifies a specific user role within the healthcare system, used for role assignment and permissions management.
Role_Description: STRING
A detailed description of the user role, including its responsibilities and scope within the healthcare environment.
Created_Timestamp: TIMESTAMP
Timestamp indicating when the user role record was first created, marking the initial setup or revision of the role.
Last_Modified_Timestamp: TIMESTAMP
Timestamp indicating when the user role record was last updated, useful for tracking changes and maintaining current information.
Created_Timestamp
Required: YES
Type: TIMESTAMP
Description: Timestamp when the custom field template was created.
Last_Modified_Timestamp
Required: YES
Type: TIMESTAMP
Description: Timestamp when the custom field template was last modified.
Record_Last_Modified_Timestamp
Required: YES
Type: TIMESTAMP
Description: Timestamp when the record was last modified.
Transaction_User_ID
Required: YES
Type: STRING
Description: User ID who made the last change to the entity.
Deleted_Indicator
Required: YES
Type: BOOL
Description: Indicates whether the custom field has been marked as deleted.
Type
Required: YES
Type: STRING
Description: Type or category of the custom field.
Tenant
Required: YES
Type: STRING
Description: Identifier of the tenant or domain to which the custom field belongs.
Active_Version
Required: YES
Type: BOOL
Description: Indicates if this version of the custom field is the active one.
Date
Required: YES
Type: DATE
Description: Date associated with the log entry.
Sequence
Required: YES
Type: INT64
Description: Sequence number indicating the order or version of the log entry.
Source_System_Name
Required: YES
Type: STRING
Description: Name of the system from which the custom field data originated.
Source_Timestamp
Required: YES
Type: STRING
Description: Timestamp from the source system when the log entry was made.
Source_File_Name
Required: YES
Type: STRING
Description: Name of the file in the source system where the custom field data is stored.
Schema_Version
Required: YES
Type: FLOAT64
Description: Version of the data schema used for the custom field.
Transaction_Actor_Type
Required: YES
Type: STRING
Description: Type of the actor performing the transaction.
Custom Field Metadata Dataset Specification
Metadata Log
This table records every change and update applied to the metadata of custom fields. It offers a historical perspective on the modifications, usage, and administration of these fields, providing a comprehensive audit trail that enhances data management practices.
Custom Field Metadata Raw Data
This table holds the unprocessed, detailed information about the custom fields, including field definitions, settings, and characteristics. It captures the intricate aspects of each field, providing a granular view essential for deep analysis and system customization.
Table: Custom_Field_Metadata
Column Name | Is Nullable | Data Type | Description |
Custom_Field_Key | YES | INT64 | Unique identifier for the custom field within the dataset. |
Custom_Field_ID | YES | STRING | A string identifier associated with the custom field. |
Title | YES | STRING | The title or label of the custom field as it appears in the user interface. |
Access_Point | YES | STRING | Indicates where the custom field is accessible within the system. |
All_Customer_Categories_Indicator | YES | BOOL | Boolean indicator specifying if the custom field is applicable to all customer categories. |
All_Roles_Indicator | YES | BOOL | Boolean indicator denoting whether the custom field is available to all user roles. |
All_Mapping_Indicator | YES | BOOL | Boolean indicator showing if the custom field is mapped across all relevant entities. |
Extracted | YES | BOOL | Boolean value indicating whether the custom field is included in data extractions. |
Read_Only | YES | BOOL | Specifies if the custom field is read-only. |
Required | YES | BOOL | Boolean flag indicating whether the custom field is mandatory. |
Available_to_AWF | YES | BOOL | Boolean value denoting availability of the custom field within the Automated Workflow (AWF). |
Available_to_Letters | YES | BOOL | Indicates if the custom field can be referenced in automated letter templates. |
Available_to_Links | YES | BOOL | Shows whether the custom field is available for linking to other system components. |
Help_Text | YES | STRING | Descriptive text providing assistance on the usage of the custom field. |
Use | YES | STRING | Describes the intended use or application of the custom field within the system. |
Format_Type | YES | STRING | Specifies the data format type of the custom field. |
Entry_Max_Length | YES | INT64 | Maximum length of data entry allowed for the custom field. |
Created_Timestamp | YES | TIMESTAMP | Timestamp marking when the custom field was created. |
Last_Modified_Timestamp | YES | TIMESTAMP | Timestamp of the last modification made to the custom field. |
Table: Custom_Field_Metadata_Customer_Categories
Column Name | Is Nullable | Data Type | Description |
Customer_Category_Key | YES | INT64 | Unique identifier for the customer category associated with the custom field. |
Custom_Field_Key | YES | INT64 | Identifier linking to the specific custom field within the metadata dataset. |
Category_Template_Key | YES | INT64 | Unique key associated with the category template, defining the structure for the customer category. |
Category_Template_Name | YES | STRING | Name of the category template, providing a descriptive label for the type of customer category. |
Created_Timestamp | YES | TIMESTAMP | Timestamp marking when the customer category association with the custom field was created. |
Last_Modified_Timestamp | YES | TIMESTAMP | Timestamp indicating the last time the customer category association with the custom field was updated. |
Table: Custom_Field_Metadata_Select_Items
Column Name | Is Nullable | Data Type | Description |
Select_Item_Key | YES | INT64 | Unique identifier for the select item within the custom field. |
Custom_Field_Key | YES | INT64 | Identifier linking to the specific custom field that includes this select item. |
Code | YES | STRING | Code representing the select item, used for identification and processing within systems. |
Description | YES | STRING | Descriptive text explaining the purpose and usage of the select item. |
Position | YES | INT64 | Numeric position indicating the order of this item among other select items within the same custom field. |
Created_Timestamp | YES | TIMESTAMP | Timestamp marking when this select item was initially created. |
Last_Modified_Timestamp | YES | TIMESTAMP | Timestamp indicating the last time this select item was updated. |
Table: Custom_Field_Metadata_Status_Reasons
Column Name | Is Nullable | Data Type | Description |
Status_Reason_Key | YES | INT64 | Unique identifier for the status reason entry within the custom field metadata. |
Custom_Field_Key | YES | INT64 | Identifier linking this status reason to its corresponding custom field. |
Review_Outcome_Reason_Mapping_Key | YES | INT64 | Key that maps the review outcome reason to specific criteria or conditions in the system. |
Custom Field Metadata Dataset Specification
Custom Field Metadata Status Reasons
Review Outcome Reason
Is Nullable: YES
Data Type: STRING
Description: Code or identifier for the review outcome reason associated with a specific status in the healthcare process.
Review Outcome Reason Description
Is Nullable: YES
Data Type: STRING
Description: Detailed explanation of what the review outcome reason represents within the healthcare context.
Review Outcome Status
Is Nullable: YES
Data Type: STRING
Description: Code or identifier for the review outcome status linked with this reason.
Review Outcome Status Description
Is Nullable: YES
Data Type: STRING
Description: Description providing further details about the review outcome status and its implications.
Created Timestamp
Is Nullable: YES
Data Type: TIMESTAMP
Description: Timestamp marking when this status reason entry was initially created.
Last Modified Timestamp
Is Nullable: YES
Data Type: TIMESTAMP
Description: Timestamp indicating the last time this status reason entry was updated.
Custom Field Metadata User Roles
User Role Key
Is Nullable: YES
Data Type: INT64
Description: Unique identifier for the user role entry within the custom field metadata.
Custom Field Key
Is Nullable: YES
Data Type: INT64
Description: Identifier linking this user role to its corresponding custom field.
Role Code
Is Nullable: YES
Data Type: STRING
Description: Code that identifies a specific role which can access or interact with the associated custom field.
Role Description
Is Nullable: YES
Data Type: STRING
Description: Detailed explanation of the user role, outlining the responsibilities and permissions associated with it.
Created Timestamp
Is Nullable: YES
Data Type: TIMESTAMP
Description: Timestamp marking when this user role entry was initially created.
Last Modified Timestamp
Is Nullable: YES
Data Type: TIMESTAMP
Description: Timestamp indicating the last time this user role entry was updated.
Custom Field Metadata Log
Custom Field Key
Is Nullable: YES
Data Type: INT64
Description: Unique identifier for the custom field template.
Custom Field ID
Is Nullable: YES
Data Type: STRING
Description: ID that links custom fields with their templates.
Title
Is Nullable: YES
Data Type: STRING
Description: Title or label of the custom field displayed in the UI.
Access Point
Is Nullable: YES
Data Type: STRING
Description: Indicates where the custom field is used (e.g., program, request, member). This indicates the context in which the custom field is applied, such as PROGRAM for program-related data, RQST for request-specific information, and MEMBER for member details.
All Customer Categories Indicator
Is Nullable: YES
Data Type: BOOL
Description: Flag indicating if the field is applicable to all customer categories.
All Roles Indicator
Is Nullable: YES
Data Type: BOOL
Description: Flag indicating if the field is applicable to all user roles.
All Mapping Indicator
Is Nullable: YES
Data Type: BOOL
Description: Flag indicating if the field is applicable to all mappings.
Extracted
Is Nullable: YES
Data Type: BOOL
Description: Indicates if the field is extracted for reporting or other purposes.
Read Only
Is Nullable: YES
Data Type: BOOL
Description: Indicates if the custom field is read-only and cannot be modified by users.
Required
Is Nullable: YES
Data Type: BOOL
Description: Indicates if the custom field is mandatory for completion.
Available to AWF
Is Nullable: YES
Data Type: BOOL
Description: Flag indicating if the custom field is available within the Automated Workflow (AWF).
Available to Letters
Is Nullable: YES
Data Type: BOOL
Description: Flag indicating if the custom field is available for use in letter templates.
Available to Links
Is Nullable: YES
Data Type: BOOL
Description: Flag indicating if the custom field is available for use in link templates.
Help Text
Is Nullable: YES
Data Type: STRING
Description: Provides guidance or instructions related to the custom field.
Use
Is Nullable: YES
Data Type: STRING
Description: Specifies the type of the custom field, such as ENTRY or SELECT.
Format Type
Is Nullable: YES
Data Type: STRING
Description: Defines the entry format type like DATE, TEXT, NUMERIC, SELECT, or MULTISELECT.
Entry Max Length
Is Nullable: YES
Data Type: INT64
Description: Contains selectable items for the custom field (applicable for SELECT type).
Select Items
Is Nullable: NO
Data Type: ARRAY
Description: List of customer categories associated with the custom field. Select items (for Type = SELECT only).
Select Items Key
Data Type: INT64
Description: A unique identifier for each entry within the dataset, ensuring distinct traceability of select item metadata.
Select Items Code
Data Type: STRING
Description: The code associated with the select item, used as an identifier in dropdown menus or forms.
Select Items Description
Data Type: STRING
Description: A detailed description of what the select item represents, providing context to users.
Select Items Position
Data Type: INT64
Description: The position of the item within its respective list or dropdown menu, used for ordering purposes.
Select Items Created Timestamp
Data Type: TIMESTAMP
Description: Timestamp indicating when the metadata record was first created, marking the initial setup time.
Select Items Last Modified Timestamp
Data Type: TIMESTAMP
Description: Timestamp indicating when the metadata record was last updated, useful for tracking changes and updates.
Customer Categories
Is Nullable: NO
Data Type: ARRAY
Description: Array of status reasons associated with the custom field.
Customer Categories Key
Data Type: INT64
Description: A unique identifier for each entry in the customer categories log, ensuring distinct traceability of records.
Customer Categories Category Template Key
Data Type: INT64
Description: A unique identifier linking to a specific category template, facilitating categorization and data management.
Custom Field Metadata Dataset Specification
Category Template Metadata
Fields
Category_Template_Name
Data Type: STRING
Description: The name of the category template associated with this entry, providing a clear label for the category type.
Customer_Categories.Created_Timestamp
Data Type: TIMESTAMP
Description: Timestamp indicating when the category metadata record was first created, marking the initial setup time.
Customer_Categories.Last_Modified_Timestamp
Data Type: TIMESTAMP
Description: Timestamp indicating when the category metadata record was last updated, useful for tracking changes and updates.
Custom Field Metadata Log
Status Reasons
Status_Reasons
Is Nullable: NO
Data Type: ARRAY
Description: Specifies the user roles that are associated with this custom field.
Status_Reasons.Key
Data Type: INT64
Description: A unique identifier for each entry in the status reasons log, ensuring distinct traceability of records.
Status_Reasons.Review_Outcome_Reason_Mapping_Key
Data Type: INT64
Description: A unique identifier linking to a specific review outcome reason, facilitating detailed categorization.
Status_Reasons.Review_Outcome_Reason
Data Type: STRING
Description: The specific reason associated with a review outcome, used to classify decisions within the review process.
Status_Reasons.Review_Outcome_Reason_Description
Data Type: STRING
Description: A detailed description of the review outcome reason, providing context and clarity for the reason's application.
Status_Reasons.Review_Outcome_Status
Data Type: STRING
Description: The status linked to the review outcome reason, indicating the current or resulting state of the review.
Status_Reasons.Review_Outcome_Status_Description
Data Type: STRING
Description: A detailed description of the review outcome status, explaining the implications and context of the status.
Status_Reasons.Created_Timestamp
Data Type: TIMESTAMP
Description: Timestamp indicating when the status reason record was first created, marking the initial setup time.
Status_Reasons.Last_Modified_Timestamp
Data Type: TIMESTAMP
Description: Timestamp indicating when the status reason record was last updated, useful for tracking changes and updates.
User Roles
User_Roles
Is Nullable: NO
Data Type: ARRAY
Description: Timestamp when the custom field template was created.
User_Roles.Key
Data Type: INT64
Description: A unique identifier for each user role entry within the dataset, ensuring distinct traceability and management of roles.
User_Roles.Role_Code
Data Type: STRING
Description: The code that uniquely identifies a specific role within the healthcare system, used for role assignment and permissions.
User_Roles.Role_Description
Data Type: STRING
Description: A detailed description of what the role entails, including its responsibilities and scope within the healthcare environment.
User_Roles.Created_Timestamp
Data Type: TIMESTAMP
Description: Timestamp indicating when the user role record was first created, marking the initial setup or revision of the role.
User_Roles.Last_Modified_Timestamp
Data Type: TIMESTAMP
Description: Timestamp indicating when the user role record was last updated, useful for tracking changes and ensuring current data.
Metadata Log Details
Created_Timestamp
Is Nullable: YES
Data Type: TIMESTAMP
Description: Timestamp when the custom field template was last modified.
Last_Modified_Timestamp
Is Nullable: YES
Data Type: TIMESTAMP
Description: Timestamp indicating the last modification of the record.
Record_Last_Modified_Timestamp
Is Nullable: YES
Data Type: TIMESTAMP
Description: ID of the user who last modified the entity.
Transaction_User_ID
Is Nullable: YES
Data Type: STRING
Description: User ID who did the last entity change.
Deleted_Indicator
Is Nullable: YES
Data Type: BOOL
Description: Indicates whether the custom field has been marked as deleted.
Type
Is Nullable: YES
Data Type: STRING
Description: The type or category of the custom field.
Tenant
Is Nullable: YES
Data Type: STRING
Description: Identifier for the tenant or domain to which the custom field belongs.
Active_Version
Is Nullable: YES
Data Type: BOOL
Description: Indicates if this version of the custom field is the active one.
Date
Is Nullable: YES
Data Type: DATE
Description: The date associated with the log entry.
Sequence
Is Nullable: YES
Data Type: INT64
Description: Sequence number indicating the order or version of the log entry.
Source_System_Name
Is Nullable: YES
Data Type: STRING
Description: Name of the system from which the custom field data originated.
Source_Timestamp
Is Nullable: YES
Data Type: STRING
Description: Timestamp from the source system when the log entry was made.
Source_File_Name
Is Nullable: YES
Data Type: STRING
Description: File name in the source system where the custom field data is stored.
Schema_Version
Is Nullable: YES
Data Type: FLOAT64
Description: Version of the data schema used for the custom field.
Action
Is Nullable: YES
Data Type: STRING
Description: The action taken in the log, such as create, update, or delete.
Transaction_Actor_Type
Is Nullable: YES
Data Type: STRING
Description: Type of the actor performing the transaction.
Custom Field Metadata Raw
Fields
Custom_Field_Key
Is Nullable: YES
Data Type: INT64
Description: Key of the custom field template.
Custom_Field_ID
Is Nullable: YES
Data Type: STRING
Description: ID linking custom fields with their template.
Title
Is Nullable: YES
Data Type: STRING
Description: Custom field UI title.
Access_Point
Is Nullable: YES
Data Type: STRING
Description: Specifies the application of custom fields across different areas, including PROGRAM for programs, RQST for requests, and MEMBER for member-related data.
All_Customer_Categories_Indicator
Is Nullable: YES
Data Type: BOOL
Description: Indicator whether the custom field is applicable to all customer categories.
All_Roles_Indicator
Is Nullable: YES
Data Type: BOOL
Description: Indicator whether the custom field is applicable to all roles.
All_Mapping_Indicator
Is Nullable: YES
Data Type: BOOL
Description: Indicator whether the custom field is applicable to all mappings.
Extracted
Is Nullable: YES
Data Type: BOOL
Description: Indicator whether the custom field is extracted for use outside its original context.
Custom Field Metadata Dataset Specification
Metadata Fields
Read_Only
Type: BOOL
Required: YES
Description: Indicator whether the custom field is read-only.
Required
Type: BOOL
Required: YES
Description: Indicator whether the custom field is required to be filled.
Available_to_AWF
Type: BOOL
Required: YES
Description: Indicator whether the custom field is available to Automated Workflow.
Available_to_Letters
Type: BOOL
Required: YES
Description: Indicator whether the custom field is available to be included in letters.
Available_to_Links
Type: BOOL
Required: YES
Description: Indicator whether the custom field is available to be included in links.
Help_Text
Type: STRING
Required: YES
Description: Help text providing guidance on the custom field's use.
Use
Type: STRING
Required: YES
Description: Type of the custom field: ENTRY or SELECT.
Format_Type
Type: STRING
Required: YES
Description: Entry format type: DATE, TEXT, NUMERIC, SELECT or MULTISELECT.
Entry_Max_Length
Type: INT64
Required: YES
Description: Max length for the entry value (for Type = ENTRY only).
Select_Items
Type: ARRAY
Required: NO
Description: List of selectable items (for SELECT type only).
Select_Items Fields
Key: INT64
A unique identifier for each entry in the select items log, ensuring distinct traceability of selectable items.
Code: STRING
The code that uniquely identifies a specific selectable item, used in dropdown menus or forms.
Description: STRING
A detailed description of what the selectable item represents, providing context to users and system designers.
Position: INT64
The ordinal position of the item within its respective list or dropdown menu, used for ordering and display purposes.
Created_Timestamp: TIMESTAMP
Timestamp indicating when the select item metadata record was first created, marking the initial setup time.
Last_Modified_Timestamp: TIMESTAMP
Timestamp indicating when the select item metadata record was last updated, useful for tracking changes and updates.
Customer_Categories
Type: ARRAY
Required: NO
Description: List of customer categories associated with the custom field.
Customer_Categories Fields
Key: INT64
A unique identifier for each entry in the customer categories log, ensuring distinct traceability and management of records.
Category_Template_Key: INT64
A unique identifier linking to a specific category template, facilitating categorization and structured data management.
Category_Template_Name: STRING
The name of the category template associated with this entry, providing a clear label for categorization purposes.
Created_Timestamp: TIMESTAMP
Timestamp indicating when the customer category metadata record was first created, marking the initial setup time.
Last_Modified_Timestamp: TIMESTAMP
Timestamp indicating when the customer category metadata record was last updated, useful for tracking changes and updates.
Status_Reasons
Type: ARRAY
Required: NO
Description: List of status reasons associated with the custom field.
Status_Reasons Fields
Key: INT64
A unique identifier for each entry in the status reasons log, ensuring distinct traceability of records.
Review_Outcome_Reason_Mapping_Key: INT64
A unique identifier linking to a specific review outcome reason, facilitating detailed categorization and management.
Review_Outcome_Reason: STRING
The specific reason associated with a review outcome, used to classify and detail decisions within the review process.
Review_Outcome_Reason_Description: STRING
A detailed description of the review outcome reason, providing context and clarity for the reason's application in reviews.
Review_Outcome_Status: STRING
The status linked to the review outcome reason, indicating the current or resulting state of the review or process.
Review_Outcome_Status_Description: STRING
A detailed description of the review outcome status, explaining the implications and context of the status within the review.
Created_Timestamp: TIMESTAMP
Timestamp indicating when the status reason record was first created, marking the initial setup time for tracking purposes.
Last_Modified_Timestamp: TIMESTAMP
Timestamp indicating when the status reason record was last updated, useful for tracking changes and ensuring current data.
User_Roles
Type: ARRAY
Required: NO
Description: List of user roles associated with the custom field.
User_Roles Fields
Key: INT64
A unique identifier for each user role entry within the dataset, ensuring distinct traceability of role records.
Role_Code: STRING
The code that uniquely identifies a specific user role within the healthcare system, used for role assignment and permissions management.
Role_Description: STRING
A detailed description of the user role, including its responsibilities and scope within the healthcare environment.
Created_Timestamp: TIMESTAMP
Timestamp indicating when the user role record was first created, marking the initial setup or revision of the role.
Last_Modified_Timestamp: TIMESTAMP
Timestamp indicating when the user role record was last updated, useful for tracking changes and maintaining current information.
Created_Timestamp
Type: TIMESTAMP
Required: YES
Description: Timestamp when the custom field template was created.
Last_Modified_Timestamp
Type: TIMESTAMP
Required: YES
Description: Timestamp when the custom field template was last modified.
Record_Last_Modified_Timestamp
Type: TIMESTAMP
Required: YES
Description: Timestamp when the record was last modified.
Custom Field Metadata Dataset Specification
Fields Overview
Transaction_User_ID
Required: YES
Type: STRING
Description: User ID who made the last change to the entity.
Deleted_Indicator
Required: YES
Type: BOOL
Description: Indicates whether the custom field has been marked as deleted.
Type
Required: YES
Type: STRING
Description: Type or category of the custom field.
Tenant
Required: YES
Type: STRING
Description: Identifier of the tenant or domain to which the custom field belongs.
Active_Version
Required: YES
Type: BOOL
Description: Indicates if this version of the custom field is the active one.
Date
Required: YES
Type: DATE
Description: Date associated with the log entry.
Sequence
Required: YES
Type: INT64
Description: Sequence number indicating the order or version of the log entry.
Source_System_Name
Required: YES
Type: STRING
Description: Name of the system from which the custom field data originated.
Source_Timestamp
Required: YES
Type: STRING
Description: Timestamp from the source system when the log entry was made.
Source_File_Name
Required: YES
Type: STRING
Description: Name of the file in the source system where the custom field data is stored.
Schema_Version
Required: YES
Type: FLOAT64
Description: Version of the data schema used for the custom field.
Transaction_Actor_Type
Required: YES
Type: STRING
Description: Type of the actor performing the transaction.