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

Primary

GET

Get patient's social history
data

PUT

Update patient's social history
data

GET

Get patient's social history
templates

PUT

Set the list of social history questions for this
patient.
Reference

GET

Get list of social history questions and templates used by this
practice

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.

answer string The patient answer to this question

deprecated string A value of 1 indicates that the question has been deprecated. A deprecated question is a question that was previously supported, and is now considered obsolete for any number of reasons; it could've been replaced with another question, the nature of the question is no longer relevant, etc. While these questions may still be answered, the use of them is not recommended, and the question will display as "deleted" in the client's workflow.

key string Unique key for this question.

lastupdated string The date this answer was last updated (or first answered if never updated).

lastupdatedby string Username of the provider who last modified the answer to this question. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

note string The notes associated with this question.

notelastupdatedby string The username of the user who last updated the note. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

notelastupdateddate string The date this note was last updated (or first added if never updated).

notperformedreason string The reason this question was not performed.

ordering integer Display ordering for this question within this template

question string Human readable question

questionid integer (Deprecated) Unique ID for this question within this template.

templateid integer The template where this question is listed

sectionnote string A section-wide note.

sectionnotelastupdatedby string The username of the user who last modified the section note. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

sectionnotelastupdateddate string The date and time the section note was last modified. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

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