The DataFile API is accessable via a secure authenticated HTTPS connection to our hosted services, and is isolated to your subscription. This requires your application to have a client id and client secret.
\nTo setup your account email support@datafileapi.com to recieve a client id and client secret.
\nBearer authentication is an HTTP authentication scheme that involves security tokens called bearer tokens. The name “Bearer authentication” can be understood as “give access to the bearer of this token.”
\nTo receive a bearer token, post your client id and client secret to the Authenticate Application request.
\nGiven the sensitive nature of the content, your client id and client secret will be updated on a regular basis. It is your responsibility to store these values securely and appropriately. Client ids and secrets may be revoked at anytime for any reason without prior warning. If you feel your id or secret has been compromised you must notify DataFile immediately. Further restrictions such as IP based restrictions will be managed on an individual basis.
\nThe client must send this token in the Authorization header when making requests.
\n\"Authorization: Bearer {access-token}\"
To receive a bearer token, post your client id and client secret via a JSON POST.
\n","urlObject":{"protocol":"https","path":["api","v1","authentication","application"],"host":["www","datafileapi","com"],"query":[],"variable":[]}},"response":[{"id":"ae62a377-aa13-4e83-b7aa-e8d616ba4ed9","name":"Authenticate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client-id\" : \"client-id\",\n \"client-secret\" : \"secret\"\n}"},"url":"https://www.datafileapi.com/api/v1/authentication/application"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Apr 2019 18:02:50 GMT"},{"key":"Server","value":"Apache/2.4.39 (Amazon) PHP/7.2.16"},{"key":"X-Powered-By","value":"PHP/7.2.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Content-Length","value":"69"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"access-token\": \"123456\",\n \"access-expiration\": \"2019-04-16 08:00:00AM\"\n}"}],"_postman_id":"88a3f048-40f5-4ee8-a5f4-b2094870d77b"},{"name":"Batch","id":"3acaf858-0bdc-470d-a656-15229d120235","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Access Token
\n","key":"Authorization","type":"text","value":"Bearer {access-token}"}],"body":{"mode":"raw","raw":"{\n \"batch-id\": \"ev-123654\",\n \"notes\": \"notes\",\n \"rush\": true,\n \"delivery-type\":\"sftp\",\n \"record-requests\": [\n {\n \"request-id\": \"r-22331\",\n \"date-of-service-range\":{\n \t\"start-date\" : \"2001-04-04\",\n \t\"end-date\" : \"2019-04-04\"\n },\n \"facility\": {\n \"organizational-npi\": 1234567890,\n \"name\": \"Acme\",\n \"address-line1\": \"456 Acme Lane\",\n \"address-line2\": \"\",\n \"city\": \"Milwaukee\",\n \"state\": \"WI\",\n \"postal-code\": \"52308\",\n \"phone-number\":\"5555555555\",\n \"fax-number\":\"5555555555\"\n },\n \"provider\": {\n \"npi\": 3456789012,\n \"first-name\": \"Frank\",\n \"last-name\": \"Smith\",\n \"address-line1\": \"123 Abc Street\",\n \"address-line2\": \"Apt 2L\",\n \"city\": \"Brooklyn\",\n \"state\": \"NY\",\n \"postal-code\": \"11233\",\n \"phone-number\": \"5555554555\",\n \"fax-number\": \"7189555555\"\n },\n \"patient\": {\n \"first-name\": \"Susan\",\n \"last-name\": \"Jones\",\n \"date-of-birth\": \"1980-08-09\",\n \"aliases\": \"\",\n \"address-line1\": \"777 Street\",\n \"address-line2\": \"4th Floor\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal-code\": \"11000\",\n \"phone-number\": \"2125556666\",\n \"fax-number\": \"2129555500\",\n \"email\": \"susan@example.com\",\n \"ssn\": \"1234\"\n }\n }\n ]\n}"},"url":"https://www.datafileapi.com/api/v1/batch","description":"A Batch Request is a grouping of one or more record-request objects. You can assign your own unique batch-id to a batch so you may later retrieve information about a batch or a record within a batch.
\nIf you do not provide a batch-id, the system will auto-generate a batch-id and it will be returned in the response. It is your responsibility to store your private batch-id for later use.
\nIn a batch request, you may request records by facility and/or provider and patient specifics via a JSON POST.
\nEITHER Facily OR Provider is required (both are acceptable).
\nPatient IS required.
\nFields within each object are optional. For example, you may not know the NPI number for a provider but may know the Doctor's name. Therefore you would submit values for the name of the Doctor but leave the NPI field blank.
\n","urlObject":{"protocol":"https","path":["api","v1","batch"],"host":["www","datafileapi","com"],"query":[],"variable":[]}},"response":[{"id":"95ea0b64-84c5-490c-84cd-84d4876bcd0b","name":"Batch","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {access_token}","description":"Access Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"batch-id\": \"ev-123654\",\n \"notes\": \"notes\",\n \"rush\": true,\n \"record-requests\": [\n {\n \"request-id\": \"r-22331\",\n \"facility\": {\n \"organizational-npi\": 1234567890,\n \"name\": \"Acme\",\n \"address-line1\": \"456 Acme Lane\",\n \"address-line2\": \"\",\n \"city\": \"Milwaukee\",\n \"state\": \"WI\",\n \"postal-code\": \"52308\"\n },\n \"provider\": {\n \"npi\": 3456789012,\n \"first-name\": \"Frank\",\n \"last-name\": \"Smith\",\n \"address-line1\": \"123 Abc Street\",\n \"address-line2\": \"Apt 2L\",\n \"city\": \"Brooklyn\",\n \"state\": \"NY\",\n \"postal-code\": \"11233\",\n \"phone-number\": \"5555554555\",\n \"fax-number\": \"7189555555\"\n },\n \"patient\": {\n \"first-name\": \"Susan\",\n \"last-name\": \"Jones\",\n \"date-of-birth\": \"1980-08-09\",\n \"aliases\": \"\",\n \"address-line1\": \"777 Street\",\n \"address-line2\": \"4th Floor\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal-code\": \"11000\",\n \"phone-number\": \"2125556666\",\n \"fax-number\": \"2129555500\",\n \"email\": \"susan@example.com\"\n }\n }\n ]\n}"},"url":"https://www.datafileapi.com/api/v1/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Apr 2019 18:03:51 GMT"},{"key":"Server","value":"Apache/2.4.39 (Amazon) PHP/7.2.16"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Content-Length","value":"369"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"batch-result\": {\n\t\t\"batch-id\": \"ev-123654\",\n\t\t\"result-overview\": [{\n\t\t\t\t\"overview\": {\n\t\t\t\t\t\"records\": 12,\n\t\t\t\t\t\"delivery-timeline-days\": 1\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"overview\": {\n\t\t\t\t\t\"records\": 10,\n\t\t\t\t\t\"delivery-timeline-days\": 3\n\t\t\t\t}\n\t\t\t}\n\t\t],\n\t\t\"results\": [{\n\t\t\t\t\"result\": {\n\t\t\t\t\t\"request-id: \": \"r-22332\",\n\t\t\t\t\t\"first-name\": \"Sara\",\n\t\t\t\t\t\"last-name\": \"Smith\",\n\t\t\t\t\t\"date-of-birth\": \"1985-02-27\",\n\t\t\t\t\t\"delivery-expectation\": {\n\t\t\t\t\t\t\"delivery-timeline-days\": 1,\n\t\t\t\t\t\t\"delivery-notes\": \"No note\"\n\t\t\t\t\t},\n\t\t\t\t\t\"notes\": \"No notes\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"result\": {\n\t\t\t\t\t\"request-id: \": \"r-22331\",\n\t\t\t\t\t\"first-name\": \"Susan\",\n\t\t\t\t\t\"last-name\": \"Jones\",\n\t\t\t\t\t\"date-of-birth\": \"1985-02-26\",\n\t\t\t\t\t\"delivery-expectation\": {\n\t\t\t\t\t\t\"delivery-timeline-days\": 3,\n\t\t\t\t\t\t\"delivery-notes\": \"No note\"\n\t\t\t\t\t},\n\t\t\t\t\t\"notes\": \"No notes\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n}"}],"_postman_id":"3acaf858-0bdc-470d-a656-15229d120235"},{"name":"Status By Batch Id","id":"f5f9ec12-b872-41db-b546-39105b0436dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Access Token
\n","key":"Authorization","type":"text","value":"Bearer {access-token}"}],"url":"https://www.datafileapi.com/api/v1/status/ev-123654","description":"After submitting a batch request, you may request its status by Batch Id. The batch id is your internal Id that you specified in the creation of a batch.
\nhttps://www.datafileapi.com/api/v1/status/{batch-id}
Access Token
\n","key":"Authorization","type":"text","value":"Bearer {access-token}"}],"url":"https://www.datafileapi.com/api/v1/status/ev-123654/r-22331","description":"After submiting a batch, you may submit a status request by Batch Id and Request Id.
\nhttps://www.datafileapi.com/api/v1/status/{batch-id}/{request_id}