Inpatient Document

Inpatient Document  - Clinical Document. It provides details of a patient's condition or care documents. This feature allows the user to retrieve, add or modify information  of a specific patient or a specific clinical document of a patient during the stay in the hospital. 

 It also allows the user to add or retrieve a list of admin documents, and document labels  for a specific patient stay in the hospital.

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

Endpoints

Get a list of specific inpatient's clinical document

GET
/v1/{practiceid}/inpatient/document/clinical
BETA: Retrieves a list of clinical document information of a specific inpatient
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
status string Status of the document.
departmentid integer The department id associated with the document.
patientid integer THe patient's ID.
stayid integer The stay ID. If this field is used, the departmentid must also match one of the departments returned in GET /stays/{stayid}.
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 most recent action note for a document
assignedto string Person the document is assigned to
clinicaldocumentid integer The primary key for inpatient clinical class of documents
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.
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
documentdata string Text data associated with this document.
documentlabelid integer A specific document type identifier.
documentroute string Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource string Explains where this document originated.
documenttypeid integer The ID of the description for this document
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
lastmodifieddate string Date the document was last modified
lastmodifieduser string The user who last modified this lab result document.
observationdatetime string Date/time the observation was taken
pages array An array of image pages associated with this admin document.
patientid integer The athenaNet patient ID.
priority string Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid integer Provider ID for this document
status string Status of the document
stayid string Stay ID
subject string Subject of the document
Example Code

Get specific clinical document by ID

GET
/v1/{practiceid}/inpatient/document/clinical/{clinicaldocumentid}
BETA: Retrieves a specific clinical 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
clinicaldocumentid integer clinicaldocumentid
pageids string Returns only the corresponding pages from the document (Ignores invalid pageids).

Output Parameters

Expand all
actionnote string The most recent action note for a document
assignedto string Person the document is assigned to
clinicaldocumentid integer The primary key for inpatient clinical class of documents
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.
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
documentdata string Text data associated with this document.
documentlabelid integer A specific document type identifier.
documentroute string Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource string Explains where this document originated.
documenttypeid integer The ID of the description for this document
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
lastmodifieddate string Date the document was last modified
lastmodifieduser string The user who last modified this lab result document.
observationdatetime string Date/time the observation was taken
pages array An array of image pages associated with this admin document.
patientid integer The athenaNet patient ID.
priority string Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid integer Provider ID for this document
status string Status of the document
stayid string Stay ID
subject string Subject of the document
Example Code

Add clinical document to inpatient's chart

POST
/v1/{practiceid}/inpatient/document/clinical
BETA: Creates a clinical document record of a specific patient in the hospital
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
attachmentcontents string The file that will become the document. Currently only a base 64 encoded pdf is supported.
caseid integer Surgical case to which the document will be attached. It's required when posting documents related to surgery like ( Intraop Record, Postop Record, Block Record, Handoff Record, Presurgical Evaluation, Line Record ).
departmentid integer The department id associated with the document.
documentlabelid integer The type of document being uploaded (this is the label that will be displayed to the user). Use GET /inpatient/configuration/documentlabels to search for valid IDs.
observationdatetime string If this document is tied to a clinical event it is the date the event occurred. Please use the format YYYY-M-DThh:mi:ss
patientid integer The patient ID.
stayid integer The stay ID associated with the document.

Output Parameters

Expand all
clinicaldocumentid integer The ID of the posted clinical document
Example Code

Get a list of specific inpatient's admin documents

GET
/v1/{practiceid}/inpatient/document/admin
BETA: Retrieves a list of administrative 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
status string Status of the document
departmentid integer The department id associated with the document.
patientid integer The patient ID.
stayid integer The stay ID. If this field is used, the departmentid must also match one of the departments returned in GET /stays/{stayid}.
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 most recent action note for a document
admindocumentid integer The primary key for inpatient administrative class of documents
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.
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
documentdata string Text data associated with this document.
documentlabelid integer A specific document type identifier.
documentroute string Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource string Explains where this document originated.
documenttypeid integer The ID of the description for this document
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
lastmodifieddate string Date the document was last modified
lastmodifieduser string The user who last modified this lab result document.
observationdatetime string Date/time the observation was taken
patientid integer The athenaNet patient ID.
priority string Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid integer Provider ID for this document
status string Status of the document
stayid string Stay ID
subject string Subject of the document
Example Code

Get specific admin document of an inpatient

GET
/v1/{practiceid}/inpatient/document/admin/{admindocumentid}
BETA: Retrieves a specific administrative 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
admindocumentid integer admindocumentid

Output Parameters

Expand all
actionnote string The most recent action note for a document
admindocumentid integer The primary key for inpatient administrative class of documents
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.
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
documentdata string Text data associated with this document.
documentlabelid integer A specific document type identifier.
documentroute string Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource string Explains where this document originated.
documenttypeid integer The ID of the description for this document
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
lastmodifieddate string Date the document was last modified
lastmodifieduser string The user who last modified this lab result document.
observationdatetime string Date/time the observation was taken
patientid integer The athenaNet patient ID.
priority string Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid integer Provider ID for this document
status string Status of the document
stayid string Stay ID
subject string Subject of the document
Example Code

Get specific admin document of an inpatient

GET
/v1/{practiceid}/inpatient/document/admin/{admindocumentid}
BETA: Retrieves a specific administrative 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
admindocumentid integer admindocumentid

Output Parameters

Expand all
actionnote string The most recent action note for a document
admindocumentid integer The primary key for inpatient administrative class of documents
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.
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
documentdata string Text data associated with this document.
documentlabelid integer A specific document type identifier.
documentroute string Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource string Explains where this document originated.
documenttypeid integer The ID of the description for this document
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
lastmodifieddate string Date the document was last modified
lastmodifieduser string The user who last modified this lab result document.
observationdatetime string Date/time the observation was taken
patientid integer The athenaNet patient ID.
priority string Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid integer Provider ID for this document
status string Status of the document
stayid string Stay ID
subject string Subject of the document
Example Code

Add inpatient's admin document

POST
/v1/{practiceid}/inpatient/document/admin
BETA: Creates a admin document record of a specific patient in the hospital
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
attachmentcontents string The file that will become the document. Currently only a base 64 encoded pdf is supported.
departmentid integer The department id associated with the document.
documentlabelid integer The type of document being uploaded (this is the label that will be displayed to the user). Use GET /inpatient/configuration/documentlabels to search for valid IDs.
observationdatetime string If this document is tied to a clinical event it is the date the event occurred. Please use the format YYYY-M-DThh:mi:ss
patientid integer The patient ID.
stayid integer The stay ID associated with the document.

Output Parameters

Expand all
admindocumentid integer The ID of the posted admin document
Example Code

Get reference list of document labels for inpatient documents

GET
/v1/{practiceid}/inpatient/configuration/documentlabels
BETA: Retrieve the configured list of document labels that can be attached to unpatient documents.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
documentclass string The document class to get the label for.
searchvalue string Search by the name of the document label, at least 3 characters are required.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
documentlabelid integer The ID of the document label.
name string The name of the document label.
Example Code