Skip to main content

Letter Dataset Specification

Updated over a month ago

Letter Dataset Specification

Letter Dataset Specification

The "Letter Dataset Specification" is a structured framework designed to manage and track the lifecycle of letters and correspondence within an organization. This dataset is crucial for organizations that rely on formal communication and documentation, ensuring that all correspondence is meticulously recorded and monitored.

Key Components

Letter Records

This table documents each letter's details, including its purpose, recipient, and content. It provides a structured way to manage the formal communications sent from the organization, ensuring clarity and accountability.

Letter Outcomes

Records the results or responses generated by each letter. This table provides insight into the effectiveness of the communications, helping to understand how recipients react and respond to the letters.

Letter Log

Tracks the history and changes made to the letters, offering an audit trail of the correspondence process. This log is essential for maintaining transparency and tracking the evolution of each piece of correspondence.

Letter Raw Data

Contains unprocessed, detailed data related to the letters. This table captures all aspects of the communication for comprehensive analysis and record-keeping, providing a granular view that can be crucial for detailed audits and reviews.

This dataset plays a pivotal role in ensuring effective management of formal communications within an organization, aiding in both operational efficiency and compliance with documentation standards.

Letter Table Specification

Column Name

Is Nullable

Data Type

Description

Member_ID

YES

STRING

ID of the member or patient associated with the letter.

Letter_Key

YES

STRING

Unique identifier for the letter.

Letter_Name

YES

STRING

Name or title of the letter.

Letter_Description

YES

STRING

Description or content of the letter.

Reference_Number

YES

STRING

Reference number associated with the letter.

Selected_Timestamp

YES

TIMESTAMP

Timestamp when the letter was selected or generated.

Letter_Class

YES

STRING

Class or category of the letter. See Dictionary Letter Class table in the Dictionary Dataset Specification.

Letter_Class_Description

YES

STRING

Description of the class or category of the letter. See Dictionary Letter Class table in the Dictionary Dataset Specification.

Request_Key

YES

INT64

Key or identifier associated with the request.

Appeal_Level_Key

YES

INT64

Key or identifier associated with the appeal level.

Screening_Request_Key

YES

INT64

Key or identifier associated with the screening request.

Request_ID

YES

STRING

ID of the request associated with the letter.

Program_ID

YES

STRING

ID of the program or system related to the letter.

Appeal_Level_ID

YES

STRING

ID of the appeal level related to the letter.

Letter_Action

YES

STRING

Action or status related to the letter. See Dictionary Letter Action table in the Dictionary Dataset Specification.

Letter_Action_Description

YES

STRING

Description of the action or status related to the letter. See Dictionary Letter Action table in the Dictionary Dataset Specification.

Letter_State

YES

STRING

State or condition of the letter.

Letter_State_Description

YES

STRING

Description of the state or condition of the letter.

Letter_State_Timestamp

YES

TIMESTAMP

Timestamp indicating the state or condition change of the letter.

Created_User_ID

YES

STRING

ID of the user who created the letter.

Created_User_Name

YES

STRING

Name of the user who created the letter.

Letter_Invalidated

YES

BOOL

Indicates whether the letter is invalidated or no longer valid. This status is determined based on the Letter_State. If the Letter_State is 'REQUEST_MOVED' or 'PROGRAM_MOVED', the value is true; otherwise, it is false.

Error_Text

YES

STRING

Text describing any errors or issues related to the letter.

Document_Location

YES

STRING

Location or path where the letter document is stored.

Document_ID

YES

STRING

ID of the document associated with the letter.

Created_Timestamp

YES

TIMESTAMP

Timestamp when the letter was created.

Last_Modified_Timestamp

YES

TIMESTAMP

Timestamp when the letter was last modified.

Letter Outcomes Table Specification

Column Name

Is Nullable

Data Type

Description

Letter_Outcome_Key

YES

INT64

Unique key or identifier for the letter outcome.

Letter_Key

YES

STRING

Key or identifier linking the outcome to a specific letter.

Outcome_Status

YES

STRING

Status or state of the outcome.

Outcome_Status_Description

YES

STRING

Description explaining the status or state of the outcome.

Outcome_Reason

YES

STRING

Reason associated with the outcome.

Outcome_Reason_Description

YES

STRING

Description explaining the reason for the outcome.

Outcome_ID

YES

STRING

ID or identifier of the outcome.

Created_Timestamp

YES

TIMESTAMP

Timestamp indicating when the outcome was created.

Last_Modified_Timestamp

YES

TIMESTAMP

Timestamp indicating the last modification time for the outcome.

Letter Log Table Specification

Column Name

Is Nullable

Data Type

Description

Member_ID

YES

STRING

Identifier for the member associated with the letter.

Letter_Key

YES

STRING

Unique key or identifier for the letter.

Letter_Name

YES

STRING

Name or title of the letter.

Letter_Description

YES

STRING

Description or content of the letter.

Reference_Number

YES

STRING

Reference number associated with the letter.

Selected_Timestamp

YES

TIMESTAMP

Timestamp indicating when the letter was selected or created.

Letter_Class

YES

STRING

Class or category of the letter. See Dictionary Letter Class table in the Dictionary Dataset Specification.

Letter_Class_Description

YES

STRING

Description explaining the letter class.

Letter Dataset Specification

Letter Log

Columns and Descriptions

  • Request_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Key or identifier for the request associated with the letter.

  • Appeal_Level_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Key or identifier for the appeal level related to the letter.

  • Screening_Request_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Key or identifier for the screening request linked to the letter.

  • Request_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or number of the request related to the letter.

  • Program_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Identifier for the program associated with the letter.

  • Appeal_Level_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or level of appeal linked to the letter.

  • Letter_Action

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Action performed on the letter.

  • Reference: See Dictionary Letter Action table in the Dictionary Dataset Specification.

  • Letter_Action_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the action taken on the letter.

  • Reference: See Dictionary Letter Action table in the Dictionary Dataset Specification.

  • Letter_State

  • Is Nullable: YES

  • Data Type: STRING

  • Description: State or status of the letter.

  • Letter_State_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the current state or status of the letter.

  • Letter_State_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the time when the letter state changed.

  • Created_User_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID of the user who created the letter.

  • Error_Text

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Text describing any errors or issues related to the letter.

  • Document_Location

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Location or path where the document associated with the letter is stored.

  • Document_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the document linked to the letter.

  • Created_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the letter was created.

  • Last_Modified_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the last modification time for the letter.

  • Outcomes

  • Is Nullable: NO

  • Data Type: ARRAY

  • Description: Outcomes or results associated with the letter.

Outcomes Subfields

  • Letter_Outcome_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Unique key or identifier for the letter outcome.

  • Outcome_Status

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Status or state of the outcome.

  • Outcome_Status_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the status or state of the outcome.

  • Outcome_Reason

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Reason associated with the outcome.

  • Outcome_Reason_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the reason for the outcome.

  • Outcome_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the outcome.

  • Created_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the outcome was created.

  • Last_Modified_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the last modification time for the outcome.

Additional Columns

  • Transaction_User_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID of the user associated with the transaction or activity related to the letter.

  • Type

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Type or category of the letter log entry.

  • Tenant

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Tenant or organization associated with the letter log entry.

  • Active_Version

  • Is Nullable: YES

  • Data Type: BOOL

  • Description: Version or status indicating the active state of the letter log entry.

  • Date

  • Is Nullable: YES

  • Data Type: DATE

  • Description: Date when the letter log entry was recorded or created.

  • Sequence

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Sequence number or order of the letter log entry.

  • Source_System_Name

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Name of the source system from which the letter log entry originated.

  • Source_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the source system generated the letter log entry.

  • Source_File_Name

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Name of the source file associated with the letter log entry.

  • Deleted_Indicator

  • Is Nullable: YES

  • Data Type: BOOL

  • Description: Indicator showing whether the letter log entry has been deleted.

  • Schema_Version

  • Is Nullable: YES

  • Data Type: FLOAT64

  • Description: Version of the schema or data structure used in the letter log entry.

  • Member_Partition

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Partition or segment of members associated with the letter log entry.

  • Action

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Action or operation performed on the letter log entry.

  • Transaction_Actor_Type

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Type of the actor performing the transaction.

Letter Raw

Columns and Descriptions

  • Member_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Identifier or key for the member associated with the letter.

  • Letter_Key

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Unique key or identifier for the letter.

  • Letter_Name

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Name or title of the letter.

  • Letter_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description or content of the letter.

  • Reference_Number

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Reference number associated with the letter.

  • Selected_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the letter was selected or chosen.

  • Letter_Class

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Class or category of the letter.

  • Reference: See Dictionary Letter Class table in the Dictionary Dataset Specification.

  • Letter_Class_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the class or category of the letter.

  • Reference: See Dictionary Letter Class table in the Dictionary Dataset Specification.

  • Request_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Key or identifier linking the letter to a request.

  • Appeal_Level_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Key or identifier indicating the appeal level.

  • Screening_Request_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Key or identifier related to screening requests.

  • Request_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the request.

  • Program_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the program.

  • Appeal_Level_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the appeal level.

  • Letter_Action

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Action associated with the letter.

  • Reference: See Dictionary Letter Action table in the Dictionary Dataset Specification.

  • Letter_Action_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the action associated with the letter.

  • Reference: See Dictionary Letter Action table in the Dictionary Dataset Specification.

  • Letter_State

  • Is Nullable: YES

  • Data Type: STRING

  • Description: State or status of the letter.

  • Letter_State_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the state or status of the letter.

  • Letter_State_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the state or status change time.

  • Created_User_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the user who created the letter.

Letter Dataset Specification

Overview

The Letter Dataset Specification outlines the structure and details of various tables and fields related to letters managed by Care Intelligence. This documentation provides a comprehensive view of the data captured, including letter details, outcomes, logs, and raw data.

Letter Raw Data

Columns

  • Letter_raw Error_Text

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Text describing any errors associated with the letter.

  • Letter_raw Document_Location

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Location or path of the document associated with the letter.

  • Letter_raw Document_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the document associated with the letter.

  • Letter_raw Created_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the letter was created.

  • Letter_raw Last_Modified_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the last modification time for the letter.

  • Letter_raw Outcomes

  • Is Nullable: NO

  • Data Type: ARRAY

  • Description: Outcomes or results associated with the letter.

Outcomes Subfields

  • Outcomes.Letter_Outcome_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Unique key or identifier for the letter outcome.

  • Outcomes.Outcome_Status

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Status or state of the outcome.

  • Outcomes.Outcome_Status_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the status or state of the outcome.

  • Outcomes.Outcome_Reason

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Reason associated with the outcome.

  • Outcomes.Outcome_Reason_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the reason for the outcome.

  • Outcomes.Outcome_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the outcome.

  • Outcomes.Created_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the outcome was created.

  • Outcomes.Last_Modified_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the last modification time for the outcome.

  • Letter_raw Record_Last_Modified_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the last modification time for the record.

  • Letter_raw Transaction_User_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the user associated with the transaction.

  • Letter_raw Type

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Type or category of the letter.

  • Letter_raw Tenant

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Tenant or organization associated with the letter.

  • Letter_raw Active_Version

  • Is Nullable: YES

  • Data Type: BOOL

  • Description: Active version or status of the letter.

  • Letter_raw Date

  • Is Nullable: YES

  • Data Type: DATE

  • Description: Date associated with the letter.

  • Letter_raw Sequence

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Sequence or order of the letter.

  • Letter_raw Source_System_Name

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Name of the source system from which the letter originated.

  • Letter_raw Source_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the source time of the letter.

  • Letter_raw Source_File_Name

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Name of the source file from which the letter was generated.

  • Letter_raw Deleted_Indicator

  • Is Nullable: YES

  • Data Type: BOOL

  • Description: Indicator showing whether the letter has been deleted.

  • Letter_raw Schema_Version

  • Is Nullable: YES

  • Data Type: FLOAT64

  • Description: Version of the schema used for the letter.

  • Letter_raw Member_Partition

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Partition or segment associated with the member.

  • Letter_raw Transaction_Actor_Type

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Type of the actor performing the transaction.

Tables Overview

Letter Records

This table documents each letter's details, including its purpose, recipient, and content. It provides a structured way to manage the formal communications sent from the organization, ensuring clarity and accountability.

Letter Outcomes

Records the results or responses generated by each letter. This table provides insight into the effectiveness of the communications, helping to understand how recipients react and respond to the letters.

Letter Log

Tracks the history and changes made to the letters, offering an audit trail of the correspondence process. This log is essential for maintaining transparency and tracking the evolution of each piece of correspondence.

Letter Raw Data

Contains unprocessed, detailed data related to the letters. This table captures all aspects of the communication for comprehensive analysis and record-keeping, providing a granular view that can be crucial for detailed audits and reviews.

Table Content

Table Name

Column Name

Is Nullable

Data Type

Description

Letter

Member_ID

YES

STRING

ID of the member or patient associated with the letter.

Letter

Letter_Key

YES

STRING

Unique identifier for the letter.

Letter

Letter_Name

YES

STRING

Name or title of the letter.

Letter

Letter_Description

YES

STRING

Description or content of the letter.

Letter

Reference_Number

YES

STRING

Reference number associated with the letter.

Letter

Selected_Timestamp

YES

TIMESTAMP

Timestamp when the letter was selected or generated.

Letter

Letter_Class

YES

STRING

Class or category of the letter. See Dictionary Letter Class table in the Dictionary Dataset Specification.

Letter

Letter_Class_Description

YES

STRING

Description of the class or category of the letter. See Dictionary Letter Class table in the Dictionary Dataset Specification.

Letter

Request_Key

YES

INT64

Key or identifier associated with the request.

Letter

Appeal_Level_Key

YES

INT64

Key or identifier associated with the appeal level.

Letter

Screening_Request_Key

YES

INT64

Key or identifier associated with the screening request.

Letter

Request_ID

YES

STRING

ID of the request associated with the letter.

Letter

Program_ID

YES

STRING

ID of the program or system related to the letter.

Letter

Appeal_Level_ID

YES

STRING

ID of the appeal level related to the letter.

Letter

Letter_Action

YES

STRING

Action or status related to the letter. See Dictionary Letter Action table in the Dictionary Dataset Specification.

Letter

Letter_Action_Description

YES

STRING

Description of the action or status related to the letter. See Dictionary Letter Action table in the Dictionary Dataset Specification.

Letter

Letter_State

YES

STRING

State or condition of the letter.

Letter

Letter_State_Description

YES

STRING

Description of the state or condition of the letter.

Letter

Letter_State_Timestamp

YES

TIMESTAMP

Timestamp indicating the state or condition change of the letter.

Letter

Created_User_ID

YES

STRING

ID of the user who created the letter.

Letter

Created_User_Name

YES

STRING

Name of the user who created the letter.

Letter

Letter_Invalidated

YES

BOOL

Indicates whether the letter is invalidated or no longer valid. This status is determined based on the Letter_State. If the Letter_State is 'REQUEST_MOVED' or 'PROGRAM_MOVED', the letter is considered invalidated.

Letter Dataset Specification

Letter Table

Columns

  • Error_Text

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Text describing any errors or issues related to the letter.

  • Document_Location

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Location or path where the letter document is stored.

  • Document_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID of the document associated with the letter.

  • Created_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp when the letter was created.

  • Last_Modified_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp when the letter was last modified.

Letter_Outcomes Table

Columns

  • Letter_Outcome_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Unique key or identifier for the letter outcome.

  • Letter_Key

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Key or identifier linking the outcome to a specific letter.

  • Outcome_Status

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Status or state of the outcome.

  • Outcome_Status_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the status or state of the outcome.

  • Outcome_Reason

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Reason associated with the outcome.

  • Outcome_Reason_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the reason for the outcome.

  • Outcome_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the outcome.

  • Created_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the outcome was created.

  • Last_Modified_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the last modification time for the outcome.

Letter_log Table

Columns

  • Member_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Identifier for the member associated with the letter.

  • Letter_Key

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Unique key or identifier for the letter.

  • Letter_Name

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Name or title of the letter.

  • Letter_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description or content of the letter.

  • Reference_Number

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Reference number associated with the letter.

  • Selected_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the letter was selected or created.

  • Letter_Class

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Class or category of the letter. See Dictionary Letter Class table in the Dictionary Dataset Specification.

  • Letter_Class_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the letter class. See Dictionary Letter Class table in the Dictionary Dataset Specification.

  • Request_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Key or identifier for the request associated with the letter.

  • Appeal_Level_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Key or identifier for the appeal level related to the letter.

  • Screening_Request_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Key or identifier for the screening request linked to the letter.

  • Request_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or number of the request related to the letter.

  • Program_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Identifier for the program associated with the letter.

  • Appeal_Level_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or level of appeal linked to the letter.

  • Letter_Action

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Action performed on the letter. See Dictionary Letter Action table in the Dictionary Dataset Specification.

  • Letter_Action_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the action taken on the letter. See Dictionary Letter Action table in the Dictionary Dataset Specification.

  • Letter_State

  • Is Nullable: YES

  • Data Type: STRING

  • Description: State or status of the letter.

  • Letter_State_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the current state or status of the letter.

  • Letter_State_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the time when the letter state changed.

  • Created_User_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID of the user who created the letter.

  • Error_Text

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Text describing any errors or issues related to the letter.

  • Document_Location

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Location or path where the document associated with the letter is stored.

  • Document_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the document linked to the letter.

  • Created_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the letter was created.

  • Last_Modified_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the last modification time for the letter.

  • Outcomes

  • Is Nullable: NO

  • Data Type: ARRAY

  • Description: Outcomes or results associated with the letter.

Outcomes Subfields

  • Letter_Outcome_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Unique key or identifier for the letter outcome.

  • Outcome_Status

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Status or state of the outcome.

  • Outcome_Status_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the status or state of the outcome.

  • Outcome_Reason

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Reason associated with the outcome.

  • Outcome_Reason_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the reason for the outcome.

  • Outcome_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the outcome.

  • Created_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the outcome was created.

  • Last_Modified_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the last modification time for the outcome.

  • Transaction_User_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID of the user associated with the transaction or activity related to the letter.

  • Type

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Type or category of the letter log entry.

  • Tenant

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Tenant or organization associated with the letter log entry.

  • Active_Version

  • Is Nullable: YES

  • Data Type: BOOL

  • Description: Version or status indicating the active state of the letter log entry.

  • Date

  • Is Nullable: YES

  • Data Type: DATE

  • Description: Date when the letter log entry was recorded or created.

  • Sequence

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Sequence number or order of the letter log entry.

Letter Dataset Specification

Letter Log Table

Columns

  • Source_System_Name

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Name of the source system from which the letter log entry originated.

  • Source_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the source system generated the letter log entry.

  • Source_File_Name

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Name of the source file associated with the letter log entry.

  • Deleted_Indicator

  • Is Nullable: YES

  • Data Type: BOOL

  • Description: Indicator showing whether the letter log entry has been deleted.

  • Schema_Version

  • Is Nullable: YES

  • Data Type: FLOAT64

  • Description: Version of the schema or data structure used in the letter log entry.

  • Member_Partition

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Partition or segment of members associated with the letter log entry.

  • Action

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Action or operation performed on the letter log entry.

  • Transaction_Actor_Type

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Type of the actor performing the transaction.

Letter Raw Table

Columns

  • Member_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Identifier or key for the member associated with the letter.

  • Letter_Key

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Unique key or identifier for the letter.

  • Letter_Name

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Name or title of the letter.

  • Letter_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description or content of the letter.

  • Reference_Number

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Reference number associated with the letter.

  • Selected_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the letter was selected or chosen.

  • Letter_Class

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Class or category of the letter. See Dictionary Letter Class table in the Dictionary Dataset Specification.

  • Letter_Class_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the class or category of the letter. See Dictionary Letter Class table in the Dictionary Dataset Specification.

  • Request_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Key or identifier linking the letter to a request.

  • Appeal_Level_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Key or identifier indicating the appeal level.

  • Screening_Request_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Key or identifier related to screening requests.

  • Request_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the request.

  • Program_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the program.

  • Appeal_Level_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the appeal level.

  • Letter_Action

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Action associated with the letter. See Dictionary Letter Action table in the Dictionary Dataset Specification.

  • Letter_Action_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the action associated with the letter. See Dictionary Letter Action table in the Dictionary Dataset Specification.

  • Letter_State

  • Is Nullable: YES

  • Data Type: STRING

  • Description: State or status of the letter.

  • Letter_State_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the state or status of the letter.

  • Letter_State_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the state or status change time.

  • Created_User_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the user who created the letter.

  • Error_Text

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Text describing any errors associated with the letter.

  • Document_Location

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Location or path of the document associated with the letter.

  • Document_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the document associated with the letter.

  • Created_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the letter was created.

  • Last_Modified_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the last modification time for the letter.

  • Outcomes

  • Is Nullable: NO

  • Data Type: ARRAY

  • Description: Outcomes or results associated with the letter.

Outcomes Subfields

  • Letter_Outcome_Key

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Unique key or identifier for the letter outcome.

  • Outcome_Status

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Status or state of the outcome.

  • Outcome_Status_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the status or state of the outcome.

  • Outcome_Reason

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Reason associated with the outcome.

  • Outcome_Reason_Description

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Description explaining the reason for the outcome.

  • Outcome_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the outcome.

  • Created_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating when the outcome was created.

  • Last_Modified_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the last modification time for the outcome.

Additional Columns

  • Record_Last_Modified_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the last modification time for the record.

  • Transaction_User_ID

  • Is Nullable: YES

  • Data Type: STRING

  • Description: ID or identifier of the user associated with the transaction.

  • Type

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Type or category of the letter.

  • Tenant

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Tenant or organization associated with the letter.

  • Active_Version

  • Is Nullable: YES

  • Data Type: BOOL

  • Description: Active version or status of the letter.

  • Date

  • Is Nullable: YES

  • Data Type: DATE

  • Description: Date associated with the letter.

  • Sequence

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Sequence or order of the letter.

  • Source_System_Name

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Name of the source system from which the letter originated.

  • Source_Timestamp

  • Is Nullable: YES

  • Data Type: TIMESTAMP

  • Description: Timestamp indicating the source time of the letter.

  • Source_File_Name

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Name of the source file from which the letter was generated.

  • Deleted_Indicator

  • Is Nullable: YES

  • Data Type: BOOL

  • Description: Indicator showing whether the letter has been deleted.

  • Schema_Version

  • Is Nullable: YES

  • Data Type: FLOAT64

  • Description: Version of the schema used for the letter.

  • Member_Partition

  • Is Nullable: YES

  • Data Type: INT64

  • Description: Partition or segment associated with the member.

  • Transaction_Actor_Type

  • Is Nullable: YES

  • Data Type: STRING

  • Description: Type of the actor performing the transaction.

Letter Dataset Specification

Overview

The Letter Dataset Specification outlines the structure, features, and technical details of the dataset used within Care Intelligence systems. This document provides a comprehensive guide to understanding the dataset's components, their functionality, and their integration into the broader system.

Dataset Structure

Key Components

The Letter Dataset is composed of several key components designed to facilitate efficient data handling and processing:

  • Letter Metadata: Includes information such as letter ID, creation date, and author details.

  • Content Sections: Divided into structured segments like introduction, body, and conclusion for easier parsing.

  • Recipient Information: Contains recipient details such as name, address, and contact information.

  • Status Tracking: Tracks the current status of the letter (e.g., draft, sent, received).

Features

Metadata Management

The dataset supports robust metadata management to ensure traceability and organization. Key features include:

  • Unique Letter IDs: Each letter is assigned a unique identifier for tracking and referencing.

  • Timestamping: Automatic recording of creation and modification dates.

  • Author Attribution: Captures the identity of the letter's creator for accountability.

Content Segmentation

Letters are divided into logical sections to improve readability and processing:

  • Introduction: Provides context and purpose for the letter.

  • Body: Contains the main content, including detailed information or instructions.

  • Conclusion: Summarizes the letter and includes any closing remarks.

Recipient Information

Recipient details are stored in a structured format to ensure accurate delivery:

  • Name: Full name of the recipient.

  • Address: Physical or email address for correspondence.

  • Contact Details: Phone number or other relevant contact information.

Status Tracking

The dataset includes mechanisms to monitor the lifecycle of a letter:

  • Draft: Letters in progress that are not yet finalized.

  • Sent: Letters that have been dispatched to the recipient.

  • Received: Confirmation that the recipient has acknowledged the letter.

Technical Specifications

Data Format

The Letter Dataset is stored in a standardized format to ensure compatibility and ease of use:

  • JSON: Utilized for its lightweight and flexible structure.

  • XML: Available for systems requiring hierarchical data representation.

Integration

The dataset integrates seamlessly with other Care Intelligence modules:

  • RTR Rules: Ensures compliance with predefined rules for letter content and distribution.

  • Analytics Engine: Provides insights into letter usage and effectiveness.

  • Workflow Automation: Streamlines the process of creating, sending, and tracking letters.

Security

The dataset incorporates security measures to protect sensitive information:

  • Encryption: All data is encrypted during transmission and storage.

  • Access Control: Permissions are assigned to ensure only authorized personnel can access the dataset.

  • Audit Logs: Tracks all changes and access events for accountability.

Usage Examples

Creating a New Letter

To create a new letter, the following steps are typically followed:

  1. Define the recipient information (name, address, contact details).

  2. Draft the content, including introduction, body, and conclusion.

  3. Assign metadata such as letter ID and author details.

  4. Save the letter in draft status for review.

Sending a Letter

Once a letter is finalized, it can be sent using the following process:

  1. Verify recipient information for accuracy.

  2. Confirm the letter content and metadata.

  3. Change the status to "Sent" and dispatch the letter.

  4. Monitor for acknowledgment to update the status to "Received."

Best Practices

Data Consistency

Ensure all fields are populated accurately to maintain dataset integrity:

  • Use standardized formats for dates and contact information.

  • Avoid leaving any required fields blank.

Security Compliance

Follow security protocols to protect sensitive data:

  • Regularly update encryption methods.

  • Limit access to authorized personnel only.

Workflow Optimization

Leverage automation tools to streamline letter management:

  • Use templates for common letter types.

  • Integrate with analytics to measure effectiveness.

Conclusion

The Letter Dataset Specification provides a detailed framework for managing letter-related data within Care Intelligence systems. By adhering to the outlined structure, features, and best practices, users can ensure efficient and secure handling of correspondence.

Related Articles
Request Dataset Specification
Provider Dataset Specification
Interaction Topic Dataset Specification
Program Dataset Specification
Task Dataset Specification
Did this answer your question?