Gyn History

The Gynecology History feature will allow the user to view the list of question and their responses to the patient GYN history. The user will also be able to update the responses to the questions. The Gynecology (GYN) History Reference features allows the user to view the configured questions, select options to answer the question, etc. The GYN history section also contains custom questions, where each question follows its own format. This section may contain global or local questions defined by the practice. 

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 GYN history
GET
/v1/{practiceid}/chart/{patientid}/gynhistory
Retrieves the list of questions and their responses captured in the GYN History
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
questions array
sectionnote string Additional notes for the entire OB/GYN history section, if any
sectionnotelastmodifiedby string The username of the provider who last modified the section note. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.
sectionnotelastmodifieddatetime 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.
Example Code
Update patient's GYN history
PUT
/v1/{practiceid}/chart/{patientid}/gynhistory
Modifies the list of questions and their responses captured in the GYN History
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.
questions array A JSON array of questions mimicking <a href="https://developer.athenahealth.com/docs/read/chart/OBGYN_History">the input</a> described in the PUT call.
sectionnote string Any additional section notes

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code
Get list of GYN history questions asked by this practice
GET
/v1/{practiceid}/chart/configuration/gynhistory
Retrieve the configured list of questions and answers related to a patients GYN history.
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
showdeleted boolean Include deleted questions
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
deleted string True if this question has been deleted
inputtype string Input type expected for the answer
ordering number Used for re-ordering questions
question string Question being inquired about
questionid string Athena ID for the question
selectoptions array Options available for the answer (empty list means that there are no restrictions)
Example Code