xCaliber healthCare Data Mesh

Clinical Document

Source Object: Clinical Document

Overview and Usage: The "Clinical Document" source object in athena EHR is a crucial component for managing and documenting clinical documents related to patient care. It is designed to capture detailed information about clinical documents, including document content, providers, and various attributes. Here's an overview of key fields and their usage:

  • Clinical Document ID: "clinicaldocumentid" serves as a unique identifier for each clinical document, ensuring accurate association and retrieval.
  • Assigned To: "assignedto" identifies the entity or individual assigned to the clinical document, providing clarity in document management and distribution.
  • Clinical Provider ID: "clinicalproviderid" links the document to the clinical provider responsible for the document's creation or management.
  • Created Date and Time: "createddatetime" records the date and time when the clinical document was created, offering a chronological record of document creation.
  • Created User: "createduser" identifies the user or entity responsible for creating the clinical document.
  • Department: "departmentid" specifies the department or healthcare unit associated with the clinical document.
  • Document Class and Type: "documentclass" and "documenttypeid" categorize the clinical document based on its class and type, facilitating document organization and retrieval.
  • Document Description: "documentdescription" provides a brief description or title for the clinical document, making it easily identifiable.
  • Document Route and Source: "documentroute" and "documentsource" specify the route and source of the document, helping to track its origin and intended destination.
  • Document Subclass: "documentsubclass" further categorizes the document within its class.
  • Entity Type: "entitytype" indicates the type of entity or patient to which the document pertains.
  • External Note: "externalnote" may contain additional notes or information related to the clinical document.
  • File Extension and Size: "fileextension" and "filesize" provide information about the document's file format and size.
  • Internal Note: "internalnote" allows for the addition of internal notes or comments related to the clinical document.
  • Last Modified Date and Time: "lastmodifieddatetime" records the date and time of the last modification made to the document.
  • Last Modified User: "lastmodifieduser" identifies the user or entity that made the last modification to the clinical document.
  • Observation Date and Time: "observationdate" and "observationtime" specify the date and time of the clinical observation or event related to the document.
  • Order Type: "ordertype" categorizes the document based on its order type, facilitating document organization.
  • Original Filename: "originalfilename" contains the original filename of the document before it was uploaded or processed.
  • Patient ID: "patientid" links the document to a specific patient's record, ensuring accurate patient-document association.
  • Priority: "priority" indicates the document's priority level.
  • Provider ID: "providerid" and "providerusername" identify the provider responsible for the document and their username.
  • Status: "status" represents the current status or state of the clinical document.
  • Tieto Order ID: "tietoorderid" serves as an identifier for the document in Tieto's order system.
  • Action Note: "actionnote" allows for the addition of action-related notes or comments.
  • Document Data: "documentdata" may contain the actual content or data of the clinical document.
  • Original Document Content: "originaldocument.contenttype" and "originaldocument.href" provide information about the content type and location of the original document.
  • Pages: The "pages" section includes details about document pages, content type, href, page ID, and page ordering.
  • Attachment Contents: "attachmentcontents" may contain additional content related to the document.
  • Attachment Type: "attachmenttype" specifies the type of attachment associated with the document.
  • Auto Close: "autoclose" indicates whether the document should be automatically closed or not.
  • Replace Internal Note: "replaceinternalnote" determines whether the internal note should be replaced.

The "Clinical Document" source object is vital for managing and documenting a wide range of clinical documents, including reports, notes, and observations. It plays a crucial role in maintaining comprehensive patient records and facilitating communication among healthcare providers. Developers can leverage this source object to build features and applications that support clinical document management and enhance the patient care experience 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
clinicaldocumentid-The primary key for the clinical 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 CLINICALDOCUMENT, ADMISSIONDISCHARGE, CONSULTNOTE, MENTALHEALTH OPERATIVENOTE, and URGENTCARE.string0..1DocumentReferencecategory.extension.valueString-document-subclassTop Level
documenttypeid-The ID of the description for this document.integer0..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
ordertype-Order type group name.string0..1DocumentReferenceextension.valueString-order-typeTop 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
originaldocument.contenttype-The content-type of the original document.string0..1DocumentReferencecontent.attachment.contentType-Top Level
originaldocument.href-The URL to get the original document.string0..1DocumentReferencecontent.attachment.url-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
attachmentcontents-The file contents that will be attached to this document. File must be Base64 encoded.string0..1DocumentReferencecontent.attachment.dataTop Level
attachmenttype-The file type of attachment.string0..1DocumentReferencecontent.attachment.contentTypeTop Level
autoclose-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.boolean0..1DocumentReferenceextension.valueBooleanauto-closeTop Level
observationtime-The time an observation was made (hh24:mi). 24 hour time.string0..1DocumentReferenceextension.valueTimeobservation-timeTop Level
replaceinternalnote-If true, will replace the existing internal note with the new one. If false, will append to the existing note.boolean0..1DocumentReferenceextension.valueBooleanreplace-internal-noteTop Level