OncoFAIR
0.1.0 - ci-build

OncoFAIR - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Artifacts Summary

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

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

OncoFAIR Consumer secondary chemotherapy data

A structure or professional using chemotherapy data (complete or aggregated). These data may be used for a variety of purposes (pharmacovigilance, clinical studies, etc.).

OncoFAIR Health Data Warehouse

A database intended to be used for research, studies or evaluation in the field of health.

OncoFAIR Producer Chemotherapy Data

Software for tracking chemotherapy information relating to a patient. The software generates chemotherapy data by means of data updates by medical staff.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

oncofair-sp-cp-date-time-reference

Search for the reference date and time of the prescribed protocol

oncofair-sp-cp-title

Search for the title of the prescribed protocol

oncofair-sp-element-form

Search for the pharmaceutical form of the prescription/administration item

oncofair-sp-element-route

Search for the route of administration element

oncofair-sp-element-site

Search on the administration site of the element

oncofair-sp-indication

Search for indications concerning the prescription item and the component prescribed or prescribed protocol

oncofair-sp-ma-category

Search for code identifying the nature of the administration element

oncofair-sp-ma-comments

Search for comments on the administration element

oncofair-sp-ma-method

Search for type of administration element

oncofair-sp-ma-planned-quantity

Search for the expected quantity of the administration element

oncofair-sp-ma-prescribed-quantity

Search for the prescribed quantity of the administration element

oncofair-sp-medication-type

Search for type of medication

oncofair-sp-mr-component-solute

Search to find out if the component prescribed is solute in the prescription element

oncofair-sp-mr-component-substitution

Search to find out if the component prescribed is declared non-substitutable in the prescription element

oncofair-sp-mr-date-time-prescription-end

Search for the the date/time prescription end

oncofair-sp-mr-date-time-prescription-start

Search for the date/time prescription start

oncofair-sp-mr-element-duration-posology

Search for duration of administration

oncofair-sp-mr-element-frequency-posology

Search for the frequency of the dosage element

oncofair-sp-mr-element-gonogo-reasonwaiting

Search for the element goNogo reason waiting

oncofair-sp-mr-element-gonogo-status

Search for the element goNogo status

oncofair-sp-mr-element-quantity-posology

Search for quantity of the prescription element in the dosage

oncofair-sp-mr-element-rate-posology

Search for rate of administration in the case of injection

oncofair-sp-mr-exempt-ltc

Search for identifier of the ALD for which the component prescribed is prescribed for one of the reasons for which the patient benefits from an exemption under article L324-1 of the CSS.

oncofair-sp-mr-is-dosage-referent

Search to find out if the component prescribed is the component that refers to the quantity or flow rate expressed in the dosage element when these are gravimetric (for example, mg or mg/h).

oncofair-sp-mr-prescribed-component-quantity

Search for the prescribed component quantity

oncofair-sp-mr-prescription-validation-date

Search for the prescription validation date of the prescription

oncofair-sp-mr-type-elementprescrption

Search for the type of element prescription

oncofair-sp-wording

Search for wording on the administration/prescribed element

Structures: Resource Profiles

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

OncoFAIR CarePlan

This object describes the chaining of prescription elements attached to the prescribed protocol. Its structure enables the chaining of nested sub-protocols.

Cet objet décrit le chaînage des éléments de prescription rattachés au protocole prescrit. Sa structure permet le chaînage de sous-protocoles imbriqués.

OncoFAIR Encounter

Must be taken in the generic sense, i.e. it goes beyond hospital admissions, outpatient consultations, dialysis sessions, day hospitals, etc.

Doit être pris au sens générique, c’est-à-dire que cela dépasse les hospitalisations, consultations externes, séances de dialyse, hôpitaux de jour, etc …

OncoFAIR Medication

This object describes the medication.

Cet objet décrit le médicament

OncoFAIR MedicationAdministration Component

This object corresponds to a product that belongs to the nomenclature of medicines used in the hospital.

Cet objet correspond à un produit qui appartient à la nomenclature de médicaments utilisée dans l’hôpital.

OncoFAIR MedicationAdministration Element

Corresponds to the activity induced by a prescription item and its dosage (structured or unstructured), and carried out at a given moment.

Correspond à l’activité induite par un élément de prescription et sa posologie (structurée ou non), et réalisée à un instant donné.

OncoFAIR MedicationAdministration Report

Regroups all the prescription elements received on which the pharmacist expresses his validation. It also includes items suggested or resulting from a replacement proposed by the pharmacist.

Regroupe l’ensemble des éléments de prescription reçus sur lesquels le pharmacien exprime sa validation. S’y ajoutent les éléments suggérés ou issus d’un remplacement proposé par le pharmacien.

OncoFAIR MedicationRequest Component

Is a product that belongs to the nomenclature of medicines used. It may, for example, be a speciality, a product defined by its common name or a pharmacopoeial product.

Est un produit qui appartient à la nomenclature de médicaments utilisée. Il peut s’agir par exemple d’une spécialité, d’un produit défini par sa DC ou d’un produit de la pharmacopée.

OncoFAIR MedicationRequest Element

Corresponds to a prescription line on a prescription. Each item contains one or more components (in the case of a magistral preparation or an infusion).

Correspond à une ligne de prescription d’une ordonnance. Chacune comporte un ou plusieurs composants (lorsqu’il s’agit d’une préparation magistrale ou d’une perfusion).

OncoFAIR MedicationRequest Prescription

Groups together all the prescription elements validated simultaneously by the same prescriber.

Regroupe l’ensemble des éléments de prescription validés simultanément par un même prescripteur.

OncoFAIR Observation

Allows you to enter information about the patient in addition to that described in the prescription elements.

Permet d’indiquer les informations relatives au patient qui complètent celles décrites par les éléments de prescription

OncoFAIR Patient

Contains the patient's identity details needed to ensure that the prescription is properly taken into account.

Contient les informations d’identité du patient nécessaires à la bonne prise en compte de la prescription médicamenteuse.

Oncology Clinical Trial

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

OncologyHealthcareService

Healthcare service(s).

Tumor Pathology Event

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

Structures: Extension Definitions

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

Administered quantity of medication

The administered quantity of medication.

Date and time

Date and time.

End date and time

End date and time.

Event Time Max

Represents the maximum time for the event.

Event Time Min

Represents the minimum time for the event.

Event Type Data

Represents the type of logical data for an event.

Histology

Grade of Histology

Laterality

Laterality of location (if it exists)

Medication Is Vehicle

Indicates whether the medication is a vehicle.

Medication LTI exemption

Long-term illness (LTI) for which the patient can benefit from an exemption.

Medication comment

Adds a comment to a Medication resource.

Medication item provenance

Adds a provenance to a MedicationItem resource

Medication status

Adds a status to a Medication resource

Medication type

Adds a type to a Medication resource

OncoFAIRCPTreatment

Extension created as part of OncoFAIR grouping together the treatment number, the day number and the reference date and time of the prescribed protocol.

Extension créée dans le cadre d'OncoFAIR regroupant le numéro de cure, le numéro de jour ainsi que la date et heure de référence du protocole prescrit.

OncoFAIRElementForm

Extension created as part of OncoFair containing the drug form.

Extension créée dans le cadre d'OncoFair contenant la forme du médicament.

OncoFAIRMAComponentAdministrationStatus

Extension created as part of OncoFAIR containing the administration status of the administered component.

Extension créée dans le cadre d'OncoFAIR contenant le statut d'administration du composant administré.

OncoFAIRMAComponentOrigin

Extension created as part of OncoFAIR containing the origin of the administered component.

Extension créée dans le cadre d'OncoFAIR contenant la provenance du composant administré.

OncoFAIRMAElementExpirationDate

Extension created as part of OncoFAIR containing the expiry date of the component administered.

Extension créée dans le cadre d'OncoFAIR contenant la date de péremption du composant administré.

OncoFAIRMAElementPlannedPeriod

Extension created as part of OncoFAIR containing the planned start and end date of administration.

Extension créée dans le cadre d'OncoFAIR contenant la date de début et de fin prévue de l'administration.

OncoFAIRMAElementTraceability

Extension created as part of OncoFAIR containing the batch and serial number of the administered component/administration element.

Extension créée dans le cadre d'OncoFAIR contenant le numéro de lot et de série du composant administré/élément d'administration.

OncoFAIRMAElementUrgent

Extension created as part of OncoFAIR containing the notion of emergency.

Extension créée dans le cadre d'OncoFAIR contenant la notion d'urgence.

OncoFAIRMRComponentSolute

Extension created as part of OncoFAIR containing the notion of solute.

Extension créée dans le cadre d'OncoFAIR contenant la notion de soluté.

OncoFAIRMRElementGoNogo

Extension created as part of OncoFAIR containing the concept of GoNogo.

Extension créée dans le cadre d'OncoFAIR contenant la notion de GoNogo.

OncoFAIRMRElementLinkType

Extension created as part of OncoFAIR containing the element's type of link.

Extension créée dans le cadre d'OncoFAIR contenant le type de liaison de l'élément.

OncoFAIRMRElementRank

Extension created as part of OncoFAIR containing the prescription element rank.

Extension créée dans le cadre d'OncoFAIR contenant le rangd d'élement de la prescription.

OncoFAIRMRElementSupply

Extension created as part of OncoFAIR containing the concept of supply.

Extension créée dans le cadre d'OncoFAIR contenant la notion de fourniture.

OncoFAIRMRExemptLTC

Extension created as part of OncoFAIR containing the notion of exemption.

Extension créée dans le cadre d'OncoFAIR contenant la notion d'exonération.

OncoFAIRMRIsDosageReferent

Extension created as part of OncoFAIR containing the notion of a posology reference.

Extension créée dans le cadre d'OncoFAIR contenant la notion de référence posologie.

OncoFAIRMRPrescriptionValidationDate

Extension créée dans le cadre d'OncoFAIR contenant la date et heure de la prescription

OncoFAIRMedicationType

Extension created as part of OncoFAIR containing the type of component.

Extension créée dans le cadre d'OncoFAIR contenant le type de composant.

OncoFAIRPharmacistAdvice

Extension created as part of OncoFAIR containing the validation and pharmaceutical proposal.

Extension créée dans le cadre d'OncoFAIR contenant la validation et proposition pharmaceutique.

Planned quantity of medication

The planned quantity of medication administered.

Start date and time

Start date and time.

Treatment Line Number

The treatment line number

Tumor Pathology Event Parent

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

Terminology: Value Sets

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

Concepts Medication Value Set

Value Set pour différiencier les niveaux de MR/MA

Event Types Data

ValueSet for various event types used in French healthcare systems.

Liste Affectation Longue Durée Value Set

Value Set pour ListeALD

Medical units Value Set

ValueSet for medical units (accommodation, medical liability unit).

Medication LTI Exemption

ValueSet for medication LTI exemption.

Medication item provenance

ValueSet for medication item provenance.

Medication status

ValueSet for medication status.

Medication types

ValueSet for medication types.

Medications Value Set

ValueSet for medications.

Morphology Value Set

Cancer morphology

Nature proposition pharmaceutique Value Set

Value Set pour NaturePropPharm

Paramètres posologie conditionnelle

Value Set pour ParamPosoConditionnelle

Renseignement complémentaire Value Set

Value Set pour RensComplement

Statut composant administré Value Set

Value Set pour StatutComposantAdm

Statut validation pharmaceutique Value Set

Value Set pour StatutValidPharm

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

Type de composant Value Set

Value Set pour TypeComposant

Type de l'élément d'administration Value Set

Value Set pour TypeEltPLA

Type de l'évènement Value Set

Value Set pour TypeEvenement

Type de liaison Value Set

Value Set pour Type Liaison

goNogo Value Set

Value Set pour goNogo

Terminology: Code Systems

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

Concepts Medication Code System

Code system pour différiencier les niveaux de MR/MA

Event Types

CodeSystem for various event types used in French healthcare systems, identified by number, abbreviation, and full name.

LTI Detailed Descriptions

Detailed list of long-term illness (LTI).

Liste ALD Code System

Code system pour l'attribut ListeALD

Medical units

CodeSystem for french medical units (accommodation, medical liability unit).

Medication item provenance

CodeSystem for french medication item provenance.

Medication status

CodeSystem for french medication status.

Medication types

CodeSystem for french medication types.

Medications

CodeSystem for french medications.

Nature proposition pharmaceutique Code System

Code system pour l'attribut NaturePropPharm

Paremètres posologie conditionnelle Code System

Code system pour l'attribut ParamPosoConditionnelle

Renseignement complémentaire Code System

Code system pour l'attribut RensComplement

Statut composant administré Code System

Code system pour l'attribut StatutComposantAdm

Statut validation pharmaceutique Code System

Code system pour l'attribut StatutValidPharm

Type de composant Code System

Code system pour l'attribut TypeComposant

Type de l'élément d'administration Code System

Code system pour l'attribut TypeEltPLA

Type de liaison Code System

Code system pour l'attribut TypeLiaison

Type évènement Code System

Code system pour l'attribut TypeEvenement

goNogo Code System

Code system pour l'attribut goNogo

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 HealthcareServiceAccomodation

An example instance of an OncoFAIR HealthcareServiceAccomodation

Example HealthcareServiceMedicalLiability

An example instance of an OncoFAIR HealthcareServiceMedicalLiability

Example OncoFAIR CarePlan

An example instance of an OncoFAIR CarePlan with required fields populated.

Example OncoFAIR Device

An example instance of an OncoFAIR Device

Example OncoFAIR Device Definiton

An example instance of an OncoFAIR Device Definition

Example OncoFAIR Encounter

An example instance of an OncoFAIR Encounter with required fields populated.

Example OncoFAIR Medication

An example instance of an OncoFAIR Medication with required fields populated.

Example OncoFAIR MedicationAdministration Component

An example instance of an OncoFAIR MedicationAdministration Component with required fields populated.

Example OncoFAIR MedicationAdministration Element

An example instance of an OncoFAIR MedicationAdministration Element with required fields populated.

Example OncoFAIR MedicationAdministration Report

An example instance of an OncoFAIR MedicationAdministration Report with required fields populated.

Example OncoFAIR MedicationRequest Component

Example instance of OncoFAIRMedicationRequestComponent

Example OncoFAIR MedicationRequest Element

Example instance of OncoFAIRMedicationRequestElement

Example OncoFAIR MedicationRequest Prescription

Example instance of OncoFAIRMedicationRequestPrescription

Example OncoFAIR Observation

An example instance of OncoFAIR Observation.

Example OncoFAIR Patient

An example instance of an OncoFAIR patient with a permanent patient identifier.

Example OncoFAIR Practitioner

An example instance of an OncoFAIR practitioner with an identifier.

Folfox Difuser OncoFAIR Device

An example instance of an OncoFAIR Device for folfox protocol

Folfox Difuseur OncoFAIR Device Definition

An example instance of an OncoFAIR Device Definition for folfox protocol.

Folfox Difuseur OncoFAIR MedicationRequest Element

Example instance of OncoFAIRMedicationRequestElement for folfox protocol

Folfox Fluoro-uracile OncoFAIR Medication

An example instance of an OncoFAIR Medication with required fields populated.

Folfox Fluoro-uracile OncoFAIR MedicationRequest Component

Example instance of OncoFAIRMedicationRequestComponent for folfox protocol

Folfox Fluoro-uracile OncoFAIR MedicationRequest Component

Example instance of OncoFAIRMedicationRequestComponent for folfox protocol

Folfox OncoFAIR CarePlan

An example instance of an OncoFAIR CarePlan with required fields populated for folfox protocol.

Folfox OncoFAIR MedicationRequest Element

Example instance of OncoFAIRMedicationRequestElement for folfox protocol

Folfox Oxaliplatine OncoFAIR Medication

An example instance of an OncoFAIR Medication with required fields populated.

Folfox Oxaliplatine OncoFAIR MedicationRequest Component

Example instance of OncoFAIRMedicationRequestComponent for folfox protocol

Folfox Perfusion OncoFAIR Device

An example instance of an OncoFAIR Device for folfox protocol

Folfox Perfusion OncoFAIR Device Definition

An example instance of an OncoFAIR Device Definition for folfox protocol.

Folfox Vehicle OncoFAIR Medication

An example instance of an OncoFAIR Medication with required fields populated.

Folfox Vehicle OncoFAIR MedicationRequest Component

Example instance of OncoFAIRMedicationRequestComponent for folfox protocol

Folfox Vehicle OncoFAIR MedicationRequest Component

Example instance of OncoFAIRMedicationRequestComponent for folfox protocol

Folfox Vehicle OncoFAIR MedicationRequest Prescription

An example instance of OncoFAIR MedicationRequest Prescription for folfox protocol at hospitals.

Folfox Vehicle OncoFAIR MedicationRequest Prescription

An example instance of OncoFAIR MedicationRequest Prescription for folfox protocol at hospitals.

Oxaliplatine with difuseur OncoFAIR MedicationRequest Component

Example instance of OncoFAIRMedicationRequestComponent for folfox protocol

Unknown

Example of ResearchStudy from OSIRIS_pivot_Treatment.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