Search FHIR

FHIR Osiris Implementation Guide
1.1.0 - trial-implementation

This page is part of the OSIRIS FHIR Implementation Guide (v1.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Artifacts Summary

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

Treatment related profiles

Information about patient treatments

Oncologic Adverse Event

Adverse event related to a cancer-related treatment associated to a grade from MEDDRA terminology (ex: 10047700: "Vomiting").

Oncology Surgery

Oncology-related surgery with a description of the outcome using RECIST categorys.

Oncology-related Medication Statement

Medication statement related to a cancer cure.

Response Evaluation

Response evaluation to an oncology treatment from RECIST terminology.

Treatment

Description of a treatment plan related to an Oncology Patient.

Clinical data related profiles

Osiris clinical data

Analysis

Assessment of the technique(s) used to establish the diagnosis(es)

Biological Sample

Description of a biological sample coming from an oncology Patient, with its storage condition.

Biomarker

Biomarker Observation about a patient from BiomarkerCode ValueSet.

Cause Of Death

Observation that indicates the cause of death of an Oncology Patient.

Family Cancer History

History of cancer in an Onco Patient Family.

Oncology Patient

Oncology patient defined by Osiris.

Oncology Patient Related Pathology

Related pathology of oncology patient.

Performance Status

Oncology-patient performance status observation (see https://www.ncbi.nlm.nih.gov/books/NBK97482/ for more information).

Sequencing Analysis

Sequencing analysis about a biological sample coming from a TumorPathologyEvent. This profile shows general information about the analysis done, additional omics results can be found in SNP, Fusion, CopyNumber, Expression and Annotation profiles.

TNM

TNM Classification of malignant tumors used to indicate the tumor, node and metastasis state of a Tumor Pathology Event.

Tumor Pathology Event

Tumor Pathology Event (TPE) Condition describing a tumoral event: reference to the parent TPE, laterality, morphology.

Vital Status

Observation that indicates the last known Vital status of an Onco Patient.

Omics related profiles

Osiris omics data

3 Prime Molecular Sequence

3 prime molecular sequence is for referencing the 3' edge of a Fusion Observation.

5 Prime Molecular Sequence

5 prime molecular sequence is for referencing the 5' edge of a Fusion Observation.

Annotation Reference

The annotation reference profile indicates the reference genome / pfam domain / database used to generate the Annotation instance linked.

Gene Expression

Observation of a Gene Expression variant derived from a SequencingAnalysis. The Expression profile is used to indicate the actionability, the pathogenecity and the gene expression quantity of the gene of interest.

Gene Fusion

Observation of a Gene Fusion derived from a SequencingAnalysis. The Fusion profile indicates the pathogenicity, the actionability and if the fusion has occured in the reading frame.

Genome Entity

The genome entity profile is used to indicate the genome reference used to build the Annotation.

Sequencing Device

Description of a sequencing device used for a Sequencing Analysis.

Single Nucleotide Polymorphism

Observation of a Single Nucleotide Polymorphism (SNP) derived from a Sequencing Analysis.

Validation

Validation information about data from a Variant / Expression / Fusion / CopyNumber profile.

Variant Annotation

The Annotation profile allows to add information about a SNP, a fusion, an expression or a copy number event. It is generally used to compare variant from a reference genome. There can be multiple instance of Variant Annotation Resource for one instance of SNP, CopyNumber, Expression or Fusion Resource.

Variant Copy Number

Observation of a Copy Number variant derived from a SequencingAnalysis. The CopyNumber profile is used to indicate the pathogenicity, the actionability, the loss of heterozygosity, the cytogenetic location, the start - end positions, the reference sequence assembly, the variation code, the segment intensity, the number of copy found and the Copy Number segment size.

General information profiles

Osiris general information

Cancer Organization

Cancer organization to describe the provider center or origin center of the onco-patient.

Clinical Trial Subject

Subject that belongs to a oncology-related Clinical Trial.

Consent for Genetic Data Usage

The genetic consent resource indicates if a patient has given his authorization to share and use its genetics data.

Oncology Clinical Trial

Oncology clinical trial used to associate a Onco Patient to a Clinical Trial

Radiomics and radiotherapy related ressources

Osiris radiomics & radiotherapy data

Imaging Device

Qualification of the equipment used to acquire a series of images

Imaging Service

Description of an imaging service.

Imaging Study

Description of an imaging study.

Imaging Study Injection

Description of an imaging study injection.

Imaging Study Injection Contrast

Description of a contrast product.

Location to the PACS server

System communication to the PACS server

Radiomics Criteria

Description of the criteria used for the biomarkers calculations

Radiomics Features

Description of the radiomics measurements described in IBSI nomenclature

Radiomics Image Filters

Filtering parameters used for the imaging analysis

Radiotherapy course Summary

A summary of a course of radiotherapy planned or delivered to a patient

Radiotherapy Phase

Summary of the radiotherapy phases planned or delivered to a patient

Radiotherapy Plan

Radiotherapy plans planned or delivered to a patient

Radiotherapy Volume Profile

A volume of the body treated by radiotherapy (plannes or delivered).

ROI segmentation

Description of the segmentation method used allowing the deffinition of a region of interest (ROI).

Structures: Extension Definitions

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

Adverse Event End date

End date of the adverse event

Algorith mName

Algorith mName

Based On Condition (Tumor Pathology Event)

Based On Condition (Tumor Pathology Event)

Biological Sample Origin

Biological Sample Origin

Connection with the imaging module

Connection with the imaging module (ImagingStudy and ROI Segmentation)

Dose To Volume

Dose To Volume

Energy Or Isotope

Energy Or Isotope

Fusion Spanning Pairs

Number of reads pairs spanning the fusion

Fusion Split Reads

Number of reads containing the fusion point

Gene Expression Data Type

Type of the expression value corresponding to the level of data processing

GenomeEntityType

Genome Entity Type

Histology

Grade of Histology

Imaging Settings

Imaging Settings.

Laterality

Laterality of location (if it exists)

Modality And Technique

Modality And Technique

Number of Fractions

The number of fractions

Number of Sessions

The number of sessions

Patient Ethnicity

The patient ethnicity

Patient Origin Center

The origin center organization of an Oncology Patient.

Radiomics Criteria Settings

Radiomics Criteria Settings.

Radiomics Image Filters Settings

Radiomics Image Filters Settings.

Reason Replanification

Reason Replanification

Strand bias

Indication of the existence of strand bias at the variant position

Treatment Intent

The treatment Intent

Treatment Line Number

The treatment line number

Treatment Termination Reason

The treatment Termination Reason

Tumor Pathology Event Parent

Reference the Tumor Pathology Event from which the metastasis comes from.

Weight and Height at the time of the Serie

Weight and Height at the time of the Serie

Terminology: Value Sets

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

Bodysite Value Set

Bodysite

Modality Value Set

Modality

Adverse Event Code Value Set

Adverse event codes

Adverse Event Grade Value Set

Adverse event grade

Algorithmic Ploidy

Algorithmic Ploidy

Alteration Type Value Set

Alteration type

Amino Acide Change Type Value Set

Amino Acide Change Type

Analysis Technical Protocol

Analysis technical protocol

Analysis Types Value Set

Analysis types

Biological Sample Nature Value Set

Biological sample nature

Biological Sample Origin Value Set

Biological sample origin

Biomarker Value Set

Biomarker types

Cause of death Value Set

Cause of death

Chromosome Value Set

Chromosome

CytoBand Value Set

CytoBand

DNA Change Type Value Set

DNAChangeType

Fusion Type Value Set

Fusion Type

Gene Expression Data Type Value Set

Gene Expression Data Type

GeneticMaterial

Genetic material

Genome entity type Value Set

Type of genome entity

GenomeBuild Value Set

GenomeBuild

Localization Method Value Set

Localization Method

Morphology Value Set

Cancer morphology

Mutation prediction Value Set

Mutation prediction

Osiris Validation Type

Osiris validation type

Panel Name

Panel Name

Parentage Value Set

Parentage

Pathogenicity Value Set

Pathogenicity

Platform Name

Platform Name

ROI Type Value Set

ROI Type

Radiomic Features Value Set

Radiomic Features

Radiotherapy Category

Radiotherapy Category

Radiotherapy Intent

RadioTherapy Intent

Radiotherapy Reason Replanification

Radiotherapy Reason Replanification

Radiotherapy Termination Reason

Radiotherapy Termination Reason

Radiotherapy Treatment Location Qualifier Value Set

Various modifiers that can be applied to body locations where radiotherapy treatments can be directed.

Radiotherapy Volume Type Value Set

Codes describing the types of body volumes used in radiotherapy planning and treatment. The value set includes the most common codes from DICOM CID 9534 Radiotherapy Targets (UID 1.2.840.10008.6.1.1244) and adds a code for Organs at Risk (OAR).

Reference Type Value Set

Annotation reference type

Response Status Value Set

Response evaluation status

Storage temperature Value Set

Sample storage temperature

Surgery Resection Quality Value Set

Surgery resection quality

TNM Version Value Set

TNM version

Topography Value Set

Cancer topography

Treatment Type Value Set

Treatment type

Tumor Laterality Value Set

Tumor laterality

Tumor Pathology Event Type Value Set

Tumor pathology event type

Vital Status Value Set

Vital status

Terminology: Code Systems

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

IBSI Code System

IBSI Code System

Imaging Code System

Imaging Code System

Osiris code system

Custom code from osiris standard

Radiotherapy Code System

Radiotherapy Code System

Requested SNOMED Codes Code System

Requested SNOMED Codes by codex

Requested SNOMED Codes Code System

Requested SNOMED Codes by mcode

SNOMED Codes Code System

SNOMED Codes Code System

Series Modality Code System

Series Modality Code System

Example: Example Instances

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

FhirOSIRISResponseEvaluation-1

Example of ResponseEvaluation from OSIRIS_pivot_ResponseEvaluation .csv

Unknown

Example of ResearchStudy from OSIRIS_pivot_Treatment.csv

fhir-osiris-annotation-1

Example of Instance from OSIRIS_pivot_Annotations.csv

fhir-osiris-annotation-reference-1

Example of Instance from OSIRIS_pivot_Annotations.csv

fhir-osiris-example-ROISegmentation

Example of Patient from OSIRIS_pivot_ROISegmentation.csv

fhir-osiris-example-RadiomicsCriteria

Example of Patient from OSIRIS_pivot_RadiomicsCriteria.csv

fhir-osiris-example-RadiomicsFeature

Example of Patient from OSIRIS_pivot_RadiomicsFeature.csv

fhir-osiris-example-RadiomicsImageFilter

Example of Patient from OSIRIS_pivot_RadiomicsImageFilter.csv

fhir-osiris-example-RadiotherapyCourse-1

Example of instance from OSIRIS_pivot_CourseRT.csv, OSIRIS_pivot_EnergyOrIsotopeRT.csv, OSIRIS_pivot_DoseToVolumeRT.csv

fhir-osiris-example-RadiotherapyCourse-2

Example of instance from OSIRIS_pivot_CourseRT.csv, OSIRIS_pivot_EnergyOrIsotopeRT.csv, OSIRIS_pivot_DoseToVolumeRT.csv

fhir-osiris-example-RadiotherapyPhase-1

Example of instance from OSIRIS_pivot_PhaseRT.csv, OSIRIS_pivot_EnergyOrIsotopeRT.csv and OSIRIS_pivot_ModalityAndTechniqueRT.csv

fhir-osiris-example-RadiotherapyPhase-2

Example of instance from OSIRIS_pivot_PhaseRT.csv, OSIRIS_pivot_EnergyOrIsotopeRT.csv and OSIRIS_pivot_ModalityAndTechniqueRT.csv

fhir-osiris-example-RadiotherapyPhase-3

Example of instance from OSIRIS_pivot_PhaseRT.csv, OSIRIS_pivot_EnergyOrIsotopeRT.csv and OSIRIS_pivot_ModalityAndTechniqueRT.csv

fhir-osiris-example-RadiotherapyPhase-4

Example of instance from OSIRIS_pivot_PhaseRT.csv, OSIRIS_pivot_EnergyOrIsotopeRT.csv and OSIRIS_pivot_ModalityAndTechniqueRT.csv

fhir-osiris-example-RadiotherapyPhase-5

Example of instance from OSIRIS_pivot_PhaseRT.csv, OSIRIS_pivot_EnergyOrIsotopeRT.csv and OSIRIS_pivot_ModalityAndTechniqueRT.csv

fhir-osiris-example-RadiotherapyPhase-6

Example of instance from OSIRIS_pivot_PhaseRT.csv, OSIRIS_pivot_EnergyOrIsotopeRT.csv and OSIRIS_pivot_ModalityAndTechniqueRT.csv

fhir-osiris-example-RadiotherapyPlan-1

Example of instance from OSIRIS_pivot_PlanRT.csv, OSIRIS_pivot_EquipmentRT.csv and OSIRIS_pivot_ModalityAndTechniqueRT.csv

fhir-osiris-example-RadiotherapyVolume-1

Example of instance from OSIRIS_pivot_VolumeRT.csv

fhir-osiris-example-RadiotherapyVolume-2

Example of instance from OSIRIS_pivot_VolumeRT.csv

fhir-osiris-example-RadiotherapyVolume-3

Example of instance from OSIRIS_pivot_VolumeRT.csv

fhir-osiris-example-RadiotherapyVolume-4

Example of instance from OSIRIS_pivot_VolumeRT.csv

fhir-osiris-example-TumorPathologyEvent-instance-1

Example of TPE from OSIRIS_pivot_TumorPathologyEvent.csv

fhir-osiris-example-TumorPathologyEvent-instance-2

Example of TPE from OSIRIS_pivot_TumorPathologyEvent.csv

fhir-osiris-example-adverseevent-1

Example of Adverse Event from OSIRIS_pivot_AdverseEvent.csv

fhir-osiris-example-analysis-clinical

Example of Analysis from OSIRIS_pivot_Analysis.csv

fhir-osiris-example-analysis-ct

Example of Analysis from OSIRIS_pivot_Analysis.csv

fhir-osiris-example-analysis-dx

Example of Analysis from OSIRIS_pivot_Analysis.csv

fhir-osiris-example-analysis-mr

Example of Analysis from OSIRIS_pivot_Analysis.csv

fhir-osiris-example-analysis-mr-2

Example of Analysis from OSIRIS_pivot_Analysis.csv

fhir-osiris-example-analysis-pt-nm

Example of Analysis from OSIRIS_pivot_Analysis.csv

fhir-osiris-example-biologicalsample-1

Example of BiologicalSample from OSIRIS_pivot_BiologicalSample.csv

fhir-osiris-example-biologicalsample-2

Example of BiologicalSample from OSIRIS_pivot_BiologicalSample.csv

fhir-osiris-example-biomarker

Example of Biomarker

fhir-osiris-example-causeofdeath

Example of CauseOfDeath

fhir-osiris-example-consent-1

Example of Instance from OSIRIS_pivot_Consent.csv

fhir-osiris-example-consent-2

Example of Instance from OSIRIS_pivot_Consent.csv

fhir-osiris-example-imagingdevice-ct

Example of Imaging Study from OSIRIS_pivot_Equipment.csv

fhir-osiris-example-imagingdevice-dx

Example of Imaging Study from OSIRIS_pivot_Equipment.csv

fhir-osiris-example-imagingdevice-mr

Example of Imaging Study from OSIRIS_pivot_Equipment.csv

fhir-osiris-example-imagingdevice-mr-2

Example of Imaging Study from OSIRIS_pivot_Equipment.csv

fhir-osiris-example-imagingdevice-pt-nm

Example of Imaging Study from OSIRIS_pivot_Equipment.csv

fhir-osiris-example-imagingendpoint-ct

Example of Imaging Study from OSIRIS_pivot_CommonImage.csv

fhir-osiris-example-imagingendpoint-dx

Example of Imaging Study from OSIRIS_pivot_CommonImage.csv

fhir-osiris-example-imagingendpoint-mr

Example of Imaging Study from OSIRIS_pivot_CommonImage.csv

fhir-osiris-example-imagingendpoint-mr-2

Example of Imaging Study from OSIRIS_pivot_CommonImage.csv

fhir-osiris-example-imagingendpoint-pt-nm

Example of Imaging Study from OSIRIS_pivot_CommonImage.csv

fhir-osiris-example-imagingstudy-ct

Example of Imaging Study from OSIRIS_pivot_CommonImage.csv, OSIRIS_pivot_Study.csv, OSIRIS_pivot_CTImage.csv, OSIRIS_pivot_CommonImage.csv

fhir-osiris-example-imagingstudy-dx

Example of Imaging Study from OSIRIS_pivot_CommonImage.csv, OSIRIS_pivot_Study.csv, OSIRIS_pivot_CTImage.csv, OSIRIS_pivot_CommonImage.csv

fhir-osiris-example-imagingstudy-mri

Example of Imaging Study from OSIRIS_pivot_CommonImage.csv, OSIRIS_pivot_Study.csv, OSIRIS_pivot_MRImage.csv, OSIRIS_pivot_CommonImage.csv

fhir-osiris-example-imagingstudy-mri-2

Example of Imaging Study from OSIRIS_pivot_CommonImage.csv, OSIRIS_pivot_Study.csv, OSIRIS_pivot_MRImage.csv, OSIRIS_pivot_CommonImage.csv

fhir-osiris-example-imagingstudy-pt-nm

Example of Imaging Study from OSIRIS_pivot_CommonImage.csv, OSIRIS_pivot_Study.csv, OSIRIS_pivot_CTImage.csv, OSIRIS_pivot_CommonImage.csv

fhir-osiris-example-injection-medication-pt-nm

Example of Imaging Study from OSIRIS_pivot_Injection.csv

fhir-osiris-example-injection-pt-nm

Example of Imaging Study from OSIRIS_pivot_Injection.csv

fhir-osiris-example-oncomedicalstatement-1

Example of OncoMedicalStatement from OSIRIS_pivot_Drug.csv

fhir-osiris-example-patient

Example of Patient from OSIRIS_pivot_Patient.csv

fhir-osiris-example-patient-ct-scan

Example of Patient from OSIRIS_pivot_Patient.csv

fhir-osiris-example-patient-dx

Example of Patient from OSIRIS_pivot_Patient.csv

fhir-osiris-example-patient-mr

Example of Patient from OSIRIS_pivot_Patient.csv

fhir-osiris-example-patient-mr-2

Example of Patient from OSIRIS_pivot_Patient.csv

fhir-osiris-example-patient-pt-nm

Example of Patient from OSIRIS_pivot_Patient.csv

fhir-osiris-example-patient-radiotherapy

Example of Patient for radiotherapy

fhir-osiris-example-sequencinganalysis-1

Example of SequencingAnalysis from OSIRIS_pivot_Analysis.csv

fhir-osiris-example-sequencinganalysis-2

Example of SequencingAnalysis from OSIRIS_pivot_Analysis.csv

fhir-osiris-example-sequencinganalysis-3

Example of SequencingAnalysis from OSIRIS_pivot_Analysis.csv

fhir-osiris-example-sequencingdevice-1

Example of SequencingDevice from OSIRIS_pivot_Analysis.csv

fhir-osiris-example-sequencingdevice-2

Example of SequencingDevice from OSIRIS_pivot_Analysis.csv

fhir-osiris-example-sequencingdevice-3

Example of SequencingDevice from OSIRIS_pivot_Analysis.csv

fhir-osiris-example-snp-1

Example of Surgery from OSIRIS_pivot_Variant.csv

fhir-osiris-example-surgery-1

Example of Surgery from OSIRIS_pivot_Treatment.csv

fhir-osiris-example-surgery-2

Example of Surgery from OSIRIS_pivot_Treatment.csv

fhir-osiris-example-treatment-1

Example of Treatment from OSIRIS_pivot_Treatment.csv

fhir-osiris-example-treatment-2

Example of Treatment from OSIRIS_pivot_Treatment.csv

fhir-osiris-example-treatment-radiotherapy

Example of Treatment from OSIRIS_pivot_Treatment.csv

fhir-osiris-example-validation-1

Example of Surgery from OSIRIS_pivot_Variant.csv

fhir-osiris-example-vitalstatus

Example of VitalStatus

fhir-osiris-genome-entity-1

Example of Instance from OSIRIS_pivot_Annotations.csv

fhir-osiris-origin-organization

Example of origin(organization) from OSIRIS_pivot_Patient.csv

fhir-osiris-provider-organization

Example of provider(organization) from OSIRIS_pivot_Patient.csv

patient-synthetic