welkin.models.formation
=======================

.. py:module:: welkin.models.formation


Classes
-------

.. autoapisummary::

   welkin.models.formation.FormationBase
   welkin.models.formation.FormationResource
   welkin.models.formation.FormationCollection
   welkin.models.formation.Assessment
   welkin.models.formation.Assessments
   welkin.models.formation.CDT
   welkin.models.formation.CDTs
   welkin.models.formation.DocumentType
   welkin.models.formation.DocumentTypes
   welkin.models.formation.EncounterDisposition
   welkin.models.formation.Encounter
   welkin.models.formation.Encounters
   welkin.models.formation.Goal
   welkin.models.formation.Goals
   welkin.models.formation.Program
   welkin.models.formation.Programs
   welkin.models.formation.Formation


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

.. py:class:: FormationBase

   .. py:attribute:: endpoint
      :type:  str
      :value: None



.. py:class:: FormationResource

   Bases: :py:obj:`FormationBase`, :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(*args, **kwargs)

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



.. py:class:: FormationCollection

   Bases: :py:obj:`FormationBase`, :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(*args, **kwargs)


.. py:class:: Assessment

   Bases: :py:obj:`FormationResource`


   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:: endpoint
      :value: 'assessments'



.. py:class:: Assessments

   Bases: :py:obj:`FormationCollection`


   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:: endpoint
      :value: 'assessments'



.. py:class:: CDT

   Bases: :py:obj:`FormationResource`


   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:: endpoint
      :value: 'cdts'



.. py:class:: CDTs

   Bases: :py:obj:`FormationCollection`


   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:: endpoint
      :value: 'cdts'



.. py:class:: DocumentType

   Bases: :py:obj:`FormationResource`


   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:: endpoint
      :value: 'document-types'



.. py:class:: DocumentTypes

   Bases: :py:obj:`FormationCollection`


   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:: endpoint
      :value: 'document-types'



.. py:class:: EncounterDisposition

   Bases: :py:obj:`FormationResource`


   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:: endpoint
      :value: 'encounter-disposition'



   .. py:attribute:: name
      :value: ''



.. py:class:: Encounter

   Bases: :py:obj:`FormationResource`


   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:: endpoint
      :value: 'encounters'



.. py:class:: Encounters

   Bases: :py:obj:`FormationCollection`


   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:: endpoint
      :value: 'encounters'



.. py:class:: Goal

   Bases: :py:obj:`FormationResource`


   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:: endpoint
      :value: 'goal-templates'



.. py:class:: Goals

   Bases: :py:obj:`FormationCollection`


   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:: endpoint
      :value: 'goal-templates'



.. py:class:: Program

   Bases: :py:obj:`FormationResource`


   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:: endpoint
      :value: 'programs'



.. py:class:: Programs

   Bases: :py:obj:`FormationCollection`


   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:: endpoint
      :value: 'programs'



.. py:class:: Formation(version: int | str = 'current')

   Bases: :py:obj:`welkin.util.Target`


   .. py:attribute:: Assessment


   .. py:attribute:: Assessments


   .. py:attribute:: CDT


   .. py:attribute:: CDTs


   .. py:attribute:: DocumentType


   .. py:attribute:: DocumentTypes


   .. py:attribute:: Encounter


   .. py:attribute:: EncounterDisposition


   .. py:attribute:: Encounters


   .. py:attribute:: Goal


   .. py:attribute:: Goals


   .. py:attribute:: Program


   .. py:attribute:: Programs