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

CapabilityStatement: OncoFAIR Consumer secondary chemotherapy data (Experimental)

Official URL: http://ltsi.univ-rennes.fr/CapabilityStatement/oncofair-consumer-secondary-chemotherapy-data Version: 0.1.0
Draft as of 2024-06-19 Computable Name: OncoFAIRConsumerOfSecondaryChemotherapyData

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

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement oncofair-consumer-secondary-chemotherapy-data

OncoFAIR Consumer secondary chemotherapy data

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 5.0.0
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2024-06-19 15:15:00+0100
  • Published by: KEREVAL and DOMASIA team of the Signal and Image Processing Laboratory (LTSI)

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

Search and consultation of aggregate data on chemotherapy

Security
Enable CORS: no
Security services supported: OAuth
Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Patienthttp://ltsi.univ-rennes.fr/StructureDefinition/oncofair-patientyyidentifierEncounter:subject
Encounterhttp://ltsi.univ-rennes.fr/StructureDefinition/oncofair-encounteryyidentifierEncounter:subjectMedicationAdministration:encounter, MedicationRequest:encounter
Observationhttp://ltsi.univ-rennes.fr/StructureDefinition/oncofair-observationyyclinical-code, clinical-date
Medicationhttp://ltsi.univ-rennes.fr/StructureDefinition/oncofair-medicationyy_filter, _has, _id, clinical-code, medication-typeMedicationRequest:medication, MedicationAdministration:medication
MedicationRequesthttp://ltsi.univ-rennes.fr/StructureDefinition/oncofair-medicationrequest-prescription
Additional supported profiles:
  OncoFAIR MedicationRequest Element
  OncoFAIR MedicationRequest Component
yyidentifier, wording, indication, mr-prescription-validation-date, mr-type-elementprescription, element-form, status, element-route, element-site, combo-date, mr-date-time-prescription-start, mr-date-time-prescription-end, mr-element-gonogo-status, mr-element-gonogo-reasonwaiting, group-identifier, mr-element-frequency-posology, mr-element-duration-posology, mr-element-rate-posology, mr-element-quantity-posology, mr-prescribed-component-quantity, mr-component-substitution, mr-is-dosage-referent, mr-exempt-ltc, mr-component-soluteMedicationRequest:encounter, MedicationRequest:medication
CarePlanhttp://ltsi.univ-rennes.fr/StructureDefinition/oncofair-careplanyyidentifier, cp-title, status, cp-date-time-reference, indicationMedicationRequest:basedOn
MedicationAdministrationhttp://ltsi.univ-rennes.fr/StructureDefinition/oncofair-medicationadministration-element
Additional supported profiles:
  OncoFAIR MedicationAdministration Component
  OncoFAIR MedicationAdministration Report
yyma-method, ma-category, element-form, element-route, element-site, date, ma-comments, ma-planned-quantity, ma-prescribed-quantity, identifier, wording, performerMedicationAdministration:encounter, MedicationAdministration:medication

Resource Conformance: supported Patient

Base System Profile
OncoFAIR Patient
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Identifier of the patient

 

Resource Conformance: supported Encounter

Base System Profile
OncoFAIR Encounter
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Identifier of the patient's stay

 

Resource Conformance: supported Observation

Base System Profile
OncoFAIR Observation
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLclinical-codetoken

Nature of additional information representing by LOINC code

SHALLclinical-datedate

Date and time of registration of the additional information

 

Resource Conformance: supported Medication

Base System Profile
OncoFAIR Medication
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_filterspecial

Filter search parameter that supports a more sophisticated search grammar. See documentation for more details.

SHALL_hasspecial

Enables resources to be selected on the basis of the properties of the resources that refer to them (reverse chaining).

SHALL_idtoken

Logical resource identifier

SHALLclinical-codetoken

Identifies the prescribed component according to a nomenclature depending on the type

SHALLmedication-typetoken

Specifies whether the component prescribed is a speciality, a common name or any other product (pharmacopoeia).

 

Resource Conformance: supported MedicationRequest

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Identifier

SHALLwordingstring

Wording of element/component

SHALLindicationstring

Indications concerning the prescription item and the component prescribed

SHALLmr-prescription-validation-datedate

Date and time at which the prescriber considered the prescription validated

SHALLmr-type-elementprescriptiontoken

Type of prescription element

SHALLelement-formtoken

Pharmaceutical form of the prescription item

SHALLstatustoken

Indicates the status of the protocol from the prescriber's point of view

SHALLelement-routetoken

Specifies the route of administration of the product

SHALLelement-sitetoken

Specifies, where appropriate, the exact point on the body where the product is to be applied to the patient

SHALLcombo-datedate

Returns medication request to be administered on a specific date or within a date range

SHALLmr-date-time-prescription-startdate

Effective start date and time of product prescription

SHALLmr-date-time-prescription-enddate

Effective end date and time of product prescription

SHALLmr-element-gonogo-statustoken

Communicates the conditional state of implementation of the prescription element according to a list of coded values

SHALLmr-element-gonogo-reasonwaitingtoken

Describes the reason for the goNogo implementation status of the prescription element if the management option via the goNogo attribute is enabled

SHALLgroup-identifiertoken

Identifier common to all components of the same prescription

SHALLmr-element-frequency-posologynumber

Indicates the recurrence of the dosage. By default, every day

SHALLmr-element-duration-posologynumber

Duration of administration

SHALLmr-element-rate-posologyquantity

Rate of administration in the case of injection

SHALLmr-element-quantity-posologyquantity

Quantity of the prescription element in the dosage

SHALLmr-prescribed-component-quantityquantity

Quantity of the component prescribed in the prescription element

SHALLmr-component-substitutiontoken

True if the component prescribed is declared non-substitutable in the prescription element

SHALLmr-is-dosage-referenttoken

True 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).

SHALLmr-exempt-ltctoken

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.

SHALLmr-component-solutetoken

True if the component prescribed is solute in the prescription element

 

Resource Conformance: supported CarePlan

Base System Profile
OncoFAIR CarePlan
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Prescribed protocol identifier

SHALLcp-titlestring

Wording of the prescribed protocol

SHALLstatustoken

Indicates the status of the protocol from the prescriber's point of view

SHALLcp-date-time-referencedate

Reference date and time of this prescribed protocol

SHALLindicationstring

Indication concerning the prescribed protocol

 

Resource Conformance: supported MedicationAdministration

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLma-methodtoken

Type of administration element

SHALLma-categorytoken

Code identifying the nature of the administration element

SHALLelement-formtoken

Pharmaceutical form of the administration item

SHALLelement-routetoken

Specifies the route of administration of the product

SHALLelement-sitetoken

Specifies, where applicable, the exact point on the body where the product is to be applied to the patient. By default, the place of administration is that shown in the prescription element associated with the administration element

SHALLdatedate

Effective date and time for starting/ending administration of the administration element

SHALLma-commentsstring

Comments of component

SHALLma-planned-quantityquantity

Quantity of the component administered in the administration element that was intended to be administered to the patient

SHALLma-prescribed-quantityquantity

Quantity actually administered to the patient or planned to be administered

SHALLidentifiertoken

Identifier

SHALLwordingstring

Wording of component/element of administration

SHALLperformerreference

Identification of the person who planned, administered or monitored the administration of the medicines represented by the administration elements