Appointment Health History Form
The Appointment Health History form allows the user to retrieve appointment specific health history information, such as medications, allergies, social history. Health History Form ( appointment - specific) allows the user to view or update patient health history information, such as medications, allergies, social history. For more information, please refer Health History Forms workflow
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 list of health history forms for given
appointment
GET
/v1/{practiceid}/appointments/{appointmentid}/healthhistoryforms
Retrieves a list of history forms for a specific appointment
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
appointmentid
integer
appointmentid
Output Parameters
Expand all
description
string
Description of the form.
filledin
string
Date of most recent user edit for this form.
formid
integer
Athena ID for this form.
formname
string
Name of the form.
lastupdated
string
The last time the structure of this form was modified.
percentcomplete
string
Percent of the form completed by the patient.
populated
string
Date this form was generated.
totalcompletedsections
string
The number of sections that have been submitted and marked as complete.
totalsections
string
Total number of sections in this form.
Example Code
Get specific health history forms for given
appointment
GET
/v1/{practiceid}/appointments/{appointmentid}/healthhistoryforms/{formid}
Retrieves a specific Health history form for an appointment
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
formid
integer
formid
appointmentid
integer
appointmentid
shownullanswers
boolean
If true, unanswered questions in the medical history, surgical history, and vaccine sections return null. If false (default), they return 'N'.
Output Parameters
Expand all
ageunit
string
The units minage and maxage are in. 'M' for months, 'Y' for years.
complete
string
Marks whether this section has been completed by/signed off by the patient.
empty
string
If there were no changes to this section. "complete" must also be true for this to be considered.
fielddata
array
Describes the list of fields within 'questions' that are patient-editable, the input type, and any select option values.
filledin
string
The date this section was last updated by the patient.
helptext
string
Patient-facing description of the section.
maxage
integer
Maximum patient age for which this section should be shown.
minage
integer
Minimum patient age for which this section should be shown.
name
string
Patient-facing name of the section.
populated
string
Date when the form was created.
populatedfrom
string
Source of the form data. Can be 'Chart' or 'Previous Answer', depending on whether any previous patient modifications have been made.
portalformsectionid
integer
The athena ID for this section.
questions
array
List of questions and existing answers (if any) for this section. All of the fields in here must be returned as is, except the values within 'fields'.
Those can be set per the specified 'inputtype'. For the FAMILY history section, the 'question' => 'fields' section is an array and not a hash.
Each element of the array contains a hash of the specified 'fielddate' ('default', 'diedofage', 'onsetage', 'relationkeyid' (required), and 'relation' (required)).
To create new relations of a given type, specify a different numerical relationkeyid.
For the SOCIAL history section, questions with inputtype: "DROPDOWN" will have an array of "dropdownvalues".
Each item in "dropdownvalues" is an array containing a key and a value together, representing a dropdown option.
You should always display the value and save/return the key ("fields[default]" should be a dropdown key).
For all SOCIAL history section questions, a property of "deprecated" with 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.
sex
string
If set, this form only applies to the specified sex. Athena will be prefiltering on this field, so it's only for reference.
type
string
The section type. It can be MEDICATION, ALLERGY, MEDICAL, FAMILY, SURGICAL, SOCIAL, OBGYN, or VACCINATION.
Example Code
Update specific health history forms for given
appointment
PUT
/v1/{practiceid}/appointments/{appointmentid}/healthhistoryforms/{formid}
Modifies a specific Health history form for an appointment
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
formid
integer
formid
appointmentid
integer
appointmentid
Content-Type
string
Content type of the payload
Output Parameters
Expand all
errormessage
string
Shows any error messages during processing. Larger errors will cause the PUT call to die.
success
string
Indicates whether the submission was successful.
Example Code
Get list of live health history forms at
practice
GET
/v1/{practiceid}/healthhistoryforms
Retrieves a list of health history forms
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
limit
integer
Number of entries to return (default 1500, max 5000)
offset
integer
Starting point of entries; 0-indexed
Output Parameters
Expand all
ageunit
string
The units minage and maxage are in. 'M' for months, 'Y' for years.
appointmenttypeids
string
A comma separated list of appointmenttypeids this form is shown for. It is 'all' if this filter is not used.
departmentids
string
A comma separated list of departmentids this form is shown for. It is 'all' if this filter is not used.
description
string
Description of the form.
formid
integer
Athena ID for this form.
formname
string
Name of the form.
lastupdated
string
The last time the structure of this form was modified.
maxage
integer
Maximum patient age for which this section should be shown.
minage
integer
Minimum patient age for which this section should be shown.
providerids
string
A comma separated list of providerids this form is shown for. It is 'all' if this filter is not used.
sex
string
If set, this form only applies to the specified sex.
specialties
string
A comma separated list of specialties this form is shown for. It is 'all' if this filter is not used.
Example Code
Get contents of one generic health history
form
GET
/v1/{practiceid}/healthhistoryforms/{formid}
Retrieves the content of the health history form
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
formid
integer
formid
Output Parameters
Expand all
ageunit
string
The units minage and maxage are in. 'M' for months, 'Y' for years.
complete
string
Marks whether this section has been completed by/signed off by the patient.
empty
string
If there were no changes to this section. "complete" must also be true for this to be considered.
fielddata
array
Describes the list of fields within 'questions' that are patient-editable, the input type, and any select option values.
filledin
string
The date this section was last updated by the patient.
helptext
string
Patient-facing description of the section.
maxage
integer
Maximum patient age for which this section should be shown.
minage
integer
Minimum patient age for which this section should be shown.
name
string
Patient-facing name of the section.
populated
string
Date when the form was created.
populatedfrom
string
Source of the form data. Can be 'Chart' or 'Previous Answer', depending on whether any previous patient modifications have been made.
portalformsectionid
integer
The athena ID for this section.
questions
array
List of questions and existing answers (if any) for this section. All of the fields in here must be returned as is, except the values within 'fields'.
Those can be set per the specified 'inputtype'. For the FAMILY history section, the 'question' => 'fields' section is an array and not a hash.
Each element of the array contains a hash of the specified 'fielddate' ('default', 'diedofage', 'onsetage', 'relationkeyid' (required), and 'relation' (required)).
To create new relations of a given type, specify a different numerical relationkeyid.
For the SOCIAL history section, questions with inputtype: "DROPDOWN" will have an array of "dropdownvalues".
Each item in "dropdownvalues" is an array containing a key and a value together, representing a dropdown option.
You should always display the value and save/return the key ("fields[default]" should be a dropdown key).
For all SOCIAL history section questions, a property of "deprecated" with 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.
sex
string
If set, this form only applies to the specified sex. Athena will be prefiltering on this field, so it's only for reference.
type
string
The section type. It can be MEDICATION, ALLERGY, MEDICAL, FAMILY, SURGICAL, SOCIAL, OBGYN, or VACCINATION.
Example Code
Get list of health history forms for given
appointment
GET
/v1/{practiceid}/appointments/{appointmentid}/healthhistoryforms
Retrieves a list of history forms for a specific appointment
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
appointmentid
integer
appointmentid
Output Parameters
Expand all
description
string
Description of the form.
filledin
string
Date of most recent user edit for this form.
formid
integer
Athena ID for this form.
formname
string
Name of the form.
lastupdated
string
The last time the structure of this form was modified.
percentcomplete
string
Percent of the form completed by the patient.
populated
string
Date this form was generated.
totalcompletedsections
string
The number of sections that have been submitted and marked as complete.
totalsections
string
Total number of sections in this form.
Example Code
Get specific health history forms for given
appointment
GET
/v1/{practiceid}/appointments/{appointmentid}/healthhistoryforms/{formid}
Retrieves a specific Health history form for an appointment
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
formid
integer
formid
appointmentid
integer
appointmentid
shownullanswers
boolean
If true, unanswered questions in the medical history, surgical history, and vaccine sections return null. If false (default), they return 'N'.
Output Parameters
Expand all
ageunit
string
The units minage and maxage are in. 'M' for months, 'Y' for years.
complete
string
Marks whether this section has been completed by/signed off by the patient.
empty
string
If there were no changes to this section. "complete" must also be true for this to be considered.
fielddata
array
Describes the list of fields within 'questions' that are patient-editable, the input type, and any select option values.
filledin
string
The date this section was last updated by the patient.
helptext
string
Patient-facing description of the section.
maxage
integer
Maximum patient age for which this section should be shown.
minage
integer
Minimum patient age for which this section should be shown.
name
string
Patient-facing name of the section.
populated
string
Date when the form was created.
populatedfrom
string
Source of the form data. Can be 'Chart' or 'Previous Answer', depending on whether any previous patient modifications have been made.
portalformsectionid
integer
The athena ID for this section.
questions
array
List of questions and existing answers (if any) for this section. All of the fields in here must be returned as is, except the values within 'fields'.
Those can be set per the specified 'inputtype'. For the FAMILY history section, the 'question' => 'fields' section is an array and not a hash.
Each element of the array contains a hash of the specified 'fielddate' ('default', 'diedofage', 'onsetage', 'relationkeyid' (required), and 'relation' (required)).
To create new relations of a given type, specify a different numerical relationkeyid.
For the SOCIAL history section, questions with inputtype: "DROPDOWN" will have an array of "dropdownvalues".
Each item in "dropdownvalues" is an array containing a key and a value together, representing a dropdown option.
You should always display the value and save/return the key ("fields[default]" should be a dropdown key).
For all SOCIAL history section questions, a property of "deprecated" with 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.
sex
string
If set, this form only applies to the specified sex. Athena will be prefiltering on this field, so it's only for reference.
type
string
The section type. It can be MEDICATION, ALLERGY, MEDICAL, FAMILY, SURGICAL, SOCIAL, OBGYN, or VACCINATION.
Example Code
Update specific health history forms for given
appointment
PUT
/v1/{practiceid}/appointments/{appointmentid}/healthhistoryforms/{formid}
Modifies a specific Health history form for an appointment
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
formid
integer
formid
appointmentid
integer
appointmentid
Content-Type
string
Content type of the payload
Output Parameters
Expand all
errormessage
string
Shows any error messages during processing. Larger errors will cause the PUT call to die.
success
string
Indicates whether the submission was successful.
Example Code
Get list of live health history forms at
practice
GET
/v1/{practiceid}/healthhistoryforms
Retrieves a list of health history forms
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
limit
integer
Number of entries to return (default 1500, max 5000)
offset
integer
Starting point of entries; 0-indexed
Output Parameters
Expand all
ageunit
string
The units minage and maxage are in. 'M' for months, 'Y' for years.
appointmenttypeids
string
A comma separated list of appointmenttypeids this form is shown for. It is 'all' if this filter is not used.
departmentids
string
A comma separated list of departmentids this form is shown for. It is 'all' if this filter is not used.
description
string
Description of the form.
formid
integer
Athena ID for this form.
formname
string
Name of the form.
lastupdated
string
The last time the structure of this form was modified.
maxage
integer
Maximum patient age for which this section should be shown.
minage
integer
Minimum patient age for which this section should be shown.
providerids
string
A comma separated list of providerids this form is shown for. It is 'all' if this filter is not used.
sex
string
If set, this form only applies to the specified sex.
specialties
string
A comma separated list of specialties this form is shown for. It is 'all' if this filter is not used.
Example Code
Get contents of one generic health history
form
GET
/v1/{practiceid}/healthhistoryforms/{formid}
Retrieves the content of the health history form
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
formid
integer
formid
Output Parameters
Expand all
ageunit
string
The units minage and maxage are in. 'M' for months, 'Y' for years.
complete
string
Marks whether this section has been completed by/signed off by the patient.
empty
string
If there were no changes to this section. "complete" must also be true for this to be considered.
fielddata
array
Describes the list of fields within 'questions' that are patient-editable, the input type, and any select option values.
filledin
string
The date this section was last updated by the patient.
helptext
string
Patient-facing description of the section.
maxage
integer
Maximum patient age for which this section should be shown.
minage
integer
Minimum patient age for which this section should be shown.
name
string
Patient-facing name of the section.
populated
string
Date when the form was created.
populatedfrom
string
Source of the form data. Can be 'Chart' or 'Previous Answer', depending on whether any previous patient modifications have been made.
portalformsectionid
integer
The athena ID for this section.
questions
array
List of questions and existing answers (if any) for this section. All of the fields in here must be returned as is, except the values within 'fields'.
Those can be set per the specified 'inputtype'. For the FAMILY history section, the 'question' => 'fields' section is an array and not a hash.
Each element of the array contains a hash of the specified 'fielddate' ('default', 'diedofage', 'onsetage', 'relationkeyid' (required), and 'relation' (required)).
To create new relations of a given type, specify a different numerical relationkeyid.
For the SOCIAL history section, questions with inputtype: "DROPDOWN" will have an array of "dropdownvalues".
Each item in "dropdownvalues" is an array containing a key and a value together, representing a dropdown option.
You should always display the value and save/return the key ("fields[default]" should be a dropdown key).
For all SOCIAL history section questions, a property of "deprecated" with 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.
sex
string
If set, this form only applies to the specified sex. Athena will be prefiltering on this field, so it's only for reference.
type
string
The section type. It can be MEDICATION, ALLERGY, MEDICAL, FAMILY, SURGICAL, SOCIAL, OBGYN, or VACCINATION.
Example Code