welkin.models

Submodules

• welkin.models.assessment
• welkin.models.base
• welkin.models.calendar
• welkin.models.care_plan
• welkin.models.cdt
• welkin.models.chat
• welkin.models.document
• welkin.models.email
• welkin.models.encounter
• welkin.models.export
• welkin.models.formation
• welkin.models.patient
• welkin.models.program
• welkin.models.sms
• welkin.models.user

Package Contents

Classes

Assessment	dict() -> new empty dictionary
AssessmentRecord	dict() -> new empty dictionary
AssessmentRecordAnswers	dict() -> new empty dictionary
AssessmentRecords	Built-in mutable sequence.
Assessments	Built-in mutable sequence.
CalendarEvent	dict() -> new empty dictionary
CalendarEvents	Built-in mutable sequence.
Schedules	Built-in mutable sequence.
WorkHours	Built-in mutable sequence.
CarePlan	dict() -> new empty dictionary
CarePlanOverview	dict() -> new empty dictionary
CDT	dict() -> new empty dictionary
CDTs	Built-in mutable sequence.
Chat	dict() -> new empty dictionary
Chats	Built-in mutable sequence.
SearchChats	Built-in mutable sequence.
DocumentSummaries	Built-in mutable sequence.
DocumentSummary	dict() -> new empty dictionary
DocumentSummaryFile	dict() -> new empty dictionary
DocumentSummaryFiles	Built-in mutable sequence.
Email	dict() -> new empty dictionary
Emails	Built-in mutable sequence.
Encounter	dict() -> new empty dictionary
EncounterDisposition	dict() -> new empty dictionary
Encounters	Built-in mutable sequence.
CDTRecordsExport	Built-in mutable sequence.
Formation
Patient	dict() -> new empty dictionary
Patients	Built-in mutable sequence.
PatientProgram	dict() -> new empty dictionary
PatientPrograms	Built-in mutable sequence.
ProgramPhase	dict() -> new empty dictionary
ProgramPhases	Built-in mutable sequence.
SMS	dict() -> new empty dictionary
SMSes	Built-in mutable sequence.
User	dict() -> new empty dictionary
Users	Built-in mutable sequence.

class welkin.models.Assessment

Bases: 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)

create(patient_id: str, encounter_id: str)

get(patient_id: str, encounter_id: str)

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

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]

delete(patient_id: str, encounter_id: str)

class welkin.models.AssessmentRecord

Bases: 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)

subresources = ()

create(patient_id: str)

get(patient_id: str)

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

update(patient_id: str)

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]

delete(patient_id: str)

class welkin.models.AssessmentRecordAnswers

Bases: 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)

update(patient_id: str, assessment_record_id: str)

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]

class welkin.models.AssessmentRecords

Bases: 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.

resource

iterator

get(patient_id: str, **kwargs)

class welkin.models.Assessments

Bases: 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.

resource

iterator

get(patient_id: str, encounter_id: str, *args, **kwargs)

class welkin.models.CalendarEvent

Bases: 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)

create()

get()

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

update(**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]

delete()

class welkin.models.CalendarEvents

Bases: 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.

resource

iterator

get(from_date: datetime.datetime, to_date: datetime.datetime, participant_ids: list | None = None, event_type: str | None = None, sort: str | None = None, include_cancelled: bool | None = None, include_encounter_info: bool | None = None, exclude_assigned_to_encounter_events: bool | None = None, viewer_timezone: str | None = None, *args, **kwargs)

class welkin.models.Schedules

Bases: 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.

resource

iterator

get(ids: list, from_date: datetime.datetime, to_date: datetime.datetime, include_cancelled: bool | None = None, available: bool = False, full: bool = False, *args, **kwargs)

class welkin.models.WorkHours

Bases: 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.

iterator

get(from_date: datetime.datetime, to_date: datetime.datetime, psm_ids: list | None = None, timezone: str | None = None, *args, **kwargs)

class welkin.models.CarePlan

Bases: 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)

subresources = ()

create(patient_id: str)

get(patient_id: str)

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

class welkin.models.CarePlanOverview

Bases: 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)

update(patient_id: str)

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]

class welkin.models.CDT

Bases: 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)

create(patient_id: str)

get(patient_id: str)

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

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]

delete(patient_id: str)

class welkin.models.CDTs

Bases: 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.

resource

iterator

get(patient_id: str, cdt_name: str, fields: list | None = None, filters: dict | None = None, date_start: datetime.datetime | None = None, date_end: datetime.datetime | None = None, sort: str | None = None, *args, **kwargs)

update(patient_id: str, cdt_name: str, body: dict | None = None, **kwargs)

class welkin.models.Chat

Bases: 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)

create(patient_id: str)

class welkin.models.Chats

Bases: 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.

resource

iterator

get(patient_id: str, include_archived: bool = False, *args, **kwargs)

class welkin.models.SearchChats

Bases: 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.

resource

iterator

get(patient_id: str, query: str, content_page_size: int = 20, include_archived: bool = False, *args, **kwargs)

class welkin.models.DocumentSummaries

Bases: 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.

resource

iterator

get(patient_id: str, *args, **kwargs)

class welkin.models.DocumentSummary

Bases: 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)

subresources = ()

get(patient_id: str)

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

create(patient_id: str)

delete(patient_id: str)

class welkin.models.DocumentSummaryFile

Bases: 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)

get(patient_id: str, document_summary_id: str) → io.BytesIO

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

class welkin.models.DocumentSummaryFiles

Bases: 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.

resource

iterator

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

class welkin.models.Email

Bases: 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)

get(patient_id: str, *args, **kwargs)

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

class welkin.models.Emails

Bases: 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.

resource

iterator

get(patient_id: str, sort: str | None = None, *args, **kwargs)

class welkin.models.Encounter

Bases: 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)

subresources = ()

nested_objects

create(patient_id: str)

get(patient_id: str, related_data: bool = False)

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

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]

delete(patient_id: str)

class welkin.models.EncounterDisposition

Bases: 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)

get(patient_id: str, encounter_id: str)

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

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]

class welkin.models.Encounters

Bases: 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.

resource

iterator

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)

class welkin.models.CDTRecordsExport

Bases: 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.

resource

iterator

get(*args, **kwargs)

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

Bases: welkin.util.Target

Assessment

Assessments

CDT

CDTs

DocumentType

DocumentTypes

Encounter

EncounterDisposition

Encounters

Goal

Goals

Program

Programs

class welkin.models.Patient

Bases: 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)

subresources = ()

create()

get(expand: bool | None = None)

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

update(**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]

delete()

class welkin.models.Patients

Bases: 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.

resource

iterator

get(filter: dict | None = None, *args, **kwargs)

class welkin.models.PatientProgram

Bases: 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)

subresources = ()

nested_objects

get(patient_id: str, assigned_programs: bool | None = None, sort: str | None = None, *args, **kwargs)

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

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]

delete(patient_id: str)

class welkin.models.PatientPrograms

Bases: 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.

resource

iterator

get(patient_id: str, assigned_programs: bool | None = None, sort: str | None = None, *args, **kwargs)

class welkin.models.ProgramPhase

Bases: 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)

class welkin.models.ProgramPhases

Bases: 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.

resource

class welkin.models.SMS

Bases: 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)

get(patient_id: str, *args, **kwargs)

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

class welkin.models.SMSes

Bases: 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.

resource

iterator

get(patient_id: str, sort: str | None = None, *args, **kwargs)

class welkin.models.User

Bases: 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)

subresources = ()

create()

get()

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

update(**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]

delete()

class welkin.models.Users

Bases: 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.

resource

iterator

get(search: str | None = None, region: str | None = None, seat_assigned: bool | None = None, user_state: str | None = None, *args, **kwargs)