Document Type - Imaging Result

Document Type - Imaging Results. These documents are reports returned by outside facilities that include information about imaging document results, for example, X-rays, MRIs, colonoscopies, Holter monitor reports, and ultrasounds. Document Type - Imaging Result Changed Subscription feature allows the user to retrieve any changes made to the imaging results since the last time this request was run. The user will need to initiate subscription. For more information about subscriptions, please refer Changed Data Subscriptions.

Reports returned by internal or external facilities that include information about imaging or other diagnostic tests, e.g., x-rays, MRIs, colonoscopies, Holter monitor reports, ultrasounds, EKGs, sleep studies. Imaging and diagnostic results appear in the Results section of the patient’s chart. By default, imaging result documents are created in an open status. 
Note: Subclassification is not available for this document class.

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

Endpoints

Add imaging result document action note

POST
/v1/{practiceid}/documents/imagingresult/{imagingresultid}/actions
Creates an action note for a specific imaging results 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
imagingresultid integer imagingresultid
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 imaging result document's action note

GET
/v1/{practiceid}/documents/imagingresult/{imagingresultid}/actions
Retrieves action note information of a specific imaging results 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
imagingresultid integer imagingresultid
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

Add imaging result document to patient's chart

POST
/v1/{practiceid}/patients/{patientid}/documents/imagingresult
Creates a imaging results 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

❙ Request Body

Expand all
accessionid string A unique identifier given to a document to track it over time.
attachmentcontents string The file contents that will be attached to this document. File must be Base64 encoded.
attachmenttype string The file type of attachment.
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.
departmentid integer The athenaNet department ID associated with the uploaded document.
documentdata string Text data stored with document
documenttypeid integer A specific document type identifier.
entityid string Identifier of entity creating the document. entitytype is required while passing entityid.
entitytype string Type of entity creating the document. entityid is required while passing entitytype.
facilityid integer The ID of the facility or clinical provider who received the order.
includefilelink boolean If true, attempt to attach a file link to the document.
internalaccessionidentifier string A unique identifier given to a document to track it over time.
internalnote string An internal note for the provider or staff. Updating this will append to any previous notes.
interpretation string The practice entered interpretation of this result. Updating this will append to any previous values.
observationdate string The date an observation was made (mm/dd/yyyy).
observationtime string The time an observation was made (hh24:mi). 24 hour time.
originalfilename string The original file name of this document without the file extension. Filename should not exceed 200 characters.
patientnote string This is a note specifically for the patient to view or action on. Updating this will append to any previous notes.
priority string Priority of this result. 1 is high; 2 is normal.
providerid integer The ID of the ordering provider.
relevantclinicalinfo string Any other clinically relevant data that you want to add.
reportstatus string The status of the report.
resultstatus string The status of the result.
ssotarget string URL that you want to use as your target when doing SSO with an external link. Note that this requires special setup before this will work.
tietoorderid integer Tie the result document to this order.

Output Parameters

Expand all
errormessage string If the operation failed, this will contain an error message.
imagingresultid 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 patient's imaging result documents

GET
/v1/{practiceid}/patients/{patientid}/documents/imagingresult
Retrieves a list of imaging results document information 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
showdeleted boolean By default, deleted documents are not listed. Set to list these.
status string The status of the task to filter document results.
getentityinfo boolean If true, entityid and entitytype will be returned. entityid will be populated in createduser attribute.
encounterid integer Show only documents attached to this encounter.
showtemplate boolean If true, interpretation template added to the document is also returned.
documentsubclass string The document subclass to filter document results.
showportalonly boolean If true, only documents published to the portal at the time of this call are returned.
departmentid integer The athenaNet department id.
showmetadata boolean When "true" is passed we will return filetype, filesize and originalfilename if applicable
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
createduser string The user who created this document.
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.
documentsubclass string Specific type of document
documenttypeid integer The ID of the description for this document
encounterid string Encounter ID
entitytype string Type of entity creating the document. Possible values are PROVIDER, PATIENT and OTHERS.
externalaccessionid string The external accession ID for this document. Format depends on the system the ID belongs to.
externalnote string DEPRECATED: This field has been deprecated and is now returned as 'patientnote'.
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.
fileextension string The file extension of this document.
filesize number The file size of this document.
imagingresultid integer The primary key for imaging result class of documents
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
interpretation string The practice entered interpretation of this result.
interpretationtemplate object The interpretation template added to the imaging result.
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
observationdatetime string Date/time (ISO 8601) the observation was taken
ordergenusname string The category name of the clinical order.
ordertype string Order type group name
originalfilename string The original file name of this document.
patientid integer The athenaNet patient ID.
patientnote string External note for the patient.
portalpublisheddatetime string The date the document was published to the portal in format (yyyy-mm-ddThh:mm:ss).
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
receivedfacilityordercode object The code as received from the facility via HL7 in OBR.4.
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 patient's imaging result document

GET
/v1/{practiceid}/patients/{patientid}/documents/imagingresult/{imagingresultid}
Retrieves a specific imaging results 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
patientid integer patientid
imagingresultid integer imagingresultid
getentityinfo boolean If true, entityid and entitytype will be returned. entityid will be populated in createduser attribute.
showtemplate boolean If true, interpretation template added to the document is also returned.

Output Parameters

Expand all
actionnote string The most recent action note for a document
alarmdays string The number days until a document will go into followup after being sent to the portal.
assignedto string The user to whom this imaging result document is currently assigned.
createddate string The date this imaging result document was created.
createddatetime string The date/time this imaging result document was created.
createduser string The user who created this imaging result document.
departmentid integer The department ID associated with this imaging result document.
description string A description of the imaging result document (e.g. "imaging result").
documentdata string Text data for this document. Typically because there are no attachments.
documentsource string Explains where this document originated (e.g. IMAGING RESULT, PORTAL, etc.)
documenttypeid string The ID of the description for this document
entitytype string Type of entity creating the document. Possible values are PROVIDER, PATIENT and OTHERS.
externalaccessionid string The external accession identifier for this record. Format depends on the system the ID is from.
facilityid string The ID of the facility which performed the imaging order
imagingresultid string The ID of the imaging result document.
internalaccessionid string The internal accession identifier for this record. Format depends on the system the ID is from.
internalnote string The "body" of the imaging result document.
interpretation string The interpretation of this result
interpretationtemplate object The interpretation template added to the imaging result.
isconfidential string If true, this result document should not be shown to the patient.
lastmodifieddate string The date this imaging result document was last modified.
lastmodifieddatetime string The date/time this imaging result document was last modified.
lastmodifieduser string The user who last modified this imaging result document.
observationdate string The date the observation on which this lab result is based was taken.
observationdatetime string The date/time the observation on which this lab result is based was taken.
ordertype string Order type group name
originaldocument object URL and content-type to download the original document. "originaldocument" is returned when document source is FAX or UPLOAD and originally faxed or uploaded file is not split into multiple documents. Please use "pages" to download document pages when "originaldocument" is not available.
pages array An array of image pages associated with this imaging result document.
patientnote string A note about this imaging result for the patient. This may or may not have been sent to the patient.
portalpublisheddatetime string The date the document was published to the portal in format (yyyy-mm-ddThh:mm:ss).
priority string Priority of this imaging result document. 1 is high; 2 is normal.
providerid string The ID of the provider associated with this imaging result document.
providerusername string The username of the provider associated with this imaging result document.
receivedfacilityordercode object The code as received from the facility via HL7 in OBR.4.
resultstatus string The status of the result (e.g. "final", "partial").
status string The status of this imaging result document (e.g. REVIEW or CLOSED).
tiedtoprocedureorsurgery string Link to retrieve the tied to surgery/procedure document.
tietoorderid string Order ID this result is tied to
Example Code

Update patient's imaging result document

PUT
/v1/{practiceid}/patients/{patientid}/documents/imagingresult/{imagingresultid}
Modifies a specific imaging results 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
patientid integer patientid
imagingresultid integer imagingresultid
Content-Type string Content type of the payload

❙ Request Body

Expand all
accessionid string A unique identifier given to a document to track it over time.
documenttypeid integer A specific document type identifier.
facilityid integer The ID of the facility or clinical provider who received the order.
internalnote string An internal note for the provider or staff. Updating this will append to any previous notes if replaceinternalnote is not set.
interpretation string The practice entered interpretation of this result. Updating this will append to any previous values.
observationdate string The date an observation was made (mm/dd/yyyy).
observationtime string The time an observation was made (hh24:mi). 24 hour time.
patientnote string This is a note specifically for the patient to view or action on. Updating this will append to any previous notes.
priority string Priority of this result. 1 is high; 2 is normal.
providerid integer The ID of the ordering provider.
replaceinternalnote boolean If true, will replace the existing internal note with the new one. If false, will append to the existing note.
replacepatientnote boolean If true, will replace the existing patient note with the new one. If false, will append to the existing note.
reportstatus string The status of the report.
resultstatus string The status of the result.
ssotarget string URL that you want to use as your target when doing SSO with an external link. Note that this requires special setup before this will work.
tietoorderid integer Tie the result document to this order.

Output Parameters

Expand all
errormessage string If the operation failed, this will contain an error message.
imagingresultid integer The document ID of the new or modified document.
success string Returns true/false if the operation was successful.
Example Code

Mark patient's imaging result document as deleted

DELETE
/v1/{practiceid}/patients/{patientid}/documents/imagingresult/{imagingresultid}
Deletes the record of a specified imaging results 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
patientid integer patientid
imagingresultid integer imagingresultid

Output Parameters

Expand all
errormessage string A message to help identify an error.
imagingresultid integer ID for the deleted imaging result.
success string Indicates a successful delete operation.
Example Code

Get page from patient's imaging result document

GET
/v1/{practiceid}/patients/{patientid}/documents/imagingresult/{imagingresultid}/pages/{pageid}
Retrieves a specific page from the specific imaging 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
patientid integer patientid
imagingresultid integer imagingresultid
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

Close an imaging result

PUT
/v1/{practiceid}/documents/imagingresult/{imagingresultid}/close
Advances an imaging result to a closed status.
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
imagingresultid integer imagingresultid
Content-Type string Content type of the payload

❙ Request Body

Expand all
actionnote string The note to be added to the document
actionreasonid integer An alternate action reason to be applied 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.
success string Returns true if the update was a success.
Example Code

Get patient's original imaging result document

GET
/v1/{practiceid}/patients/{patientid}/documents/imagingresult/{imagingresultid}/originaldocument
Retrieves original imaging result document of the patient. This is applicable when document source is FAX or UPLOAD and originally faxed or uploaded file is not split into multiple documents. Please use "Get page from patient's imaging result document" endpoint to download documentpages when original document is not available.
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
imagingresultid integer imagingresultid

Output Parameters

Expand all
attachment string The original document in uploaded format.
Example Code

Get list of imaging result change events to which you can subscribe

GET
/v1/{practiceid}/imagingresults/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
departmentids array List of Departmentids subscribed
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 imaging results

POST
/v1/{practiceid}/imagingresults/changed/subscription
Subscribes for changed imaging results 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
departmentids array For every New/Update Subscriptions complete list of departmentids should be passed. NOTE: Without DepartmentIDs entire Context/Practice will be subscribed.
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 imagingresults was successful.
Example Code

Get list of imaging result change subscription(s)

GET
/v1/{practiceid}/imagingresults/changed/subscription
Retrieves list of events applicable for imaging results
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
departmentids array List of Departmentids subscribed
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 imaging results based on subscription

GET
/v1/{practiceid}/imagingresults/changed
Retrieves list of modified imaging results records
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
showportalonly boolean If true, only documents published to the portal at the time of this call are returned.
leaveunprocessed boolean For testing purposes, do not mark records as processed
showprocessedenddatetime string See showprocessedstartdatetime
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 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
createduser string The user who created this document.
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.
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.
externalnote string DEPRECATED: This field has been deprecated and is now returned as 'patientnote'.
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.
fileextension string The file extension of this document.
filesize number The file size of this document.
imagingresultid integer The primary key for imaging result class of documents
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
interpretation string The practice entered interpretation of this result.
interpretationtemplate object The interpretation template added to the imaging result.
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
observationdatetime string Date/time (ISO 8601) the observation was taken
ordergenusname string The category name of the clinical order.
ordertype string Order type group name
originalfilename string The original file name of this document.
patientid integer The athenaNet patient ID.
patientnote string External note for the patient.
portalpublisheddatetime string The date the document was published to the portal in format (yyyy-mm-ddThh:mm:ss).
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
receivedfacilityordercode object The code as received from the facility via HL7 in OBR.4.
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 change for imaging events

DELETE
/v1/{practiceid}/imagingresults/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 imagingresults was successful.
Example Code