|
|
version 1.0 |
This document discusses Claimpower API and its methods to connect to the API Server and query patient data from Claimpower EHR, in the context of meeting the Meaningful Use Stage 3 requirements.
This API criterion allow patients, through a third-party application, to pull certain components of their unique health data directly from the provider's EHR, and potentially could—on demand—pull such information from multiple providers caring for a patient. Claimpower has developed a web API platform enabling Meaningful Use Stage 3 standards compliant documentation for the APIs.
Claimpower API uses the SOAP protocol service architecture which allows seamless integration over the HTTPS protocol. This means that any client that can communicate over HTTPS can easily communicate with the Claimpower API. Such communication across physical and logical barriers such as firewalls, etc. is much easier to facilitate and manage. Most companies already have ports open for such communication which facilitates easier configuration for Claimpower API. It is straightforward for any client request to communicate with a Claimpower API as the call to the operation essentially entails the building of a URL string to call an operation in the service. Data passed to the operation in XML.
The Claimpower API uses Token key for security. This means that when making calls to any resource with the Claimpower API , you must pass a token key. To obtain a token Key, you need to call a API function.
| Parameters | Data Type | Description |
|---|---|---|
| Client Key | String | Client Registration Key |
Add web reference to below :
WebService :https://www.claimpowerehr.com/cpwebapps/cpdatarequest.asmx
string StrToken = "", StrClientkey="9999";
ClientAPI.CpDataRequestSoapClient objWebService = new ClientAPI.CpDataRequestSoapClient();
StrToken = objWebService.GetToken(StrClientkey);
| Parameters | Data Type | Description |
|---|---|---|
| Token | String | API Generated Token |
| FirstName | String | Patient First Name |
| LastName | String | Patient Last Name |
| DateOfBirth | Date | Patient Date of Birth |
| Gender | String | Patient Gender Male for "M" and Female for "F" |
| SSN | String | Social Security Number |
Add web reference to below :
WebService :https://www.claimpowerehr.com/cpwebapps/cpdatarequest.asmx
string StrXML = "";
string FirstName = "Test";
string LastName = "Patient";
string DateOfBirth = "";
string Gender = "";
string SSN = "";
ClientAPI.CpDataRequestSoapClient objWebService = new ClientAPI.CpDataRequestSoapClient();
//Retrive Patient
StrXML = objWebService.GetPatients(StrToken, FirstName, LastName, DateOfBirth,Gender,SSN);
| Parameters | Data Type | Description |
|---|---|---|
| Token | String | API Generated Token |
| PatID | String | Get Patient ID from API GetPatient function |
| CatNames | String | Category Name |
| pStartDate(Optional) | Date | Start Date |
| pEndDate(Optional) | Date | End Date |
Add web reference to below :
WebService :https://www.claimpowerehr.com/cpwebapps/cpdatarequest.asmx
string StrXML = "";
string FirstName = "Test";
string LastName = "Patient";
string DateOfBirth = "";
string Gender = "";
string SSN = "";
string PatID ="00000002" ;
string pStartDate = "";
string pEndDate = "";
ClientAPI.CpDataRequestSoapClient objWebService = new ClientAPI.CpDataRequestSoapClient();
//Requesting for a Single Category Data
StrXML = objWebService.GetCategoryData(StrToken, PatID.ToString(), pStartDate, pEndDate, "PatInfo");
//Requesting for a multiple Category Data with Date
pStartDate = "01/01/2017";
pEndDate = "12/31/2017";
StrXML = objWebService.GetCategoryData(StrToken, PatID, pStartDate, pEndDate,"PatInfo,SmkSts,Procedures");
| Name | Description | Supported Searches |
|---|---|---|
| PatInfo | Patient Information (Patient Name, Sex, Date of Birth, Race, Ethnicity, Preferred Language) | Patient ID |
| SmkSts | Smoking Status | Patient ID |
| Problems | Problems | Patient ID |
| Medications | Medications | Patient ID |
| Allergies | Medication Allergies | Patient ID |
| MedicationsAdm | Medications Administered | Patient ID + [Date] |
| LabTest | Laboratory Tests | Patient ID |
| LabResult | Laboratory Value(s) / Result(s) | Patient ID |
| Vitals | Vital Signs | Patient ID + [Date] |
| Procedures | procedures | Patient ID + [Date] |
| CareTeam | Care Team Member(s) | Patient ID |
| Immunizations | Immunizations | Patient ID |
| Implants | Implantable Device(s) | Patient ID |
| Assessment | Assessments | Patient ID + [Date] |
| CarePlan | Plan of Treatment | Patient ID + [Date] |
| Goals | Goals | Patient ID + [Date] |
| HealthConcerns | Health Concerns | Patient ID |
| FuncCogSt | Functional and Cognitive Status | Patient ID |
| RsnRefrl | Reason for Referral | Patient ID |
| Encounters | Encounter Diagnosis | Patient ID + [Date] |
| Parameters | Data Type | Description |
|---|---|---|
| Token | String | API Generated Token |
| PatID | String | Get Patient ID from API GetPatient function |
| pStartDate(Optional) | Date | Start Date |
| pEndDate(Optional) | Date | End Date |
Add web reference to below :
WebService :https://www.claimpowerehr.com/cpwebapps/cpdatarequest.asmx
string StrXML = "";
string PatID ="00000002" ;
string pStartDate = "01/01/2017";
string pEndDate = "12/31/2017"
ClientAPI.CpDataRequestSoapClient objWebService = new ClientAPI.CpDataRequestSoapClient();
//Retrive All Category Data
StrXML = objWebService.GetAllData(StrToken, PatID, pStartDate, pEndDate);
This section discusses the terms and conditions of using the Claimpower API version 1.0.
This is a legal agreement (Agreement) between you (a Developer or User) and Claimpower. BY USING Claimpower API AND/OR Claimpower EHR AND/OR ACCEPTING THIS AGREEMENT, YOU ARE CONSENTING TO BE BOUND BY ITS TERMS. Claimpower API documentation, access link and materials (together “Materials”) have been made available to developers for development and testing. The Materials are provided to developers as-is with no other warranties expressed or implied. Developers may use the Materials with adherence to the below terms and conditions:
|
1. |
Claimpower EHR web link has the most up-to- date documentation of Claimpower API. Developers may keep copies of the Materials; however, they may not be distributed. Developers wishing to share the Materials may do so via linking other developers to the Materials hosted on the Claimpower EHR. |
|
2. |
Developers own developments using the Materials. Claimpower owns the materials, as well as any improvements to or derivatives of the Materials, such as enhancements to the testing tools or documentation. |
|
3. |
All Claimpower API is web-service based API and developers are welcome to use any programming language of choice to interact with API. |
|
4. |
Developers are responsible for the products developed and how the products connect to the other software. Developers are also responsible for complying with all applicable laws, including not infringing on Claimpower or others’ intellectual property rights. Developers are also responsible for complying with all MU and other applicable compliances required for their application that use Claimpower API. Some Interfaces listed on Claimpower API link may require customer to license additional functionality or build additional workflows or features, so developers are encouraged to work closely with Claimpower and Mutual Customers. |
|
5. |
Claimpower makes no representations, warranties, or guarantees regarding any information provided by the Claimpower API or the results obtained from any 3rd Party App. or the use of any product or service and shall not be responsible or liable for any errors or omissions in that information or the results obtained from any such use. |
|
6. |
Client applications using the service for API calls require an identifier to connect. Client identifier creation can be accomplished by vendors, in the case of patient facing applications, or organizations, in the case of provider-facing applications. |
|
7. |
You will not, through use of the Claimpower API create Application, or other code or program that would disable, hack or otherwise interfere with any security, digital signing, digital rights management, verification or authentication mechanisms implemented in or by the Claimpower API, Claimpower EHR, any services or other Claimpower software or technology, or enable others to do so. |
|
8. |
We reserve right on case by case basis to do a background check of developer. This may require additional documentation from developer. |
|
9. |
Entity representation: If you are using the Claimpower API on behalf of a legal entity (i.e. an App company), you represent that you have proper authority to act on behalf of and bind the entity to these Terms, and by accepting, you accept on behalf of the entity (and all references to “you” in the Terms refer to the entity). |
|
10. |
End User Use: In order to use application developed using Claimpower API, end user has to be active registered user of Claimpower. |
|
11. |
Applications must not contain any malware, malicious or harmful code, program, or other internal component (e.g., computer viruses, Trojan horses, “backdoors”) which could damage, destroy, or adversely affect the Claimpower API, Claimpower Software, services, or other software, firmware, hardware, data, systems, services, or networks. |