eirenerx-sdk
v0.1.8
Published
EireneRx JavaScript SDK
Downloads
12
Readme
EireneRx API SDK
This is a javascript client sdk to implement the click-through integration process for EireneRx Vendors.
Install
Client-Side
bower install eirenerx-sdk
Server-Side
npm install eirenerx-sdk
Usage
<script src="/eirenerx.js"></script>
EireneRx.ePrescribeLink({
key: 'YOURKEY',
secret: 'YOURSECRET',
email: 'UsersEmail',
sponsor: 'UsersCustomerId',
identifier: 'Patient Identifier'
}, callback);
function callback(err, url) {
// url contains link to be clicked
}
EireneRx.getPatient({
key: 'YOURKEY',
secret: 'YOURSECRET',
sponsor: 'CUSTOMERID',
center: 'CUSTOMER_LOCATION_ID'},
identifier,
callback);
function callback(err, patient) {
// if not found returns a new patient object to be saved
// * see add patient example in examples folder *
// if found returns a patient object to be saved
// * see update patient example in examples folder *
patient.save(patient, callback);
});
var hooks = EireneRx.webhooksModule;
hooks = {
lists();
create();
update();
delete();
};
API
EireneRx global contains two methods:
- ePrescribeLink
- getPatient
ePrescribeLink
ePrescribeLink
takes the following parameters:
- options
- callback
The options
object must contain the following key-value pairs:
- key - Your Key ID
- secret - Your Secret Id
- sponsor - Customer Id
- email - User's Email Address
- identifier - Patient's Identifier
The callback
function will return two parameters:
- err - if not null then an error has returned from the method call.
- url - if no error, the full url to attach to your interface is returned.
getPatient
getPatient
will return a full patient object, enable you to make modifications and update EireneRx with those modifications. It takes two parameters:
- options
- identifier
- callback
The options object should contain the following key-value pairs:
- key - Your Key ID
- secret - Your Secret Id
- sponsor - Customer Id
- center - Customer Center Id
The identifier
- identifier - Patient Identifier Id
The callback function is executed when the return response is made from the api. The callback has two arguments:
- err - if the err object is not null then an error has occured.
- patient - if no error the patient object will return an empty object if the patient does not exist in EireneRx, or will contain the completed information for the patient.
In the call back function you may add/modifiy the patient objects values and to persist back to the eirenerx api, simply call the patient.save()
method.
TODO: WebSockets for Medication Events!!!!
Development Release Process
npm run dist
git push origin master
git push --tags
npm publish
LICENSE
MIT
Contribution
TODO: Add Contribution Requirements
- StyleGuide: http://nodeguide.com/style.html