Retention Implementation Guide
1.0.0 - ci-build

Retention Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions

Artifacts Summary

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

Structures: Questionnaires

These define forms used by systems conforming to this implementation guide to capture or expose data to end users.

QuestionnaireCbqHf

Questionnaire CBQ-HF

QuestionnaireKccq

Questionnaire KCCQ

QuestionnaireMna

Questionnaire MNA

QuestionnaireMoca

Questionnaire MoCA

QuestionnairePhq9

Questionnaire PHQ-9

QuestionnaireSymptoms

Questionnaire Symptoms

Structures: Resource Profiles

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

Caregiver Retention

Caregiver profile for Retention project

Patient Retention

Patient profile for Retention project

Structures: Extension Definitions

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

Caregiver Children

Caregiver Children for Retention project

Caregiver Date of birth

Caregiver Date of birth for Retention project

Caregiver Employment status

Caregiver Employment status for Retention project

Caregiver Highest level of education

Caregiver Highest level of education for Retention project

Caregiver Living situation

Caregiver Living situation for Retention project

Caregiver Medical condition

Caregiver Medical condition for Retention project

Caregiver Sex

Caregiver Sex for Retention project

Patient ABO blood group

Patient ABO blood group for Retention project

Patient Country of residence

Patient Country of residence for Retention project

Patient Employment status

Patient Employment status for Retention project

Patient Ethnicity

Patient Ethnicity for Retention project

Patient Height

Patient Height for Retention project

Patient Highest level of education

Patient Highest level of education for Retention project

Patient Marital Status

Patient Marital Status for Retention project

Patient Sex

Patient Sex for Retention project

Terminology: Code Systems

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

ABO blood group Codesystem

Code system with input values for ABO blood group

Angina Codesystem

Code system with input values for Angina

Atrial fibrillation Codesystem

Code system with input values for Atrial fibrillation

Body Temperature Codesystem

Code system with input values for Body Temperature

Body weight Codesystem

Code system with input values for Body weight

CPET Codesystem

Code system with input values for CPET

Country of residence Codesystem

Code system with input values for Country of residence

Dyspnea Codesystem

Code system with input values for Dyspnea

Employment status Codesystem

Code system with input values for Employment status

Ethnicity Codesystem

Code system with input values for Ethnicity

Heart rate Codesystem

Code system with input values for Heart rate

Helper Codesystem

Code system with helper codes to distinguish between similar FHIR resources

Highest level of education Codesystem

Code system with input values for Highest level of education

Intention of LVAD Codesystem

Code system with input values for Intention of LVAD

Jugular Venous Pressure Codesystem

Code system with input values for Jugular Venous Pressure

Living situation Codesystem

Code system with input values for Living situation

MR Aetiology Codesystem

Code system with input values for MR Aetiology

Marital Status Codesystem

Code system with input values for Marital Status

Medical condition Codesystem

Code system with input values for Medical condition

Medication Codesystem

Code system for Medication groups

NYHA class Codesystem

Code system with input values for NYHA class

No Yes Codesystem

Code system with input values for No or Yes

Peripheral capillary oxygen saturation Codesystem

Code system with input values for Peripheral capillary oxygen saturation

Peripheral edema Codesystem

Code system with input values for Peripheral edema

Questionnaire Symptoms answers Codesystem

Code system with the answers for the Symptoms Questionnaire

Retention Codesystem

Code system to describe entities that can not be described using standard Code systems

Severe alcohol intake Codesystem

Code system with input values for Severe alcohol intake

Sex Codesystem

Code system with input values for Sex

Smoker Codesystem

Code system with input values for Smoker

Systolic blood pressure Codesystem

Code system with input values for Systolic blood pressure

Thyroid disease Codesystem

Code system with input values for Thyroid disease

Troponin Codesystem

Code system with input values for Troponin

Type death Codesystem

Code system with input values for Type death

Type of CV admission Codesystem

Code system with input values for Type of CV admission

Type of LVAD Codesystem

Code system with input values for Type of LVAD

Type of rejection Codesystem

Code system with input values for Type of rejection

VAD alarm Codesystem

Code system with input values for VAD alarm

Ventricular stimulation Codesystem

Code system with input values for Ventricular stimulation

Example: Example Instances

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

6MWT

6MWT

ACEi Captopril

ACEi Captopril

ACEi Cilazapril

ACEi Cilazapril

ACEi Enalapril

ACEi Enalapril

ACEi Fosinopril

ACEi Fosinopril

ACEi Lisinopril

ACEi Lisinopril

ACEi Perindopril

ACEi Perindopril

ACEi Quinapril

ACEi Quinapril

ACEi Ramipril

ACEi Ramipril

ACEi Trandolapril

ACEi Trandolapril

ALAT

ALAT

ALB

ALB

ALP

ALP

ARBs Candesartan

ARBs Candesartan

ARBs Losartan

ARBs Losartan

ARBs Olmesartan

ARBs Olmesartan

ARBs Valsartan

ARBs Valsartan

ASAT

ASAT

Allograft vasculopathy

Allograft vasculopathy

Amiodarone

Amiodarone

Anemia

Anemia

Angina

Angina

Antibiotics

Antibiotics

Anticoagulants Acenocoumarol

Anticoagulants Acenocoumarol

Anticoagulants Apixaban

Anticoagulants Apixaban

Anticoagulants Dabigatran

Anticoagulants Dabigatran

Anticoagulants Edoxaban

Anticoagulants Edoxaban

Anticoagulants Rivaroxaban

Anticoagulants Rivaroxaban

Anticoagulants Warfarin

Anticoagulants Warfarin

Antiplatelets Aspirin

Antiplatelets Aspirin

Antiplatelets Clopidogrel

Antiplatelets Clopidogrel

Antiplatelets Prasugrel

Antiplatelets Prasugrel

Antiplatelets Ticagrelor

Antiplatelets Ticagrelor

Aortic aneurysm

Aortic aneurysm

Aortic Root diameter

Aortic Root diameter

AR - Mild

AR - Mild

AR - Moderate

AR - Moderate

AR - Severe

AR - Severe

Arrhythmia alarms - Atrial fibrillation

Arrhythmia alarms - Atrial fibrillation

Arrhythmia alarms - Bradycardia

Arrhythmia alarms - Bradycardia

Arrhythmia alarms - Tachycardia

Arrhythmia alarms - Tachycardia

Arterial Hypertension

Arterial Hypertension

AS - Mild

AS - Mild

AS - Moderate

AS - Moderate

AS - Severe

AS - Severe

Ascites

Ascites

Atrial fibrillation

Atrial fibrillation

B12

B12

BORG

BORG

Basal right ventricle diameter

Basal right ventricle diameter

Benign Prostatic hyperplasia

Benign Prostatic hyperplasia

Beta-blocker Bisoprolol

Beta-blocker Bisoprolol

Beta-blocker Carvedilol

Beta-blocker Carvedilol

Beta-blocker Metoprolol

Beta-blocker Metoprolol

Beta-blocker Nebivolol

Beta-blocker Nebivolol

Body Temperature - Clinical Data

Body Temperature - Clinical Data

Body Temperature - RWD Sensors

Body Temperature - RWD Sensors

Body Temperature - Special Event

Body Temperature - Special Event

Body weight - Clinical Data

Body weight - Clinical Data

Body weight - RWD Sensors

Body weight - RWD Sensors

Body weight - Special Event

Body weight - Special Event

Brady-arrhythmias / AV block

Brady-arrhythmias / AV block

COPD

COPD

CPET

CPET

CPK

CPK

CRP

CRP

CRT

CRT

Calcium

Calcium

Calcium Channel Blockers Amlodipine

Calcium Channel Blockers Amlodipine

Calcium Channel Blockers Diltiazem

Calcium Channel Blockers Diltiazem

Calcium Channel Blockers Felodipine

Calcium Channel Blockers Felodipine

Calcium Channel Blockers Lacidipine

Calcium Channel Blockers Lacidipine

Calcium Channel Blockers Nifedipine

Calcium Channel Blockers Nifedipine

Calcium Channel Blockers Verapamil

Calcium Channel Blockers Verapamil

Calories

Calories

Cancer

Cancer

Capillary oxygen saturation at beginning

Capillary oxygen saturation at beginning

Capillary oxygen saturation at the end

Capillary oxygen saturation at the end

Cardiac index

Cardiac index

Cardiomyopathy - Congenital

Cardiomyopathy - Congenital

Cardiomyopathy - Dilated

Cardiomyopathy - Dilated

Cardiomyopathy - Hypertrophic

Cardiomyopathy - Hypertrophic

Cardiomyopathy - Ischemic

Cardiomyopathy - Ischemic

Cardiomyopathy - Other

Cardiomyopathy - Other

Cardiomyopathy - Restrictive

Cardiomyopathy - Restrictive

Cardiomyopathy - Toxic

Cardiomyopathy - Toxic

CaregiverExample

Example Caregiver for Retention project

Carotid Artery Disease

Carotid Artery Disease

Cerebrovascular disease

Cerebrovascular disease

Cholesterol

Cholesterol

Ciclosporin

Ciclosporin

CMV infection after transplant

CMV infection after transplant

CMV infection requering medical treatment

CMV infection requering medical treatment

CMV risk profile - High risk

CMV risk profile - High risk

CMV risk profile - Low risk

CMV risk profile - Low risk

CMV risk profile - Moderate risk

CMV risk profile - Moderate risk

Conduction delay - Incomplete LBBB

Conduction delay - Incomplete LBBB

Conduction delay - Incomplete RBBB

Conduction delay - Incomplete RBBB

Conduction delay - LAH

Conduction delay - LAH

Conduction delay - LBBB

Conduction delay - LBBB

Conduction delay - LPH

Conduction delay - LPH

Conduction delay - non specific

Conduction delay - non specific

Conduction delay - RBBB

Conduction delay - RBBB

Coronary artery disease

Coronary artery disease

CPK - MB

CPK - MB

Creatinine

Creatinine

CV admission other than HF

CV admission other than HF

D-Dimer

D-Dimer

Date CV admission

Date CV admission

Date death

Date death

Date DL infection

Date DL infection

Date GI bleeding

Date GI bleeding

Date heart transplant

Date heart transplant

Date HF admission

Date HF admission

Date HF decomp

Date HF decomp

Date HF diagnosis

Date HF diagnosis

Date LVAD implant

Date LVAD implant

Date non-CV admission

Date non-CV admission

Date stroke

Date stroke

Death

Death

Deep sleep time

Deep sleep time

Diabetes Mellitus type 1

Diabetes Mellitus type 1

Diabetes Mellitus type 2

Diabetes Mellitus type 2

Diastolic blood pressure - Clinical Data

Diastolic blood pressure - Clinical Data

Diastolic blood pressure - RWD Sensors

Diastolic blood pressure - RWD Sensors

Digoxin

Digoxin

Distance

Distance

Dizziness - Special Event

Dizziness - Special Event

Drive line infection

Drive line infection

Drive line Reinfection

Drive line Reinfection

Driveline infections

Driveline infections

Dyslipidemia

Dyslipidemia

Dyspnea - Clinical Data

Dyspnea - Clinical Data

Dyspnea - Special Event

Dyspnea - Special Event

EF

EF

Echo date

Echo date

Encounter Telephone

Encounter Telephone Example

Encounter Visit

Encounter Visit Example

Estimated glomerular filtration rate

Estimated glomerular filtration rate

E to CO2 slope

E to CO2 slope

Everolimus

Everolimus

Ezetimibe

Ezetimibe

Fatigue - Clinical Data

Fatigue - Clinical Data

Fatigue - Special Event

Fatigue - Special Event

Ferritin

Ferritin

Fibrinogen

Fibrinogen

Floors climbed

Floors climbed

Fluid intake

Fluid intake

Fractional area change

Fractional area change

Gastrointestinal bleeding after LVAD

Gastrointestinal bleeding after LVAD

Glucose

Glucose

HDL

HDL

Haematocrit

Haematocrit

Heart failure related visit

Heart failure related visit

Heart rate - Clinical Data

Heart rate - Clinical Data

Heart rate - ECG

Heart rate - ECG

Heart rate - RWD Sensors

Heart rate - RWD Sensors

Heart rate - Special Event

Heart rate - Special Event

Heart rate variability

Heart rate variability

Heart transplant

Heart transplant

Hemoglobin

Hemoglobin

Hepatomegaly

Hepatomegaly

HF admission

HF admission

HF decompensation needing iv. Diuretic-inotrops

HF decompensation needing iv. Diuretic-inotrops

ICD

ICD

INR

INR

Included in heart transplant list due to driveline infections

Included in heart transplant list due to driveline infections

Infection

Infection

Infection in other LVAD components

Infection in other LVAD components

Inferior Vena Cava (IVC)

Inferior Vena Cava (IVC)

Insulin

Insulin

Intention of LVAD

Intention of LVAD

Interventricular Septum Thickness

Interventricular Septum Thickness

Iron

Iron

Ivabradine

Ivabradine

Jugular venous vressure

Jugular venous vressure

LDH

LDH

LDL

LDL

Left atrium volume

Left atrium volume

Left ventricular Posterior wall thickness

Left ventricular Posterior wall thickness

Light sleep time

Light sleep time

Loop diuretics Bumetanide

Loop diuretics Bumetanide

Loop diuretics Furosemide

Loop diuretics Furosemide

Loop diuretics Torasemide

Loop diuretics Torasemide

Lvad implant

Lvad implant

LVED Volume

LVED Volume

LVES Volume

LVES Volume

METS

METS

Magnesium

Magnesium

MR Aetiology

MR Aetiology

MR - Mild

MR - Mild

MR - Moderate

MR - Moderate

MR - Severe

MR - Severe

MRA Eplerenone

MRA Eplerenone

MRA Spironolactone

MRA Spironolactone

MS - Mild

MS - Mild

MS - Moderate

MS - Moderate

MS - Severe

MS - Severe

Mycophenolate mofetil

Mycophenolate mofetil

Mycophenolate sodium

Mycophenolate sodium

Nt pro BNP

Nt pro BNP

Number HF admission

Number HF admission

Number HF decompensations

Number HF decompensations

Number of CV admissions

Number of CV admissions

Number of HF admissions during the previous year

Number of HF admissions during the previous year

Number of non-CV admissions

Number of non-CV admissions

NYHA class

NYHA class

O2 max

O2 max

Other antiarrhythmics Flecainide

Other antiarrhythmics Flecainide

Other antiarrhythmics Mexiletine

Other antiarrhythmics Mexiletine

Other antiarrhythmics Sotalol

Other antiarrhythmics Sotalol

Other Antidiabetics Alpha-glucosidase inhibitor

Other Antidiabetics Alpha-glucosidase inhibitor

Other Antidiabetics Dipeptidyl peptidase-4 inhibitors

Other Antidiabetics Dipeptidyl peptidase-4 inhibitors

Other Antidiabetics Glucagon-like peptide-1 receptor agonist

Other Antidiabetics Glucagon-like peptide-1 receptor agonist

Other Antidiabetics Metformin

Other Antidiabetics Metformin

Other Antidiabetics Sulfonylurea

Other Antidiabetics Sulfonylurea

Other Antidiabetics Thiazolidinedione

Other Antidiabetics Thiazolidinedione

Other Antihyperlipidemic Drugs Fibrates

Other Antihyperlipidemic Drugs Fibrates

Other Antihyperlipidemic Drugs Fish oil

Other Antihyperlipidemic Drugs Fish oil

Other Antihyperlipidemic Drugs PCSK9

Other Antihyperlipidemic Drugs PCSK9

Other drugs

Other drugs

Other non-CV admissions

Other non-CV admissions

Other - Special Event

Other - Special Event

Patient Example

Example Patient for Retention project

PPI

PPI

PRCLT

PRCLT

Pacemaker

Pacemaker

Palpitations - Special Event

Palpitations - Special Event

Peripheral artery disease

Peripheral artery disease

Peripheral capillary oxygen saturation - Clinical Data

Peripheral capillary oxygen saturation - Clinical Data

Peripheral capillary oxygen saturation - RWD Sensors

Peripheral capillary oxygen saturation - RWD Sensors

Peripheral capillary oxygen saturation - Special Event

Peripheral capillary oxygen saturation - Special Event

Peripheral edema

Peripheral edema

Peripheral hypoperfusion

Peripheral hypoperfusion

Phosphorus

Phosphorus

Platelets

Platelets

Pleural effusion

Pleural effusion

Potassium

Potassium

Potassium binders Patiromer

Potassium binders Patiromer

Potassium binders Sodium polystyrene sulfonate

Potassium binders Sodium polystyrene sulfonate

Potassium binders Sodium zirconium cyclosilicate

Potassium binders Sodium zirconium cyclosilicate

Potassium sparing diuretics Amiloride

Potassium sparing diuretics Amiloride

Potassium sparing diuretics Triamterene

Potassium sparing diuretics Triamterene

Potassium supplements Aspartate

Potassium supplements Aspartate

Potassium supplements Bicarbonate

Potassium supplements Bicarbonate

Potassium supplements Citrate

Potassium supplements Citrate

Potassium supplements Gluconate

Potassium supplements Gluconate

Potassium supplements Phosphate

Potassium supplements Phosphate

PQ - PR

PQ - PR

Previous antibody mediated rejection

Previous antibody mediated rejection

Previous cardiac surgery

Previous cardiac surgery

Previous coronary revascularization - Percutaneous

Previous coronary revascularization - Percutaneous

Previous coronary revascularization - Surgical

Previous coronary revascularization - Surgical

Previous opportunistic infections

Previous opportunistic infections

Previous rejection episodes - 1R

Previous rejection episodes - 1R

Previous rejection episodes - 2R

Previous rejection episodes - 2R

Previous rejection episodes - 3R

Previous rejection episodes - 3R

Previous rejection episodes - Humoral

Previous rejection episodes - Humoral

Previous valvular intervention - Aortic mechanical valve

Previous valvular intervention - Aortic mechanical valve

Previous valvular intervention - Mitraclip

Previous valvular intervention - Mitraclip

Previous valvular intervention - Mitral mechanical valve

Previous valvular intervention - Mitral mechanical valve

Previous valvular intervention - Other

Previous valvular intervention - Other

Previous valvular intervention - Surgical aortic valve repair

Previous valvular intervention - Surgical aortic valve repair

Previous valvular intervention - Surgical mitral valve repair

Previous valvular intervention - Surgical mitral valve repair

Previous valvular intervention - Surgical tricuspid valve repair

Previous valvular intervention - Surgical tricuspid valve repair

Previous valvular intervention - TAVr

Previous valvular intervention - TAVr

Previous valvular intervention - Tricuspid device

Previous valvular intervention - Tricuspid device

Previous valvular intervention - Tricuspid mechanical valve

Previous valvular intervention - Tricuspid mechanical valve

Pulmonary rales

Pulmonary rales

QRS

QRS

QT

QT

Questionnaire Response CBQ-HF

Questionnaire Response CBQ-HF

Questionnaire Response KCCQ

Questionnaire Response KCCQ

Questionnaire Response MNA

Questionnaire Response MNA

Questionnaire Response MoCA

Questionnaire Response MoCA

Questionnaire Response PHQ-9

Questionnaire Response PHQ-9

Questionnaire Response Symptoms

Questionnaire Response Symptoms

RER

RER

RVSP

RVSP

Rejection needing treatment in HT

Rejection needing treatment in HT

Renal insufficiency

Renal insufficiency

Resting heart rate

Resting heart rate

Right atrium area

Right atrium area

Right heart failure - At the time of implantation

Right heart failure - At the time of implantation

Right heart failure - One month after implantation

Right heart failure - One month after implantation

S3

S3

S4

S4

SGLT2i Canagliflozin

SGLT2i Canagliflozin

SGLT2i Dapagliflozin

SGLT2i Dapagliflozin

SGLT2i Empagliflozin

SGLT2i Empagliflozin

SGLT2i Ertugliflozin

SGLT2i Ertugliflozin

SGLT2i Sotagliflozin

SGLT2i Sotagliflozin

Sacubitril - Valsartan

Sacubitril - Valsartan

Severe alcohol intake

Severe alcohol intake

Sinus rhythm

Sinus rhythm

Sleep interruptions

Sleep interruptions

Smoker

Smoker

Sodium

Sodium

Statins Atorvastatin

Statins Atorvastatin

Statins Fluvastatin

Statins Fluvastatin

Statins Lovastatin

Statins Lovastatin

Statins Pitavastatin

Statins Pitavastatin

Statins Pravastatin

Statins Pravastatin

Statins Rosuvastatin

Statins Rosuvastatin

Statins Simvastatin

Statins Simvastatin

Steps

Steps

Steroids Cortisone

Steroids Cortisone

Steroids Dexamethasone

Steroids Dexamethasone

Steroids Hydrocortisone

Steroids Hydrocortisone

Steroids Methylprednisolone

Steroids Methylprednisolone

Steroids Prednisolone

Steroids Prednisolone

Steroids Prednisone

Steroids Prednisone

Stroke after LVAD implantation

Stroke after LVAD implantation

Sustained ventricular tachicardia one month after implantation

Sustained ventricular tachicardia one month after implantation

Syncope

Syncope

Systolic blood pressure - Clinical Data

Systolic blood pressure - Clinical Data

Systolic blood pressure - RWD Sensors

Systolic blood pressure - RWD Sensors

Systolic blood pressure - Special Event

Systolic blood pressure - Special Event

TAPSE

TAPSE

TSH

TSH

Tacrolimus Extended release (Envarsus)

Tacrolimus Extended release (Envarsus)

Tacrolimus Immediate release (Prograft)

Tacrolimus Immediate release (Prograft)

Tacrolimus Slow release (Advagraft)

Tacrolimus Slow release (Advagraft)

Tbil

Tbil

Thiazides Bendroflumethiazide

Thiazides Bendroflumethiazide

Thiazides Chlortalidone

Thiazides Chlortalidone

Thiazides Hydrochlorothiazide

Thiazides Hydrochlorothiazide

Thiazides Indapamide

Thiazides Indapamide

Thiazides Metolazone

Thiazides Metolazone

Thyroid disease

Thyroid disease

Tot prot

Tot prot

TR - Mild

TR - Mild

TR - Moderate

TR - Moderate

TR - Severe

TR - Severe

Transient ischemic attack

Transient ischemic attack

Triglycerides

Triglycerides

Troponin

Troponin

TS - Mild

TS - Mild

TS - Moderate

TS - Moderate

TS - Severe

TS - Severe

Type death

Type death

Type of LVAD

Type of LVAD

Unplanned emergency department visit date

Unplanned emergency department visit date

Unplanned emergency department visits

Unplanned emergency department visits

Urea

Urea

Uric acid

Uric acid

VAD alarm - Measurement

VAD alarm - Measurement

VAD flow - Measurement

VAD flow - Measurement

VAD PI - Measurement

VAD PI - Measurement

VAD PI - Special Event

VAD PI - Special Event

VAD power - Measurement

VAD power - Measurement

VAD power - Special Event

VAD power - Special Event

VAD speed - Measurement

VAD speed - Measurement

Vasodilators Hydralazine

Vasodilators Hydralazine

Vasodilators Isosorbide dinitrate

Vasodilators Isosorbide dinitrate

Venous thromboembolism / pulmonary embolism

Venous thromboembolism / pulmonary embolism

Ventricular stimulation

Ventricular stimulation

Ventricular tachycardia / Ventricular fibrillation / Resuscitated sudden death

Ventricular tachycardia / Ventricular fibrillation / Resuscitated sudden death

Vericiguat

Vericiguat

White Blood Cells

White Blood Cells

fT3

fT3

fT4

fT4

gGT

gGT