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.



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

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



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

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



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

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



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

attribute :family_name

#gender ⇒ string (readonly)

Returns The patient’s gender.

Returns:

  • (string) —

    The patient’s gender



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

attribute :gender

#gender_identity ⇒ string (readonly)

Returns The patient’s gender identity as free text.

Returns:

  • (string) —

    The patient’s gender identity as free text



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

attribute :gender_identity

#gender_identity_fhir ⇒ string (readonly)

Returns The patient’s gender identity as FHIR extension coded.

Returns:

  • (string) —

    The patient’s gender identity as FHIR extension coded.



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

attribute :gender_identity_fhir

#given_name ⇒ string (readonly)

Returns The patient’s first or given name.

Returns:

  • (string) —

    The patient’s first or given name



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

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

#legal_family_name ⇒ string (readonly)

Returns The patient’s legal last or family name.

Returns:

  • (string) —

    The patient’s legal last or family name



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

attribute :legal_family_name

#legal_given_name ⇒ string (readonly)

Returns The patient’s legal first or given name.

Returns:

  • (string) —

    The patient’s legal first or given name



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

attribute :legal_given_name

#legal_name ⇒ string (readonly)

Returns The patient’s full legal name.

Returns:

  • (string) —

    The patient’s full legal name.



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

attribute :legal_name

#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



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

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.



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

attribute :phone_number

#preferred_family_name ⇒ string (readonly)

Returns The patient’s preferred last or family name.

Returns:

  • (string) —

    The patient’s preferred last or family name



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

attribute :preferred_family_name

#preferred_given_name ⇒ string (readonly)

Returns The patient’s preferred first or given name.

Returns:

  • (string) —

    The patient’s preferred first or given name



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

attribute :preferred_given_name

#preferred_name ⇒ string (readonly)

Returns The patient’s full preferred name.

Returns:

  • (string) —

    The patient’s full preferred name.



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

attribute :preferred_name

#preferred_pronouns ⇒ string (readonly)

Returns The patient’s preferred pronouns.

Returns:

  • (string) —

    The patient’s preferred pronouns.



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

attribute :preferred_pronouns

#primary_language ⇒ string (readonly)

Returns The patient’s primary language.

Returns:

  • (string) —

    The patient’s primary language



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

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



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

attribute :timezone