Models

This package contains all data models of YCMS. Please refer to django.db.models for general information about Django models.

Abstract Base Model

class ycms.cms.models.abstract_base_model.AbstractBaseModel(*args, **kwargs)

Bases: Model

Abstract base class for all models

classmethod get_model_name_plural()

Get the plural representation of this model name

Returns:: The plural model name
Return type:: str

get_repr()

Returns the canonical string representation of the content object

To be implemented in the inheriting model

Bed

class ycms.cms.models.bed.Bed(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing a Bed.

Parameters:

id (BigAutoField) – Primary key: ID
created_at (DateTimeField) – Created at
updated_at (DateTimeField) – Updated at
bed_type (CharField) – Bed type. specialty bed types may be available

Relationship fields:

Parameters:

creator (ForeignKey to User) – Creator (related name: bed)
room (ForeignKey to Room) – Room. The room this bed belongs to (related name: beds)

Reverse relationships:

Parameters:: assignments (Reverse ForeignKey from BedAssignment) – All assignments of this bed (related name of bed)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

assignments

Type: Reverse ForeignKey from BedAssignment

All assignments of this bed (related name of bed)

bed_type

Type: CharField

Bed type. specialty bed types may be available

Choices:

normal
small
ventilator

bed_type_name: Helper property to get the human-readable representation of the bed’s type

created_at

Type: DateTimeField

Created at

creator

Type: ForeignKey to User

Creator (related name: bed)

creator_id: Internal field, use creator instead.

get_bed_type_display(*, field=<django.db.models.CharField: bed_type>): Shows the label of the bed_type. See get_FOO_display() for more information.

get_next_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=True, **kwargs): Finds next instance based on created_at. See get_next_by_FOO() for more information.

get_next_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=True, **kwargs): Finds next instance based on updated_at. See get_next_by_FOO() for more information.

get_previous_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=False, **kwargs): Finds previous instance based on created_at. See get_previous_by_FOO() for more information.

get_previous_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=False, **kwargs): Finds previous instance based on updated_at. See get_previous_by_FOO() for more information.

get_repr()

This overwrites the default Django __repr__() method which would return <Bed: Bed object (id)>. It is used for logging.

Returns:: The canonical string representation of the bed
Return type:: str

id

Type: BigAutoField

Primary key: ID

is_available

Helper property to check if the bed is available. Returns True if there is no bed assignment to this bed with a discharge date in the future.

Returns:: if the bed is available
Return type:: bool

objects = <django.db.models.Manager object>

room

Type: ForeignKey to Room

Room. The room this bed belongs to (related name: beds)

room_id: Internal field, use room instead.

updated_at

Type: DateTimeField

Updated at

Bed Assignment

class ycms.cms.models.bed_assignment.BedAssignment(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing a BedAssignment.

Parameters:

id (BigAutoField) – Primary key: ID
created_at (DateTimeField) – Created at
updated_at (DateTimeField) – Updated at
admission_date (DateTimeField) – Admission date. date the hospital stay begins
discharge_date (DateTimeField) – Estimated discharge date. date the hospital stay is estimated to end
accompanied (BooleanField) – Accompanied. Whether the patient is accompanied by a chaperone

Relationship fields:

Parameters:

creator (ForeignKey to User) – Creator (related name: bedassignment)
medical_record (ForeignKey to MedicalRecord) – Medical record. The medical record associated with this bed assignment (related name: bed_assignment)
recommended_ward (ForeignKey to Ward) – Recommended ward. Recommendation for stay at this ward (related name: bedassignment)
bed (ForeignKey to Bed) – Bed. The bed assigned to the patient (related name: assignments)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

accompanied

Type: BooleanField

Accompanied. Whether the patient is accompanied by a chaperone

admission_date

Type: DateTimeField

Admission date. date the hospital stay begins

bed

Type: ForeignKey to Bed

Bed. The bed assigned to the patient (related name: assignments)

bed_id: Internal field, use bed instead.

created_at

Type: DateTimeField

Created at

creator

Type: ForeignKey to User

Creator (related name: bedassignment)

creator_id: Internal field, use creator instead.

discharge_date

Type: DateTimeField

Estimated discharge date. date the hospital stay is estimated to end

duration

Helper property for accessing the patient’s current hospital stay duration

Returns:: the current bed assignment duration
Return type:: str

get_next_by_admission_date(*, field=<django.db.models.DateTimeField: admission_date>, is_next=True, **kwargs): Finds next instance based on admission_date. See get_next_by_FOO() for more information.

get_next_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=True, **kwargs): Finds next instance based on created_at. See get_next_by_FOO() for more information.

get_next_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=True, **kwargs): Finds next instance based on updated_at. See get_next_by_FOO() for more information.

get_previous_by_admission_date(*, field=<django.db.models.DateTimeField: admission_date>, is_next=False, **kwargs): Finds previous instance based on admission_date. See get_previous_by_FOO() for more information.

get_previous_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=False, **kwargs): Finds previous instance based on created_at. See get_previous_by_FOO() for more information.

get_previous_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=False, **kwargs): Finds previous instance based on updated_at. See get_previous_by_FOO() for more information.

get_repr()

This overwrites the default Django __repr__() method which would return <BedAssignment: BedAssignment object (id)>. It is used for logging.

Returns:: The canonical string representation of the bed assignment
Return type:: str

id

Type: BigAutoField

Primary key: ID

medical_record

Type: ForeignKey to MedicalRecord

Medical record. The medical record associated with this bed assignment (related name: bed_assignment)

medical_record_id: Internal field, use medical_record instead.

objects = <ycms.cms.models.timetravel_manager.TimetravelManager object>

progress

Helper property for accessing the patient’s current hospital stay progress

Returns:: the current bed assignment progress
Return type:: int

recommended_ward

Type: ForeignKey to Ward

Recommended ward. Recommendation for stay at this ward (related name: bedassignment)

recommended_ward_id: Internal field, use recommended_ward instead.

until_discharge

Helper property for accessing the patient’s current hospital stay until discharge

Returns:: the current bed assignment until discharge
Return type:: str

updated_at

Type: DateTimeField

Updated at

Icd10 Entry

class ycms.cms.models.icd10_entry.ICD10Entry(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing an ICD-10 Entry.

Parameters:

id (BigAutoField) – Primary key: ID
code (CharField) – Code. ICD-10-GM classification code
description (CharField) – Description. ICD-10-GM classification description

Reverse relationships:

Parameters:: medicalrecord (Reverse ForeignKey from MedicalRecord) – All medical records of this ICD-10 entry (related name of diagnosis_code)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

code

Type: CharField

Code. ICD-10-GM classification code

description

Type: CharField

Description. ICD-10-GM classification description

get_repr()

This overwrites the default Django __repr__() method which would return <ICD10Entry: ICD10Entry object (id)>. It is used for logging.

Returns:: The canonical string representation of the ICD-10-GM entry
Return type:: str

id

Type: BigAutoField

Primary key: ID

medicalrecord_set

Type: Reverse ForeignKey from MedicalRecord

All medical records of this ICD-10 entry (related name of diagnosis_code)

objects = <django.db.models.Manager object>

Medical Record

class ycms.cms.models.medical_record.MedicalRecord(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing a MedicalRecord.

Parameters:

id (BigAutoField) – Primary key: ID
created_at (DateTimeField) – Created at
updated_at (DateTimeField) – Updated at
record_type (CharField) – Record type. type of this record
note (TextField) – Note. Additional notes for this medical record

Relationship fields:

Parameters:

creator (ForeignKey to User) – Creator (related name: medicalrecord)
patient (ForeignKey to Patient) – Patient. The patient associated with this medical record (related name: medical_records)
diagnosis_code (ForeignKey to ICD10Entry) – Diagnosis code. Diagnosis code according to ICD-10 (related name: medicalrecord)

Reverse relationships:

Parameters:: bed_assignment (Reverse ForeignKey from BedAssignment) – All bed assignment of this medical record (related name of medical_record)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

bed_assignment

Type: Reverse ForeignKey from BedAssignment

All bed assignment of this medical record (related name of medical_record)

created_at

Type: DateTimeField

Created at

creator

Type: ForeignKey to User

Creator (related name: medicalrecord)

creator_id: Internal field, use creator instead.

diagnosis_code

Type: ForeignKey to ICD10Entry

Diagnosis code. Diagnosis code according to ICD-10 (related name: medicalrecord)

diagnosis_code_id: Internal field, use diagnosis_code instead.

get_next_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=True, **kwargs): Finds next instance based on created_at. See get_next_by_FOO() for more information.

get_next_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=True, **kwargs): Finds next instance based on updated_at. See get_next_by_FOO() for more information.

get_previous_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=False, **kwargs): Finds previous instance based on created_at. See get_previous_by_FOO() for more information.

get_previous_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=False, **kwargs): Finds previous instance based on updated_at. See get_previous_by_FOO() for more information.

get_record_type_display(*, field=<django.db.models.CharField: record_type>): Shows the label of the record_type. See get_FOO_display() for more information.

get_repr()

This overwrites the default Django __repr__() method which would return <MedicalRecord: MedicalRecord object (id)>. It is used for logging.

Returns:: The canonical string representation of the medical record
Return type:: str

id

Type: BigAutoField

Primary key: ID

note

Type: TextField

Note. Additional notes for this medical record

objects = <ycms.cms.models.timetravel_manager.TimetravelManager object>

patient

Type: ForeignKey to Patient

Patient. The patient associated with this medical record (related name: medical_records)

patient_id: Internal field, use patient instead.

record_name: Helper property to get the human-readable representation of the record’s type

record_type

Type: CharField

Record type. type of this record

Choices:

intake
note
lab

updated_at

Type: DateTimeField

Updated at

Patient

class ycms.cms.models.patient.Patient(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing a Patient.

Parameters:

id (BigAutoField) – Primary key: ID
created_at (DateTimeField) – Created at
updated_at (DateTimeField) – Updated at
insurance_type (BooleanField) – Insurance type. Whether the patient is privately insured or not
first_name (CharField) – First name. First name of the patient
last_name (CharField) – Last name. Last name of the patient
gender (CharField) – Gender. Gender of the patient
date_of_birth (DateField) – Date of birth. Date of birth of the patient
_first (CharField) – first
_last (CharField) – last

Relationship fields:

Parameters:: creator (ForeignKey to User) – Creator (related name: patient)

Reverse relationships:

Parameters:: medical_records (Reverse ForeignKey from MedicalRecord) – All medical records of this patient (related name of patient)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

age

Helper property to get the patient’s age in years

Returns:: the patient’s age in years
Return type:: int

created_at

Type: DateTimeField

Created at

creator

Type: ForeignKey to User

Creator (related name: patient)

creator_id: Internal field, use creator instead.

current_admission_date

Helper property for accessing the patient’s current admission date

Returns:: the current admission date
Return type:: str

current_bed

Helper property for accessing the patient’s current bed

Returns:: the current bed
Return type:: Bed

current_discharge_date

Helper property for accessing the patient’s current discharge date

Returns:: the current discharge date
Return type:: str

current_room

Helper property for accessing the patient’s current room

Returns:: the current room
Return type:: Room

current_stay

Helper property for accessing the patient’s current hospital stay

Returns:: the current bed assignment
Return type:: BedAssignment

current_ward

Helper property for accessing the patient’s current ward

Returns:: the current ward
Return type:: Ward

date_of_birth

Type: DateField

Date of birth. Date of birth of the patient

first_name

Type: CharField

First name. First name of the patient

gender

Type: CharField

Gender. Gender of the patient

Choices:

m
f
d

get_gender_display(*, field=<django.db.models.CharField: gender>): Shows the label of the gender. See get_FOO_display() for more information.

get_insurance_type_display(*, field=<django.db.models.BooleanField: insurance_type>): Shows the label of the insurance_type. See get_FOO_display() for more information.

get_next_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=True, **kwargs): Finds next instance based on created_at. See get_next_by_FOO() for more information.

get_next_by_date_of_birth(*, field=<django.db.models.DateField: date_of_birth>, is_next=True, **kwargs): Finds next instance based on date_of_birth. See get_next_by_FOO() for more information.

get_next_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=True, **kwargs): Finds next instance based on updated_at. See get_next_by_FOO() for more information.

get_previous_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=False, **kwargs): Finds previous instance based on created_at. See get_previous_by_FOO() for more information.

get_previous_by_date_of_birth(*, field=<django.db.models.DateField: date_of_birth>, is_next=False, **kwargs): Finds previous instance based on date_of_birth. See get_previous_by_FOO() for more information.

get_previous_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=False, **kwargs): Finds previous instance based on updated_at. See get_previous_by_FOO() for more information.

get_repr()

This overwrites the default Django __repr__() method which would return <Patient: Patient object (id)>. It is used for logging.

Returns:: The canonical string representation of the patient
Return type:: str

id

Type: BigAutoField

Primary key: ID

insurance_name: Helper property to get the human-readable representation of the patient’s insurance type

insurance_type

Type: BooleanField

Insurance type. Whether the patient is privately insured or not

Choices:

False
True

last_name

Type: CharField

Last name. Last name of the patient

medical_records

Type: Reverse ForeignKey from MedicalRecord

All medical records of this patient (related name of patient)

objects = <ycms.cms.models.timetravel_manager.TimetravelManager object>

short_info

Helper property to get a short info string about the patient

Returns:: the patient’s info as a short string
Return type:: str

updated_at

Type: DateTimeField

Updated at

Room

class ycms.cms.models.room.Room(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing a Room.

Parameters:

id (BigAutoField) – Primary key: ID
created_at (DateTimeField) – Created at
updated_at (DateTimeField) – Updated at
room_number (CharField) – Room number. number of this room within its ward

Relationship fields:

Parameters:

creator (ForeignKey to User) – Creator (related name: room)
ward (ForeignKey to Ward) – Ward. The ward this room belongs to (related name: rooms)

Reverse relationships:

Parameters:: beds (Reverse ForeignKey from Bed) – All beds of this room (related name of room)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

age_difference_between_patients

Helper property for accessing age difference between patients currently stationed in the room

Returns:: age difference between patients in the room
Return type:: int

assignable_beds

Helper property for accessing the free bed

Returns:: free beds in the room
Return type:: list

available_beds

Helper property for accessing the rooms free bed count

Returns:: number of free beds in the room
Return type:: int

beds

Type: Reverse ForeignKey from Bed

All beds of this room (related name of room)

created_at

Type: DateTimeField

Created at

creator

Type: ForeignKey to User

Creator (related name: room)

creator_id: Internal field, use creator instead.

genders

Helper property for accessing all genders of patients currently stationed in the room

Returns:: genders of patients in the room
Return type:: set

get_next_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=True, **kwargs): Finds next instance based on created_at. See get_next_by_FOO() for more information.

get_next_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=True, **kwargs): Finds next instance based on updated_at. See get_next_by_FOO() for more information.

get_previous_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=False, **kwargs): Finds previous instance based on created_at. See get_previous_by_FOO() for more information.

get_previous_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=False, **kwargs): Finds previous instance based on updated_at. See get_previous_by_FOO() for more information.

get_repr()

This overwrites the default Django __repr__() method which would return <Room: Room object (id)>. It is used for logging.

Returns:: The canonical string representation of the room
Return type:: str

id

Type: BigAutoField

Primary key: ID

insurance_types

Helper property for accessing all insurance_types of patients currently stationed in the room

Returns:: insurance_types of patients in the room
Return type:: set

is_private

Helper property for determining if the room should be considered private

Returns:: whether this is a private room
Return type:: boolean

minus_max_age

Helper property for accessing minus maximum age of patients currently stationed in the room

Returns:: maximum age of patients in the room
Return type:: int

objects = <django.db.models.Manager object>

occupied_beds

Helper property for accessing the rooms occupied bed count

Returns:: number of occupied beds in the room
Return type:: int

patient_ages

Helper property for accessing ages of patients currently stationed in the room

Returns:: ages of patients in the room
Return type:: list

patients()

Helper property for accessing all patients currently stationed in the room

Returns:: patients in the room
Return type:: list [ Patient ]

room_number

Type: CharField

Room number. number of this room within its ward

total_beds

Helper property for accessing the rooms bed count

Returns:: number of beds in the room
Return type:: int

updated_at

Type: DateTimeField

Updated at

ward

Type: ForeignKey to Ward

Ward. The ward this room belongs to (related name: rooms)

ward_id: Internal field, use ward instead.

Timetravel Manager

class ycms.cms.models.timetravel_manager.TimetravelManager(*args, **kwargs)

Bases: Manager

This manager filters querysets by time, if the corresponding GET parameter was specified in the request.

get_queryset()

Get the queryset, filtered by time if the parameter was specified in the request.

Returns:: The queryset

ycms.cms.models.timetravel_manager.current_or_travelled_time(): Helper function to return a mocked current time whenever we are timetravelling

ycms.cms.models.timetravel_manager.set_request(**kwargs): Helper function for setting the request object once a signal is received

User

class ycms.cms.models.user.CustomUserManager(*args, **kwargs)

Bases: BaseUserManager

This manager provides custom methods for user creation

create_superuser(personnel_id, email, password=None, **extra_fields)

Create a new super user

Parameters:

personnel_id (int) – employee’s ID
email (str) – email address of the user, also used in lieu of username
password (str) – user password
extra_fields (dict) – additional fields

Returns:

the newly created user

Return type:

User

create_user(creator, personnel_id, email, group, assigned_ward=None, is_active=False, **extra_fields)

Create a new user and ensure they are added to the correct group (if any)

Parameters:

creator (User) – the user who attempts to create this new user
personnel_id (int) – employee’s ID
email (str) – email address of the user, also used in lieu of username
group (str) – one of CHOICES
assigned_ward (Ward) – the ward this user is assigned to or None
is_active (bool) – Whether this user should be active
extra_fields (dict) – additional fields

Returns:

the newly created user

Return type:

User

class ycms.cms.models.user.User(*args, **kwargs)

Bases: AbstractBaseUser, PermissionsMixin, AbstractBaseModel

A custom User model that replaces the default Django User model.

Parameters:

id (BigAutoField) – Primary key: ID
password (CharField) – Password
last_login (DateTimeField) – Last login
is_superuser (BooleanField) – Superuser status. Designates that this user has all permissions without explicitly assigning them.
created_at (DateTimeField) – Created at
updated_at (DateTimeField) – Updated at
personnel_id (CharField) – Personnel ID. Employment ID number of the hospital staff. Used for authentication.
email (EmailField) – Email. Valid email address for this user
job_type (CharField) – Job type. Job type of the employee
first_name (CharField) – First name. First name of the employee
last_name (CharField) – Last name. Last name of the employee
ward_as_timeline (BooleanField) – Ward as timeline
is_active (BooleanField) – Is active
is_staff (BooleanField) – Is staff

Relationship fields:

Parameters:

creator (ForeignKey to User) – Creator (related name: user)
assigned_ward (ForeignKey to Ward) – Ward. Ward this employee is assigned to (if any) (related name: user)
groups (ManyToManyField to Group) – Groups. The groups this user belongs to. A user will get all permissions granted to each of their groups. (related name: user_set)
user_permissions (ManyToManyField to Permission) – User permissions. Specific permissions for this user. (related name: user_set)

Reverse relationships:

Parameters:

user (Reverse ForeignKey from User) – All users of this user (related name of creator)
patient (Reverse ForeignKey from Patient) – All patients of this user (related name of creator)
ward (Reverse ForeignKey from Ward) – All wards of this user (related name of creator)
room (Reverse ForeignKey from Room) – All rooms of this user (related name of creator)
bed (Reverse ForeignKey from Bed) – All beds of this user (related name of creator)
medicalrecord (Reverse ForeignKey from MedicalRecord) – All medical records of this user (related name of creator)
bedassignment (Reverse ForeignKey from BedAssignment) – All bed assignments of this user (related name of creator)
logentry (Reverse ForeignKey from LogEntry) – All log entries of this user (related name of user)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

REQUIRED_FIELDS = ['email', 'job_type', 'first_name', 'last_name']

USERNAME_FIELD = 'personnel_id'

assigned_ward

Type: ForeignKey to Ward

Ward. Ward this employee is assigned to (if any) (related name: user)

assigned_ward_id: Internal field, use assigned_ward instead.

bed_set

Type: Reverse ForeignKey from Bed

All beds of this user (related name of creator)

bedassignment_set

Type: Reverse ForeignKey from BedAssignment

All bed assignments of this user (related name of creator)

created_at

Type: DateTimeField

Created at

creator

Type: ForeignKey to User

Creator (related name: user)

creator_id: Internal field, use creator instead.

email

Type: EmailField

Email. Valid email address for this user

first_name

Type: CharField

First name. First name of the employee

get_job_type_display(*, field=<django.db.models.CharField: job_type>): Shows the label of the job_type. See get_FOO_display() for more information.

get_next_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=True, **kwargs): Finds next instance based on created_at. See get_next_by_FOO() for more information.

get_next_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=True, **kwargs): Finds next instance based on updated_at. See get_next_by_FOO() for more information.

get_previous_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=False, **kwargs): Finds previous instance based on created_at. See get_previous_by_FOO() for more information.

get_previous_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=False, **kwargs): Finds previous instance based on updated_at. See get_previous_by_FOO() for more information.

get_repr()

This overwrites the default Django __repr__() method which would return <User: User object (id)>. It is used for logging.

Returns:: The canonical string representation of the user
Return type:: str

group

Return the primary group of this user

Returns:: The first group of this user
Return type:: Group

groups

Type: ManyToManyField to Group

Groups. The groups this user belongs to. A user will get all permissions granted to each of their groups. (related name: user_set)

id

Type: BigAutoField

Primary key: ID

is_active

Type: BooleanField

Is active

is_staff

Type: BooleanField

Is staff

is_superuser

Type: BooleanField

Superuser status. Designates that this user has all permissions without explicitly assigning them.

job_type

Type: CharField

Job type. Job type of the employee

Choices:

ADMINISTRATOR
DOCTOR
NURSE

last_login

Type: DateTimeField

Last login

last_name

Type: CharField

Last name. Last name of the employee

logentry_set

Type: Reverse ForeignKey from LogEntry

All log entries of this user (related name of user)

medicalrecord_set

Type: Reverse ForeignKey from MedicalRecord

All medical records of this user (related name of creator)

objects = <ycms.cms.models.user.CustomUserManager object>

password

Type: CharField

Password

patient_set

Type: Reverse ForeignKey from Patient

All patients of this user (related name of creator)

personnel_id

Type: CharField

Personnel ID. Employment ID number of the hospital staff. Used for authentication.

room_set

Type: Reverse ForeignKey from Room

All rooms of this user (related name of creator)

title

Return the title of this user

Returns:: The title of this user
Return type:: str

updated_at

Type: DateTimeField

Updated at

user_permissions

Type: ManyToManyField to Permission

User permissions. Specific permissions for this user. (related name: user_set)

user_set

Type: Reverse ForeignKey from User

All users of this user (related name of creator)

ward_as_timeline

Type: BooleanField

Ward as timeline

ward_set

Type: Reverse ForeignKey from Ward

All wards of this user (related name of creator)

Ward

class ycms.cms.models.ward.Ward(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing a Ward.

Parameters:

id (BigAutoField) – Primary key: ID
created_at (DateTimeField) – Created at
updated_at (DateTimeField) – Updated at
ward_number (CharField) – Ward number. Number of the ward
floor (IntegerField) – Floor. Floor on which the nurse station for this ward is located
name (CharField) – Ward name. Name this ward is commonly referred to by

Relationship fields:

Parameters:: creator (ForeignKey to User) – Creator (related name: ward)

Reverse relationships:

Parameters:

user (Reverse ForeignKey from User) – All users of this ward (related name of assigned_ward)
rooms (Reverse ForeignKey from Room) – All rooms of this ward (related name of ward)
bedassignment (Reverse ForeignKey from BedAssignment) – All bed assignments of this ward (related name of recommended_ward)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

available_beds

Helper property for accessing the wards free bed count

Returns:: number of free beds in the ward
Return type:: int

bedassignment_set

Type: Reverse ForeignKey from BedAssignment

All bed assignments of this ward (related name of recommended_ward)

created_at

Type: DateTimeField

Created at

creator

Type: ForeignKey to User

Creator (related name: ward)

creator_id: Internal field, use creator instead.

floor

Type: IntegerField

Floor. Floor on which the nurse station for this ward is located

get_next_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=True, **kwargs): Finds next instance based on created_at. See get_next_by_FOO() for more information.

get_next_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=True, **kwargs): Finds next instance based on updated_at. See get_next_by_FOO() for more information.

get_previous_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=False, **kwargs): Finds previous instance based on created_at. See get_previous_by_FOO() for more information.

get_previous_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=False, **kwargs): Finds previous instance based on updated_at. See get_previous_by_FOO() for more information.

get_repr()

This overwrites the default Django __repr__() method which would return <Ward: Ward object (id)>. It is used for logging.

Returns:: The canonical string representation of the ward
Return type:: str

id

Type: BigAutoField

Primary key: ID

name

Type: CharField

Ward name. Name this ward is commonly referred to by

objects = <django.db.models.Manager object>

occupied_beds

Helper property for accessing the wards occupied bed count

Returns:: number of occupied beds in the ward
Return type:: int

patients

Helper property for accessing all patients currently stationed in the ward

Returns:: patients in the ward
Return type:: list [ Patient ]

rooms

Type: Reverse ForeignKey from Room

All rooms of this ward (related name of ward)

total_beds

Helper property for accessing the wards bed count

Returns:: number of beds in the ward
Return type:: int

updated_at

Type: DateTimeField

Updated at

user_set

Type: Reverse ForeignKey from User

All users of this ward (related name of assigned_ward)

ward_number

Type: CharField

Ward number. Number of the ward