This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "ClinicalUseIssue FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
Line 66: Line 66:
This resource has been designed in consultation with CDS WG and Pharmacy WG, and in conjunction with the MedicationKnowledge resource.
This resource has been designed in consultation with CDS WG and Pharmacy WG, and in conjunction with the MedicationKnowledge resource.
The MedicationKnowledge  resource will use these resources.
<br />
<br />

Revision as of 17:12, 28 August 2019


Draft resource in build:

Relationship to other resources

Owning work group name


Committee Approval Date:

6th May 2019

Contributing or Reviewing Work Groups

  • Pharmacy
  • Orders and Observations
  • Clinical Decision Support

FHIR Resource Development Project Insight ID


Scope of coverage

ClinicalUseIssue covers the background information about potential use of treatments or therapies (drugs, devices, procedures, substance etc), and how they affect a patient, positively and in particular negatively.

The high level scope is:

Indications - in what circumstances it is good practice to give the treatment

Contraindications - in what circumstances it is NOT good practice to give the treatment

Undesirable effects - what possible negative consequences are known to be issue for this treatment ("side effects")

Interactions - what possible negative effects may be brought about by using this treatment (especially a drug), due to other previously employed drugs or treatments.

These are not related to any particular instance of use and also not any actual good or bad outcome, but are reference information, to guide the potential choice of treatments.

There is one resource for one set of facts about a single usage pattern. This does not cover multiple indications, or both indications and contraindications in one.

It is a polymorphic resource, that can be one of several distinct things - an indication and interaction are very different things. (Earlier iterations had 4 separate resources, but these were combined at the request of CDS WG).

Out of scope are actual events such as AdverseEvent (or Condition), and context specific collections of information such as MedicationKnowledge or MedicinalProductDefinition (both of which will use these resources).

These are also different to DetectedIssue, which represents a decision support finding being triggered. Detectedissue may well use these resources to indicate the source of information that was used in the activation process.

Resource appropriateness

The clinical concepts are well known, and well integrated into modern EHRs. Decision support systems are becoming mainstream, but may use proprietary formats to represent their source information. There is a clear need for this data in current generation systems, and support for it within FHIR seems highly appropriate.

This resource has been designed in consultation with CDS WG and Pharmacy WG, and in conjunction with the MedicationKnowledge resource.

Expected implementations

EMA and European drug manufacturers, who have a requirement to submit to EMA (and already do so in a proprietary format). They are required to move to IDMP, and this is a good opportunity to use a standards-based FHIR solution.

FDA for drug submission (currently using SPL, which is not likely to change in the near term, but have expressed an interest in FHIR).

FDA for Pharmaceutical Quality (HL7 PSS approved, based on this resource, June 2019),

Content sources

The core basis for the resource is the information in ISO 11615 Medicinal Products standard, which is in turn partly based on the existing implementations in the EU and US. A large amount of actual data exists in the EMA EU XEVMPD data base (and XEVPRM XML messages). Example FHIR data for several full product data sheets exists based on draft resources.

Also, information gained from early stage implementation of these resources at EMA (2018, 2019), and from many many received to EMA about the draft API specification from the European medicines regulatory network (

Also from FDA requirements (for PQ/CMC) and other workgroup review (BR&R, Pharmacy) and their comments.

Example Scenarios

Pharma companies submit details of new products to regulators. Updates are made when necessary e.g. clinical particulars change (a new contra-indication)

Pharmacies and prescribers can view and download this information for reference and integration with their systems.

Specific use cases include:

Submission of products from drug companies and NCAs (National Competent Authorities - the national regulators) to regional regulators. This is already implemented in Europe (by EMA and EU-wide stakeholders) with an earlier non-HL7 format (XEVPRM/XEVMPD). That scenarion is currently being re-implemented, using this resource, as part of the EU wide SPOR project.

Resource Relationships

See diagram below.

Some notable resource references: Reference to RegulatedPackagedProduct for the subject - the product that this is an indication for, for instance.

ClinicalUseIssue and MedicationKnowledge

MedicationKnowledge resource is aimed at drug knowledge bases. There is partial overlap in scope between that resource and some aspects of regulatory use cases. Where information about indications, contra-indications etc is needed, it is anticipated that this resource would be used.

The boundaries between all these resource have been carefully thought out and have had much discussion in workgroups (BR&R, Pharmacy, CDS) and with FMG representatives.

Also refer to the logical model which was used to clarify the resource relationships, at the request of FMG, in the preparation of this proposal (linked to the approved MedicationKnowledge proposal page): MedicationKnowledge_FHIR_Resource_Proposal

High level relationships of the main prescribing resources and the regulatory strata below:

Relationship to other resources


Draft content is modelled in the FHIR build (, with outline supporting documentation. Completion planned Q4 2019.

gForge Users


When Resource Proposal Is Complete

When you have completed your proposal, please send an email to

FMG Notes