sharp_revenue_testing_guide
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| sharp_revenue_testing_guide [2025/01/03 18:16] – created brad.sharp | sharp_revenue_testing_guide [2025/06/05 20:09] (current) – [Eligibility/Insurance Discovery Products] brad.sharp | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Demographics/ | + | ====== Sharp Revenue Tools API Guide ====== |
| + | |||
| + | ===== Product List ===== | ||
| + | ==== Eligibility - Product ID: 1 ==== | ||
| + | This is used when you have all the information about the patient' | ||
| + | ==== Demographics - Product ID: 2==== | ||
| + | This runs the top level of the patients credit report and is utilized in Insurance Discovery. It will return | ||
| + | information such as address, gender, SSN. Use Product ID of 2 | ||
| + | ==== Sharp Coverage Discovery - Product ID: 3==== | ||
| + | When you don't know what insurance the patient has, you can run this. Using as much information you can provide this will fish for insurance. Use Product ID of 3 | ||
| + | ==== MbiFinder - Product ID: 5==== | ||
| + | This is used when you have the old Medicare member number and you need the new member number. Use Product ID of 5 | ||
| + | |||
| + | |||
| + | |||
| + | ===== Selected API List ===== | ||
| + | |||
| + | There are many API endpoints on the server to choose from and use. While the Swagger provides information on how to use the API’s, we encourage you to contact our developers with questions. | ||
| + | |||
| + | There are many API’s used for patient searching within the system. This utilizes the patient management feature of Revenue Tools. If the system you're integrating with is an EMR-type system that manages patient information, | ||
| + | |||
| + | ===== General Response Information ===== | ||
| + | |||
| + | The root object returned by many APIs contains a property called **ClaimRevResultId**, | ||
| + | |||
| + | ===== Run Sharp Revenue ===== | ||
| + | |||
| + | To run Revenue Tools with the mentioned products, use this API: | ||
| + | |||
| + | **POST**: / | ||
| + | |||
| + | ==== Request ==== | ||
| + | |||
| + | <code json> | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }] | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | Much of the first part of the request contains housekeeping properties: | ||
| + | |||
| + | * AccountNumber - Automatically set if left blank. | ||
| + | * RequestingSoftware - Enter any value you'd like. | ||
| + | * Client ID - Can be left blank; it is a legacy property. | ||
| + | * UniqueTransactionNumber - This should be unique to your system. The system will create one if left blank. | ||
| + | * ProductsToRun - An array of all the products you'd like to run for this patient. | ||
| + | * IsRevenueToolsPayerID - this is set to true if using payer ID's from the Revenue Tools portion of the processing system. If you're using the Payer ID that is typically on a claim, the system has to lookup the mapping for that payer. In that case you'd use False in this location. If an EMR is setup to send claims to ClaimRev, that EMR will have claim payer ID's setup with the insurance information for that patient. That is when this value should be false. | ||
| + | |||
| + | Note: The PreAuthorization product is still in development, | ||
| + | |||
| + | ==== Response ==== | ||
| + | See Swagger for response details. | ||
| + | |||
| + | ===== Check Sharp Revenue Status ===== | ||
| + | |||
| + | This API returns the Sharp Revenue object if you need the results again. | ||
| + | |||
| + | POST: / | ||
| + | |||
| + | ==== Request ==== | ||
| + | <code json> | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | </ | ||
| + | * uniqueTransactionNumber is the number that comes back on the results of / | ||
| + | < | ||
| + | ... | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | ... | ||
| + | </ | ||
| + | ==== Response ==== | ||
| + | Same as RunSharpRevenue. | ||
| + | |||
| + | |||
| + | ===== Check Sharp Revenue Get Previous Results By Object ID ===== | ||
| + | The RunSharpRevenue api returns a property called claimRevResultsId, | ||
| + | |||
| + | GET: / | ||
| + | **Note: this is a GET call, there is no body and should be set to none in postman.** | ||
| + | |||
| + | |||
| + | ==== Response ==== | ||
| + | Same as RunSharpRevenue. | ||
| + | |||
| + | ===== How To Get Test Information Back ===== | ||
| + | Note that the test API's are just to get started, switching to production with real data is important and will help complete your integration. | ||
| + | |||
| + | ==== Demographics/ | ||
| The demographics part of the service will typically return the info that was passed to it. For example, if the caller requests data on John Smith of San Pablo CA with a date-of-birth of 1/23/1974, that is exactly what the service will return. However, the exact behavior will depend on the person’s last name: | The demographics part of the service will typically return the info that was passed to it. For example, if the caller requests data on John Smith of San Pablo CA with a date-of-birth of 1/23/1974, that is exactly what the service will return. However, the exact behavior will depend on the person’s last name: | ||
| Line 22: | Line 133: | ||
| ¹ Note that available employment information is usually very sparse. The employment data returned by the mock service is modeled on actual data returned by our vendors, and not all fields will be populated. | ¹ Note that available employment information is usually very sparse. The employment data returned by the mock service is modeled on actual data returned by our vendors, and not all fields will be populated. | ||
| - | ====== Eligibility/ | + | ==== Eligibility/ |
| The behavior of the service is largely dependent on the name of the subscriber / guarantor: | The behavior of the service is largely dependent on the name of the subscriber / guarantor: | ||
| + | * **Note Use Payer** Payer Number: 00015 and PayerName: | ||
| * **Subscriber first name starts with “H”** – return Active coverage if subscriber id is present, otherwise return an AAA 72 validation (indicating a missing subscriber id). | * **Subscriber first name starts with “H”** – return Active coverage if subscriber id is present, otherwise return an AAA 72 validation (indicating a missing subscriber id). | ||
| * **Subscriber first name starts with “I”** – return Not Found response with an AAA 42 validation (indicating service temporarily unable to respond); a different AAA validation code can be sent if the first name contains a hyphen followed by the code (for example, a first name of “I-41” will cause a AAA 41 to be returned). | * **Subscriber first name starts with “I”** – return Not Found response with an AAA 42 validation (indicating service temporarily unable to respond); a different AAA validation code can be sent if the first name contains a hyphen followed by the code (for example, a first name of “I-41” will cause a AAA 41 to be returned). | ||
sharp_revenue_testing_guide.1735928214.txt.gz · Last modified: 2025/01/03 18:16 by brad.sharp