A sample that stores a clinical record.


class HKClinicalRecord : HKSample


The clinical record stores information about a single condition, procedure, or result. While the record’s properties expose some high-level information, the fhirResource property contains the underlying data from the user’s healthcare institution.

Note that the record inherits the HKSample class’s startDate and endDate properties. However, the system does not populate these properties with information from the FHIR data; instead, the startDate and endDate reflect the time and date when the system downloaded the FHIR data to the device.


Accessing Clinical Record Data

var clinicalType: HKClinicalType

An identifier that indicates the type of record, such as an allergic reaction, a lab result, or a medical procedure.

var displayName: String

The primary display name as shown in the Health app.

var fhirResource: HKFHIRResource?

The Fast Healthcare Interoperability Resources (FHIR) data for this record.


Inherits From

See Also

Medical Records

Accessing Health Records

Read clinical record data from the HealthKit store.

Accessing Sample Data in the Simulator

Set up sample accounts to build and test your app.

Accessing a User’s Clinical Records

Display a user’s clinical records by requesting authorization and querying HealthKit for the records.

class HKFHIRResource

An object containing Fast Healthcare Interoperability Resources (FHIR) data.

class HKCDADocumentSample

A Clinical Document Architecture (CDA) sample that stores a single document.

class HKDocumentSample

An abstract class that represents a health document in the HealthKit store.

static let CDA: HKDocumentTypeIdentifier

The CDA Document type identifier, used when requesting permission to read or share CDA documents.

class HKDocumentType

A sample type used to create queries for documents.