Comments for Roll Up Scores for Multiple Physicians or Locations
If multiple physician and/or locations are sent in an API call, the output will be one rollup score per physician/location.
Endpoint
POSThttps://api1.consumerism.pressganey.com/api/bsr/comments
Header Parameters
| Property | Type | Description | Required/Optional |
|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | URL Encoded request body | Required |
| Access-Token | String | Access token received from the platform | Required |
POST Request Parameters
Required Fields
| Property | Type | Description | Required/Optional |
|---|---|---|---|
| entityId | String | Unique identifier of a Location. You can get this unique codes from the Mapping file. You can pass multiple location ID as &locationID=123&locationId=234 | Required |
Optional Request Parameters
Following parameters are optional fields you can pass to customize the results. You don't have to pass any of these, and we will use the default/industry standard values here.
| Property | Type | Description | Default Value |
|---|---|---|---|
| page | Integer | The page to return containing the requested number of testimonials per page | 1 |
| perPage | Integer | The number of reviews per page | 20 |
| days | Integer | Maximum age of the reviews in days. For example, days=7 means reviews from the past 1 week | 365 |
| fromDate | String | Start timestamp (use fromDate and toDate together and it has precedence over days). Format - ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z') | |
| toDate | String | End Timestamp (use fromDate and toDate together and it has precedence over days). Format - ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z') | |
| minSurveyCount | Integer | Returns responses only when there are at least as many ratings as specified in minRatingCount. | 0 |
| minRatingCount | Integer | Returns responses only when there are at least as many ratings as specified in minRatingCount. | 30 |
| minWordCount | Integer | Returns only those reviews, which have minimum number of words in it. | 0- meaning, no restriction on word count |
| showRatings | Boolean | If you don't need rating, send this parameter as false | true |
| showComments | Default | If you don't need comments, send this parameter as false | true |
| additionalFields | List<String> | List of string which specifies the additional fields needed in the API response. See additional fields section for more details. |
Additional fields
Following are the list of additional fields we support. You can pass any one of them as a list, and you will get corresponding fields in the output.
| Property | Type | Description | Required/Optional |
|---|---|---|---|
| reviewSummary | String | API will return an AI generated summary of comments for a provider or location. These summaries reference the last 90 days of published comments. The minimum comment limit is 5. | Optional |
JSON Response
A JSON object containing the latest comments for the requested locations. Each JSON object within entities JSONArray represents a single location.
{
"status": {
"message": "success",
"code": 200
},
"data": {
"client": "Test Client",
"entities": [
{
"id": "123456",
"name": "Surgical Services",
"reviewSummary":"The reviews highlighted several positive points about the healthcare provider. Patients felt the doctor was professional, caring, a good listener, and took time to understand their concerns. Multiple patients were very happy with their treatment and grateful for the care they received. However, one patient had an unsatisfactory experience feeling the doctor seemed annoyed, rushed, and uncaring about their condition. This highlights an opportunity for the provider to improve patient interactions by showing more empathy, fully listening to patient concerns, and taking whatever time is needed, regardless of schedule constraints. Additionally, the cost of prescriptions should be considered to provide affordable treatment options. Overall most patients reported very positive experiences feeling heard, understood, and effectively treated. But the one negative review shows room for improving patient interactions and affordability of care. Addressing those factors could help create consistently positive experiences for all patients.",
"totalCommentCount": 11,
"totalRatingCount": 14,
"totalSurveyCount": 48,
"overallRating": {
"name": "Overall Satisfaction",
"value": 3.5,
"questionRatings": [
{
"name": "Please rate your overall satisfaction:",
"value": 3.5,
"responseCount": 33
}
]
},
"comments": [
{
"id": 23654444,
"source": "Test Survey",
"mentionTime": "2017-05-28T07:05:03Z",
"wordCount": 3,
"comment": "Test Survey feedback",
"ratings": [],
"response": {
"responseText": "thank you for your feedback",
"respondedBy": "bf Administrator",
"respondedTime": "2017-05-28T07:06:19Z"
}
},
{
"id": 23653088,
"source": "Patient Experience Survey",
"mentionTime": "2017-05-28T05:44:23Z",
"wordCount": 2,
"comment": "only comment",
"ratings": []
},
{
"id": 23653055,
"source": "Patient Experience Survey",
"mentionTime": "2017-06-28T04:44:28Z",
"wordCount": 5,
"comment": "Great comment with annotation",
"ratings": [
{
"name": "Ease of Scheduling",
"value": 3.75
}
],
"response": {
"responseText": "Final annotation edited by Avatar",
"respondedBy": "bf Administrator",
"respondedTime": "2017-05-28T05:30:37Z"
},
"overallRating": {
"name": "Overall Satisfaction",
"value": 2.5
}
},
{
"id": 23653033,
"source": "Patient Experience Survey",
"mentionTime": "2017-06-27T16:59:39Z",
"wordCount": 4,
"comment": "Excellent Comment by dolphin",
"ratings": [
{
"name": "Ease of Scheduling",
"value": 3.75
}
],
"overallRating": {
"name": "Overall Satisfaction",
"value": 3.75
}
},
{
"id": 23652626,
"source": "Patient Experience Survey",
"mentionTime": "2017-05-19T10:11:55Z",
"wordCount": 2,
"comment": "Excellent service!",
"ratings": [
{
"name": "Ease of Scheduling",
"value": 2.5
}
],
"response": {
"responseText": "Thanks for your feedback",
"respondedBy": "Chase Ausley",
"respondedTime": "2017-06-28T14:39:32Z"
},
"overallRating": {
"name": "Overall Satisfaction",
"value": 2.5
}
},
{
"id": 23652572,
"source": "Patient Experience Survey",
"mentionTime": "2017-06-19T09:56:00Z",
"wordCount": 3,
"comment": "good Secure survey",
"ratings": [
{
"name": "Ease of Scheduling",
"value": 3.13
}
],
"response": {
"responseText": "test 123 edited",
"respondedBy": "bf Administrator",
"respondedTime": "2017-06-22T09:28:42Z"
},
"overallRating": {
"name": "Overall Satisfaction",
"value": 1.25
}
},
{
"id": 23652477,
"source": "Patient Experience Survey",
"mentionTime": "2017-06-16T11:51:10Z",
"wordCount": 5,
"comment": "Excellent comment by tpk tester",
"ratings": [
{
"name": "Ease of Scheduling",
"value": 3.13
}
],
"overallRating": {
"name": "Overall Satisfaction",
"value": 5
}
},
{
"id": 23652460,
"source": "Patient Experience Survey",
"mentionTime": "2017-06-16T11:40:03Z",
"wordCount": 4,
"comment": "excellent with overall rating",
"ratings": [
{
"name": "Ease of Scheduling",
"value": 2.5
}
],
"overallRating": {
"name": "Overall Satisfaction",
"value": 2.5
}
},
{
"id": 23652445,
"source": "Patient Experience Survey",
"mentionTime": "2017-06-16T10:39:08Z",
"wordCount": 5,
"comment": "services are really good",
"ratings": [
{
"name": "Ease of Scheduling",
"value": 1.25
}
]
},
{
"id": 23652398,
"source": "Patient Experience Survey",
"mentionTime": "2017-05-16T05:10:34Z",
"wordCount": 6,
"comment": "very good care provider - dolphin",
"ratings": [
{
"name": "Ease of Scheduling",
"value": 3.8
}
],
"response": {
"responseText": "test response",
"respondedBy": "bf Administrator",
"respondedTime": "2017-06-16T07:00:55Z"
}
},
{
"id": 23653147,
"source": "Patient Experience Survey",
"mentionTime": "2017-05-20T07:20:48Z",
"wordCount": 2,
"comment": "good one",
"ratings": []
}
],
"totalPages": 1,
"ratings": [
{
"name": "Ease of Scheduling",
"value": 4.1,
"questionRatings": [
{
"name": "Please rate the ease of scheduling the appointment:",
"value": 4.1,
"responseCount": 44
},
{
"name": "Please rate the courtesy and helpfulness of the office staff:",
"value": 4.2,
"responseCount": 40
}
]
}
]
}
],
"filter": {
"minThreshold": 0,
"minRatingCount": 30,
"minSurveyCount": 0,
"minWordCount": 0,
"days": 365,
"page": 1,
"perPage": 20,
"showComments": true,
"showRatings": true,
"configVersion": "v2",
"period": {
"to": "2017-06-28T14:41:56Z",
"from": "2016-05-28T00:00:00Z"
}
}
}
}
JSON Response Parameters
| Property | Type | Description |
|---|---|---|
| data.filter | Object | The filters applied on the testimonials |
| data.client | String | Organization Name in our dashboard |
| data.entities | Array | The physician entities for which data is being returned |
| data.entities.id | String | Unique identifier of the entity |
| data.entities.name | String | The name of the entity |
| data.entities.reviewSummary | String | The Review Summary of the entity |
| data.entities.totalRatingCount | Integer | Total number of survey responses available for primary rating. |
| data.entities.totalCommentCount | Integer | Number of actual comments available for the entity |
| data.entities.totalSurveyCount | Integer | Total number of surveys available for the entity |
| data.entities.overallRating.name | String | Overall Rating name |
| data.entities.overallRating.value | Decimal | Overall rating of the Provider |
| data.entities.overallRating.questionRatings | Array | Individual question level rating which contributed for the overall rating |
| data.entities.overallRating.questionRatings.name | String | Question name contributed for overall rating |
| data.entities.overallRating.questionRatings.value | Decimal | Star rating of the question |
| data.entities.overallRating.questionRatings.responseCount | Integer | No. of responses received for this question |
| data.entities.ratings | Array | The ratings for this entity |
| data.entities.ratings.name | String | The name of the rating |
| data.entities.ratings.value | Decimal | The score |
| data.entities.ratings.questionRatings | Array | List of questions used for calculating this rating |
| data.entities.ratings.questionRatings.name | String | Question text |
| data.entities.ratings.questionRatings.value | Decimal | Question rating |
| data.entities.ratings.questionRatings.responseCount | Integer | Total number of responses for this question |
| data.entities.comments | Array | The comments for this entity |
| data.entities.comments.id | Integer | Unique identifier of the Comment |
| data.entities.comments.comment | String | The comment content |
| data.entities.comments.overallRating | Object | Overall rating of the comment |
| data.entities.comments.overallRating.name | String | Overall rating name |
| data.entities.comments.overallRating.value | Decimal | Overall rating of the comment |
| data.entities.comments.ratings | Array | Individual ratings |
| data.entities.comments.ratings.name | String | The name of the rating |
| data.entities.comments.ratings.value | Decimal | Individual question rating |
| data.entities.comments.mentionTime | Datetime (ISO-8601) | The date & time at which this review was mentioned |