xCaliber healthCare Data Mesh

Phone Message Document

Source Object: Phone Message Document

Overview and Usage: The "Phone Message Document" source object contains data related to phone messages and communications between healthcare providers and patients or other parties. It is an important part of a patient's medical record, providing details about interactions that may affect the patient's care. Below are key fields found in this source object:

  • ActionNote: Action notes associated with the phone message, which can include important details, comments, or next steps regarding the message.
  • AppointmentID: An identifier for the related appointment, if applicable. It connects the phone message to specific appointments or scheduling events.
  • AssignedTo: Indicates the individual or department assigned to handle or respond to the phone message.
  • CreatedDateTime: The date and time when the phone message document was created.
  • CreatedUser: The user responsible for creating the phone message document.
  • DeletedDateTime: If the message was deleted, this field records the date and time when it was removed from the records.
  • DepartmentID: Identifies the department associated with the phone message. It helps categorize messages by department or care unit.
  • DocumentSource: The source or origin of the phone message document, which may indicate the platform or system that generated the document.
  • DocumentSubclass: The subclass of the phone message document, specifying the document's subtype or category.
  • PhoneMessageID: A unique identifier for the phone message, which allows for easy reference and retrieval.
  • EncounterID: If applicable, the encounter ID connects the phone message to a specific patient encounter, helping healthcare providers associate the message with a particular medical visit.
  • InternalNote: Additional notes or comments related to the phone message document, not visible to the patient or external parties.
  • LastModifiedDate: The date when the phone message document was last modified.
  • LastModifiedUser: The user responsible for the last modification to the phone message document.
  • Pages: Information related to pages or attachments included in the phone message document.
    • Pages.ContentType: The content type or format of the attached pages.
    • Pages.Href: Hyperlinks to the attached pages or documents.
    • Pages.PageID: Identifiers for the pages attached to the phone message document.
    • Pages.PageOrdering: The order or sequence of attached pages.
  • PatientID: Identifies the patient associated with the phone message, allowing for the connection of messages to specific individuals.
  • Priority: Indicates the priority level of the phone message, helping healthcare providers prioritize their response.
  • ProviderID: Identifies the healthcare provider or staff member responsible for handling or responding to the phone message.
  • Status: Records the current status of the phone message, indicating whether it's open, closed, pending, or has a different status.
  • Subject: The subject or topic of the phone message, providing a brief description of its content.
  • DocumentClass: The class of the document, categorizing it according to document type.
  • DocumentDescription: A description or title of the phone message document.
  • DocumentRoute: The route or path through which the document was routed or delivered.
  • DocumentType: Specifies the type or category of the document.
  • DocumentTypeID: An identifier associated with the document type.
  • ExternalAccessionID: If relevant, this field may store an external identifier or reference for the document.
  • ExternalNote: Additional notes or comments for external purposes, possibly visible to patients or external parties.
  • InternalAccessionID: An internal identifier or reference for the document.
  • LastModifiedDateTime: The date and time of the last modification to the phone message document.
  • ObservationDateTime: The date and time when observations or interactions related to the phone message occurred.
  • TietoOrderID: An identifier linking the document to an order or action within the healthcare system.
  • AttachmentContents: Contents or data associated with attachments to the phone message document.
  • AutoClose: Indicates whether the message should automatically close after a certain action or response.

The "Phone Message Document" source object is crucial for maintaining a record of phone communications within a healthcare setting. It helps healthcare providers track, respond to, and document important messages from patients and other parties, ensuring continuity of care and effective communication.

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
actionnote-The most recent action note for a documentstring0..1DocumentReferenceextension.valueStringaction-noteTop Level
appointmentid-The appointment ID for this documentinteger0..1DocumentReferenceextension.valueStringappointment-idTop Level
assignedto-Person the document is assigned tostring0..1DocumentReferenceextension.valueStringassigned-toTop Level
createddatetime-Date the document was created. Please use createddatetime instead.string0..1DocumentReferencedateTop Level
createduser-The user who created this document.string0..1DocumentReferenceextension.valueStringcreated-userTop Level
deleteddatetime-Date/time (ISO 8601) the document was deletedstring0..1DocumentReferenceextension.valueDatetimedeleted-datetimeTop Level
departmentid-Department for the documentstring0..1DocumentReferenceextension.valueStringdepartment-idTop Level
documentsource-Explains where this document originated.string0..1DocumentReferenceextension.valueStringdocument-sourceTop Level
documentsubclass-Specific type of documentstring0..1DocumentReferencecategory.extension.valueStringdocument-subclassTop Level
phonemessageid-The primary key for phone message documentsinteger0..1DocumentReferenceidTop Level
encounterid-Encounter IDstring0..1DocumentReferencecontext.encounter.referenceTop Level
internalnote-The 'Internal Note' attached to this documentstring0..1DocumentReferenceextension.valueStringinternal-noteTop Level
lastmodifieddate-Date/time (ISO 8601) the document was last modifiedstring0..1DocumentReferenceextension.valueDateTimelast-modified-dateTop Level
lastmodifieduser-The user who last modified this document.string0..1DocumentReferenceextension.valueStringlast-modified-userTop Level
pages.contenttype-The content-type that will be returned by the page image call.string0..1DocumentReferencecontent.attachment.contentTypeTop Level
pages.href-The URL to get the document image.string0..1DocumentReferencecontent.attachment.urlTop Level
pages.pageid-The ID to use in a call to get the page image.string0..1DocumentReferencecontent.attachment.idTop Level
pages.pageordering-Within this list of pages, the ordering (starting with 1).string0..1DocumentReferencecontent.attachment.extension.valueStringpage-orderingTop Level
patientid-The athenaNet patient ID.integer0..1DocumentReferencesubject.referenceTop 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.valueStringpriorityTop Level
providerid-Provider ID for this documentinteger0..1DocumentReferenceauthor.referenceTop Level
status-Status of the documentstring0..1DocumentReferencestatusTop Level
subject-Subject of the documentstring0..1DocumentReferenceextension.valueStringsubjectTop Level
documentclass-Class of documentstring0..1DocumentReferencecategory.coding.codeTop Level
documentdescription-Description of the document typestring0..1DocumentReferencedescriptionTop Level
documentroute-Explains method by which the document was entered into the athenaNet (INTERFACE (digital), FAX, etc.)string0..1DocumentReferenceextension.valueStringdocument-routeTop Level
documenttype-The description for this documentstring0..1DocumentReferenceextension.valueStringdocument-typeTop Level
documenttypeid-The ID of the description for this documentnumber0..1DocumentReferenceextension.valueStringdocument-type-idTop 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 patientstring0..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
internalnote-The 'Internal Note' attached to this documentstring0..1DocumentReferenceextension.valueStringinternal-noteTop Level
lastmodifieddatetime-Date/time (ISO 8601) the document was last modifiedstring0..1DocumentReferenceextension.valueDateTimelast-modified-datetimeTop Level
observationdatetime-Date/time (ISO 8601) the observation was takenstring0..1DocumentReferenceextension.valueDateTimeobservation-datetimeTop Level
tietoorderid-Order ID of the order this document is tied to, if anynumber0..1DocumentReferencecontext.related.referenceTop Level
attachmentcontents-The file contents that will be attached to this document. PDFs are recommended.string0..1DocumentReferencecontent.attachment.dataTop 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
documentdata-Text data stored with documentstring0..1DocumentReferenceextension.valueStringdocument-dataTop Level