Order Guidelines

When you file a request to retrieve medical records, we are able to attempt a retrieval using very minimal input from you (at least a unique id and email). However, our ability to leverage a variety of sources is commensurate with the information you supply initially. For example, we need the end user’s social security number before we reach out to EMR partners or HIEs.

As a general rule, try to supply all the information available to you at the time you send a request to our API. For more nuances, you can refer to the table below, which classifies the criticality of each request attribute for each type of integration in our network.

N/A : Field not used for the specific network channel/vendor
Optional : The network channel doesn’t require this field but we may use it if supplied to optimize hit rate or improve the user experience.
Required : The network channel requires this field at least for some orders.

	Patient Portals	Direct EMR	HIEs	APS vendors
firstName	Optional	Required	Required	Required
middleName	Optional	Optional	Optional	Optional
lastName	Optional	Required	Required	Required
dateOfBirth	Optional	Required	Required	Required
gender	Optional	Required	Required	Required
ssn	N/A	Required	Required	Required
phone	Optional	Optional	Optional	Optional
address	Optional	Required	Required	Required
providers	Optional	Optional	Optional	Required
attachments	N/A	Required	Required	Required
suggestedSources	Optional	N/A	N/A	N/A
conditions	Optional	Optional	Optional	Optional

Notes:

For "address" - recommend at least providing the Street Address and either state or zip
For "providers" - Best practice is to give BOTH a provider name and the name of the organization. At least one of either Provider Name and Organization is required in order to fulfill the APS vendor retrieval.