PanCareSurPass Project HL7 FHIR Implementation Guide, published by PanCareSurPass Project. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/pcsp/ 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.
Logical data models as HL7 FHIR resources
SurPass V2.0 |
Survivorship Passport V2.0 Maturity Level: 2 - Ready for Review |
HL7 FHIR profile for the SurPass document bundle
Bundle: Survivor Passport |
This profile represents the constraints applied to the Bundle resource by the PCSP FHIR Implementation Guide. |
These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.
Care Plan |
Care Plan Maturity Level: 0 - Draft |
Chemotherapy |
Chemotherapy Maturity Level: 2 - Ready for Review |
Diagnosis |
Diagnosis Maturity Level: 2 - Ready for Review |
Front Line Treatment |
Front Line Treatment. The first treatment given for a disease. It is often part of a standard set of treatments, such as surgery followed by chemotherapy and radiation. When used by itself, first-line therapy is the one accepted as the best treatment. If it does not cure the disease or it causes severe side effects, other treatment may be added or used instead. Also called induction therapy, primary therapy, and primary treatment. Maturity Level: 2 - Ready for Review |
Major Surgery |
Major Surgery. Maturity Level: 2 - Ready for Review |
Metadata FSE Italy |
Metadata FSE Italy. Maturity Level: 0 |
Other info and relevant events |
Other info and relevant events Maturity Level: 2 - Ready for Review |
Progression-Relapse after FLT |
Progression-Relapse after FLT Maturity Level: 2 - Ready for Review |
Progression-Relapse during FLT |
Progression-Relapse during FLT Maturity Level: 2 - Ready for Review |
Radiotherapy |
Radiotherapy Maturity Level: 2 - Ready for Review |
Stem Cell Transplantation |
Stem Cell Transplantation. Maturity Level: 2 - Ready for Review |
Subject of care |
Subject of care Maturity Level: 2 - Ready for Review |
Treatment Summary |
Treatment Summary data model Maturity Level: 2 - Ready for Review |
These define constraints on FHIR resources for systems conforming to this implementation guide.
BiologicallyDerivedProduct: Stem Cell |
This profile defines how to represent Stem Cell in FHIR for describing a Stem Cell Transplantation data required by the PanCareSurPass algorithm to generate the care plan. |
CarePlan: PCSP-generated plan |
This profile defines how to represent the Care Plan proposed by the PCSP platoform in HL7 FHIR. This profile can be used for both the version generated by the platoform and that curated and validated by Clinicians. |
Composition: Survivor Passport |
This profile defines how to represent a PCSP Survivor Passport by using a HL7 FHIR Composition for the purpose of the PanCareSurPass project. |
Condition: GvHD |
This profile defines how to represent Graft versus host disease (GvHD) in HL7 FHIR for the purpose of the PanCareSurPass project. |
Condition: Metastatic Cancer |
This profile defines how to represent metastatic cancer in FHIR for the purpose of the PanCareSurPass project. This profile is inspired from the mCode IG. Records the history of secondary neoplasms, including location(s) and the date of onset of metastases. A secondary cancer results from the spread (metastasization) of cancer from its original site (Definition from: NCI Dictionary of Cancer Terms). |
Condition: Others |
This profile defines how to describe the presence of some other conditions (e.g. Hypogonadism, Growth hormone deficiency, Hydrocephalus in HL7 FHIR for the purpose of the PanCareSurPass project. |
Condition: Primary Cancer |
This profile defines how to represent Primary Cancer Condition in HL7 FHIR for the purpose of the PanCareSurPass project. This profile is inspired from the mCode IG. A primary cancer condition, the original or first tumor in the body (Definition from: NCI Dictionary of Cancer Terms). Cancers that are not clearly secondary (i.e., of uncertain origin or behavior) should be documented as primary. This profile should be also used for documenting primary cancer relapses during or after FLT. |
Condition: Severe Toxicity |
This profile defines how to describe a Severe Toxicity event in HL7 FHIR for the purpose of the PanCareSurPass project. |
DocumentReference: PCSP |
This profile defines how to embed a PDF PCSP Survivor Passport in FHIR for the purpose of the PanCareSurPass project. This profile can be aslo used for send attachments (e.g Raditherapy reports or HDR) to the platform |
Encounter: Treatment Center |
This profile defines how to represent data of arrival to the center and Center information in FHIR for the purpose of the PanCareSurPass project. |
Location: PCSP |
This profile defines how to represent FHIR Location for the purpose of the PanCareSurPass project. |
MedicationAdministration: Chemotherapy |
This profile defines how to represent MedicationAdministration in HL7 FHIR for describing Chemotherapy data for the purpose of the PanCareSurPass project. |
MedicationStatement: Chemotherapy |
This profile defines how to represent MedicationStatement in FHIR for describing minimal information about provided medications for the purpose of the PanCareSurPass project. |
Observation: Blood type/RH |
This profile defines how to represent Blood type/RH before or after the SCT in HL7 FHIR for the purpose of the PanCareSurPass project. |
Observation: Cancer Stage Group |
The extent of the cancer in the body, according to a given cancer staging classification system, based on evidence such as physical examination, imaging, and/or biopsy or based on pathologic analysis of a specimen. |
Observation: Chemotherapy Cumulative Dose |
This profile defines how to represent Chemotherapy Cumulative Dose in FHIR for the purpose of the PanCareSurPass project. |
Observation: Diagnosis details |
This profile defines how to represent diagnosis details (when the diagnosis was made; who made it;…) in FHIR for the purpose of the PanCareSurPass project. |
Observation: Hereditary Predisposition |
This profile defines how to represent Hereditary Predispositions in HL7 FHIR for the purpose of the PanCareSurPass project. |
Observation: Radiotherapy Total Dose PCSP |
This profile defines how to represent Radiotherapy Total Dose in FHIR for the purpose of the PanCareSurPass project. |
Observation: Risk Factor |
This profile defines how to represent a Risk Factor in HL7 FHIR as determined by the PCSP platoform. |
Observation: TNM Distant Metastases Category |
Category describing the extent of a tumor metastasis in remote anatomical locations, based on evidence such as physical examination, imaging, and/or biopsy. |
Observation: TNM Primary Tumor Category |
Category of the primary tumor, based on its size and extent, based on evidence such as physical examination, imaging, and/or biopsy. |
Observation: TNM Regional Nodes Category |
Category of the presence or absence of metastases in regional lymph nodes, based on evidence such as physical examination, imaging, and/or biopsy. |
Organization: Primary Treatment Center / Center of diagnosis |
This profile defines how to represent the Primary Treatment Center or the Center of diagnosis in FHIR for the purpose of the PanCareSurPass project. |
Patient: PCSP |
This profile defines how to represent Patient in FHIR for the purpose of the PanCareSurPass project. |
PlanDefinition: Front Line Treatment |
This profile defines how to provide Front Line Treatment protocol infos in FHIR for the scope of the PanCareSurPass project. |
Procedure: Catheter |
This profile defines how to describe the Catheterization of vein Procedure in HL7 FHIR for the purpose of the PanCareSurPass project. |
Procedure: Cryopreservation |
This profile defines how to describe the cryopreservation of sperms or oocyte for cancer patient in HL7 FHIR for the purpose of the PanCareSurPass project. |
Procedure: Front Line Treatment |
This profile defines how to provide Front Line Treatment data in FHIR for the scope of the PanCareSurPass project. |
Procedure: Other Treatments |
This profile defines how to convey textual information about other oncological treatments in HL7 FHIR for the purpose of the PanCareSurPass project. |
Procedure: Radiotherapy |
This profile defines how to represent Procedures in FHIR for describing a set of Radiotherapy data required by the PanCareSurPass algorithm to generate the care plan. |
Procedure: Radiotherapy Boost |
This profile defines how to represent Procedures in FHIR for describing a set of data required by PanCareSurPass for Radiotherapy Boosts |
Procedure: Radiotherapy Shielding |
This profile defines how to represent Shielding Procedures in FHIR for describing a set of Radiotherapy data required by the PanCareSurPass algorithm to generate the care plan. |
Procedure: SCT Prophylaxis |
This profile defines how to represent GVHD prophylaxis, conditioning regimen Procedures in FHIR for supporting Stem Cell Transplantation data, as required by the PanCareSurPass algorithm to generate the care plan. |
Procedure: Stem Cell Transplantation |
This profile defines how to represent Procedures in FHIR for describing a set of Stem Cell Transplantation data required by the PanCareSurPass algorithm to generate the care plan. |
Procedure: Surgery |
This profile defines how to represent Procedures in FHIR for describing a set of Surgery data required by the PanCareSurPass algorithm to generate the care plan. It is used also to provide inforamtion about shunt, amputation, and other procedures |
Procedure: Transfusion other infos |
This profile defines how to describe the Transfusion Procedure in HL7 FHIR for the purpose of the PanCareSurPass project. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
Act Location |
This extension provides a means to indicate where an act was, is or it is intended to take place. |
Annotation Type |
This extension is used to indicate the kind of note captured |
Body Location Qualifier |
Qualifier to refine an body location. These include qualifiers for relative location, directionality, number, and plane, and exclude qualifiers for laterality. |
Condition related to resource |
The resource has an unspecified relationship with a Condition. |
Laterality Qualifier |
Qualifier to specify laterality. |
Not affected Organ |
This extension is used to explicitly indicate the Organ (body site) that has not been affected by this procedure. |
Performed Timing |
This extension allows to indicate when the procedure was performed as Timing. |
Previous Status |
This extension provides a mean to indicate the previous clinicalStatus of a condition. It might be used for example to indicate if a relapse is now in remission. |
Procedure Used Reference |
Extend the usedReference element to BiologicallyDerivedProduct |
Radiotherapy Energy or Isotope |
The radiation energy used for radiotherapy. The energy spectrum is characterized by the maximum energy, the maximum accelaration voltage, or the used isotope. This extension is based on the CodeX™ Radiation Therapy RadiotherapyEnergyOrIsotope extension |
Randomization arm for trial |
This extension is used to provide a textual description of the randomization arm for trials (FLT). |
Relapse Type |
This extension is used to indicate if a relapse/progression is local, remote or combined. |
Resource related information |
This extension provides a means to link the source resource to any target related information. This extension shall not be used when other more specific elements or standard extensions apply. E.g. Observation.hasMember. |
Sacrified organ |
Organs are 'sacrified' either to allow a radical excision of the tumor or on purpose (spleen) for staging procedures |
Stem Cell Donor Type |
Specify the type of donor for the cell used in a transplantation |
Stem Cell Source Type |
Specify the type of source for the cell used in a transplantation |
These define sets of codes used by systems conforming to this implementation guide.
Active or resolved Condition |
Active or resolved Condition |
||
Acute Gvhd Grade |
Acute Gvhd Grade |
||
Affected Organs (surgery) |
Affected Organs (surgery) |
||
Amputation Surgical Procedure Type |
Types of amputation procedure this resource is referring to |
||
Annotation type |
Annotation type |
||
Antineoplastic and immunostimulating agents |
List of WHO ATC codes for antineoplastic and immunostimulating agents. |
||
Before/after procedure |
SCT Timing events: Before/after procedure |
||
Body Location Qualifier Value Set |
Qualifiers to refine a body structure or location including qualifiers for relative location, directionality, number, and plane, and excluding qualifiers for laterality. |
||
Body Location Qualifier Value Set |
Types of documents exchanged with the PCSP platform |
||
Brachytherapy Type |
Types of Brachytherapy this procedure is referring to |
||
Calculated|Estimated |
|
||
Cancer Staging System Value Set |
System used for staging. |
||
Chemotherapy cumulative dose units |
Chemotherapy cumulative dose units |
||
Chronic Gvhd condition |
Acute Gvhd Grade |
||
Colostomy Surgical Procedure Type |
Types of colostomy procedure this resource is referring to |
||
Conditions at risk |
Condition at risk proposed by the PCSP algorithm |
||
Conditions: follow up |
Conditions: follow up |
||
Document Type |
Types of documents exchanged with the PCSP platform |
||
FLT Plan Type |
FLT Plan Type |
||
Gastrostomy Surgical Procedure Type |
Types of Gastrostomy procedure this resource is referring to |
||
Grade: follow up |
Grade: follow up |
||
Gvhd condition |
Gvhd condition |
||
Hereditary Predispositions (ICD10) |
Hereditary Predispositions (ICD10) |
||
Hereditary Predispositions (Orphacode) |
Hereditary Predispositions (Orphacode) |
||
Hereditary Predispositions or Disease |
Hereditary Predispositions or Disease |
||
ICCC-3 |
International Classification of Childhood Cancer, third edition + exceptional values |
||
ICD-O-3 Morphology |
ICD-O-3 Morphology |
||
ICD-O-3 Topography |
ICD-O-3 Topography |
||
Laterality Qualifier Value Set |
Qualifiers to specify laterality. |
||
Morphologically abnormal structure |
Morphologically abnormal structure. |
||
Not Applicable|Unknown |
Not Applicable/Unknown Value Set |
||
Not Performed|Unknown |
Not Performed/Unknown Value Set |
||
Observation Codes for Distant Metastases Category |
Identifying codes based on the timing of classification for distant metastases (M) staging observations. |
||
Observation Codes for Primary Tumor Category |
Identifying codes based on the timing of classification for primary tumor (T) staging observations. |
||
Observation Codes for Regional Node Category |
Identifying codes based on the timing of classification for regional node (N) staging observations. |
||
Observation Codes for Stage Group Category |
Identifying codes based on the timing of classification for stage group observations. |
||
Other Infors Condition |
Other Infors Condition |
||
Other/Unknown/Text |
Other/Unknown/Text Value Set |
||
Prosthesis Type |
Types of Prosthesis this procedure is referring to |
||
Prosthetic Surgical Procedure Type |
Types of Prosthetic procedure this resource is referring to |
||
Radiotherapy Device Type |
Radiotherapy device type this procedure is referring to |
||
Radiotherapy Dose Type |
Types of radiotherapy cumulative dose this procedure is referring to |
||
Radiotherapy Isotopes |
Radiotherapy Isotopes |
||
Radiotherapy Type |
Types of radiotherapy this procedure is referring to |
||
Radiotherapy dose units |
Radiotherapy dose units |
||
Radiotherapy sites |
PancareSurPass radiotherapy sites Value Set |
||
Recommendations |
Recommendations proposed by the PCSP algorithm |
||
Relapse type (Local/Distant/Combined) |
Relapse type (Local/Distant/Combined) |
||
Risk Factors |
Risk Factors used by the PCSP algorithm |
||
Route of administration |
Route of administration |
||
SCT Prophylaxis Cathegory |
SCT Prophylaxis Cathegory |
||
SCT Prophylaxis Type |
SCT Prophylaxis Type |
||
Sacrified Organs (surgery) |
Sacrified Organs (surgery). Organs are 'sacrified' either to allow a radical excision of the tumor or on purpose (spleen) for staging procedures |
||
Shunt Procedure Type |
Types of shunt surgical procedure this resource is referring to |
||
Stage Group Value Set |
This value set is intended to contain allowable values for Stage Group, according to TNM staging rules. AJCC codes (preferably, version 8 for current cancers) SHOULD be used. |
||
Stem Cell Donor type |
Stem Cell Donor type |
||
Stem Cell Source type |
Stem Cell Source type |
||
Stem Cell Transplantation type |
Stem Cell Transplantation type |
||
Surgical Actions |
Surgical Actions |
||
Surgical Procedure Type |
Types of surgical procedure this resource is referring to |
||
TNM Distant Metastases Category Value Set |
This value set is intended to contain allowable values for the M category, according to TNM staging rules. AJCC codes (preferably, version 8 for current cancers) SHOULD be used. |
||
TNM Primary Tumor Category Value Set |
This value set is intended to contain allowable values for the T category, according to TNM staging rules. AJCC codes (preferably, version 8 for current cancers) SHOULD be used. |
||
TNM Regional Nodes Category Value Set |
This value set is intended to contain allowable values for the N category, according to TNM staging rules. AJCC codes (preferably, version 8 for current cancers) SHOULD be used. |
||
Toxicity Severity |
Toxicity Severity |
||
Unknown|Other |
Unknown or Other |
These define new code systems used by systems conforming to this implementation guide.
PCSP Code System |
Coded concepts specified by the PancareSurPass Project |
PCSP Conditions at risk |
Condition at risk proposed by the PCSP algorithm |
PCSP Recommendations |
Recommendations proposed by the PCSP algorithm |
Radiotherapy sites |
PancareSurPass radiotherapy sites Code System |
Risk Factors |
Risk Factors used by the PCSP algorithm |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
21982 | |
21983 | |
21984 | |
21985 | |
21986 | |
21987 | |
21988 | |
21992 | |
3974 | |
3975 | |
3976 |
TRIAL |
3978 | |
3980 | |
3982 | |
3985 | |
3986 | |
3992 | |
3993 | |
3996 | |
3998 | |
46bee55b-5cd0-4727-86a5-3f9317a5d7d9 | |
4952 | |
4953 | |
4955 | |
5008 | |
5062 | |
BiologicallyDerivedProduct: Stem Cell Transplantation |
Biologically Derived Product: Stem Cell Transplantation example |
CarePlan: Automatically Generated Example |
Sample of Care Plan generated by the platform |
Composition: SurPass |
Example of SurPass Composition |
Condition: Primary Diagnosis Hulafe |
Sample of Primary Diagnosis based on information provided by Hulafe (Condition) |
Condition: Sample from Mainz |
Sample of Primary Cancer Condition based on information available by Mainz |
Condition: complete Primary Cancer Condition example (TBC) |
Sample of Primary Cancer Condition based on information available by Mainz |
Condition: complete metastatic site Condition example (TBC) |
Sample of metastatic site Condition based on information available by Mainz |
DocumentReference: Preliminary SurPass |
Sample of DocumentReference used to refer a preliminary SurPass |
Encounter: Primary Diagnosis Hulafe (Encounter) |
Sample of Primary Diagnosis based on information provided by Hulafe (Encounter) |
Encounter: Sample from Mainz |
Sample of Encounter associated to the Primary Cancer Condition Mainz sample |
Encounter: Sample from Mainz (Zeisig) |
Sample of Encounter associated to the Primary Cancer Condition Mainz sample |
Location: Chemotherapy Hulafe |
Sample of Chemotherapy based on information provided by Hulafe (Location) |
Location: Stem Cell Transplantation |
Location: Stem Cell Transplantation example |
MedicationAdministration: Chemotherapy Hulafe Ciclofosfamide |
Sample of Chemotherapy based on information provided by Hulafe (Ciclofosfamide) |
MedicationAdministration: Chemotherapy Hulafe Citarabina |
Sample of Chemotherapy based on information provided by Hulafe (Citarabina) |
MedicationAdministration: Chemotherapy Hulafe Metotrexato |
Sample of Chemotherapy based on information provided by Hulafe (Metotrexato) |
MedicationAdministration: Chemotherapy Hulafe Vincristina |
Sample of Chemotherapy based on information provided by Hulafe (Vincristina) |
MedicationStatement: Chemotherapy Hulafe Corticosteroids |
Sample of Chemotherapy based on information provided by Hulafe (Corticosteroids not used for at least 4 weeks continuously) |
Observation: Blood type/RH before the SCT |
Observation: Blood type/RH before the SCT example |
Observation: Chemotherapy Hulafe Ciclofosfamide Cumulative Dose |
Sample of Chemotherapy based on information provided by Hulafe (Ciclofosfamide Cumulative Dose) |
Observation: Chemotherapy Hulafe Citarabina Cumulative Dose |
Sample of Chemotherapy based on information provided by Hulafe (Citarabina Cumulative Dose) |
Observation: Chemotherapy Hulafe Metotrexato Cumulative Dose |
Sample of Chemotherapy based on information provided by Hulafe (Metotrexato Cumulative Dose) |
Observation: Chemotherapy Hulafe Vincristina Cumulative Dose |
Sample of Chemotherapy based on information provided by Hulafe (Vincristina Cumulative Dose) |
Observation: Radiotherapy Total Dose |
Observation: Radiotherapy Total Dose example |
Observation: Risk Factor |
Sample of Risk Factor: RT to thyroid gland |
Observation: Risk Factor |
Sample of Risk Factor: RT >= 10 Gy to breasts |
Observation: Risk Factor |
Sample of Risk Factor: RT >= 35 Gy to heart |
Observation: Risk Factor |
Sample of Risk Factor: Anthracyclines >= 250 mg/m1 |
Observation: Sample from Mainz (Zeisig) |
Sample of Observation associated to the Primary Cancer Condition Mainz sample to provide details about the diagnosis |
Organization: Primary Diagnosis Hulafe (Organization) |
Sample of Primary Diagnosis based on information provided by Hulafe (Organization) |
Patient: Hulafe |
Sample of Patient demographics data based on information provided by Hulafe |
Patient: Sample created on Mainz data (Fischer) |
Sample of Patient created based on information provided by Mainz |
Patient: Sample created on Mainz data (Zeisig) |
Sample of Patient created based on information provided by Mainz |
Patient: Sample created on Vulsk data |
Sample of Patient created based on information provided by Vulsk |
Patient: Sample from Cineca |
Sample of Patient created based on information available in the PCSP platform |
Patient: Sample from Hulafe |
Sample of Patient created based on information provided by Hulafe |
Procedure: Radiotherapy |
Procedure: Radiotherapy example |
Procedure: Stem Cell Transplantation |
Procedure: Stem Cell Transplantation example |
Procedure: Transfusion |
Procedure: Transfusion |
ROTSurPass |
Scheda di follow up. La compilazione della prima scheda ROT-Surpass dovrà avvenire contestualmente alla consegna del SurPass o comunque alla prima visita dopo la fine del trattamento (OT). |