welkin.models.encounter
=======================

.. py:module:: welkin.models.encounter


Classes
-------

.. autoapisummary::

   welkin.models.encounter.EncounterDisposition
   welkin.models.encounter.EncounterStatus
   welkin.models.encounter.Encounter
   welkin.models.encounter.Encounters


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

.. py:class:: EncounterDisposition

   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, encounter_id: str)

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



   .. py:method:: update(patient_id: str, encounter_id: str, **kwargs)

      D.update([E, ]**F) -> None.  Update D from dict/iterable E and F.
      If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
      If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
      In either case, this is followed by: for k in F:  D[k] = F[k]



.. py:class:: EncounterStatus

   Bases: :py:obj:`enum.Enum`


   Generic enumeration.

   Derive from this class to define new enumerations.


   .. py:attribute:: OPEN
      :value: 'OPEN'



   .. py:attribute:: CANCELLED
      :value: 'CANCELLED'



   .. py:attribute:: DRAFT
      :value: 'DRAFT'



   .. py:attribute:: FINALIZED
      :value: 'FINALIZED'



.. py:class:: Encounter

   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:attribute:: nested_objects


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


   .. py:method:: get(patient_id: str, related_data: bool = False)

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



   .. py:method:: update(patient_id: str, **kwargs)

      D.update([E, ]**F) -> None.  Update D from dict/iterable E and F.
      If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
      If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
      In either case, this is followed by: for k in F:  D[k] = F[k]



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


.. py:class:: Encounters

   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 | None = None, user_id: str | None = None, related_data: bool | None = None, with_care_team: bool | None = None, only_with_calendar_event: bool | None = None, statuses: list | None = None, sort: str | None = None, *args, **kwargs)