medkit.core.document
====================

.. py:module:: medkit.core.document


Classes
-------

.. autoapisummary::

   medkit.core.document.Document


Module Contents
---------------

.. py:class:: Document

   Bases: :py:obj:`typing_extensions.Protocol`\ [\ :py:obj:`medkit.core.annotation.AnnotationType`\ ]


   
   Base protocol for document classes of any modality (text, audio, etc).

   Documents can contain :class:`~medkit.core.annotation.Annotation` objects.













   :Attributes:

       **uid:**
           Unique identifier of the document

       **anns:**
           Annotations of the document, stored in an
           :class:`~medkit.core.annotation_container.AnnotationContainer` for
           easier access (can be subclassed to add modality-specific features).

       **attrs:**
           Attributes of the document, stored in an
           :class: `~medkit.core.attribute_container.AttributeContainer` for
           easier access

       **raw_segment:**
           Auto-generated segment containing the full unprocessed document.


   ..
       !! processed by numpydoc !!

   .. py:attribute:: uid
      :type:  str


   .. py:attribute:: anns
      :type:  medkit.core.annotation_container.AnnotationContainer[medkit.core.annotation.AnnotationType]


   .. py:attribute:: attrs
      :type:  medkit.core.attribute_container.AttributeContainer


   .. py:attribute:: raw_segment
      :type:  medkit.core.annotation.AnnotationType