Review of Systems

The Review of System (ROS) section allows the provider to record information about the review of system option of the encounter. This feature will allow the user to retrieve or modify the Review of Systems summary. Review of Systems Templates Reference are configured in the system. The user will be able to retrieve the list of ROS templates.

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

Endpoints

Get review of systems findings and notes for given encounter
GET
/v1/{practiceid}/chart/encounter/{encounterid}/reviewofsystems

Retrieves a Physical Exam summary for a specific encounter

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
encounterid integer encounterid
showstructured boolean If true, returns the review of systems as structured data. If false, returns it via lightly-HTML marked up English text, as displayed in the athenanet encounter summary.
wellchildtemplateids array If wellchildtemplateids are passed in, this will return only the template data for the ids passed in, and not the data selected for the current encounter. The showstructured flag must be true to use this. This can be used in conjunction with templateids.
templateids array If templateids are passed in, this will return only the template data for the ids passed in, and not the data selected for the current encounter. The showstructured flag must be true to use this. This can be used in conjunction with wellchildtemplateids.

Output Parameters

Expand all
hpitoros string Whether ROS is as noted in HPI.
lastmodifiedby string A string representing the username of the user who last modified the review of systems section.
lastmodifieddatetime string The last time any information in the review of systems section was modified
reportedby string The type of person who reported information for the review of systems template. One of Patient, Parent, Caregiver, or Staff.
reviewofsystems array The structured review of systems data. It is structured as a list of paragraphs, each containing a list of sentences, each containing a list of findings.
sectionnote string The structured section-level note for the review of systems section.
sectionnotelastmodifiedby string A string representing the username of a the user who last modified the review of systems section note.
sectionnotelastmodifieddatetime string The last time the review of systems section note was modified
summarytext string The unstructured review of systems summary.
templatedata array An array of objects each containing the name and id for review of systems templates attached to the encounter.
templates string The comma separated list of selected review of systems templates used.
wellchildlastmodifiedby string A string representing the username of the user who last modified the well child review of systems section.
wellchildlastmodifieddatetime string The last time any information in the well child review of systems section was modified
wellchildreportedby string The type of person who reported information for the well child review of systems template. One of Patient, Parent, Caregiver, or Staff.
wellchildros array The structured well child review of systems data. It is structured as a list of paragraphs, each containing a list of sentences, each containing a list of findings. This is targeted towards children but behaves the same as any other review of systems templates.
wellchildsectionnote string The structured section-level note for the well child review of systems section.
wellchildsectionnotelastmodifiedby string A string representing the username of a the user who last modified the well child review of systems section note.
wellchildsectionnotelastmodifieddatetime string The last time the well child review of systems section note was modified
wellchildsummarytext string The unstructured well child review of systems summary.
wellchildtemplatedata array An array of objects each containing the name and id for well child review of systems templates attached to the encounter.
wellchildtemplates string The comma separated list of selected well child review of systems templates used.
Example Code
Update review of systems findings and notes for given encounter
PUT
/v1/{practiceid}/chart/encounter/{encounterid}/reviewofsystems

Modifies the Physical Exam summary for a specific encounter

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
encounterid integer encounterid
Content-Type string Content type of the payload

❙ Request Body

Expand all
hpitoros boolean Whether ROS is as noted in HPI.
replacesectionnote boolean If true, will replace the existing section note with the new one. If false, will append to the existing note.
reportedby string The type of person who reported information for the review of systems template. One of Patient, Parent, Caregiver, or Staff. This will always be set to null if you do not pass any templateids even if you set this to a non null value in the API. This is because this field is only valid when there is an ROS template added to the encounter.
reviewofsystems array This is a JSON structure containing everything you want the ROS to now contain. If you call the GET version of this call you can see some sample output. It is extremely important to note that anything you pass in will become the new ROS. Even if you only wish to make an addition, you will need to pass in the whole output of the GET plus your addition, otherwise anything you don't pass in will be removed.
sectionnote string The text to be updated to the review of systems section note for this encounter.
templateids array This is a JSON array of the template ids that should remain on (or be added to) the ROS. Any template ids not included in this list will be removed from the ROS.
wellchildreplacesectionnote boolean If true, will replace the existing well child section note with the new one. If false, will append to the existing note.
wellchildreportedby string The type of person who reported information for the well child review of systems template. One of Patient, Parent, Caregiver, or Staff. This will always be set to null if you do not pass any wellchildtemplateids even if you set this to a non null value in the API. This is because this field is only valid when there is a Well Child ROS template added to the encounter.
wellchildros array This is a JSON structure containing everything you want the well child ROS to now contain. If you call the GET version of this call you can see some sample output. It is extremely important to note that anything you pass in will become the new well child ROS. Even if you only wish to make an addition, you will need to pass in the whole output of the GET plus your addition, otherwise anything you don't pass in will be removed.
wellchildsectionnote string The text to be updated to the well child review of systems section note for this encounter.
wellchildtemplateids array This is a JSON array of the well child template ids that should remain on (or be added to) the ROS. Any template ids not included in this list will be removed from the well child ROS section.

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 'review of systems' findings and notes for given encounter
GET
/v1/{practiceid}/chart/encounter/{encounterid}/reviewofsystems/templates

BETA: Retrieves the list of Review of Systems templates for this encounter

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
encounterid integer encounterid
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
ageunits string The units for measuring age. (Y=years, M=months, W=weeks, D=days)
encountersection string The section this template belongs to. For this API, either ReviewOfSystems or WellChildROS.
maxage integer The maximum age filtered by this template
minage integer The minimum age filtered by this template
name string The name of the template
note string The note attached to this template
sex string The sex filtered by this template
templateid integer The template ID.
Example Code