Document Type - Office Note
Document Type - Office Note feature allows the user to retrieve the office notes for 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
Endpoints
- Primary
Get patient's office note document
GET
/v1/{practiceid}/patients/{patientid}/documents/officenote
Retrieves office notes 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
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
showdeleted
boolean
By default, deleted documents are not listed. Set to list these.
status
string
The status of the task to filter document results.
departmentid
integer
The athenaNet department id.
encounterid
integer
Show only documents attached to this encounter.
documentsubclass
string
The document subclass to filter document results.
limit
integer
Number of entries to return (default 1500, max 5000)
offset
integer
Starting point of entries; 0-indexed
Output Parameters
Expand all
appointmentid
number
The appointment ID for this document,
assignedto
string
Person the document is assigned to
clinicalproviderid
number
The clinical provider ID of the performing provider
contraindicationreason
array
List of codes indicating why the order was contraindicated (for vaccines only). If this field is not present, the order does not contain a contraindication reason.
createddate
string
Date the document was created. Please use createddatetime instead.
createddatetime
string
Date/Time (ISO 8601) the document was created
declinedreason
array
List of codes indicating why the order was not given. If this field is not present, the order was not declined. If the array is empty, no reason has been chosen.
declinedreasontext
string
The user-facing description of the reason the order was not given.
deleteddatetime
string
Date/time (ISO 8601) the document was deleted
departmentid
string
Department for the document
documentclass
string
Class of document
documentdescription
string
Description of the document type
documentroute
string
Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource
string
Explains where this document originated (e.g. ENCOUNTER, PORTAL, etc.)
documentsubclass
string
Specific type of document
documenttype
string
The description for this document
documenttypeid
number
The ID of the description for this document
encounterid
string
Encounter ID
externalaccessionid
string
The external accession ID for this document. Format depends on the system the ID belongs to.
externalnote
string
External note for the patient
internalaccessionid
string
The internal accession ID for this document. Format depends on the system the ID belongs to.
internalnote
string
The 'Internal Note' attached to this document
lastmodifieddatetime
string
Date/time (ISO 8601) the document was last modified
observationdatetime
string
Date/time (ISO 8601) the observation was taken
officenoteid
number
The primary key for officenote class of documents
priority
number
Document priority, when available.
providerid
number
Provider ID for this document
receivernote
string
External note sent to the receiving facility
status
string
Status of the document
subject
string
Subject of the document
tietoorderid
number
Order ID of the order this document is tied to, if any
Example Code