hl7-eu-logo
PROTECT-CHILD Pediatric Transplant Data Implementation Guide
0.1.0-ci-build -

PROTECT-CHILD Pediatric Transplant Data Implementation Guide
0.1.0-ci-build - ci-build

PROTECT-CHILD Pediatric Transplant Data Implementation Guide, published by Protect Child. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/protect-child/ and changes regularly. 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: 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.

BioSample logical model

Logical model for the PROTECT-CHILD bio_sample table.

ClinicalEvent logical model

Logical model for the PROTECT-CHILD clinical_event table. Each visit record captures either the start or end of a clinical event.

ClinicalEventType logical model

Logical model for the PROTECT-CHILD clinical_event_type table.

ClinicalVariable logical model

Logical model for the PROTECT-CHILD clinical_variable table. Includes weight, height, diuresis, and concomitant disease.

ConcomitantMedication logical model

Logical model for the PROTECT-CHILD concomitant_medication table.

Donor logical model

Logical model for the PROTECT-CHILD donor table.

ImmPat logical model

Logical model for the PROTECT-CHILD imm_pat table. Phase field (Induction / Maintenance) maps to MedicationStatement.category.

Immunological Data logical model

Logical model for the PROTECT-CHILD immunological_data table. Covers blood group, Rh, HLA allele typing, DSA, Banff category, C4d, and ANCA.

Immunosuppressant logical model

Logical model for the PROTECT-CHILD immunosuppressant catalogue table.

InstrumentalInvestigation logical model

Logical model for the PROTECT-CHILD instrumental_investigation table.

LabResult logical model

Logical model for the PROTECT-CHILD lab_result table.

LabTest logical model

Logical model for the PROTECT-CHILD lab_test catalogue table.

Microbiology logical model

Logical model for the PROTECT-CHILD microbiology table. Covers viral serology, DNA quantification, culture results, and BKVAN evidence.

Patient logical model

Logical model for the PROTECT-CHILD patient table.

PreMedication logical model

Logical model for the PROTECT-CHILD pre_medication table.

Transplant logical model

Logical model for the PROTECT-CHILD transplant table.

Visit logical model

Logical model for the PROTECT-CHILD visit table.

Vital Sign logical model

Logical model for the PROTECT-CHILD vital_sign table. Contains standard vitals and ABPM measurements.

Structures: Resource Profiles

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

Biological Sample

Biological sample linked to a transplant visit, aligned with the DMv1.2 bio_sample table. Patient navigable via Specimen.subject. Visit linked via extension[visit_id]. Analysis intent (genomic_sample / epigenomic_sample) is represented as BioSampleAnalysisRequest (ServiceRequest) resources with specimen = Reference(BioSample). send_ingemm_date maps to the native Specimen.receivedTime.

Biological Sample Analysis Request

A work order representing the intent to perform omics analysis (genomic or epigenomic) on a BioSample. One instance per analysis type per sample. Analysis intent (genomic_sample / epigenomic_sample) is carried here as ServiceRequest.code; Specimen.type remains free for specimen material type. specimen = Reference(BioSample).

Clinical Event

A clinical event for a transplant patient, aligned with the DMv1.2 clinical_event table. Event phase (START/END) is represented via native Condition lifecycle. Boolean DM fields are in Condition.evidence.code (presence = true). Free-text fields are in Condition.note. Dialysis episodes, retransplantation, and transplant-list entry are linked ClinicalEventProcedure resources via Procedure.reasonReference.

Clinical Event Flag Observation

Boolean flag associated with a clinical event (DMv1.2 clinical_event table). Each instance represents one true flag. Absence of an instance for a given code means the flag is false. Linked to the parent ClinicalEvent via Observation.focus. The transplant type extension enables organ-specific invariants pc-flag-1 through pc-flag-3.

Clinical Event Procedure

A procedure sub-event associated with a clinical event (DMv1.2 dialysis episodes, retransplantation, transplant-list entry). Linked to the parent ClinicalEvent Condition via Procedure.reasonReference.

Clinical Variable

Clinical variables recorded for a transplant patient at a visit, aligned with the DMv1.2 clinical_variable table. Captures weight, height, diuresis, and concomitant disease(s). Vital signs (BP, HR, O2, temperature) moved to the VitalSign profile in DMv1.2.

Concomitant Medication

Concomitant medication record for a transplant patient at a visit, aligned with the DMv1.2 concomitant_medication table.

Donor liver graft type observation

Type of liver graft (complete vs partial) captured as an Observation (LOINC 74836-8). Only applicable for liver or combined transplants — invariant pc-donor-1 enforces this when tx_type extension is present.

Donor pre-KTX dialysis type observation

Dialysis method prior to kidney transplantation (LOINC 70958-4). Only applicable for kidney or combined transplants — invariant pc-donor-2 enforces this when tx_type extension is present.

Immunological Data

Immunological data panel for a transplant patient at a given visit, aligned with the DMv1.2 immunological_data table. Covers ABO/Rh blood typing, HLA allele typing (IMGT/HLA notation), DSA, Banff category, C4d, ANCA, and related fields.

Conformance: Systems producing this resource SHALL populate identifier, status, category, code, subject, encounter, and at least one component. Systems consuming this resource SHALL be able to process all defined components.

Immunosuppressant

Immunosuppressive drug catalogue entry. imm_id is carried as an identifier; the drug name maps to Medication.code.

Immunosuppressant PK Observation

Pharmacokinetic monitoring result (pre-dose trough level, 2 h post-dose level / C2, or AUC) for an immunosuppressant therapy record. Linked to the parent ImmPat MedicationStatement via Observation.partOf. Use Observation.subject to carry the patient directly for FHIR searchability.

Immunosuppressant to Patient

Immunosuppressive treatment record for a transplant patient (induction or maintenance), aligned with the DMv1.2 imm_pat table. Covers both induction and maintenance phases via MedicationStatement.category. Patient is navigable via context (Visit) → Visit.subject. Pharmacokinetic monitoring values (pre_dose_level, csa_2h_post_dose_level, auc) are represented as linked ImmPatPKObservation resources via Observation.partOf.

Instrumental Investigation

Catalogue entry for an instrumental investigation test type, aligned with the instrumental_investigation table.

Lab Result

Individual laboratory result for a transplant recipient, aligned with the lab_result table.

Lab Test

Definition of a laboratory test (catalogue entry), aligned with the lab_test table. Systems SHALL use LOINC codes from LabTestNameVS as the primary code. Local codes from LabTestLocalCS SHALL only be used for calculated values without a single unambiguous LOINC code.

Laboratory DiagnosticReport

Laboratory report grouping one or more lab result observations for a transplant recipient.

Microbiology

Microbiology panel for transplant recipients and/or donors. Component slices cover virology (EBV, CMV, Parvovirus B19, HSV, Adenovirus, VZV, BKV) plus organ-specific findings. The transplant type (extension[tx-type]) is required when organ-specific components are populated; invariants pc-micro-1 through pc-micro-4 enforce applicability.

Patient Demographics Observation

Panel Observation for patient or donor age at transplant (age_years, age_months). Category is #survey to distinguish from laboratory results. One instance per patient or donor. Subject accepts PatientTransplant or Donor.

Patient Instrumental Investigation

Instrumental investigation performed on a transplant patient, aligned with the pat_inst_inv table. All DM fields map to native Observation elements — no extensions.

Patient Liver Disease Diagnosis

Primary liver disease diagnosis that led to transplantation, aligned with DMv1.2 diag_primary_disease and date_diag_primary_disease. date_diag_primary_disease maps to Condition.onsetDateTime.

Patient Pre-transplant Immunology Observation

Panel Observation for pre-transplant immunological scalar facts: maximum PRA, most recent PRA, and histological diagnosis date. Category is #laboratory. One instance per transplant recipient. ABO/Rh and HLA typing are in ImmunologicalData.

Patient Renal Disease Diagnosis

Primary renal disease diagnosis that led to transplantation, aligned with DMv1.2 diag_primary_disease and date_diag_primary_disease. date_diag_primary_disease maps to Condition.onsetDateTime.

Pre-transplant Medication

Pre-transplant medication record aligned with the pre_medication table.

Pre-transplant Medication — Child Record

A subsidiary pre-transplant medication record (rituximab desensitisation or antiviral prophylaxis) linked to its parent PreMedication via MedicationStatement.partOf. status #completed = given; status #not-taken = explicitly not given.

Study Centre

A PROTECT-CHILD participating transplant centre. center_no (1–4) is carried as identifier.value in the study-centre namespace. All PatientTransplant resources reference their centre via Patient.managingOrganization.

Transplant

Procedure profile representing a transplant, aligned with DMv1.2 transplant table. The donor is linked via extension[donor_id]. The associated Visit is linked natively via Procedure.encounter. Intraoperative details are represented as a single TransplantDetails panel Observation linked via Observation.partOf.

Transplant Details

Intraoperative and peri-operative details panel for a transplant, aligned with the DMv1.2 transplant table. All detail fields are components of a single Observation linked to the Transplant Procedure via Observation.partOf. One instance per transplant. The mandatory txType component carries the transplant type (liver / kidney / combined) so organ-specific invariants (pc-td-1 through pc-td-5) can be evaluated without cross-resource resolution.

Transplant Donor

Transplant donor profile based on the FHIR Patient resource, aligned with the donor table.

Transplant Recipient

Transplant recipient profile based on the FHIR Patient resource, aligned with the DMv1.2 patient table. Blood group, Rh, and HLA data are in ImmunologicalData. Age at transplant is in PatientDemographicsObservation; PRA and histological date are in PatientImmunologyObservation. Patient.birthDate SHOULD also be populated when known. Primary disease diagnoses are PatientLiverDiseaseDiagnosis / PatientRenalDiseaseDiagnosis (Condition).

Visit

Encounter profile representing a visit in the transplant follow-up schedule. All clinical resources back-reference this Visit via their native encounter/context element or a slim extension on the resource itself. No extensions are needed on Visit.

Vital Sign

Vital signs panel for a transplant patient at a visit, aligned with the DMv1.2 vital_sign table. Captures standard vitals plus ABPM (24-hour ambulatory blood pressure) metrics.

Structures: Extension Definitions

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

Transplant donor reference

Reference to the donor associated with this transplant.

Transplant type context

Records the transplant type (liver / kidney / combined) on resources that carry organ-specific data fields, enabling organ-specific FHIRPath invariants within a single resource.

Visit reference

visit_id – reference to the Visit during which this sample was collected.

Terminology: Value Sets

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

ABO Group ValueSet

ABO blood groups for transplant recipients and donors.

Banff Category ValueSet
Biological Sample Analysis Type ValueSet

Allowed analysis type codes for BioSampleAnalysisRequest.code.

Clinical Event Flag ValueSet

Codes for ClinicalEventFlagObservation.code — one per boolean DM flag on the clinical_event table. Presence of an Observation with this code means the flag is true.

Clinical Event Procedure Type ValueSet

Allowed procedure types for ClinicalEventProcedure.

Clinical Event Type ValueSet

Allowed clinical event types in the PROTECT-CHILD study (DMv1.2).

Concomitant Disease Category ValueSet

Allowed concomitant disease codes in clinical_variable (DMv1.2).

DSA HLA Class ValueSet
Dialysis method ValueSet

Dialysis method values using LOINC answer codes.

Donor Liver Type ValueSet
Immunosuppressant Dose Unit ValueSet

Allowed UCUM dose units for immunosuppressant therapy records (DMv1.2 imm_pat.unit field).

Immunosuppressant Drug Type

ValueSet of immunosuppressive drug types.

Immunosuppressant PK Observation Type ValueSet

Allowed PK observation types for ImmPatPKObservation.

Immunosuppressant Phase ValueSet

Allowed phase values for MedicationStatement.category on ImmPat records.

Instrumental Investigation Name

ValueSet of instrumental investigation tests conducted.

Intraoperative Complications ValueSet

Allowed intraoperative complications during transplantation.

Lab Result Unit ValueSet

Allowed UCUM units of measurement for lab result values (DMv1.2 unit field).

Lab Test Name ValueSet

Allowed laboratory test names for the PROTECT-CHILD data model. LOINC codes are used as the primary standard; local codes from LabTestLocalCS are used only for calculated or composite measures without a single unambiguous LOINC equivalent.

MFI Category ValueSet
PRA Type ValueSet
Patient Instrumental Investigation Result ValueSet

Allowed results for the instrumental investigation test (Normal, Abnormal).

Pre-medication Antihypertensive Drug ValueSet

Allowed antihypertensive drugs for antihypertensive_treatment.

Rh Factor ValueSet
Transplant Detail ValueSet

Allowed codes for transplant detail Observation components.

Transplant Type ValueSet

Allowed transplant types.

Type of surgical biliary anastomosis ValueSet

Allowed types of biliary anastomosis in liver transplant.

Ureteral Graft Anastomosis Type ValueSet

Allowed ureteral graft anastomosis types.

Vascular Complication Type ValueSet
Visit Type ValueSet

Allowed types of visits in the transplant follow-up schedule (DMv1.2).

Terminology: Code Systems

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

ABO Group CodeSystem

ABO blood groups for transplant recipients and donors.

Banff Category CodeSystem

Banff working classification of kidney/liver allograft pathology categories (Solez et al.). See https://www.banfffoundation.org/ for the full classification.

Biological Sample Analysis Type

Intended omics analysis type for a biological sample. Used as the ServiceRequest.code on BioSampleAnalysisRequest resources.

Clinical Event Evidence CodeSystem

Coded findings used in Condition.evidence.code to represent boolean DM fields. Presence of a code means the flag is true; absence means false.

Clinical Event Procedure Type CodeSystem

Types of procedures linked to a ClinicalEvent via ClinicalEventProcedure.reasonReference. Used for dialysis episodes, retransplantation, and transplant-list entry (DMv1.2).

Clinical Event Type CodeSystem

Types of clinical events in the PROTECT-CHILD study (DMv1.2), replacing outcome_type and post_event_type.

Clinical Variable Component Codes

Local codes for ClinicalVariable Observation component slices that are not covered by LOINC. Currently used for the concomitant_disease repeating component.

Concomitant Disease Category CodeSystem

Concomitant disease codes used in the DMv1.2 clinical_variable table. Coded values are carried as ClinicalVariable Observation components (component[concomitant_disease]).

DSA HLA Class CodeSystem

Post-transplant donor-specific antibody HLA class.

Donor Liver Type CodeSystem

Type of liver donation (complete vs partial).

Immunological Data Component Codes

Local component codes for immunological data panel slices. HLA allele positions use per-position codes (hla-a-1, hla-a-2, …) so that pattern-discriminator slicing can distinguish allele 1 from allele 2. Non-HLA codes cover DSA, Banff, C4d, ANCA, and related fields.

Immunological Data Panel CodeSystem

Local code for the PROTECT-CHILD composite immunological data panel, which covers ABO/Rh typing, HLA allele typing, DSA, Banff category, C4d, and ANCA.

Immunosuppressant Drug Type

Types of immunosuppressive drugs used in the transplant setting.

Immunosuppressant PK Observation Type CodeSystem

Types of pharmacokinetic monitoring observations for immunosuppressant therapy (DMv1.2 pre_dose_level, csa_2h_post_dose_level, auc).

Immunosuppressant Phase CodeSystem

Whether the immunosuppressant record is for induction or maintenance phase (DMv1.2). Used as MedicationStatement.category codes.

Instrumental Investigation Name

Types of instrumental investigation tests conducted (expanded for DMv1.2).

Intraoperative Complications CodeSystem

Intraoperative complications during transplantation (liver or kidney).

Lab Test Local Codes

Local codes for laboratory tests that do not have a single unambiguous LOINC code in the PROTECT-CHILD context (e.g., calculated values or composite measures).

MFI Category CodeSystem

Mean fluorescence intensity category for DSA.

Microbiology component codes

Local codes for microbiology panel Observation components.

PRA Type CodeSystem

Distinguishes maximum (historical) vs most recent PRA measurements. Used as component codes in PatientImmunologyObservation.

Patient Instrumental Investigation Result CodeSystem

Result of the instrumental investigation test conducted (Normal / Abnormal).

Patient Observations Panel CodeSystem

Local codes for PROTECT-CHILD patient observation panels.

Pre-medication Antihypertensive Drug CodeSystem

Antihypertensive drugs used as pre-transplant medication.

Rh Factor CodeSystem

Rh factor for transplant recipients and donors.

Transplant Detail CodeSystem

Codes for transplant-level details captured as Observation components.

Transplant Type CodeSystem

Type of solid-organ transplant (liver, kidney, combined liver-kidney).

Type of surgical biliary anastomosis CodeSystem

Types of biliary anastomosis used in liver transplantation.

Ureteral Graft Anastomosis Type CodeSystem

Types of ureteral graft anastomosis used in transplantation (DMv1.2).

Vascular Complication Type CodeSystem

Types of vascular complications in transplant (DMv1.2).

Visit Type CodeSystem

Type of visit in the transplant follow-up schedule.

Vital Sign Local Codes

Local codes for ABPM-derived metrics that have no published LOINC code: systolic/diastolic blood pressure load and nocturnal dip percentages.

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming to this implementation guide.

Study centre identifier namespace

Namespace for PROTECT-CHILD study centre identifiers (center_no = 1–4).

Example: Example Instances

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

Example Biological Sample

Example biological sample aligned with DMv1.2. genomic_sample=true, epigenomic_sample=false.

Example Clinical Event Procedure — Hemodialysis

Hemodialysis episode linked to a clinical event via reasonReference.

Example Clinical Event Procedure — Retransplantation

Retransplantation event linked to the graft-failure clinical event. retransplantation=true is implicit from the existence of this resource.

Example Clinical Event Procedure — Transplant List Entry

Date patient was listed for retransplantation, linked to the triggering clinical event.

Example Clinical Event — Kidney Rejection START

Example clinical event recording the start of a kidney rejection episode at a 3-month visit.

Example Clinical Variable

Example clinical variables for a transplant patient at a 1-month follow-up visit (DMv1.2).

Example Concomitant Medication

Example ongoing concomitant antihypertensive medication (DMv1.2).

Example ImmPat PK Observation — Pre-dose level

Tacrolimus trough level (C0) linked to the maintenance ImmPat record via partOf.

Example Immunological Data

Example immunological data panel for a liver transplant recipient at 1-month visit.

Example Immunosuppressant

Methylprednisolone as an immunosuppressant catalogue entry.

Example Immunosuppressant to Patient — Induction

Example induction immunosuppressant record (methylprednisolone) at time of transplant.

Example Immunosuppressant to Patient — Maintenance

Example maintenance immunosuppressant record (tacrolimus) at 1-month visit. PK monitoring values are separate ImmPatPKObservation resources linked via Observation.partOf.

Example Instrumental Investigation

Example instrumental investigation catalogue entry — Liver doppler ultrasound.

Example Lab Result Observation

Example creatinine result for a transplant recipient.

Example Lab Test

Example lab test catalogue entry — Albumin, reported in g/dL.

Example Laboratory Report

Example lab report grouping a single creatinine result.

Example Microbiology record

Example microbiology panel for a liver transplant recipient.

Example Patient Instrumental Investigation

Example liver doppler ultrasound result for a transplant recipient.

Example Pre-medication

Example record of pre-transplant medications for a liver transplant recipient.

Example Transplant Details

Example transplant details panel for a liver transplant (DMv1.2).

Example Vital Sign

Example vital signs panel for a transplant recipient at 1-month visit.

Example donor age observation

Age at donation for the transplant donor (PatientDemographicsObservation; subject = Reference(Donor)).

Example donor liver graft type

Complete liver graft from a deceased donor.

Example donor pre-KTX dialysis type

Hemodialysis prior to kidney transplant.

Example genomic analysis request

ServiceRequest representing genomic_sample = true for BioSampleExample1.

Example patient age observation

Age at transplant for the recipient (PatientDemographicsObservation).

Example patient liver disease diagnosis

Primary liver disease diagnosis leading to transplantation.

Example patient pre-transplant immunology observation

PRA and histological diagnosis date for the recipient (PatientImmunologyObservation).

Example patient renal disease diagnosis

Primary renal disease diagnosis leading to transplantation.

Example transplant

Example transplant instance mapped from the DMv1.2 transplant table.

Example transplant donor

Example Patient instance conforming to Donor.

Example transplant recipient

Example Patient instance conforming to DMv1.2 PatientTransplant.

Example visit

Example visit. Clinical resources (ClinicalVariable, Microbiology, PreMedication, etc.) carry the back-reference to this Visit via their own .encounter / .context element or extension.

PROTECT-CHILD Centre 1 — La Paz

La Paz University Hospital, Madrid, Spain (center_no = 1).

PROTECT-CHILD Centre 2 — Padova

University of Padova, Italy (center_no = 2).

PROTECT-CHILD Centre 3 — Palma

Son Espases University Hospital, Palma, Spain (center_no = 3).

PROTECT-CHILD Centre 4 — Hamburg

University Medical Centre Hamburg-Eppendorf, Germany (center_no = 4).