Personal Health Records
1.0.0-ballot - ballot International flag

This page is part of the Standard Personal Health Record (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Artifacts Summary

Contents:

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

Search From Date

Return records from this date
Search by identifier in patient with multipleOr

This SearchParameter enables query of patient by identifier with mutlipleOr enabled.

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

Apple HealthKit Category Sample Logical Model

Data elements for the Apple HealthKit HKCategorySample.
Apple HealthKit Correlation Sample Logical Model

Data elements for the Apple HealthKit HKCorrelation.
Apple HealthKit HealthStore Characteristic Logical Model

Relevant Data elements that correspond to the CharacteristicType stored in Apple HealthStore.
Apple HealthKit Object Logical Model

Data elements for the Apple HealthKit HKObject.
Apple HealthKit Quantity Sample Logical Model

Data elements for the Apple HealthKit HKQuantitySample.
Apple HealthKit Sample Logical Model

Data elements for the Apple HealthKit HKSample.
Apple HealthKit Workout Activity Logical Model

Data elements for the Apple HealthKit HKWorkoutActivity.
Apple HealthKit Workout Event Logical Model

Data elements for the Apple HealthKit HKWorkoutEvent.
Apple HealthKit Workout Sample Logical Model

Data elements for the Apple HealthKit HKWorkout.
Environmental

Standard PHR profile of the Environmental resource.
Financial Receipt

Financial receipt for over-the-counter (OTC) purchases. Based off the Claim resource.
Nutrient Outtake

Standard PHR profile of the NutrientOuttake resource.
SocialMedia

Standard PHR profile of the SocialMedia resource.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Patient contributed data: sleep observation

patient sleep logs recorded by device or app.
PhrBundle

Standard PHR profile of the Bundle resource.
PhrComposition

Standard PHR profile of the Composition resource.
PhrDocumentReference

Standard PHR profile of the DocumentReference resource.
PhrMedia

Standard PHR profile of the Media resource.
PhrPatient

Standard PHR profile of the Patient resource.
PhrProvenance

Standard PHR profile of the Provenance resource.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Apple HealthKit Biological Sex Value Set

Apple HealthKit Biological Sex Value Set
Apple HealthKit Category Type Value Set

A type that identifies samples that contain a value from a small set of possible values.
Apple HealthKit Charactersitic Type Value Set

Apple HealthKit Charactersitic Type Value Set
Apple HealthKit Correlation Type Value Set

Possible values for AppleHealthKitSample.correlationType
Apple HealthKit Quantity Type Value Set

Possible values for AppleHealthKitSample.quantityType
Apple HealthKit Sample Type Value Set

Possible values for AppleHealthKitSample.sampleType
Apple HealthKit Workout Activity Type Value Set

Possible values for AppleHealthLitSample.workoutActivityType
Apple HealthKit Workout Event Type Value Set

Possible values for AppleHealthKitWorkoutEvent.type
Patient contributed data: sleep observation code

This value set includes codes to track patient sleep recorded by device or app
Patient contributed data: sleep stage value

This value set includes codes to track patient sleep values recorded by device or app

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Apple HealthKit Biological Sex Code System

Constants indicating the user’s sex.
Apple HealthKit Category Type Code System

HKCategoryTypeIdentifier - Identifiers for creating category types.
Apple HealthKit Characteristic Type Code System

The identifiers that create characteristic type objects.
Apple HealthKit Correlation Type Code System

Code System required for defining correlationType ValueSet
Apple HealthKit Quantity Type Code System

Code System required for defining quantityType ValueSet
Apple HealthKit Sample Type Code System

Code System required for defining sampleType ValueSet
Apple HealthKit Workout Activity Type Code System

Code System required for defining workoutActivityType ValueSet
Apple HealthKit Workout Event Type Code System

Code System required for defining workout event type ValueSet

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Jane Doe

A sample patient resource for Jane Doe.
Jane Doe Composition

A minimal narrative composition for Jane Doe's patient data.
Jane Doe PDF Report

A PDF genomics report for Jane Doe regarding celiac disease.
Jane Doe Smartphone Photo

A JPEG photo taken from Jane Doe's smartphone.
Jane Doe's Photo Provenance

Self-attested provenance record for Jane Doe's smartphone photo.
PCDSleepObservation-duration-example

Example - pcd-sleep-observation duration
PCDSleepObservation-stage-example

Example - pcd-sleep-observation stage
PatientDataReceipt Message

An atomic update to a patient record; sent via a commit/push command and POST or PUT operation.
PhrBundle-example

Jane Doe - PhrBundle