FAQs

How do I get a username and password for the API?

You need a username and password to make API requests. Your Appriss project manager will create your account and provide you with your login credentials. You will have a different password for the testing and production environments.

How do I recover or reset our user account password?

If you have lost your password or need it to be reset, your Appriss project manager will provide you with a new one. For security reasons, it is not possible for Appriss to recover lost passwords.

What are the testing and production API endpoints we need to be hitting?

The API endpoints are listed in the endpoints section of the API documentation.

What is the average response time for a PMP Gateway request?

The response time for PMP Gateway requests depends directly on the response time of the PMP(s) being queried. The response can be only as fast as the slowest PMP. In general, the average response time is about 6 or 7 seconds for a search request.

How long should I wait for a response from PMP Gateway?

You should wait at least 30 seconds for a PMP Gateway response. PMP Gateway may request data from multiple state PMP systems and consequently, can respond only as quickly as the slowest state PMP system it queries.

Where does PMP Gateway get prescription data from?

The prescription data comes from state prescription monitoring programs (PMPs). For more information on the PMP network and how PMP Gateway fits into it, check out the architecture section in the documentation.

How do I get approval to request data from a PMP?

Each PMP controls who has access to its presctiption data. To request access to a specific PMP, contact your Appriss project manager, they will take care of the details.

Should I include optional XML elements in my requests?

Yes, include as many of the optional XML elements as you can. Different states use different elements to reteive data and including optional elements will improve the results you receive. Additionally, in the future, states may change the elements they use. Including the optional elements now will prevent possible errors in the future.

How are PMP prescription records matched to the patient data I supply?

The logic behind patient matching is performed at the PMP level and can vary between PMPs. PMP Gateway does not perform any matching or filtering - it takes the results from each PMP, aggregates them and sends you the result.

Why do I have to send provider information with each report request?

Patient prescription data is protected health information . Consequently, for each request, we need to log the health care provider making the request and the faclity where they work.

Are we permitted to store the prescription data returned by PMP Gateway?

This depends on which state PMP systems the prescription data was retrieved from and each individual state's laws.

What roles am I allowed to use in a patient request or a report request?

Physician
Pharmacist
Pharmacist with prescriptive authority
Nurse Practitioner
Psychologist with prescriptive authority
Optometrist with prescriptive authority
Naturopathic Physician with prescriptive authority
Physician Assistant with prescriptive authority
Medical Resident with prescriptive authority
Medical Intern with prescriptive authority
Dentist

Our PMP Gateway roles are a subset of roles derived from interstate sharing via the state-run web portals. Delegates and non-prescribers are not used in integrations and are not allowed access via PMP Gateway.

Please note: Any additional roles listed in the PMP Gateway schema are a carry-over from the existing interstate data sharing system, PMPi, and are not applicable for EHR integration.