Personal Health Records, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/personal-health-record-format-ig/ and changes regularly. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
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 |
These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.
| Environmental Observation |
A logical model representing environmental conditions relevant to patient health, such as air quality, temperature, noise, and UV exposure. These factors may be collected by consumer weather stations, smartphone sensors, or wearable devices. |
| Financial Receipt |
A logical model for over-the-counter (OTC) health-related purchase receipts. Captures expenses for items such as pharmacy purchases, medical supplies, copays, and wellness products that may not generate a formal insurance Claim resource. |
| Nutrient Outtake |
A logical model representing bodily elimination and excretion output. Complements nutrient intake by tracking outputs such as urine, stool, emesis, and perspiration. Relevant for hydration monitoring, bowel health, kidney function, and post-surgical intake/output tracking. |
| Social Media Usage |
A logical model representing social media and digital device usage patterns relevant to patient mental health and wellness. Captures screen time, engagement patterns, and self-reported sentiment. Relevant for behavioral health, digital wellness, and adolescent health monitoring. |
These define forms used by systems conforming to this implementation guide to capture or expose data to end users.
| GAD-7 assesment |
GAD-7 Scored Assessment |
| PHQ-9 assesment |
PHQ-9 Scored Assessment |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| PGHD Activity Profile |
This profile defines how to represent Activity. |
| PGHD AlcholConsumption Profile |
This profile defines how to represent AlcholConsumption. |
| PGHD AlcholUse Profile |
This profile defines how to represent Alchol use. |
| PGHD Audiogram Profile |
This profile defines how to represent Audiogram. |
| PGHD BMI Profile |
This profile defines how to represent BMI measurements. |
| PGHD BloodGlucose Profile |
This profile defines how to represent blood glucose. |
| PGHD BloodPressure Profile |
This profile defines how to represent blood pressure measurements. |
| PGHD Body Measurement Profile |
This profile defines how to represent body measurements. |
| PGHD BodyHeight Profile |
This profile defines how to represent body height measurements. |
| PGHD BodyTemperature Profile |
This profile defines how to represent body temperature measurements. |
| PGHD BodyWeight Profile |
This profile defines how to represent body weight measurements. |
| PGHD Cardiac Function Profile |
This profile defines how to represent Cardiac Function. |
| PGHD Device Profile |
This profile defines the device used for the measurement. |
| PGHD Diving Profile |
This profile defines how to represent Diving. |
| PGHD Electrocardiogram Profile |
This profile defines how to represent Electrocardiogram. |
| PGHD Food Profile |
This profile defines how to represent Food. |
| PGHD Hearing Profile |
This profile defines how to represent Hearing. |
| PGHD HearingSensitivity Profile |
This profile defines how to represent HearingSensitivity. |
| PGHD HeartRate Profile |
This profile defines how to represent heart rate measurements. |
| PGHD Heartbeat Profile |
This profile defines how to represent Heartbeat. |
| PGHD Medication Adherence Profile |
This profile defines how to represent medication adherence. |
| PGHD MedicationAdministration Insulin Profile |
This profile defines the administered insulin doses of a patient. |
| PGHD MedicationDispense Profile |
This profile defines the dispensing on the part of a pharmacy. |
| PGHD Mindfulness Profile |
This profile defines how to represent Mindfulness. |
| PGHD Mobility Profile |
This profile defines how to represent Mobility. |
| PGHD Nutrition Profile |
This profile defines how to represent Nutrition. |
| PGHD OxygenSaturation Profile |
This profile defines how to represent oxygen saturation measurements. |
| PGHD Patient Profile |
This profile defines patient information. |
| PGHD Pregnancy Status Profile |
This profile defines how to represent Pregnancy status. |
| PGHD Questionnaire Profile |
This profile defines the questionnaire. |
| PGHD QuestionnaireResponse Profile |
This profile defines the QuestionnaireResponse. |
| PGHD ReproductiveHealth Profile |
This profile defines how to represent ReproductiveHealth. |
| PGHD RespiratoryRate Profile |
This profile defines how to represent respiratory rate measurements. |
| PGHD Scored Assessment Profile |
This profile defines the implementation of the Scored Assessment. |
| PGHD Self Care Profile |
This profile defines how to represent SelfCare. |
| PGHD SelfCare Plan Profile |
This profile defines the SelfCare Plan. |
| PGHD Sleep Episode Profile |
This profile defines how to represent Sleep episode. |
| PGHD Sleep Profile |
This profile defines how to represent Sleep. |
| PGHD SnoreEvent Profile |
This profile defines how to represent SnoreEvent. |
| PGHD SnoreIndex Profile |
This profile defines how to represent SnoreIndex. |
| PGHD State of Mind Profile |
This profile defines the implementation of the State of Mind. |
| PGHD Symptom Profile |
This profile defines how to represent Symptom. |
| PGHD Test Result Profile |
This profile defines how to represent TestResult. |
| PGHD UVExposure Profile |
This profile defines how to represent UVExposure. |
| PGHD Vital Signs Profile |
This profile defines how to represent vital signs measurements. |
| PGHD VoltageMeasurement Profile |
This profile defines how to represent VoltageMeasurement. |
| PGHD Workout Profile |
This profile defines how to represent Workout. |
| 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. |
These define sets of codes used by systems conforming to this implementation guide.
| Body Temperature Measurement Location Codes |
Code indicating the location where the body temperature was measured |
| ECG Classification Codes |
Codes for classification of ECG waveforms |
| ECG Lead Codes |
Codes for ECG induction |
| ECG Lead Codes |
Codes for ECG and related items |
| ECG Symptoms Status Codes |
Code indicating whether or not the user's symptoms are input during ECG waveform acquisition |
| Observation Activity Codes |
Codes representing activity-related measurement items |
| Observation AlcholConsumption Codes |
Codes representing items measured for alcohol consumption |
| Observation BodyMeasurements Codes |
Codes representing measurement items related to physical measurements |
| Observation Diving Codes |
Codes for diving-related measurement items |
| Observation GAD7 Risk Codes |
Codes representing GAD-7 Assesment Risk measurement items |
| Observation Hearing Codes |
Code for a measurement item related to hearing |
| Observation LabResults Codes |
Codes representing measurement items associated with the inspection |
| Observation Mind Codes |
Codes representing mind measurement items |
| Observation Mindfulness Codes |
Codes representing mindfulness-related measures |
| Observation Mobility Codes |
Codes representing mobility-related measurement items |
| Observation Nutrition Codes |
Codes representing nutrition-related measures |
| Observation PHQ9Risk Codes |
Codes representing PHQ-9 Assesment Risk measurement items |
| Observation ReproductiveHealth Codes |
Codes representing reproductive-health-related measures |
| Observation Scored Assessment Codes |
Code for scored assessment |
| Observation SelfCare Codes |
Codes representing selfcare-related measurement items |
| Observation Sleep Codes |
Codes representing sleep-related measurement items |
| Observation State of Mind Association Codes |
Codes for state of mind association |
| Observation State of Mind Codes |
Codes for state of mind |
| Observation State of Mind Codes |
Codes for state of mind |
| Observation State of Mind Kind Codes |
Codes for state of mind kind |
| Observation State of Mind Label Codes |
Codes for state of mind label |
| Observation State of Mind Valence Codes |
Codes for state of mind valence |
| Observation Symptom Codes |
Codes representing symptom-related measurement items |
| Observation Symptom SNOMED CT Codes |
Codes representing symptom-related measurement items with SNOMED CT |
| Observation UVExposure Codes |
Codes representing UV Exposure-related measurement items |
| Observation Vitalsigns Codes |
Codes representing vitalsigns-related measurement items |
| Observation Workout Codes |
Codes representing workout-related measurement items |
| 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 |
| Sleep Analysis |
Codes for stages of sleep |
| Symptom Appetite Changes |
Codes expressing changes in appetite |
| Symptom Presence |
Code for presence or absence of symptoms |
| Symptom Severity |
Code for degree of symptoms |
These define new code systems used by systems conforming to this implementation guide.
| Appetite Changes Codes |
Codes expressing changes in appetite |
| Body Posture Codes |
Code for posture |
| Body Temperature Measurement Location Codes |
Code indicating the location where the body temperature was measured |
| ECG Classification Codes |
Codes for classification of ECG waveforms |
| ECG Classification Codes |
Codes for ECG and related items |
| ECG Lead Codes |
Codes for ECG induction |
| ECG Symptoms Status Codes |
Code indicating whether or not the user's symptoms are input during ECG waveform acquisition |
| GAD-7 Assesment Risk Codes |
Code for GAD-7 Assesment Risk |
| Hearing Sensitivity Codes |
Code indicating the type of value of the hearing test result |
| Observation PGHD Codes |
Code defining the type of PGHD data |
| PHQ-9 Assesment Risk Codes |
Code for PHQ-9 Assesment Risk |
| Scored Assessment Codes |
Code for scored assessment |
| Sleep Analysis Codes |
Codes for stages of sleep |
| Sleep Episode Codes |
Codes for sleep episodes |
| Snore Event Item Codes |
Code representing the measurement used in the snoring event |
| State of Mind Association Codes |
Codes for state of mind association |
| State of Mind Codes |
Code for state of mind |
| State of Mind Kind Codes |
Codes for state of mind kind |
| State of Mind Label Codes |
Codes for state of mind label |
| State of Mind Valence Codes |
Codes for state of mind valence |
| Symptom Presence Codes |
Code for presence or absence of symptoms |
| Symptom Severity Codes |
Code for degree of symptoms |
These define transformations to convert between codes by systems conforming with this implementation guide.
| ConceptMapSymptomPGHD2SNOMEDCT |
| ConceptMapSymptomSNOMEDCT2PGHD |
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. |
| ObservationSleepEpisodeExample2 |
SleepEpisode Example |
| PCDSleepObservation-duration-example |
Example - pcd-sleep-observation duration |
| PCDSleepObservation-stage-example |
Example - pcd-sleep-observation stage |
| PGHDPatientExample |
Patient Example |
| 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 |
| QuestionnaireResponseScoredAssessmentGAD7Example |
GAD-7 Scored Assessment Example |
| QuestionnaireResponseScoredAssessmentPHQ9Example |
PHQ-9 Scored Assessment Example |
| ScoredAssessmentGAD7Example |
GAD-7 Scored Assessment Example |
| ScoredAssessmentPHQ9Example |
PHQ-9 Scored Assessment Example |
| StateOfMind2Example |
State of Mind Example |
| StateOfMindExample |
State of Mind Example |
| pghd-activity-activeEnergyBurned |
Activity activeEnergyBurned Example |
| pghd-activity-activeEnergyBurned-underwaterDiving |
Activity activeEnergyBurned Example |
| pghd-activity-activeEnergyBurned-walking |
Activity activeEnergyBurned Example |
| pghd-activity-appleExerciseTime |
Activity appleExerciseTime Example |
| pghd-activity-appleMoveTime |
Activity appleMoveTime Example |
| pghd-activity-appleStandHour |
Activity appleStandHour Example |
| pghd-activity-basalEnergyBurned |
Activity basalEnergyBurned Example |
| pghd-activity-cyclingCadence |
Activity cyclingCadence Example |
| pghd-activity-distanceWalkingRunning-walking |
Activity distanceWalkingRunning Example |
| pghd-alchol-consumption-bloodAlcoholContent |
AlcholConsumption bloodAlcoholContent Example |
| pghd-alchol-use-numberOfAlcoholicBeverages |
AlcholUse numberOfAlcoholicBeverages Example |
| pghd-audiogram |
Audiogram Example |
| pghd-blood-glucose-1 |
BloodGlucose Example |
| pghd-blood-glucose-2 |
BloodGlucose Example |
| pghd-blood-glucose-3 |
BloodGlucose Example |
| pghd-bloodpressure |
BloodPressure Example |
| pghd-bmi |
BMI Example |
| pghd-bodyheight |
BodyHeight Example |
| pghd-bodymeasurement |
BodyMeasurement bodyFatPercentage Example |
| pghd-bodytemperature |
BodyTemperature Example |
| pghd-bodyweight |
Body Weight Example |
| pghd-cardiac-function-lowHeartRateEvent |
CardiacFunction lowHeartRateEvent Example |
| pghd-diving-underwaterDepth |
Diving underwaterDepth Example |
| pghd-diving-waterTemperature |
Diving waterTemperature Example |
| pghd-food |
Food Example |
| pghd-hearing-environmentalAudioExposure |
Hearing environmentalAudioExposure Example |
| pghd-hearingSensitivity-1 |
HearingSensitivity Example |
| pghd-hearingSensitivity-2 |
HearingSensitivity Example |
| pghd-hearingSensitivity-3 |
HearingSensitivity Example |
| pghd-hearingSensitivity-4 |
HearingSensitivity Example |
| pghd-heart-electrocardiogram |
Heart electrocardiogram Example |
| pghd-heartbeat |
Heartbeat Example |
| pghd-heartrate |
HeartRate Example |
| pghd-medication-adherence |
MedicationAdherence Example |
| pghd-medicationadministration-insulin |
MedicationAdministration Insulin Example |
| pghd-mindfulness-mindfulSession |
Mindfulness Example |
| pghd-mobility-stairDescentSpeed |
Mobility stairDescentSpeed Example |
| pghd-nutrition-dietaryCarbohydrates |
Nutrition dietaryCarbohydrates Example |
| pghd-nutrition-dietaryEnergyConsumed |
Nutrition dietaryEnergyConsumed Example |
| pghd-nutrition-dietaryFiber |
Nutrition dietaryFiber Example |
| pghd-nutrition-dietaryProtein |
Nutrition dietaryProtein Example |
| pghd-oxygenSaturation |
OxygenSaturation Example |
| pghd-pregnancy-status |
PregnancyStatus Example |
| pghd-reproductive-health-intermenstrualBleeding |
ReproductiveHealth intermenstrualBleeding Example |
| pghd-respiratoryrate |
RespiratoryRate Example |
| pghd-selfcare-handwashingEvent |
SelfCare handwashingEvent Example |
| pghd-sleep-asleepCore |
Sleep asleepCore Example |
| pghd-sleep-episode-1 |
SleepEpisode Example |
| pghd-sleep-episode-core-sleep-1 |
SleepEpisode Example |
| pghd-sleep-episode-core-sleep-2 |
SleepEpisode Example |
| pghd-sleep-episode-deep-sleep- |
SleepEpisode Example |
| pghd-sleep-episode-deep-sleep-1 |
SleepEpisode Example |
| pghd-sleep-episode-latency-to-sleep-onset-1 |
SleepEpisode Example |
| pghd-sleep-episode-latency-to-sleep-onset-2 |
SleepEpisode Example |
| pghd-snore-event-1 |
SnoreIndex Example |
| pghd-snore-event-2 |
SnoreIndex Example |
| pghd-snore-event-3 |
SnoreIndex Example |
| pghd-snore-index- |
SnoreIndex Example |
| pghd-snore-index-2 |
SnoreIndex Example |
| pghd-symptom-fever |
Symptom fever Example |
| pghd-testresult-forcedVitalCapacity |
TestResult forcedVitalCapacity Example |
| pghd-uvexposure |
UVExposure Example |
| pghd-vitalsigns-appleSleepingWristTemperature |
VitalSigns appleSleepingWristTemperature Example |
| pghd-voltage-measurement |
VoltageMeasurement Example |
| pghd-workout-underwaterDiving |
Workout underwaterDiving Example |
| pghd-workout-walking |
Workout walking Example |