Document Type - Lab Result

Document Type - Lab Results. These documents are processed by athenahealth, for example, lab results obtained from a blood draw, fluid specimen, or a biopsy/surgical excision. Lab results are with the laboratory name, the date and time of the specimen collection, analytes and values, growth rate, or observations of tissue samples. Whenever possible, structured analytes should be entered on documents. Analytes are entered by practice users unless they are received via interface. This feature allows the user to retrieve, add or modify information of a specific patient or a specific lab result of a patient. It also provides a facility to retrieve lab results document in HTML. The document content could be images, XML.etc. The Lab Result Changed Subscription feature will allow the user to retrieve, delete, create or modify changes to lab results. The user will need to subscribe. For more information about subscriptions, please refer Changed Data Subscriptions.

Lab Results
Obtained from a blood draw, fluid specimen, or a biopsy/surgical excision, lab results appear in the Results section of a patient’s chart. By default, lab result documents are created in an open status. However, creating lab results in a closed status is encouraged if the practice has already reviewed this data via another mechanism. 

Whenever possible, structured analytes should be entered on documents, and clinicalordertype (test type) and clinicalprovider (performing lab/data source) should always be specified. 

Note: Subclassification is not available for this document class.

Lab Analytes
API users can add and update lab analyte results through the existing lab result document POST and PUT endpoints for a specified patient. An analyte is a lab result value, such as glucose, HDL cholesterol, and WBC. 

The user's application must be the primary source of the lab analytes added through the lab result API. The analytes being uploaded into athenaNet are only a copy of the data available through the user's own application. The user is responsible for contacting/warning a patient’s provider or care team if any analyte result collected from a patient is outside of a reasonable threshold.

Adding Lab Analytes
Using the lab result document endpoint, users can create a lab result document with one or more lab analytes. The lab analyte value in the POST API is a url-encoded JSON structure.  Each entry contains items related to an analyte. Example lab analyte value for the POST:

[
  {
    "analytename" : "HGB A1C",
    "units" : "%",
    "abnormalflag" : "ABNORMAL",
    "referencerange" : "1-10",
    "resultstatus" : "Final",
    "value" : "5",
    "note" : "example note"
  },
  {
    "analytename" : "Alpha-1-Globulin",
    "units" : "mg/mol",
    "abnormalflag" : "CRITICAL HIGH",
    "referencerange" : "0.05-0.09",
    "resultstatus" : "Pending",
    "value" : "1.5",
    "note" : "example note"
  }
]

 

The analytename is required in order to POST a lab analyte. All other fields are optional.

Updating Lab Analytes
Lab analytes associated with lab result documents can be updated through the lab result PUT endpoint.  You must first get the labresultid of the lab result. You can get this from the lab result GET API via:

GET /patients/{patientid}/documents/labresult?departmentid={departmentid}
After retrieving the labresultid, you will must then get the analyteid of the analyte that you want to update. The analyteid uniquely identifies that particular analyte result. You can use the analyteid to update the fields associated with that particular analyte result using the document specific lab result GET API via:

GET /patients/{patientid}/documents/labresult/{labresultid}?departmentid={departmentid}
Sample API Response:

[
   {
      "createddate" : "05\/11\/2016",
      "description" : "lab result",
      "documentsource" : "INTERFACE",
      "labresultid" : "664739",
      "lastmodifieddate" : "05\/11\/2016",
      "observations" : [
         {
            "abnormalflag" : "abnormal",
            "analyteid" : "872001",
            "analytename" : "HGB A1C",
            "note" : "example note",
            "referencerange" : "1-10",
            "resultstatus" : "final",
            "units" : "%",
            "value" : "5"
         }
      ],
      "pages" : [],
      "priority" : "2",
      "status" : "REVIEW"
   }

]

Once you have the analyteid(s), you will must add a ‘“analyteid” : “{analyteid}}’ line to all the entries of the analyte(s) you are updating. 

If an entry doesn’t have an analyteid, it will be considered a new analyte instead of an update and added to the lab result document.

Example lab analyte value for the PUT:

[
  {
    "analytename" : "HGB A1C",
    "analyteid" : "123456",
    "loinc" : "12773-9",
    "units" : "%",
    "abnormalflag" : "ABNORMAL",
    "referencerange" : "1-10",
    "resultstatus" : "Final",
    "value" : "12",
    "note" : "example note"
  },
  {
    "analytename" : "ACTH, Plasma",
    "units" : "mg/mol",
    "abnormalflag" : "NORMAL",
  }
]

NOTE: The above example would update the HGB A1C analyte since the analyteid was provided and add the ACTH, Plasma analyte to the lab result since the analyteid was NOT provided.

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

Endpoints

Get lab result document's action note

GET
/v1/{practiceid}/documents/labresult/{labresultid}/actions
Retrieves action note information of a specific lab 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
labresultid integer labresultid
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 lab result document action note

POST
/v1/{practiceid}/documents/labresult/{labresultid}/actions
Creates an action note for a specific Lab Result 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
labresultid integer labresultid
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 patient's interpretation document

GET
/v1/{practiceid}/patients/{patientid}/documents/interpretation
Retrieves an interpretation 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
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.
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
interpretationid number The primary key for interpretation class of documents.
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
observationdatetime string Date/time (ISO 8601) the observation was taken
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
Example Code

Get list of patient's lab result documents

GET
/v1/{practiceid}/patients/{patientid}/documents/labresult
Retrieves a list of lab result 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
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 The ID of the description for this document
encounterdate string Date of the encounter associated with 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.
externalnoteonly 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.
fileextension string The file extension of this document.
filesize number The file size of this 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
interpretation string The practice entered 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.
isreviewedbyprovider string Whether the lab result has been reviewed by a provider
labresultid integer The primary key for labresult class of documents
labresultloinc string Laboratory code that identifies the overall result.
lastmodifieddate string Date/time (ISO 8601) the document was last modified
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
notefromlab string A note from lab.
observationdate string Date/time the observation was taken
observationdatetime string Date/time (ISO 8601) the observation was taken
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.
performinglabaddress1 string This is the address1 field of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabaddress2 string This is the address2 field of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabcity string This is the city of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabname string This is the name of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabstate string This is the state of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabzip string This is the zip code of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
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.
reportstatus string The status of the report.
resultstatus string The status of the result.
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 lab result document to patient's chart

POST
/v1/{practiceid}/patients/{patientid}/documents/labresult
Creates a lab result 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
accessionid string A unique identifier given to a document to track it over time.
analytes array This is an array of hashes in JSON. Each entry contains information for a single analyte. See <a href="https://developer.athenahealth.com/docs/read/workflows/documents/Lab_Analytes">https://developer.athenahealth.com/docs/read/workflows/documents/Lab_Analytes</a> for an example.
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.
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.
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.
notetopatient string This is a note specifically for the patient to view or action on. Updating this will append to any previous notes.
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.
priority string Priority of this result. 1 is high; 2 is normal.
providerid integer The ID of the ordering provider.
reportstatus string The status of the report.
resultnotes string Result notes of a document.
resultstatus string The status of the result.
specimenreceiveddatetime string Date-time indicating when the specimen was received in format (yyyy-mm-ddThh:mm:ss).
specimenreporteddatetime string Date-time indicating when the specimen was reported in format (yyyy-mm-ddThh:mm:ss).
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.
labresultid integer The document ID of the new or modified document.
success string Returns true/false if the operation was successful.
Example Code

Get patient's lab result document

GET
/v1/{practiceid}/patients/{patientid}/documents/labresult/{labresultid}
Retrieves a specific lab result 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
labresultid integer labresultid
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.
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
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 The ID of the description for this document
encounterdate string Date of the encounter associated with 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.
externalnoteonly 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
interpretation string The practice entered 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.
isreviewedbyprovider string Whether the lab result has been reviewed by a provider
labresultid integer The primary key for labresult class of documents
labresultloinc string Laboratory code that identifies the overall result.
lastmodifieddate string Date/time (ISO 8601) the document was last modified
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
lastmodifieduser string The user who last modified this document.
notefromlab string A note from lab.
observationdate string Date/time the observation was taken
observationdatetime string Date/time (ISO 8601) the observation was taken
observations array Individual observation details
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 document.
patientnote string A note about this lab result for the patient. This may or may not have been sent to the patient.
performinglabaddress1 string This is the address1 field of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabaddress2 string This is the address2 field of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabcity string This is the city of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabname string This is the name of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabstate string This is the state of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabzip string This is the zip code of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
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
providerusername string The username of the provider associated with this lab result document.
receivedfacilityordercode object The code as received from the facility via HL7 in OBR.4.
reportstatus string The status of the report.
resultcategory string The category of the result.
resultnotes string Result note on a document.
resultstatus string The status of the result.
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 patient's lab result document

PUT
/v1/{practiceid}/patients/{patientid}/documents/labresult/{labresultid}
Modifies a specific lab result 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
labresultid integer labresultid
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.
analytes array This is an array of hashes in JSON. Each entry contains information for a single analyte. See <a href="https://developer.athenahealth.com/docs/read/workflows/documents/Lab_Analytes">https://developer.athenahealth.com/docs/read/workflows/documents/Lab_Analytes</a> for an example.
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.
notetopatient string This is a note specifically for the patient to view or action on. Updating this will append to any previous notes.
observationdate string The date an observation was made (mm/dd/yyyy).
observationtime string The time an observation was made (hh24:mi). 24 hour time.
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.
resultnotes string Result notes of a document.
resultstatus string The status of the result.
specimenreceiveddatetime string Date-time indicating when the specimen was received in format (yyyy-mm-ddThh:mm:ss).
specimenreporteddatetime string Date-time indicating when the specimen was reported in format (yyyy-mm-ddThh:mm:ss).
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.
labresultid 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 lab result document as deleted

DELETE
/v1/{practiceid}/patients/{patientid}/documents/labresult/{labresultid}
Deletes the record of a specified lab result 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
labresultid integer labresultid

Output Parameters

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

Get page from patient's lab result document

GET
/v1/{practiceid}/patients/{patientid}/documents/labresult/{labresultid}/pages/{pageid}
Retrieves a specific page from the specific lab result 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
labresultid integer labresultid
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

This endpoint is used to apply a document action on a specific document.

PUT
/v1/{practiceid}/documents/labresult/{documentid}/dataentrycompleted
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

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

❙ Request Body

Expand all
actionnote string The note to be added 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.
success string Returns true if the update was a success.
Example Code

Close a lab result

PUT
/v1/{practiceid}/documents/labresult/{labresultid}/close
Advances a lab 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
labresultid integer labresultid
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 lab result document

GET
/v1/{practiceid}/patients/{patientid}/documents/labresult/{labresultid}/originaldocument
Retrieves original lab 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 lab 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
labresultid integer labresultid

Output Parameters

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

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

GET
/v1/{practiceid}/labresults/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 lab results

POST
/v1/{practiceid}/labresults/changed/subscription
Subscribes for changed lab 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 labresults was successful.
Example Code

Get list of lab result change subscription(s)

GET
/v1/{practiceid}/labresults/changed/subscription
Retrieves list of events applicable for lab results changes
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 lab results based on subscription

GET
/v1/{practiceid}/labresults/changed
Retrieves list of records of modified lab results of 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
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
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 The ID of the description for this document
encounterdate string Date of the encounter associated with this document
encounterid string Encounter ID
externalaccessionid string The external accession ID for this document. Format depends on the system the ID belongs to.
externalnoteonly 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.
fileextension string The file extension of this document.
filesize number The file size of this 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
interpretation string The practice entered 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.
isreviewedbyprovider string Whether the lab result has been reviewed by a provider
labresultid integer The primary key for labresult class of documents
labresultloinc string Laboratory code that identifies the overall result.
lastmodifieddate string Date/time (ISO 8601) the document was last modified
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
notefromlab string A note from lab.
observationdate string Date/time the observation was taken
observationdatetime string Date/time (ISO 8601) the observation was taken
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.
performinglabaddress1 string This is the address1 field of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabaddress2 string This is the address2 field of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabcity string This is the city of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabname string This is the name of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabstate string This is the state of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
performinglabzip string This is the zip code of the performing lab. For point-of-care tests this is the department. Otherwise, it is the clinical provider
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.
reportstatus string The status of the report.
resultstatus string The status of the result.
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 lab events

DELETE
/v1/{practiceid}/labresults/changed/subscription
Deletes a 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 labresults was successful.
Example Code