Forms

Forms for creating and modifying database objects. Please refer to django.forms for general information about Django forms (see also: Working with forms).

• Authentication
  • Password Reset Request Form
    • PasswordResetRequestForm
      • PasswordResetRequestForm.media
  • Registration Form
    • RegistrationForm
      • RegistrationForm.__init__()
      • RegistrationForm.clean_email()
      • RegistrationForm.clean_personnel_id()
      • RegistrationForm.media
      • RegistrationForm.save()
• Patients
  • Record Form
    • RecordForm
      • RecordForm.__init__()
      • RecordForm.media

Custom Model Form

class ycms.cms.forms.custom_model_form.CustomModelForm(**kwargs)

Bases: ModelForm

Form for populating all text widgets of a ModelForm with the default placeholder “Enter … here”. Use this form as base class instead of django.forms.ModelForm.

Form fields:

__init__(**kwargs)

Initialize placeholder model form

Parameters:

**kwargs (dict) – The supplied keyword arguments

Raises:

TypeError – If form is instantiated directly without an inheriting subclass

add_error_messages(request)

This function accepts the current request and adds the form’s error messages to the message queue of django.contrib.messages.

Parameters:

request (HttpRequest) – The current request submitting the form

clean()

This method extends the default clean()-method of the base ModelForm to provide debug logging

Returns:

The cleaned data (see Overriding the clean() method)

Return type:

dict

get_error_messages()

Return all error messages of this form and append labels to errors

Returns:

The errors of this form

Return type:

list

property media

Return all media required to render the widgets on this form.

save(commit=True)

This method extends the default save()-method of the base ModelForm to provide debug logging

Parameters:

commit (bool) – Whether or not the changes should be written to the database

Returns:

The saved object returned by The save() method

Return type:

object

ycms.cms.forms.custom_model_form.lowfirst(string)

Make the first letter of a string lowercase (counterpart of capfirst(), see also capfirst).

Parameters:

string (str) – The input text

Returns:

The lowercase text

Return type:

str

Intake Bed Assignment Form

class ycms.cms.forms.intake_bed_assignment_form.IntakeBedAssignmentForm(*args, **kwargs)

Bases: CustomModelForm

Form for creating intake bed assignments. Not used for assignment by station managers.

Form fields:

• admission_date: Admission date (DateTimeField)

• discharge_date: Estimated discharge date (DateTimeField)

• recommended_ward: Recommended ward (ModelChoiceField)

• accompanied: Accompanied (BooleanField)

__init__(*args, **kwargs)

Initialize medical record form

Parameters:

• *args (list) – The supplied arguments

• **kwargs (dict) – The supplied keyword arguments

property media

Return all media required to render the widgets on this form.

save(commit=True)

This method extends the default save()-method of the base ModelForm to create a new bed assignment.

Parameters:

commit (bool) – Whether or not the changes should be written to the database

Returns:

The saved medical record

Return type:

MedicalRecord

Intake Record Form

class ycms.cms.forms.intake_record_form.IntakeRecordForm(*args, **kwargs)

Bases: CustomModelForm

Form for creating intake records. Not used for general records.

Form fields:

• patient: Patient (ModelChoiceField)

• diagnosis_code: Diagnosis code (ModelChoiceField)

• note: Note (CharField)

__init__(*args, **kwargs)

Initialize medical record form

Parameters:

• *args (list) – The supplied arguments

• **kwargs (dict) – The supplied keyword arguments

property media

Return all media required to render the widgets on this form.

save(commit=True)

This method extends the default save()-method of the base ModelForm to create a new intake record.

Parameters:

commit (bool) – Whether or not the changes should be written to the database

Returns:

The saved medical record

Return type:

MedicalRecord

Patient Form

class ycms.cms.forms.patient_form.PatientForm(**kwargs)

Bases: CustomModelForm

Form for creating patients

Form fields:

• first_name: First name (CharField)

• last_name: Last name (CharField)

• gender: Gender (TypedChoiceField)

• date_of_birth: Date of birth (DateField)

• insurance_type: Insurance type (TypedChoiceField)

property media

Return all media required to render the widgets on this form.

Unknown Patient Form

class ycms.cms.forms.unknown_patient_form.UnknownPatientForm(**kwargs)

Bases: CustomModelForm

Form for creating placeholder patients

Form fields:

• gender: Gender (TypedChoiceField)

• approximate_age: Approximate age (IntegerField)

property media

Return all media required to render the widgets on this form.

prefix = 'unknown'

save(commit=True)

This method extends the default save()-method of the base ModelForm to create a new bed assignment.

Parameters:

commit (bool) – Whether or not the changes should be written to the database

Returns:

The saved bed assignment

Return type:

BedAssignment

User Form

class ycms.cms.forms.user_form.UserForm(**kwargs)

Bases: CustomModelForm

Form for editing users

Form fields:

• first_name: First name (CharField)

• last_name: Last name (CharField)

• assigned_ward: Ward (ModelChoiceField)

• ward_as_timeline: Ward as timeline (BooleanField)

property media

Return all media required to render the widgets on this form.

Ward Form

class ycms.cms.forms.ward_form.WardForm(**kwargs)

Bases: CustomModelForm

Form for creating wards

Form fields:

• ward_number: Ward number (CharField)

• floor: Floor (IntegerField)

• name: Ward name (CharField)

property media

Return all media required to render the widgets on this form.