Class: Mirah::Inputs::PractitionerInput

Inherits:

BaseInputObject

• Object
• BaseInputObject
• Mirah::Inputs::PractitionerInput

Defined in:

lib/mirah/inputs/practitioner_input.rb

Overview

A set of parameters for updating a Data::Practitioner

Instance Attribute Summary

• #default_practitioner_role ⇒ string readonly

  The clinical role for this practitioner.

• #email ⇒ string readonly

  The practitioner’s primary email address.

• #external_id ⇒ string readonly

  The identifier provided by your system.

• #external_organization_ids ⇒ Array<string> readonly

  The identifiers from your system of the organizations this practitioner has a role in.

• #family_name ⇒ string readonly

  The practitioner’s last or family name.

• #given_name ⇒ string readonly

  The practitioner’s first or given name.

• #sso_username ⇒ string readonly

  The username (nameid) used for single sign on by this practitioner.

• #suffix ⇒ string readonly

  The practitioner’s suffix, e.g.

• #title ⇒ string readonly

  The practitioner’s title, e.g.

Method Summary

Methods inherited from BaseInputObject

from_graphql_hash, #initialize, #to_graphql_hash, #valid?, #validate!

Constructor Details

This class inherits a constructor from Mirah::BaseInputObject

Instance Attribute Details

#default_practitioner_role ⇒ string (readonly)

Returns The clinical role for this practitioner.

Returns:

• (string) —

  The clinical role for this practitioner

# File 'lib/mirah/inputs/practitioner_input.rb', line 33

input :default_practitioner_role, required: false

#email ⇒ string (readonly)

Returns The practitioner’s primary email address.

Returns:

• (string) —

  The practitioner’s primary email address

# File 'lib/mirah/inputs/practitioner_input.rb', line 29

input :email, required: false

#external_id ⇒ string (readonly)

Returns The identifier provided by your system.

Returns:

• (string) —

  The identifier provided by your system

# File 'lib/mirah/inputs/practitioner_input.rb', line 9

input :external_id, required: true

#external_organization_ids ⇒ Array<string> (readonly)

Returns The identifiers from your system of the organizations this practitioner has a role in.

Returns:

• (Array<string>) —

  The identifiers from your system of the organizations this practitioner has a role in

# File 'lib/mirah/inputs/practitioner_input.rb', line 41

input :external_organization_ids, required: false

#family_name ⇒ string (readonly)

Returns The practitioner’s last or family name.

Returns:

• (string) —

  The practitioner’s last or family name

# File 'lib/mirah/inputs/practitioner_input.rb', line 17

input :family_name, required: false

#given_name ⇒ string (readonly)

Returns The practitioner’s first or given name.

Returns:

• (string) —

  The practitioner’s first or given name

# File 'lib/mirah/inputs/practitioner_input.rb', line 13

input :given_name, required: false

#sso_username ⇒ string (readonly)

Returns The username (nameid) used for single sign on by this practitioner.

Returns:

• (string) —

  The username (nameid) used for single sign on by this practitioner.

# File 'lib/mirah/inputs/practitioner_input.rb', line 37

input :sso_username, required: false

#suffix ⇒ string (readonly)

Returns The practitioner’s suffix, e.g. ‘MD’.

Returns:

• (string) —

  The practitioner’s suffix, e.g. ‘MD’

# File 'lib/mirah/inputs/practitioner_input.rb', line 25

input :suffix, required: false

#title ⇒ string (readonly)

Returns The practitioner’s title, e.g. ‘Dr’.

Returns:

• (string) —

  The practitioner’s title, e.g. ‘Dr’

# File 'lib/mirah/inputs/practitioner_input.rb', line 21

input :title, required: false