Document Type - Patient Case

The Document Type - Patient Case. When a patient calls the practice with a clinical question, one can document the call in athenaNet while the patient is on the phone and assign it to the appropriate person for resolution. This document is a clinical patient case. The feature allows the users to retrieve, modify, assign or reassign the patient case or modify the status of the document. Document Type - Patient Case Close Reasons Reference allows the user to retrieve a list of reasons to close a patient case. Document Type - Patient Case Document Changed Subscription feature will allow the user to retrieve changes made to the patient case content, status, reassignments, etc. The user will need to subscribe. For more information about subscriptions, please refer Changed Data Subscriptions.

Patient Case
Documents patient communications outside an encounter. See the Patient Cases documentation for more detailed information.

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

Endpoints

Get action note for given patient case
GET
/v1/{practiceid}/documents/patientcase/{patientcaseid}/actions

Retrieves action note information of a specific patient case 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

patientcaseid integer patientcaseid
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
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
This is used to update an action note on a specific document of a type indicated by the URI.
POST
/v1/{practiceid}/documents/patientcase/{patientcaseid}/actions

Returns a success message pertaining to the update.

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

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

❙ Request Body

Expand all
actionnote string The new action note to add to the document.

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 list of case documents for a patient
GET
/v1/{practiceid}/patients/{patientid}/documents/patientcase

Retrieves a list of patientcase 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
clinicalproviderid integer DEPRECATED: The clinical provider ID. The information can now be found in the field entitled 'facilityid'
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
createddocuments array Documents created by a patient case.
createduser string The user who created this document.
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
documentdescription string DEPRECATED: The document description. The information can now be found in the field entitled 'description'
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
lastmodifieddate string DEPRECATED: The last modified date. The information can now be found in the field entitled lastmodifieddatetime
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
lastmodifieduser string The user who last modified this document.
observationdatetime string Date/time the observation was taken
patientcaseid string The patient case id
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
Add case document for a patient
POST
/v1/{practiceid}/patients/{patientid}/documents/patientcase

Creates a patient case document record 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
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
autoclose boolean Documents will, normally, automatically appear in the clinical inbox for providers to review. In some cases, you might want to force the document to skip the clinical inbox, and go directly to the patient chart with a "closed" status. For that case, set this to true.
callbackname string The name of the person to call (if other than patient).
callbacknumber string The phone number to use to call back the patient (mutually exclusive with callbacknumbertype).
callbacknumbertype string The phone number type to use to call back the patient (mutually exclusive with callbacknumber).
clinicalproviderid integer The ID of the external provider/lab/pharmacy associated the document.
departmentid integer The athenaNet department ID associated with the uploaded document.
documentsource string Explains where this document originated.
documentsubclass string Subclasses for PATIENTCASE documents
internalnote string An internal note for the provider or staff. Updating this will append to any previous notes.
outboundonly boolean True/false flag indicating the patient case requires an outbound phone call and is not a response to an inbound call.
priority string Priority of this result. 1 is high; 2 is normal.
providerid integer The ID of the ordering provider.
subject string The subject of this patient case.

Output Parameters

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

Retrieves information on a specific patient case 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

patientcaseid integer patientcaseid
practiceid integer practiceid
patientid integer patientid

Output Parameters

Expand all
actionnote string The most recent action note for a document
assignedto string Person the document is assigned to
callbackname string The person to call (if other than patient).
callbacknumber string The phone number to use to call back the patient.
callbacknumbertype string The type of callback number (e.g. home, office, work, guarantor).
calltype string Type of call. (Options include: Tickler, Cancellation, ReminderCall etc...)
clinicalproviderid integer DEPRECATED: The clinical provider ID. The information can now be found in the field entitled 'facilityid'
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
createddocuments array Documents created by a patient case.
createduser string The user who created this document.
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
documentdescription string DEPRECATED: The document description. The information can now be found in the field entitled 'description'
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
lastmodifieddate string DEPRECATED: The last modified date. The information can now be found in the field entitled lastmodifieddatetime
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
lastmodifieduser string The user who last modified this document.
observationdatetime string Date/time the observation was taken
outboundonly string If the call made in the patient case is outbound
patientcaseid string The patient case id
patientid integer The athenaNet patient ID.
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
providerusername string The username of the provider associated with this lab result 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 case document for a patient
PUT
/v1/{practiceid}/patients/{patientid}/documents/patientcase/{patientcaseid}

Modifies information on a specific patientcase 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

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

❙ Request Body

Expand all
callbackname string The name of the person to call (if other than patient).
callbacknumber string The phone number to use to call back the patient (mutually exclusive with callbacknumbertype).
callbacknumbertype string The phone number type to use to call back the patient (mutually exclusive with callbacknumber).
clinicalproviderid integer The ID of the external provider/lab/pharmacy associated the document.
documentsource string Explains where this document originated.
documentsubclass string Subclasses for PATIENTCASE documents
internalnote string An internal note for the provider or staff. Updating this will append to any previous notes.
outboundonly boolean True/false flag indicating the patient case requires an outbound phone call and is not a response to an inbound call.
priority string Priority of this result. 1 is high; 2 is normal.
providerid integer The ID of the ordering provider.
subject string The subject of this patient case.

Output Parameters

Expand all
errormessage string If the operation failed, this will contain an error message.
patientcaseid integer The document ID of the new or modified document.
success string Returns true/false if the operation was successful.
Example Code
Reassign patient case document
PUT
/v1/{practiceid}/patients/{patientid}/documents/patientcase/{patientcaseid}/assign

Reassigns a specific patient case 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

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

❙ Request Body

Expand all
username string AthenNet user to whom the case is being reassigned to.This parameter is case-sensitive.

Output Parameters

Expand all
assignedto string String denoting the entity that the patientcase has been assigned to.
success string Boolean to denote success or failure.
Example Code
Close patient case document
PUT
/v1/{practiceid}/patients/{patientid}/documents/patientcase/{patientcaseid}/close

Closes a specific patient case 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

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

❙ Request Body

Expand all
actionreasonid integer Valid Document Action Reason ID for closure of Patient Case.

Output Parameters

Expand all
error string String denoting the failure for cse closure.
success string Boolean to denote success or failure.
Example Code
Re-open patient case document
PUT
/v1/{practiceid}/patients/{patientid}/documents/patientcase/{patientcaseid}/reopen

Re-opens a specific patient case document which had been closed

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

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

Output Parameters

Expand all
error string String denoting the error during reopening case.
success string Boolean notifying a success or failure.
Example Code
Get list of information documents for a patient
GET
/v1/{practiceid}/patients/{patientid}/documents/patientinfo

Retrieve a list of patient information documents

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.
showdeclinedorders boolean If set, include orders that were declined
documentclass string The class(es) of document(s) comma separated.
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
clinicalproviderid 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.
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
diagnosislist array Diagnoses for this document
discusseddate string Date on which the order is discussed.
discusseduser string Name of the user which whom the order is discussed.
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.
documentsubclass string Specific type of document
documenttypeid integer 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.
healthwiseid integer The unique ID assigned to health wise document.
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
notetopatient string The external note sent to the receiving facility
observationdatetime string Date/time (ISO 8601) the observation was taken
ordertype string Order type group name
patientinfoid integer ID of a patient info document
patientnote string External note for the patient.
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 list of cases for given patient
GET
/v1/{practiceid}/patients/{patientid}/patientcases

Retrieves a list of patient cases 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
departmentid integer The athenaNet department id.
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
createddate string Date the patient case was created
description string Description of the patient case
patientcaseid string ID for the document
patientcasetype string Type of patient case
status string Status of the patient case
subject string Subject of the patient case
Example Code
Get list of close-reasons for patient cases
GET
/v1/{practiceid}/reference/documents/patientcase/closereasons

Retrieves a list of reasons to be used to close patient cases

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
patientcaseid integer denotes the id of the patient case.

Output Parameters

Expand all
reason string Human readable string for the reason.
reasonid integer ID of the reason.
Example Code
Get list of change events for patient cases
GET
/v1/{practiceid}/documents/patientcase/changed/subscription/events

Retrieve list of all events that can be input for this subscription.

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

Output Parameters

Expand all
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code
Subscribe to all/specific change events for patient cases
POST
/v1/{practiceid}/documents/patientcase/changed/subscription

Subscribes for changed patient case document events

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

❙ Request Body

Expand all
eventname string By default, you are subscribed to all possible events. If you only wish to subscribe to an individual event, pass the event name with this argument.

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for patientcase was successful.
Example Code
Get list of subscribed events for changes in patient cases
GET
/v1/{practiceid}/documents/patientcase/changed/subscription

Retrieves list of events applicable for patient case changed 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

Output Parameters

Expand all
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code
Get list of changes in patient cases
GET
/v1/{practiceid}/documents/patientcase/changed

Retrieves a list of modified patient cases

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
leaveunprocessed boolean For testing purposes, do not mark records as processed
showprocessedenddatetime string See showprocessedstartdatetime
patientids array One or more ID's of the Patient
showprocessedstartdatetime string Show already processed changes. This will show changes that you previously retrieved at some point after this datetime mm/dd/yyyy hh24:mi:ss (Eastern). Can be used to refetch data if there was an error, such as a timeout, and records are marked as already retrieved. This is intended to be used with showprocessedenddatetime and for a short period of time only. Also note that all messages will eventually be deleted.
limit integer Number of entries to return (default 1000, max 5000)Please note that this endpoint has a different default than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
actionnote string The most recent action note for a document
assignedto string Person the document is assigned to
callbackname string The person to call (if other than patient).
callbacknumber string The phone number to use to call back the patient.
callbacknumbertype string The type of callback number (e.g. home, office, work, guarantor).
calltype string Type of call. (Options include: Tickler, Cancellation, ReminderCall etc...)
clinicalproviderid integer DEPRECATED: The clinical provider ID. The information can now be found in the field entitled 'facilityid'
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
createddocuments array Documents created by a patient case.
createduser string The user who created this document.
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
documentdescription string DEPRECATED: The document description. The information can now be found in the field entitled 'description'
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
lastmodifieddate string DEPRECATED: The last modified date. The information can now be found in the field entitled lastmodifieddatetime
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
lastmodifieduser string The user who last modified this document.
observationdatetime string Date/time the observation was taken
outboundonly string If the call made in the patient case is outbound
patientcaseid string The patient case id
patientid integer The athenaNet patient ID.
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
providerusername string The username of the provider associated with this lab result 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
Unsubscribe to all/specific events for changes in patient cases
DELETE
/v1/{practiceid}/documents/patientcase/changed/subscription

Delete an specific event which is no longer required

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
eventname string By default, you are unsubscribed from all possible events. If you only wish to unsubscribe from an individual event, pass the event name with this argument.

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for patientcase was successful.
Example Code