Document Type - Surgery

Document Type - Surgery feature allows the user to view documents of a specific person prior to surgery and surgery results.

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

Get list of surgery documents

GET
/v1/{practiceid}/patients/{patientid}/documents/surgery
Retrieves a list of surgery documents 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.
startdate string An optional filter to specify the start of the documents search date range (MM/DD/YYYY). Inclusive.
encounterid integer Show only documents attached to this encounter.
documentsubclass string The document subclass to filter document results.
showdeclinedorders boolean If set, include orders that were declined
documentclass string The class(es) of document(s) comma separated.
enddate string An optional filter to specify the end of the documents search date range (MM/DD/YYYY). Inclusive.
departmentid integer The athenaNet department id.
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
cclist array The list of order document carbon-copy providers.
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
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.
futuresubmitdate string The future submit date in the format mm/dd/yyyy.
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
ordertype string Order type group name
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
receivernote string The external note sent to the receiving facility
status string Status of the document
subject string Subject of the document
surgeryid integer ID of a surgery document
tietoorderid integer Order ID of the order this document is tied to, if any
Example Code

Get specific surgery document

GET
/v1/{practiceid}/patients/{patientid}/documents/surgery/{surgeryid}
Retrieves information for a specific surgery 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
surgeryid integer surgeryid

Output Parameters

Expand all
actionnote string The most recent action note for a document
appointmentid integer The appointment ID for this document
approveddate string The date this document was approved
assignedto string Person the document is assigned to
cclist array The list of order document carbon-copy providers.
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.
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
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
documenttype string The description for this 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 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
lastmodifieduser string The user who last modified this document.
observationdate string
observationdatetime string Date/time (ISO 8601) the observation was taken
orderid integer Order document id
ordertype string Order type group name
outofnetworkreferralreasonid integer ID of the out of network referral reason.
pages array An array of image pages associated with this document.
patientcaseid string The patient case id
performdate string Date the order was performed.
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
questions array BETA FIELD: The custom list of questions and answers associated with this order. This list will vary by practice.
receivernote string The external note sent to the receiving facility
specimencollectedby string The username of the individual who took the specimen
specimencollectiondatetime string Date/time (ISO 8601) of the specimen collection
specimencollectionsite string Options are ExternalLab, Office, Home, AddOn
specimennotes string Note included with the specimen
specimensourceid integer The internal ID of the site (on the patient) where the specimen was taken. Deprecated. Use SPECIMENSOURCENAME
specimensourcename string The site (on the patient) where the specimen was taken
standingorderdurationdays integer Duration of the standing order
standingorderfrequencydays integer Frequency at which the order repeats
standingorderstartdate string Start date of the standing order
status string Status of the document
subject string Subject of the document
submitter string Submitter of a document.
tiedtodocuments array All documents that are tied to this order
tietoorderid integer Order ID of the order this document is tied to, if any
Example Code

Get list of surgical-results documents

GET
/v1/{practiceid}/patients/{patientid}/documents/surgicalresult
Retrieves a list of surgery result documents 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 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
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
surgicalresultid number The primary key for surgicalresult class of documents
tietoorderid number Order ID of the order this document is tied to, if any
Example Code

Get list of unknown documents for given patient

GET
/v1/{practiceid}/patients/{patientid}/documents/unknown
Retrieves a list of unknown documents 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 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
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
documenttype string The description for this 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.
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
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
receivernote string The external note sent to the receiving facility
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
unknownid integer ID of an unknown document.
Example Code

Get list of vaccine documents

GET
/v1/{practiceid}/patients/{patientid}/documents/vaccine
Retrieves a list of vaccines documents 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.
startdate string An optional filter to specify the start of the documents search date range (MM/DD/YYYY). Inclusive.
encounterid integer Show only documents attached to this encounter.
documentsubclass string The document subclass to filter document results.
showdeclinedorders boolean If set, include orders that were declined
documentclass string The class(es) of document(s) comma separated.
enddate string An optional filter to specify the end of the documents search date range (MM/DD/YYYY). Inclusive.
departmentid integer The athenaNet department id.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
administerlotnumber string Lot number of the medication or vaccine administered
administersite string The site on the patient that the medication/vaccine/etc was administered
appointmentid integer The appointment ID for this document
assignedto string Person the document is assigned to
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.
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.
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
manufacturer string Manufacturer of the administered medication
ndc string The National Drug Code for the document
observationdatetime string Date/time (ISO 8601) the observation was taken
ordertype string Order type group name
partiallyadministered string Whether the vaccine is partially administered or not
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
quantityunit string Unit for prescription quantity
quantityvalue number Value for prescription quantity
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
vaccineid integer ID of a vaccine document
visgivendate string Date when the Vaccine Information Statement was given to the patient.
Example Code