documenter.getpostman.com Open in urlscan Pro
2606:4700:4400::ac40:9a6a  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Public


Documentation Settings

ENVIRONMENT
No Environment

LAYOUT
Double Column

LANGUAGE
cURL - cURL



ICANotes API
Introduction
Terms and Conditions of Use
Authentication
HTTP Methods
Response
Errors
API Call Limit
How to Use
FAQ
PatientID
PatientDemographics
PatientCCD
AllergyIntolerance
MedicationRequest
Condition
Observation
DiagnosticReport
Immunization
Procedure
Device
CarePlan
Goal
Care Team


ICANOTES API

Document Version 1.1
API Version 1.0
ICANotes Version 11.6

The ICANotes API (hereinafter "The API" or "The ICANotes API") allows you to
perform various operations with our API services using a client that supports
https via ssl. Please continue reading below for further information.

The API is built using predictable URLs that make writing application easy. The
API follows HTTP rules, enabling a wide range of HTTP clients to interact with
the API.

This entire document is be a public facing URL that is listed in
https://chpl.healthit.gov/#/search


TERMS AND CONDITIONS OF USE

Please read these Terms of Use before using the API hosted on ICANotes. These
terms of Use apply to all users of the API. If you do not agree with these Terms
of Use, do not use the API. Usage of the API constitutes acceptance of these
Terms of Use.


PURPOSE

The purpose of the API is to allow you to access the protected PHI of patients.
The documentation is provided to developers as stated in this document with no
other warranties, either expressed or implied. ICANotes retains the rights to
the intellectual property contained in the API.


USAGE

Developers may use the API provided they adhere to the following terms and
conditions:

   

 * Protect the password that you use to access the API and for all activities
   performed using the password. Do not share the password. Report any breach of
   security or unauthorized use of the password to ICANotes immediately.

   

 * Developers are responsible for adhering to all relevant laws, including but
   not limited to, HIPAA and violation of intellectual property rights.

   

 * Use the most current version of the API which is available through the
   ICANotes website. ICANotes reserves the right to monitor usage of the API to
   protect the integrity, confidentiality and security of PHI. ICANotes may
   update the API at any time without notification to the developers.

   

 * Developers may keep copies of the API documentation for their own use. It
   should not be shared with others. To share the documentation with other
   developers, developers should provide the link to the API on the ICANotes
   website.

   


LICENSE

ICANotes grants you a non-exclusive, non-transferable, limited revocable license
to access the ICANotes API. You may not, on your own, or through a third party,
attempt to derive the source code of the API or modify and create a derivative
work based on the components of the API.


TERMINATION

ICANotes may terminate the right to use and access the API if it is determined
that usage is in violation of these terms and conditions.


AMENDMENT

ICANotes reserves the right to amend these terms. We will try to provide notice
prior to amended terms taking effect. Any amendment will be effective upon
posting of the updated terms on the ICANotes API site.


AUTHENTICATION

All ICANotes API endpoint requests are required to have a:

   
 * userKey
   
 * userToken
   

This may be obtained by logging into the Patient Portal and requesting the
credentials.

These values are then entered as parameters into the request. For example:
https://r2.icanotes.com/API/EndPoint?userKey={{userKey}}&userSecret={{userSecret}}


POINTS TO NOTE

   

 * You can manage (regenerate or delete) your active userTokens created at the
   Patient Portal.

   

 * userTokens do not get deleted unless you delete them from the Patient Portal
   page yourself. There is no need to create multiple userTokens to send out
   requests, but you do have the ability to generate as many as needed.

   

 * userTokens carry important information about your identity. Please be sure to
   keep them secure and secret.

   


HTTP METHODS

At Present, ICANotes API uses the following HTTP Verbs for every action:

   
 * GET
   
 * POST
   


RESPONSE

Responses will be in JSON format.


ERRORS

ICANotes API uses HTTP status codes to indicate the success or failure of an API
call. In general, status codes in the 2xx range means success; 4xx range means
there was an error in the provided information, and those in the 5xx range
indicates server side errors. Commonly used HTTP status codes are listed below:

Status Code Descriptions 2xx Success 4xx Bad request sent to server 5xx Server
Side Error

View More

Status Code Description 200 Success - The request was successfully completed.
400 Bad request - The request cannot be performed, usually because of malformed
parameter or missing parameter. 401 Unauthorized (Invalid AuthToken) - The
request was rejected because of an invalid AuthToken. 403 Forbidden - The user
does not have enough permission, is possibly not an user of the respective
organization to access the resource, or the request to the API was sent
incorrectly. 429 Too many requests - Too many requests were made within a
certain time frame. 500 The ICANotes API server encountered an error which
prevents it from fulfilling the request. Although this rarely happens, we
recommend you to contact us at ticket@icanotes.com if you receive this error.
Please be sure to include the error message, what endpoint you were trying to
access, and any other pertinent data you feel may be relevant. Thank you!


API CALL LIMIT

ICANotes' API at present does not impose an overall API request limit. However
this is subject to change at any time asper our API TOS. We do however, have
safeguards in place that promote a better quality of service and availability to
users. To make sure everyone is serviced in a timely manner, if users attempt to
abuse, overload, or spam the endpoints, they will receive a 429 status code.
They will then need to wait 15 minutes before attempting to try their access
again.


HOW TO USE

In order to utilize this API there are a few things that must first be
configured. Although we have the ability to interact with any client that
supports http transactions via ssl, our supported client is Postman. You do not
need any third party software for this to work however.

   
 * You must first download the Postman collection of our API endpoints.
   
 * You must obtain the userKey and userSecret by going to the patient portal of
   ICANotes.
   
 * You must then open Postman.
   
 * Click on the gear in the upper right of Postman, and choose "Create an
   Environment".
   
 * Specify the environment name.
   
 * Enter a variable called userKey - this is the userKey obtained from the
   Patient portal.
   
 * Enter a variable called userSecret - this is the userSecret obtained from the
   Patient portal.
   
 * Place a call to the PatientID endpoint.
   
 * Take the patientID value that was returned, we then create a variable called
   patientID.
   
 * You are now ready to begin using the API endpoints via Postman.
   


FAQ

   
 * How do I obtain a patient's lab orders?
   

   
 * In the Observation endpoint, you may query for a patient's lab results with
   their patientID.
   

   
 * How do I obtain a patient's UDI information?
   

   
 * In the Device endpoint, the UDI information for the patient's device is
   returned in the udi data object, which is returned with any queries made to
   the endpoint.
   

   
 * How do I obtain a patient's Assessment and Plan of Treatment information?
   

   
 * In the Care Plan endpoint, if there is assessment and treatment information
   which was generated for a patient within the scope of the current query, that
   information will be displayed.
   

   
 * How do I obtain a patient's name, sex, date of birth, race, ethnicity, and
   preferred language?
   

   
 * That information can be queried from the demographics endpoint.