Human API
Health Intelligence Platform
Quick-Start Guide
March 2022
Table of Contents
Overview
The Human API team is excited to welcome you aboard!
This document is a guide to get your brokerage set up and using Human API for medical record orders.
If you have any questions during the set-up or ordering process, please reach out to the support team at help@humanapi.co
Set-Up
Portal Sign-In
You need credentials to log into the Human API Portal. Upon executing a contract with Human API, an email will be sent to you to sign up for the Portal. See below for an email example:
With your new credential, you should navigate to the Human API Portal at https://portal.humanapi.co.
Once you are logged in you will see your Dashboard.
Set Up a Landing Page
A Human API representative will work with you to choose a format for the landing page your applicants will see when they go into connect.
Set Up Email Delegation (optional)
Human API can email invitation links to new users of your application. We recommend that the emails be sent from an address that belongs to your organization, rather than directly from Human API. The emails coming from you will have much higher delivery and click-through rates.
Before we can send emails on your behalf, we need an authorization from the domain’s owner (yourself). Such authorization relies on well-established email authentication standards such as SPF, DKIM and DMARC. You or your IT personnel will need to go through the setup procedure to grant the authorization on your side. You can obtain a step-by-step guide on how to do this from the Human API support team.
Orders
Placing a Single Order
Human API’s Health Intelligence Platform enables you to submit orders that create an invitation for a specific user or applicant to share their health data with your organization.
To submit an order for your applicant:
-
On your Human API portal, go to the Humans page.
-
On the top right corner, click New Order.
-
Select the type of order you want to submit.
For more information, see the Order Types section. -
Fill out the personal and contact information of the applicant. A unique ID is needed.
Note: You will not be able to submit an order if you don’t complete mandatory fields.
-
Upload the applicant’s signed HIPAA authorization form. Please note the file must be in PDF format and under 10MB.
-
If you need medical evidence from a specific provider, fill out the Providers section.
-
Click Create New Order
-
To receive order updates, add a subscriber using the Add new person button (optional).
Placing a Bulk Order
Human API Health Intelligence Platform enables you to submit bulk orders to create invitations for multiple users or applicants to share their health data with your organization.
Before submitting a bulk order you need the following requirements:
-
A CSV template
- Use Human API’s CSV template. You can download the template directly from the platform or
reach out to help@humanapi.co to request the template.
- Use only one CSV template per bulk order.
- The maximum order number per bulk upload is 100. -
Signed HIPAA Authorization form
- You can drag and drop multiple HIPAA authorization form files at once.
- Ensure the HIPAA authorization file names match the file names listed in the CSV file.
For example, if your HIPAA authorization file name is 12345.pdf, the exact same name must be referenced in the CSV file.
To submit a bulk order:
-
On your Human API portal, go to the Humans page.
-
On the top right corner, click New Bulk Order.
The following screen opens:
3. If you don’t have a CSV template, click Download CSV Template at the bottom of the page.
4. Once you have the CSV file ready, click Choose files. Or drag and drop your CSV file and HIPAA
authorization form files.
5. If your CSV is correct and matches the HIPAA authorization form file names, a Valid status appears.
If the platform identifies errors, an additional CSV listing the errors will be available.
Note: To prevent errors in the CSV template, avoid deleting any column or column header. If you need to leave an empty field, avoid leaving blank spaces.
6. Click Create Orders.
Downloading Reports
Once your applicant’s health data has successfully been retrieved, an indication that reports are available will appear in the portal. You can retrieve a pdf of the data and/or a summary of the health data through the portal.
1. On your Human API portal, go to the Humans page.
2. Click on the applicant to see the reports available.
3. Click the Download button on the report you would like to view.
For more information, see the Report Types section.
Order Types
There are different medical evidence order types that set each of the workflows stated in this guide:
-
EHR with APS fallback
-
EHR only
-
APS only
EHR with APS Fallback Order
An EHR w/ APS order on the Health Intelligence Platform pursues obtaining medical records from an applicant through different electronic networks such as Patient Portals, Direct-to-provider networks, and Health Information Exchanges, and if no EHR record is found within a predetermined timeframe (7 days) , an APS order is automatically initiated.
When a EHR w/ APS order is created with Human API:
-
Human API sends the applicant an invitation to connect their Patient Portal.
-
Simultaneously, Human API requests medical evidence to EHR networks using the HIPAA consent form. .
-
If no EHR records are found through Patient Portal or EHR networks, an APS order is initiated..
EHR with APS Fallback Order Waiting Times
Human API waits approximately 7 calendar days for an EHR record to be returned through any of the EHR data networks before ordering an APS record.
-
If no EHR is returned after 7 calendar days, an APS order is filed.
-
APS retrieval times vary based on the applicant’s provider. Human API’s average APS wait time is 13 days.
-
The Patient Portal link stays active for 7 days.
-
Applicants receive reminder emails on days 2 and 4 following order creation.
EHR Only Order
An EHR only order pursues obtaining medical records from an applicant through different electronic networks such as Patient Portals, Epic Charts Gateway, and Veradigm.
When a EHR only order is created with Human API:
-
Human API sends the applicant an invitation to connect to the Patient Portal.
-
Simultaneously, Human API requests medical evidence to EHR networks using the HIPAA consent form.
EHR Only Order Waiting Times
-
The Patient Portal link stays active for 7 days.
-
Applicants receive reminder emails on days 2 and 4 following order creation.
APS Only Order
An APS can be ordered without the EHR process being triggered.
When a APS Order is created with Human API:
Human API requests medical evidence from Datafied. Human API does not send any Connect emails or reminders to the applicant.
APS Only Order Waiting Times
APS retrieval times vary based on the applicant’s provider. Human API’s average APS wait time is 13 days.
Report Types
There are a few report types available:
-
Full health history with highlights
-
Traditional APS with summary
Full Health History with Highlights
This report includes the full EHR record and a summary of the data.
-
Only available for EHRs
-
Highlights build, social history, key conditions, and trended results in an easy-to-read summary at the beginning of the report.
-
The full medical record is attached behind the summary.
Traditional APS with Summary
This report includes the full APS report and a summary.
-
Available if an order pivots to APS after failed EHR retrieval attempts.
-
Summary includes social history, key impairments, family history, procedures, a health snapshot with comments on key findings, and test results with out of range values.
-
The full APS report is attached behind the summary.
Task Workflows
While fulfilling an order, Human API may run into blockers or issues which require your attention or the applicant’s. When that happens, we raise a task and we notify the appropriate party (either yourself or the applicant, or both). The order remains in a “Pended” state until the task is resolved. This section describes the different types of tasks and how to resolve them.
If there are open tasks within an order, the list appears as following:
Special Authorization Workflow
On some orders, the EHR vendor might require a special authorization form in addition to the initial HIPAA form provided.
Note: During this workflow, the status of the order will be Pending. There may be a 24 hour lag between the order marked as Pending and the task being visible.
-
Human API sends an email to the applicant requesting to download, sign, and upload the pre-filled special authorization form.
-
When the applicant opens the Special Authorization form upload link, the following screen appears:
3. Once the applicant uploads the signed special authorization form, Human API returns to the EHR
vendor to continue processing the order.
Demographics required
Human API raises a demographics required task when the information supplied in the order is incomplete or invalid. For example, when the name of the applicant doesn’t match what the provider has on record.
Additional fee required
In some cases, the healthcare provider requires a fee to be paid for releasing the medical records, when the fee exceeds a maximum threshold, Human API will suspend the order and prompt you to approve the fee first.
Comments
0 comments
Please sign in to leave a comment.