Class: Mirah::Data::Patient

Inherits:
BaseObject show all
Defined in:
lib/mirah/data/patient.rb

Overview

Patients represent people who are in treatment. They can have appointments, and be the target of assessments. Patients are only treated in the context of an episode of care.

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseObject

from_graphql_hash, #initialize, #to_graphql_hash

Constructor Details

This class inherits a constructor from Mirah::BaseObject

Instance Attribute Details

#birth_date ⇒ Date (readonly)

Returns The patient's date of birth.

Returns:

  • (Date) —

    The patient's date of birth.


26
 
# File 'lib/mirah/data/patient.rb', line 26

attribute :birth_date, serializer: Serializers::DateSerializer.new

#email ⇒ string (readonly)

Returns The patient's primary email address.

Returns:

  • (string) —

    The patient's primary email address


38
 
# File 'lib/mirah/data/patient.rb', line 38

attribute :email

#external_id ⇒ string (readonly)

Returns The identifier provided by your system.

Returns:

  • (string) —

    The identifier provided by your system


14
 
# File 'lib/mirah/data/patient.rb', line 14

attribute :external_id

#external_managing_organization_id ⇒ string (readonly)

Returns Your system identifier for the organization this patient is with.

Returns:

  • (string) —

    Your system identifier for the organization this patient is with


56
 
# File 'lib/mirah/data/patient.rb', line 56

attribute :external_managing_organization_id, path: %w[managingOrganization], target: 'externalId'

#family_name ⇒ string (readonly)

Returns The patient's last or family name.

Returns:

  • (string) —

    The patient's last or family name


22
 
# File 'lib/mirah/data/patient.rb', line 22

attribute :family_name

#gender ⇒ string (readonly)

Returns The patient's gender.

Returns:

  • (string) —

    The patient's gender


30
 
# File 'lib/mirah/data/patient.rb', line 30

attribute :gender

#given_name ⇒ string (readonly)

Returns The patient's first or given name.

Returns:

  • (string) —

    The patient's first or given name


18
 
# File 'lib/mirah/data/patient.rb', line 18

attribute :given_name

#id ⇒ string (readonly)

Returns The internal Mirah identifier.

Returns:

  • (string) —

    The internal Mirah identifier


10
 
# File 'lib/mirah/data/patient.rb', line 10

attribute :id

#managing_organization_id ⇒ string (readonly)

Returns The internal mirah id of the organization this patient is with.

Returns:

  • (string) —

    The internal mirah id of the organization this patient is with


52
 
# File 'lib/mirah/data/patient.rb', line 52

attribute :managing_organization_id, path: %w[managingOrganization], target: 'id'

#phone_number ⇒ string (readonly)

Returns The patient's primary phone number that is suitable for receiving text messages. Please do not use a phone number which corresponds to a landline as text messages will not be received.

Returns:

  • (string) —

    The patient's primary phone number that is suitable for receiving text messages. Please do not use a phone number which corresponds to a landline as text messages will not be received.


43
 
# File 'lib/mirah/data/patient.rb', line 43

attribute :phone_number

#primary_language ⇒ string (readonly)

Returns The patient's primary language.

Returns:

  • (string) —

    The patient's primary language


34
 
# File 'lib/mirah/data/patient.rb', line 34

attribute :primary_language

#timezone ⇒ string (readonly)

Returns The patient's timezone. If not specified, the organization's default will be used. Timezone should be formatted like: en.wikipedia.org/wiki/Tz_database.

Returns:

  • (string) —

    The patient's timezone. If not specified, the organization's default will be used. Timezone should be formatted like: en.wikipedia.org/wiki/Tz_database


48
 
# File 'lib/mirah/data/patient.rb', line 48

attribute :timezone