OCKPatient Class Reference

Inherits from NSObject
Conforms to NSCopying
NSSecureCoding
Declared in OCKPatient.h

The OCKPatient class is an object that represents a patient.

– initWithIdentifier:carePlanStore:name:detailInfo:careTeamContacts:tintColor:monogram:image:categories:userInfo:

Returns an initialized patient using the specified values.

- (instancetype)initWithIdentifier:(NSString *)identifier carePlanStore:(OCKCarePlanStore *)store name:(NSString *)name detailInfo:(nullable NSString *)detailInfo careTeamContacts:(nullable NSArray<OCKContact*> *)careTeamContacts tintColor:(nullable UIColor *)tintColor monogram:(null_unspecified NSString *)monogram image:(nullable UIImage *)image categories:(nullable NSArray<NSString*> *)categories userInfo:(nullable NSDictionary *)userInfo

Parameters

identifier

The identifier for the patient.

store

The care plan store for the patient.

name

The name for the patient.

detailInfo

Additional information for the patient.

careTeamContacts

The contacts in charge of the patients.

tintColor

The tint color for the patient.

monogram

A monogram for the patient.

image

An image for the patient.

categories

An array of categories of the patient.

Return Value

An initialized patient object.

Declared In

OCKPatient.h

  identifier

The identifier for the patient.

@property (nonatomic, copy, readonly) NSString *identifier

Declared In

OCKPatient.h

  store

The care plan store for the patient.

@property (nonatomic, readonly) OCKCarePlanStore *store

Declared In

OCKPatient.h

  name

A string indicating the name for a patient.

@property (nonatomic, copy, readonly) NSString *name

Declared In

OCKPatient.h

  detailInfo

A string indicating additional details for a patient.

@property (nonatomic, copy, readonly, nullable) NSString *detailInfo

Discussion

This can include date of birth, gender, etc.

Declared In

OCKPatient.h

  careTeamContacts

The care team contacts that are repsonsible for this patient.

@property (nonatomic, copy, readonly, nullable) NSArray<OCKContact*> *careTeamContacts

Discussion

Must be OCKContact objects of type OCKContactTypeCareTeam.

Declared In

OCKPatient.h

  tintColor

The tint color for a patient.

@property (nonatomic, readonly, nullable) UIColor *tintColor

Discussion

If the value is not specified, the app’s tint color is used.

Declared In

OCKPatient.h

  monogram

A string indicating the monogram for a contact.

@property (nonatomic, readonly, null_resettable) NSString *monogram

Discussion

If a monogram is not provided, it will be generated automatically. If a monogram is available, it will be clipped to two glyphs.

Declared In

OCKPatient.h

  image

An image for a contact.

@property (nonatomic, nullable) UIImage *image

Discussion

If an image is not provided, a monogram will be used for the contact. An image can be set after a contact object has been created. If an image is available, it will be displayed instead of the monogram.

Declared In

OCKPatient.h

  categories

An array of strings indicating the categories of the patient (e.g. pediatric, cardiology).

@property (nonatomic, copy, readonly, nullable) NSArray<NSString*> *categories

Declared In

OCKPatient.h

  userInfo

Save any additional objects that comply with the NSCoding protocol.

@property (nonatomic, copy, readonly, nullable) NSDictionary<NSString*id<NSCoding> > *userInfo

Declared In

OCKPatient.h