welkin.models.document
======================

.. py:module:: welkin.models.document


Classes
-------

.. autoapisummary::

   welkin.models.document.DocumentSummaryFile
   welkin.models.document.DocumentSummaryFiles
   welkin.models.document.DocumentSummary
   welkin.models.document.DocumentSummaries


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

.. py:class:: DocumentSummaryFile

   Bases: :py:obj:`welkin.models.base.Resource`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:method:: get(patient_id: str, document_summary_id: str) -> io.BytesIO

      Return the value for key if key is in the dictionary, else default.



.. py:class:: DocumentSummaryFiles

   Bases: :py:obj:`welkin.models.base.Collection`


   Built-in mutable sequence.

   If no argument is given, the constructor creates a new empty list.
   The argument must be an iterable if specified.


   .. py:attribute:: resource


   .. py:attribute:: iterator


   .. py:method:: create(patient_id: str, document_summary_id: str, files: list | None = None, *args, **kwargs)


.. py:class:: DocumentSummary

   Bases: :py:obj:`welkin.models.base.Resource`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: subresources


   .. py:method:: get(patient_id: str)

      Return the value for key if key is in the dictionary, else default.



   .. py:method:: create(patient_id: str)


   .. py:method:: delete(patient_id: str)


.. py:class:: DocumentSummaries

   Bases: :py:obj:`welkin.models.base.Collection`


   Built-in mutable sequence.

   If no argument is given, the constructor creates a new empty list.
   The argument must be an iterable if specified.


   .. py:attribute:: resource


   .. py:attribute:: iterator


   .. py:method:: get(patient_id: str, *args, **kwargs)