NAV Navbar
JSON

Access Token API

Create new Access Token

This API call returns a new access token.

Endpoint

POST https://api1.consumerism.pressganey.com/api/service/v1/token/create

Request Parameters

Parameter Default Description Required/Optional
appId String Application ID of the Application that was created to access the API Required
appSecret String Application Secret. Keep this info secret because it acts as the password Required

Response

The call returns a JSON object which contains an access token and its expiry time. This access token is required to retrieve data using the REST API.

{
  "accessToken": "Wz78OmgKtowHppizWjxO7mqms7+8q1QfjaQfb9WUBooVI6IZmp5V/w==",
  "status": {
    "message": "Success",
    "code": 200,
  },
  "expiresIn": "2014-08-22 09:11:20"
}

Response Parameters

Property Type Description
status JSON Object Indicates the status of the response
code Number Status code for the response. Possible codes are: 200 – Success 400 – Bad Request 500 – Internal Server Error
message String Detailed message from the server about the status
accessToken String Access token for authentication. This access token is valid until the expiry time indicated in the response
expiresIn String Date time when the access token will expire

Patient Visit Record API

Introduction

The Press Ganey Consumer Solutions Patient Visit Data API is a set of HTTP based REST services. Before using the API, an Application must be provisioned by Press Ganey Consumer Solutions. The Application credentials will be made available in the API settings page of the Binary Health Analytics platform. The Application ID and Application Secret create a unique combination that will be used for authorization in all the API calls. Use the Application ID and Application Secret to receive an Access Token. The access token is needed to start making server to server API calls and is valid for a limited period of time.

Create Patient Visit Record

API endpoint to create patient visit record.

Endpoint

POST https://api1.consumerism.pressganey.com/api/service/visitrecord/create

Header Parameters

Property Type Description Required/Optional
Content-Type application/json Content in JSON format Required
Access-Token String Access token received from the platform Required

Request JSON Parameters

The body of the POST request will include an array of patient records, each with following elements.

Property Type Description Required/Optional
name String Name of the patient Required
firstName String First name of the patient Optional
middleName String Middle name Optional
lastName String Last name Optional
email String Email id of the patient Required
phone String Phone no. of the patient Optional
gender String Gender info of the Patient.Expected valuesM => Male F => Female Optional
age Integer Age of the patient Optional
address String Address Optional
zipCode String Zip Code Optional
medicalRecordId String Internal Medical record id Optional
visitTime String Visit Time of the patient.Provide this in ISO 8601 format Optional
visitRecordId String Current Visit Record id Optional
locationName String Location name Optional
locationCode String Location code (shared with BF) Required
npi String NPI no. of the physician consulted Required 
[
{
"name": "John Doe",
"firstName": "John",
"middleName": "M",
"lastName": "Doe",
"email": "johndoe@gmail.com",
"phone": 9874561230,
"gender": "M",
"age": 50,
"address": "Tysons Corner",
"zipCode": "98561",
"medicalRecordId": "12367213548-4646",
"visitTime": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"visitRecordId": "2312346587-43213",
"locationName": "adsas",
"locationCode": "741852",
"npi": "1324567980"
},
 {
"name": "Jane Smith",
"firstName": "Jane",
"middleName": "M",
"lastName": "Smith",
"email": "janesmith@gmail.com",
"phone": 9874561230,
"gender": "M",
"age": 50,
"address": "Tysons Corner",
"zipCode": "98561",
"medicalRecordId": "12367213548-4644",
"visitTime": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"visitRecordId": "2312346587-43214",
"locationName": "adsas",
"locationCode": "741852",
"npi": "1324567980"
}
]

Response JSON Parameters

Property Type Description
message String Shows the status message
code String Shows the status code
records String Returns the requested users email with success or error state 
{
"status": {
"message": "success",
"code": 200
},
"records": {
"johndoe@gmail.com": "Success",
"janesmith@gmail.com": "Error"
}
}
JSON