Document Type - ACOG Document

Document Type - ACOG Document (American College of Obstetrician and Gynecologist). This feature allows the user to retrieve information of a specific patient or specific ACOG of a patient. It also provides a facility to retrieve ACOG document in HTML. The document content could be images, Clinical documents, XML, etc. Note: The existence of an OB episode doesn't necessarily mean there will be an accompanying ACOG document.

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 patient's ACOG documents
GET
/v1/{practiceid}/patients/{patientid}/documents/acog

Retrieves the ACOG 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.
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
acogid string The ID of the ACOG document
clinicalproviderid string The clinical provider ID
closeddate string When the OB episode was closed.
createddate string The date this ACOG document was created.
createddatetime string The date/time this ACOG document was created.
deleteddatetime string When this document was deleted (if at all).
deliverydate string The actual delivery date.
departmentid string The department ID associated with this ACOG document.
description string A description of the ACOG document (e.g. "image documentation").
documentclass string This is the class of the ACOG document
documentroute string The route the document was sent via (e.g. "FAX")
documentsource string The source of the document (e.g. "EPISODE")
documentsubclass string This is the subclass of ACOG document. This is what we use as "documentclass" for uploads via the API.
edddate string The estimated delivery date.
initialexamdate string The initial exam date.
lastmodifieddate string The date this ACOG document was last modified.
lastmodifieddatetime string The date/time this ACOG document was last modified
obepisodeid string The ID of the OB episode.
obepisodestatus string The status of the OB Episode (different from the document status)
priority string Priority of this ACOG document. 1 is high; 2 is normal.
status string The status of this ACOG document (SUBMITTED, FOLLOWUP, CLOSED or DELETED)
Example Code
Get one patient's ACOG document
GET
/v1/{practiceid}/patients/{patientid}/documents/acog/{acogid}

Retrieves a specific ACOG 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

acogid integer acogid
practiceid integer practiceid
patientid integer patientid

Output Parameters

Expand all
acogid string The ID of the ACOG document
clinicalproviderid string The clinical provider ID
closeddate string When the OB episode was closed.
createddate string The date this ACOG document was created.
createddatetime string The date/time this ACOG document was created.
deleteddatetime string When this document was deleted (if at all).
deliverydate string The actual delivery date.
departmentid string The department ID associated with this ACOG document.
description string A description of the ACOG document (e.g. "image documentation").
documentclass string This is the class of the ACOG document
documentroute string The route the document was sent via (e.g. "FAX")
documentsource string The source of the document (e.g. "EPISODE")
documentsubclass string This is the subclass of ACOG document. This is what we use as "documentclass" for uploads via the API.
edddate string The estimated delivery date.
initialexamdate string The initial exam date.
lastmodifieddate string The date this ACOG document was last modified.
lastmodifieddatetime string The date/time this ACOG document was last modified
obepisodeid string The ID of the OB episode.
obepisodestatus string The status of the OB Episode (different from the document status)
priority string Priority of this ACOG document. 1 is high; 2 is normal.
status string The status of this ACOG document (SUBMITTED, FOLLOWUP, CLOSED or DELETED)
Example Code
Get HTML formatted details from ACOG document
GET
/v1/{practiceid}/patients/{patientid}/documents/acog/{acogid}/html

Retrieves a specific ACOG document of the patient in HTML format

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

acogid integer acogid
practiceid integer practiceid
patientid integer patientid
includewrapper boolean If true, will include a wrapper with standard HTML tags

Output Parameters

Expand all
htmldata string ACOG document formatted as HTML.
Example Code