ORKHealthClinicalTypeRecorderConfiguration Class Reference

Inherits from ORKRecorderConfiguration : NSObject
Declared in ORKHealthClinicalTypeRecorder.m
ORKRecorder.h

Other Methods

– initWithIdentifier:

Returns an initialized recorder configuration.

- (instancetype)initWithIdentifier:(NSString *)identifier

Parameters

identifier

The unique identifier of the recorder configuration.

Return Value

An initialized recorder configuration.

Discussion

This method is the designated initializer.

Declared In

ORKRecorder_Private.h

– initWithIdentifier:healthClinicalType:healthFHIRResourceType:

Returns an initialized health clinical type recorder configuration using the specified clinical type.

- (instancetype)initWithIdentifier:(NSString *)identifier healthClinicalType:(HKClinicalType *)healthClinicalType healthFHIRResourceType:(nullable HKFHIRResourceType)healthFHIRResourceType

Parameters

identifier

The unique identifier of the recorder configuration.

healthClinicalType

The HKClinicalType that should be collected during the active task.

healthFHIRResourceType

The HKFHIRResourceType that should be used as predicate while querying for the healthClinicalType. Providing a HKFHIRResourceType that does not correspond to a HKClinicalType will NOT generate any result.

Return Value

An initialized health clinical type recorder configuration.

Discussion

This method is the designated initializer.

Declared In

ORKRecorder.h

– recorderForStep:outputDirectory:

Returns a recorder instance using this configuration.

- (ORKRecorder *)recorderForStep:(ORKStep *)step outputDirectory:(NSURL *)outputDirectory

Parameters

step

The step for which this recorder is being created.

outputDirectory

The directory in which all output file data should be written (if producing ORKFileResult instances).

Return Value

A configured recorder instance.

Declared In

ORKRecorder.h

– initWithCoder:

Returns a new health clinical type recorder configuration initialized from data in the given unarchiver.

- (instancetype)initWithCoder:(NSCoder *)aDecoder

Parameters

aDecoder

Coder from which to initialize the health clinical type recorder configuration.

Return Value

A new health clinical type recorder configuration.

Declared In

ORKRecorder.h

– requestedHealthKitTypesForReading

Returns the HealthKit types for which this recorder requires read access in a set of HKSampleType objects.

- (NSSet *)requestedHealthKitTypesForReading

Discussion

Typically, the task view controller automatically collects and collates the types of HealthKit data requested by each of the active steps in a task, and requests access to them at the end of the initial instruction steps in the task.

If your recorder requires or would benefit from read access to HealthKit at runtime during the task, return the appropriate set of HKSampleType objects.

Declared In

ORKRecorder.h

Other Methods

  healthClinicalType

The HKClinicalType to be collected from HealthKit. (read-only)

@property (nonatomic, readonly, copy) HKClinicalType *healthClinicalType

Declared In

ORKRecorder.h

  healthFHIRResourceType

The HKFHIRResourceType to used as predicate for HKQuery. (read-only)

@property (nonatomic, readonly, copy) HKFHIRResourceType healthFHIRResourceType

Declared In

ORKRecorder.h