Overview

Lorem Ipsum

REST Implementation

Our API uses REST Web Services to implement create, replace, update, and delete (CRUD) functions.

  • GET operations are used for inquiry requests.
  • The DELETE verbs are not used or implemented by Imagine.
  • Unless otherwise specified, PUT operations are required for each service.
  • The REST Service expects all properties encoded as US ASCII Strings.

This web service uses the JSON (JavaScript Object Notation) method of encoding data for transmission via the HTTP network protocol. Most programming languages have libraries to convert an arbitrary object to and from a JSON data transfer encoding. Imagine provides a sample client application in the JAVA language implementing all functions described herein.

For access contact bob@imaginefertility.com

 

 

Connecting to the Server

The CardConnect REST Web Service base URL includes a protocol, host, port and servlet specification.

https://<site>.imaginefertility.com:<port>/api/v1/

 

Testing Your Credentials

To test and validate site-level credentials, you can make a GET request with no body to the base URL. 

For example:

GET /api/v1/ HTTP/1.1

If the credentials are valid, the response returns the message “Imagine REST Servlet.” 

This represents an HTTPS request to the REST web service base URL. The servlet name is fixed within the application; the host and port are assigned by Imagine. 

A username and password are required in the HTTP Authorization Header property in each API request. You can use either the site-level or MID-level API credentials that you received from Imagine. 

Basic Authorization is expected, using a Base64-encoded username and password string as the value. If this value is incorrect or not provided in the request header, an HTTP Exception “401:Unauthorized” is returned to the caller

Patient

METHODS: GET, POST

/patient/

All required fields are used to evaluate for duplication of patient records.

emr: Numeric unique patient id from the electronic medical records system. Used for duplicate checking. REQUIRED.

centerid: This is the id number of the clinic, in the case of multiple mutually shared clients. REQUIRED.

Firstname: Varcar(50) field. REQUIRED FOR POST.

Lastname: Varcar(50) field. REQUIRED FOR POST.

address1: Varcar(50) field.

address2: Varcar(50) field.

city: Varcar(50) field.

state: Varcar(50) field.

zip: Varcar(50) field.

email: Varcar(50) field.

phone: Varcar(50) field.

dob: Date of Birth. Varcar(50) field. REQUIRED FOR POST.

 

DocuSign

METHODS: GET

/docusign/

emr: Numeric unique patient id from the electronic medical records system. Used for duplicate checking. REQUIRED.

centerid: This is the id number of the clinic, in the case of multiple mutually shared clients. REQUIRED.

DOCUSIGN: This is the Imagine ID number of the docusign envelope.

envelope: This is the UUID of the envelope from docusign.

status: This is the status of the envelope. Sent, Open, Voided, or Complete.

updated: The last datetime the envelope was updated on DocuSign.

package: The name of the treatment package the Docusign Agreement was created for.

amount: The total amount of the package.

Firstname: Varcar(50) field. REQUIRED FOR POST.

Lastname: Varcar(50) field. REQUIRED FOR POST.

 

Notes

METHODS: GET, POST

/notes/

emr: Numeric unique patient id from the electronic medical records system. Used for duplicate checking. REQUIRED.

centerid: This is the id number of the clinic, in the case of multiple mutually shared clients. REQUIRED.

createdate: Date and time of the note.

note: This is the text of the note entered.

user: The name of the user who created the note. ON POST: This is a number you will be assigned.

emrid: The emr id of the patient with the note. Used for data validation.

{
             “centerid”: “”,
              “emr”: “”,
              “Firstname”: “”,
              “Lastname”: “”,
              “address1”: “”,
              “address2”: “”,
              “city”: “”,
              “state”: “”,
              “zip”: “”,
              “email”: “”,
              “phone”: “”,
              “DOB”: “”,
}

{

          “emr”:””
          “centerid”:””
         “DOCUSIGN”:””
         “envelope”:””
         “status”:””
         “updated”:””
         “package”:””
         “amount”:””
         “Firstname”:””
         “Lastname”:””

}

{

          “createdate”:””
          “note”:””
         “user”:””
         “emrid”:””
}