Social History

The Social History feature allows the user return/update a collection of the patient's behavioral history, such as smoking, exercise, etc. Some of these social history areas can be configured by the practice using templates. A user cannot configure the questions on the templates via the API; they must be configured in athenaNet. However, the social history template API endpoints can switch out the local templates being used to ask social history questions. Global templates always show by default, and cannot be hidden on a per patient basis. They can be hidden globally or with patient demographic filters using the "New Social History" admin page. If a local template is switched by the practice or through the API, the questions and answers retrieved will be those associated with the new template.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Get patient's social history data
GET
/v1/{practiceid}/chart/{patientid}/socialhistory

Retrieves the social history information of a specific patient

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
recipientcategory string The intended audience for the data. If given, questions marked as confidential for this audience will be withheld.
departmentid integer The athenaNet department id.
shownotperformedquestions boolean Include questions that the provider did not perform.
showunansweredquestions boolean Include questions where there is no current answer.

Output Parameters

Expand all
questions array The social history questions and answers for this patient.
sectionnote string A section-wide note.
templates array The selected social history templates for this patient.
Example Code
Update patient's social history data
PUT
/v1/{practiceid}/chart/{patientid}/socialhistory

Modifies the social history information of a specific patient

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

❙ Request Body

Expand all
departmentid integer The department for this patient. A patient may have multiple charts, and the department determines which chart to retrieve.
questions array The list of question/answer pairs to be submitted. A JSON array of questions mimicking <a href="https://developer.athenahealth.com/docs/read/chart/Social_History">the inputs</a> described in the PUT call. Only the questions submitted will be added/updated/deleted.
sectionnote string A section-wide note

Output Parameters

Expand all
message string On failure, the reason for failure
success string Whether the operation was successful.
Example Code
Get patient's social history templates
GET
/v1/{practiceid}/chart/{patientid}/socialhistory/templates

Retrieves a list of selected social history templates for specific patient

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
departmentid integer The athenaNet department id.

Output Parameters

Expand all
templateid integer ID for this social history template
templatename string Name for this social history template
Example Code
Set the list of social history questions for this patient.
PUT
/v1/{practiceid}/chart/{patientid}/socialhistory/templates

No description

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

❙ Request Body

Expand all
departmentid integer The athenaNet department id.
templateids string A comma separated list of template IDs to display in the social history section.

Output Parameters

Expand all
message string On failure, the reason for failure
success string Whether the operation was successful.
Example Code
Get list of social history questions and templates used by this practice
GET
/v1/{practiceid}/chart/configuration/socialhistory

Retrieves a list of configured social history templates and questions for this practice.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

Output Parameters

Expand all
questions array List of questions contained by this template
templateid integer ID for this social history template
templatename string Name for this social history template
Example Code