xCaliber healthCare Data Mesh

Admin Document

Source Object: Admin Document

Overview and Usage: The "Admin Document" source object in athena EHR is a fundamental component for managing administrative documents related to patient records and healthcare operations. It offers a structured approach to store, organize, and manage data associated with healthcare administration, ensuring systematic document management and retrieval.

  • Document Management: "Admin Document" serves as a central repository for various administrative documents, facilitating their creation, storage, and retrieval.
  • Workflow Tracking: Documents can be routed through predefined workflows, helping to manage and monitor the progression of administrative tasks.
  • Entity Association: It allows the association of documents with specific entities, such as patients or healthcare providers. This linkage ensures that documents are contextually relevant and accessible to the right individuals.
  • Document Categorization: Documents are categorized by class, type, and subclass, providing a systematic approach to document organization. This categorization simplifies document retrieval and management.
  • Communication: "Admin Document" supports internal and external communication through features such as document notes and comments. These capabilities aid in discussions, notifications, and feedback related to the document.
  • Version Tracking: The source object records critical details like the date and user responsible for document creation and modification. This information is invaluable for tracking document versions and maintaining a comprehensive document history.
  • Priority Management: Administrators can assign priority levels to documents, ensuring that high-priority tasks receive the attention they require for prompt handling.
  • Content Storage: "Admin Document" stores the actual data or content of administrative documents, including multiple pages and various content types. This comprehensive storage facilitates document retrieval and reference.
  • Procedural Linkage: Documents can be linked to specific medical procedures or surgeries, enhancing the documentation of healthcare operations and associated administrative tasks.
  • Accessibility: External and internal accession IDs facilitate document access from both external systems and within the athena EHR. This accessibility ensures that authorized individuals can retrieve documents as needed.

The "Admin Document" source object is integral for healthcare administration within athena EHR, enabling the structured management of administrative documents, efficient workflow tracking, and effective communication related to patient care and provider operations. Developers can use this source object to build features and applications that streamline administrative document management processes within athena EHR.

Mapping Table

Data FieldExample ValueSource Data Field DescriptionSource Field Data TypeSource Data Field CardinalityMapped FHIR++ ResourceMapped FHIR Data FieldAugmented MappingAssociated Coding SystemAssociated FHIR Data Field ExtensionMapping Context
assignedto-Person the document is assigned to.string0..1DocumentReferenceextension.valueString-assigned-toTop Level
adminid-The primary key for the admin document.integer0..1DocumentReferenceid-Top Level
clinicalproviderid-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.integer0..1DocumentReferencecustodian.reference-Top Level
createddatetime-Date/Time (ISO 8601) the document was created.string0..1DocumentReferencedate-Top Level
createduser-The user who created this document.string0..1DocumentReferenceextension.valueString-created-userTop Level
departmentid-Department for the document.string0..1DocumentReferenceextension.valueString-department-idTop Level
documentclass-Class of document.string0..1DocumentReferencecategory.coding.codesystem=athena-Top Level
documentdescription-Description of the document type.string0..1DocumentReferencedescription-Top Level
documentroute-Explains method by which the document was entered into the athenaNet (INTERFACE (digital), FAX, etc.).string0..1DocumentReferenceextension.valueString-document-routeTop Level
documentsource-Explains where this document originated.string0..1DocumentReferenceextension.valueString-document-sourceTop Level
documentsubclass-Specific type of document.string0..1DocumentReferencecategory.extension.valueString-document-subclassTop Level
documenttypeid-The ID of the description for this documentinteger0..1DocumentReferenceextension.valueString-document-type-idTop Level
entitytype-Type of entity creating the document. Possible values are PROVIDER, PATIENT and OTHERS.string0..1DocumentReferenceextension.valueString-entity-typeTop Level
externalnote-External note for the patient.string0..1DocumentReferenceextension.valueString-external-noteTop Level
fileextension-The file extension of this document.string0..1DocumentReferenceextension.valueString-file-extensionTop Level
filesize-The file size of this document.number0..1DocumentReferenceextension.valueString-file-sizeTop Level
internalnote-The 'Internal Note' attached to this document.string0..1DocumentReferenceextension.valueString-internal-noteTop Level
lastmodifieddatetime-Date/time (ISO 8601) the document was last modified.string0..1DocumentReferenceextension.valueDateTime-last-modified-datetimeTop Level
lastmodifieduser-The user who last modified this document.string0..1DocumentReferenceextension.valueString-last-modified-userTop Level
observationdate-Date of the encounter associated with this document.string0..1DocumentReferenceextension.valueDate-observation-dateTop Level
originalfilename-The original file name of this document.string0..1DocumentReferenceextension.valueString-original-file-nameTop Level
patientid-The athenaNet patient ID.integer0..1DocumentReferencesubject.reference-Top Level
priority-Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.string0..1DocumentReferenceextension.valueString-priorityTop Level
providerid-Provider ID for this document.integer0..1DocumentReferenceauthor.reference-Top Level
providerusername-The username of the provider associated with this lab result document.string0..1DocumentReferenceauthor.reference.display-Top Level
status-Status of the document.string0..1DocumentReferencestatus-Top Level
tietoorderid-Order ID of the order this document is tied to, if any.integer0..1DocumentReferencecontext.related-Top Level
actionnote-The most recent action note for a document.string0..1DocumentReferenceextension.valueString-action-noteTop Level
documentdata-Text data associated with this document.string0..1DocumentReferenceextension.valueString-document-dataTop Level
documentdescription-Description of the document type.string0..1DocumentReferencedescription-Top Level
pages.contenttype-The content-type that will be returned by the page image call.string0..1DocumentReferencecontent.attachment.contentType-Top Level
pages.href-The URL to get the document image.string0..1DocumentReferencecontent.attachment.url-Top Level
pages.pageid-The ID to use in a call to get the page image.string0..1DocumentReferencecontent.attachment.id-Top Level
pages.pageordering-Within this list of pages, the ordering (starting with 1).string0..1DocumentReferencecontent.attachment.extension.valueString-Top Level
actionnote-The most recent action note for a document.string0..1DocumentReferenceextension.valueStringaction-noteTop Level
deleteddatetime-Date/time (ISO 8601) the document was deleted.string0..1DocumentReferenceextension.valueDatetimedeleted-datetimeTop Level
tiedtoprocedureorsurgery-Link to retrieve the tied to surgery/procedure document.string0..1DocumentReferenceextension.valueStringtied-to-procedure-or-surgeryTop Level
externalaccessionid-The external accession ID for this document. Format depends on the system the ID belongs to.string0..1DocumentReferenceextension.valueStringexternal-accession-idTop Level
externalnote-External note for the patient.string0..1DocumentReferenceextension.valueStringexternal-noteTop Level
internalaccessionid-The internal accession ID for this document. Format depends on the system the ID belongs to.string0..1DocumentReferenceextension.valueStringinternal-accession-idTop Level