Document Type - Phone Message

Document Type - Phone Message. Messages typically received over fax, for example, including messages with notes that patients were triaged or treated over phone. May include/list multiple patients on one page. These faxes could also be from a third party answering service if your organization employs such a service. This feature allows the user to retrieve or create a phone messages for a given department.

Phone Message
A phone message typically received over fax, e.g., including messages with notes that patients were triaged. May include/list multiple patients on one page. Messages pertaining to patient care should be documented as individual patient cases (see above). By default, phone message documents are created in an open status. 

Notes: 
•  Subclassification is not available for this document class. 
•  Phone messages are the other document class that can be created without a patient ID because some documents may apply to no patients or to >1 patient.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Create new phone message for given department
POST
/v1/{practiceid}/documents/phonemessage

Create a record of a new phone message for a department in the system

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

Output Parameters

Expand all
errormessage string If the operation failed, this will contain an error message.
phonemessageid integer The document ID of the new or modified document.
success string Returns true/false if the operation was successful.
Example Code
Get list of phone messages for given department
GET
/v1/{practiceid}/documents/phonemessage

Retrieves a list of phone message documents for a given department

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 Allow documents that have been deleted to be returned.
status string Show only documents of this status. CLOSED will also set SHOWCLOSED to true. DELETED will set SHOWDELETED to true.
startdate string The start date in a range (mm/dd/yyyy).
showdocumentswithpatientid boolean Allow documents with patient IDs assigned to be returned.
enddate string The end date in a range (mm/dd/yyyy).
providerid integer The ID of the ordering provider.
departmentid integer The athenaNet department ID associated with the uploaded document.
showclosed boolean Allow documents in the CLOSED status to be returned.
limit integer Number of entries to return (default 1000, max 1000)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
appointmentid integer The appointment ID for this document
assignedto string Person the document is assigned to
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
deleteddatetime string Date/time (ISO 8601) the document was deleted
departmentid string Department for the document
description string Description of the document type
documentclass string Class of document
documentroute string Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource string Explains where this document originated.
documentsubclass string Specific type of document
documenttypeid integer A specific document type identifier.
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.
facilityid integer The ID of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies.
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 the observation was taken
patientid integer The athenaNet patient ID.
phonemessageid integer The primary key for phone message documents
priority string Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid integer Provider ID for this document
status string Status of the document
subject string Subject of the document
tietoorderid integer Order ID of the order this document is tied to, if any
Example Code
Get specific phone message
GET
/v1/{practiceid}/documents/phonemessage/{phonemessageid}

Retrieves specific phone message document information

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
phonemessageid integer phonemessageid

Output Parameters

Expand all
actionnote string The most recent action note for a document
appointmentid integer The appointment ID for this document
assignedto string Person the document is assigned to
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
deleteddatetime string Date/time (ISO 8601) the document was deleted
departmentid string Department for the document
description string Description of the document type
documentclass string Class of document
documentdata string Text data associated with this document.
documentroute string Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource string Explains where this document originated.
documentsubclass string Specific type of document
documenttypeid integer A specific document type identifier.
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.
facilityid integer The ID of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies.
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 the observation was taken
pages array An array of image pages associated with this document.
patientid integer The athenaNet patient ID.
phonemessageid integer The primary key for phone message documents
priority string Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid integer Provider ID for this document
status string Status of the document
subject string Subject of the document
tietoorderid integer Order ID of the order this document is tied to, if any
Example Code
Update specific phone message
PUT
/v1/{practiceid}/documents/phonemessage/{phonemessageid}

Modifies a specific phone message document

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

Output Parameters

Expand all
errormessage string If the operation failed, this will contain an error message.
phonemessageid integer The document ID of the new or modified document.
success string Returns true/false if the operation was successful.
Example Code
Get action note for given phone message
GET
/v1/{practiceid}/documents/phonemessage/{phonemessageid}/actions

Retrieves action note information of a specific phone message document

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

Output Parameters

Expand all
actionnote string The action notes that are attached to the document.
assignedto string This field will describe who was assigned this document during this document action.
createdby string The username of the person that created this document action.
createddatetime string The datetime this action note was created.
patientid integer The patient ID this document is tied to.
priority integer Priority given for this document action.
status string Status given for this document action.
Example Code
Create action note for given phone message
POST
/v1/{practiceid}/documents/phonemessage/{phonemessageid}/actions

Creates an action note for a specific phone message document

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

Output Parameters

Expand all
errormessage string If there was an error with this call and SUCCESS is set to false, this field may provide additional information.
newdocumentid string The document ID of newly created document as a result of action of Deny-New Prescription To Follow (DNTF).
success string Returns true if the update was a success.
versiontoken string A token representing the current state of this document. Will only be set if VERSIONTOKEN was originally sent to the endpoint.
Example Code
Get specific page from given phone message
GET
/v1/{practiceid}/documents/phonemessage/{phonemessageid}/pages/{pageid}

Retrieves a specific page from the specific phone message document of the 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
pageid integer pageid
phonemessageid integer phonemessageid
filesize string The file size of the document being requested.

Output Parameters

Expand all
attachment string The image of the page in jpeg format.
Example Code
Create new phone message for given patient
POST
/v1/{practiceid}/patients/{patientid}/documents/phonemessage

Creates a phone message document record 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
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If the operation failed, this will contain an error message.
phonemessageid integer The document ID of the new or modified document.
success string Returns true/false if the operation was successful.
Example Code
Get list of phone messages for given patient
GET
/v1/{practiceid}/patients/{patientid}/documents/phonemessage

Retrieves a list of phone message document information 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
Try in Postman

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 integer The appointment ID for this document
assignedto string Person the document is assigned to
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
deleteddatetime string Date/time (ISO 8601) the document was deleted
departmentid string Department for the document
description string Description of the document type
documentclass string Class of document
documentroute string Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource string Explains where this document originated.
documentsubclass string Specific type of document
documenttypeid integer A specific document type identifier.
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.
facilityid integer The ID of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies.
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 the observation was taken
phonemessageid integer The primary key for phone message documents
priority string Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid integer Provider ID for this document
status string Status of the document
subject string Subject of the document
tietoorderid integer Order ID of the order this document is tied to, if any
Example Code
Delete specific phone message
DELETE
/v1/{practiceid}/patients/{patientid}/documents/phonemessage/{phonemessageid}

Deletes the record of a specified phone message document

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
phonemessageid integer phonemessageid
patientid integer patientid

Output Parameters

Expand all
errormessage string If the operation failed, this will contain an error message.
phonemessageid integer The document ID of the new or modified document.
success string Returns true/false if the operation was successful.
Example Code
Get specific phone message
GET
/v1/{practiceid}/patients/{patientid}/documents/phonemessage/{phonemessageid}

Retrieves a specific phone message document information

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
phonemessageid integer phonemessageid
patientid integer patientid

Output Parameters

Expand all
actionnote string The most recent action note for a document
appointmentid integer The appointment ID for this document
assignedto string Person the document is assigned to
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
deleteddatetime string Date/time (ISO 8601) the document was deleted
departmentid string Department for the document
description string Description of the document type
documentclass string Class of document
documentdata string Text data associated with this document.
documentroute string Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource string Explains where this document originated.
documentsubclass string Specific type of document
documenttypeid integer A specific document type identifier.
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.
facilityid integer The ID of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies.
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 the observation was taken
pages array An array of image pages associated with this document.
phonemessageid integer The primary key for phone message documents
priority string Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid integer Provider ID for this document
status string Status of the document
subject string Subject of the document
tietoorderid integer Order ID of the order this document is tied to, if any
Example Code
Update specific phone message
PUT
/v1/{practiceid}/patients/{patientid}/documents/phonemessage/{phonemessageid}

Modifies a specific phone message document information

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

Output Parameters

Expand all
errormessage string If the operation failed, this will contain an error message.
phonemessageid integer The document ID of the new or modified document.
success string Returns true/false if the operation was successful.
Example Code
Get specific page from given phone message
GET
/v1/{practiceid}/patients/{patientid}/documents/phonemessage/{phonemessageid}/pages/{pageid}

Retrieves a specific page from the specific phone message document for the 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
pageid integer pageid
phonemessageid integer phonemessageid
patientid integer patientid
filesize string The file size of the document being requested.

Output Parameters

Expand all
attachment string The image of the page in jpeg format.
Example Code