Visit Record

Introduction

The Press Ganey Consumer Experience Visit Record API is a set of HTTP based REST services. Before using the API, an Application must be provisioned by Press Ganey Consumer Experience. The Application credentials will be made available in the API settings page of the Consumer Experience 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 Visit Record

API endpoint to create patient or customer visit record.

Endpoint

POSThttps://api1.consumerism.pressganey.com/api/service/visitrecord/create

Header Parameters

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

Request JSON Parameters

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

Property	Type	Description	Required/Optional
name	String	The name of the patient or customer. Do not populate if using firstName, middleName, and lastName format.	Required
firstName	String	First name of the patient or customer.	Optional
middleName	String	Middle name of the patient or customer.	Optional
lastName	String	Last name of the patient or customer.	Optional
email	String	Email id of the patient or customer	Required
phone	String	Phone no. of the patient or customer	Optional
age	Integer	Age of the patient or customer	Optional
address	String	Address of the patient or customer.	Optional
zipCode	String	Zip Code of the patient or customer.	Optional
customerUniqueId	String	Unique patient or customer ID. This can be set as the same value as medicalRecordId. If both values are provided, medicalRecordId will take precedence.	Optional
medicalRecordId	String	Unique Medical Record Number (MRN) of patient (healthcare specific). This can be set as the same value as customerUniqueId. If both values are provided, medicalRecordId will take precedence.	Optional
visitTime	String	The visit time of the patient or customer, provided in ISO 8601 format. Property is used for Campaign timing triggers.	Optional
visitRecordId	String	Unique identifier for the visit. This field ensures the event's idempotency.	Optional
locationName	String	Location name. Name of hospital, restaurant, hotel, etc.	Optional
locationCode	String	The location code shared with PG. ID code for hospital, restaurant, store, hotel, etc.	Required
npi	String	NPI no. of the physician consulted (healthcare specific).	Required
dataFeedId	Integer	Determines the API feed name (e.g., API Feed - 100). Used to segment the data sent to the PG platform.	Optional

Sample Request Payload:

[
    {
        "address": "Tysons Corner",
        "age": 50,
        "customerUniqueId": "12367213548-4646",
        "dataFeedId": 100,
        "email": "johndoe@gmail.com",
        "firstName": "John",
        "lastName": "Doe",
        "locationCode": "741852",
        "locationName": "adsas",
        "middleName": "M",
        "name": "John Doe",
        "npi": "1324567980",
        "phone": "9874561230",
        "visitRecordId": "2312346587-43213",
        "visitTime": "2021-11-01T12:30:00Z",
        "zipCode": "98561"
    },
    {
        "address": "Tysons Corner",
        "age": 50,
        "customerUniqueId": "12367213548-4644",
        "dataFeedId": 100,
        "email": "janesmith@gmail.com",
        "firstName": "Jane",
        "lastName": "Smith",
        "locationCode": "741852",
        "locationName": "adsas",
        "middleName": "M",
        "name": "Jane Smith",
        "npi": "1324567980",
        "phone": "9874561230",
        "visitRecordId": "2312346587-43214",
        "visitTime": "2021-11-01T12:30:00Z",
        "zipCode": "98561"
    }
]

Response JSON Parameters

Property	Type	Description
message	String	Shows the status message
code	String	Shows the status code
records	String	Returns the requested visit record id with success or error state

{
    "records": {
        "2312346587-43213": "Error",
        "2312346587-43214": "Success"
    },
    "status": {
        "code": 200,
        "message": "success"
    }
}