Skip to main content
All CollectionsReportingPHI Extracts
Healthify PHI Referrals Extract Data Dictionary
Healthify PHI Referrals Extract Data Dictionary

Definitions for fields specific to Healthify's standard data extract of identified referral information

Steven Ogando avatar
Written by Steven Ogando
Updated over a year ago

Report Summary

Need help figuring out what this report is and what it contains? Below you will find a brief report description as well as necessary data definitions.

The Healthify PHI Referrals Extract enables customers with referrals to receive automatic exports of referrals created within Healthify during the report's date range with identifiable patient information included. Customers may receive this file on a selected time interval (typically monthly or weekly) delivered as a zipped CSV file via SFTP upload.

Each row represents a single referral that was created within Healthify, and the file will be filtered by the Network or Company, as well as the defined time interval (month, week, day, etc.) of Referral Created Date. The rows will be sorted in chronological order based on the Referral Created Time.

A standard configuration is to distribute a monthly interval file on the 15th of the following month if the customer is interested in using this data to get a picture of the status of referrals, to ensure there is ample time for end users to review and process referrals after they have been created. 

Data Definitions

Fields are listed in the order they appear in the PHI Referrals Extract.

Referral ID: The unique identifier of the referral. This is a numeric ID that is also visible in the Healthify application.

Referral UUID: The secure unique identifier of the referral. (Note: This is provided primarily for troubleshooting purposes, but serves the same purpose in data analysis as the Referral ID, to uniquely identify a referral.)

Referral Created Date: The date when the referral was created in the company or network's time zone. Formatted YYYY-MM-DD.

Referral Created Time: The complete date and time when the referral was created in the company or network's time zone. Formatted in 24-hour time.

Referring User ID: The unique identifier of the user who created the referral.

Referring User First Name: The current first name of the user who created the referral. (Note: If the user's name has changed at any point, this value will represent the most current name as of the time that the report was pulled.)

Referring User Last Name: The current last name of the user who created the referral. (Note: If the user's name has changed at any point, this value will represent the most current name as of the time that the report was pulled.)

Referring User Email: The current email address of the user who created the referral. 

Referring Team ID: The unique identifier of the team of the user who created the referral at the time of referral creation.  A team is a group of users which belongs to a company. (Note: If the referring user has changed teams after creating the referral, this value will still represent the user's team when the referral was created, not the user's current team.)

Referring Team Name: The current name of the team of the user who created the referral at the time of referral creation.  A team is a group of users which belongs to a company. (Note: If the team's name has changed at any point, this value will represent the most current name as of the time that the report was pulled.)

Referring Company ID: The unique identifier of the company of the user who created the referral at the time of referral creation. (Note: If the referring user has changed companies after creating the referral, this value will still represent the user's company when the referral was created, not the user's current company.)

Referring Company Name: The current name of the company of the user who created the referral at the time of referral creation. (Note: If the company's name has changed at any point, this value will represent the most current name as of the time that the report was pulled.)

Receiving Service ID: The unique identifier of the service to which the referral was made. A "service" is a specific social service or program provided by a community organization at one or more locations. Referrals are made to a single service at a single location.

Receiving Service Name: The current name of the service to which the referral was made. A "service" is a specific social service or program provided by a community organization at one or more locations. (Note: If the service's name has changed at any point, this value will represent the current name as of the time that the report was pulled.)

Receiving Location ID: The unique identifier of the location to which the referral was made. A "location" is a specific place where a community organization provides services. Only present if the receiving organization has an address or a location.

Receiving Location Address Line 1: The first line of the location’s address to which the referral was made.

Receiving Location Address Line 2: The second line of the location’s address to which the referral was made.

Receiving Location City: The city of the location’s address to which the referral was made.

Receiving Location State: The state of the location’s address to which the referral was made.

Receiving Location Zip Code: The zip code of the location’s address to which the referral was made.

Receiving Location Phone Number: The phone number of the location to which the referral was made.

Receiving Location Phone Extension: The phone number extension of the location to which the referral was made. Only present if there is an extension.

Receiving Organization ID: The unique identifier of the organization which currently owns the service and location to which the referral was made. An "organization" is an entity which provides community or social services and may optionally own services and locations.

Receiving Organization Name: The current name of the organization which currently owns the service and location to which the referral was made. An "organization" is an entity which provides community or social services and may optionally own services and locations.

Receiving Company ID: The current Company ID of the service and location that the referral was sent to. Only present for Coordinate referrals.

Receiving Company Name: The current Company Name of the service and location that the referral was sent to. Only present for Coordinate referrals.

Client UUID: The secure unique identifier of the client who was referred.

Client Gender: The current gender of the client who was referred. (Note: Gender is not required for clients.)

Client First Name: The current first name of the client who was referred.

Client Last Name: The current last name of the client who was referred.

Client Birth Date: The current date of birth of the client who was referred. Formatted YYYY-MM-DD (although data analysis tools such as Excel may automatically convert dates to your system’s default date format).

Client Address Line 1: Line 1 of the current address of the client who was referred.

Client Address Line 2: Line 2 of the current address of the client who was referred.

Client Address City: City of the current address of the client who was referred.

Client Address State: State of the current address of the client who was referred.

Client Address Zip Code: Zip code of the current address of the client who was referred.

Client Email: The current email address of the the client who was referred.

Client External ID: The current external identifier of the client who was referred. External ID is a generic field that Healthify customers may use to link client records in Healthify to corresponding records in a separate system, typically through an integration or flat file patient import. Often a medical record number (MRN) or member identifier.

Client HICN ID: The current HICN identifier of the client who was referred.

Client HICN ID Effective Date: The current effective date of the HICN identifier of the client who was referred.

Client Medicaid ID: The current Medicaid identifier of the client who was referred.

Client Medicaid ID Effective Date: The current effective date of the Medicaid identifier of the client who was referred.

Client Medicare ID: The current Medicare identifier of the client who was referred.

Client Medicare ID Effective Date: The current effective date of the Medicare identifier of the client who was referred.

Client Identifiers: Identifiers aside from the External ID that are associated with the client (including Medicare / Medicaid).

Referral Type: Whether the referral was an In-Network - Preferred, In-Network, or Out-of-Network referral. In-Network - Preferred referrals are sent to services that participate in the specified network as In-Network Preferred Partners. In-Network referrals are sent to services that participate in the specified network as In-Network Partners. Out-of Networks referrals are logged within the Healthify platform, and these services do not participate in the specified network. 

Referral Out-of-Network CBO Contacted: if an Out-of-Network referral is eligible for the Closed Loop Referral feature, and able to be contacted, the following fields will show to recognize what action was taken.

  • Null: the referral was not Out-of-Network

  • Not Eligible: the Out-of-Network resource was not eligible for contact

  • No: the resource was eligible for contact but the user did not contact the resource

  • Yes: the resource was eligible for contact and the user did contact the resource

Referral End User Attestation (Yes / No): Whether the client has given authorization to share their information with the referral's recipients. Values are "Yes", "No", or null, where a null value indicates end-user attestation is not applicable.

Referral Current Status Name: The status of the referral as of the time that the report was pulled. Values are "Unstarted", "In-Review", "Service In-Progress", "Service Completed", or "Canceled."

Referral Current Status Created Date: The date when the referral current status was created in the company or network's time zone. Formatted YYYY-MM-DD.

Referral Current Status Created Time: The complete date and time when the referral current status was created in the company or network's time zone. Formatted in 24-hour time.

Referral Current Cancelation Context: The reason for cancelation provided by the user. Only present if the referral current status is "Canceled."

Referral Source: where the referral as been created. In-App for referrals who have been created by a user in the application. Other possible data can be listed as API, Redox, or Member.

Converted Source Screening UUID: If the referral was created from a resource basket following the user completing a screening for the client, this will list the screening's UUID for that particular referral. This will allow you to connect a screening to the referrals that were then created based on the needs identified in the screening. The Screening UUID can be found in our PHI and De-identified Screenings Extract Report.

  • Note: This field will remain blank if your organization is not utilizing our screening feature.

Converted Source Search UUID: If the referral was created after the user completed a search, this will list the search UUID. This will allow you to connect the needs searched with the outcome of the search. The Search UUID can be found in our PHI and De-identified Search Extract Report.

Service Offering Name List: The service offering(s) the user selected for the referral. Values come from Healthify's Service Offerings taxonomy. Users may select zero, one, or many service offerings for a referral from a list of all service offerings associated with the receiving service. Provided as a comma-separated list sorted in alphabetical order.

For example, the service "St. Alexander's Food Pantry" may be tagged with the service offerings "Food pantries" and "Affordable food." When referring to this service, the user may select "Affordable food" for the referral to indicate the specific service offering(s) to which they are referring their client.

Service Offering Count: The number of service offerings the user selected for the referral.

Service Offering Category Name List: The social determinants of health (SDoH) domain category(ies) of the user-selected service offerings for the referral. Values come from Healthify's Service Offerings taxonomy. Provided as a comma-separated list sorted in alphabetical order.

Each service offering belongs to one category for reporting purposes. Categories which contain multiple service offerings connected to the referral will only appear once. For example, if the service offerings list shows "Affordable food" and "Food pantries", both of which are within the "Food" category, the Service Offerings Categories List will display "Food."

Service Offering Category Count: The number of social determinants of health (SDoH) domain category(ies) of the user-selected service offerings for the referral.

Client Population Name List: The population tags of the client. Population tags are customizable per Company.

Client Intervention Name List: The intervention tags of the client. Intervention tags are customizable per Company.

Client Phones: the phone numbers listed on the client's profile in Healthify.

Questions? We're here to help. Email us at scc.support@wellsky.com.

Did this answer your question?