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

Difference between revisions of "PackagedProductDefinition FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with " <div class="messagebox cleanup metadata"> <div style="float: left;">35px| </div> <div style="background:#F0F0F0"> This page documents a :category...")
 
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  
 
<div class="messagebox cleanup metadata">
 
<div class="messagebox cleanup metadata">
<div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div>
+
Current version: https://confluence.hl7.org/display/FHIR/PackagedProductDefinition+FHIR+Resource+Proposal<div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div>
 
<div style="background:#F0F0F0">
 
<div style="background:#F0F0F0">
This page documents a [[:category:Pending FHIR Resource Proposal|Pending]] [[:category:FHIR Resource Proposal|FHIR Resource Proposal]]
+
This page documents a [[:category:Approved FHIR Resource Proposal|Approved]] [[:category:FHIR Resource Proposal|FHIR Resource Proposal]]
 
</div>
 
</div>
 
</div>
 
</div>
 
[[Category:FHIR Resource Proposal]]
 
[[Category:FHIR Resource Proposal]]
[[Category:Pending FHIR Resource Proposal]]
+
[[Category:Approved FHIR Resource Proposal]]
  
  
Line 40: Line 40:
  
 
<!-- Additional work groups that may have an interest in contributing to, or reviewing  the content of the resource (optional) -->
 
<!-- Additional work groups that may have an interest in contributing to, or reviewing  the content of the resource (optional) -->
* Pharmacy
+
*Pharmacy
* Orders and Observations
+
*Orders and Observations
* Clinical Decision Support
 
  
 
==FHIR Resource Development Project Insight ID==
 
==FHIR Resource Development Project Insight ID==
Line 52: Line 51:
 
==Scope of coverage==
 
==Scope of coverage==
  
To support the content of the ISO 11615 IDMP Medicinal Product standard and other domain areas with similar requirements. 11615 covers detailed definition of products, their submissions to regulators, authorization activities, ingredients, packaging, accompanying devices, clinical particulars etc. Not all of those are expected to be covered in this single resource.
+
PackagedProductDefinition is to be used when describing the package structure and physical packaging of a medicinal product.  
  
==RIM scope==
+
This includes all "layers" from outer box to the inner carton, blister pack or bottle etc - down to whatever it is that touches the actual medication inside. It also covers (by references to ManufacturedItemDefinition) the items present at all levels, such as a cardboard packet containing a cream in a tube (metal with a plastic top), plus another carton containing a plastic and foil blister pack with a tablet inside.
  
 +
It provides the link between the Medicinal Product and the various packaging options that may exist. These can be licensed either at product level (one authorization for all packs) or at package level (different authorizations for different).
 +
 +
New packages types can be created and updated with different life cycles to the overarching products that they belong to, so this information is suited to be being a standalone resource, rather than an component of another.
 +
 +
This detail would very rarely, be needed when prescribing – for which the correct resource is Medication. If you need to know package details (size, shape, material etc.) this resource has that level of detail. It also allows tracking which tablets are available in which package variations.
 +
===In scope:===
 +
Packaging structure, for all levels (inner and outer packaging), and references to the items contained in each (tablets, bottles, devices etc), with quantities.
 +
 +
Legal status (e.g. over the counter, or prescription only) and the relevant regulated authorization
 +
 +
Manufacturer
 +
 +
Materials used, physical characteristics, e.g. size
 +
===Not in scope:===
 +
For day to day prescribing, the resource to use is Medication. This covers basic drug information – code, form, strength, batch number.
 +
==Closely related scope:==
 +
Some other closely related information is in scope of other proposed resources, but not in scope of this resource:
 +
 +
MedicinalProductDefinition - the overarching medicine that can come in different pack types, and is typically the entity that is legally authorised for sale.
 +
 +
ManufacturedItemDefinition - the actual physical item of medication, not including any packaging. This however not always the unit that is administered, for which see AdminstrableProductDefinition, since the manufactured item may need combining (dissolving etc) in another item.
 +
 +
Pharmaceutical aspects of the product (AdminstrableProductDefinition) - can be created from one or more ManufacturedItemDefinitions (possibly mixed together)
 +
 +
Regulatory authorizations (RegulatedAuthorization) - legal aspects of the product as a whole (of which the manufactured item is a key component).
 +
 +
Details of ingredients (Ingredient) and their substances (SubstanceDefinition).
 +
===RIM scope===
 
Similar in scope to the product parts of CPM. Entity: Material (EntityClass="MAT")
 
Similar in scope to the product parts of CPM. Entity: Material (EntityClass="MAT")
  
Line 73: Line 100:
  
 
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 drug submission (currently using SPL, which is not likely to change in the near term, but have expressed an interest in FHIR).
 +
 +
Norwegian SAFEST project implementation https://github.com/HL7Norway/SAFEST
  
 
==Content sources==
 
==Content sources==
Line 84: Line 113:
 
==Example Scenarios==
 
==Example Scenarios==
  
Pharma companies submit details of new products to regulators, including the different packages that exist. The same "product" (drug, etc.) can be packaged in different way (20 tablet pack, 50 tablet pack etc), and may have different physical details and be licenced differently. Hence these are "addressable" entities, requiring a stand-alone resource.
+
Pharma companies submit details of new products to regulators, including the different packages that exist. The same "product" (drug, etc.) can be packaged in different way (20 tablet pack, 50 tablet pack etc), and may have different physical details and be licensed differently. Hence these are "addressable" entities, requiring a stand-alone resource.
  
 
Pharmacies and prescribers can view and download this information for reference and integration with their systems.
 
Pharmacies and prescribers can view and download this information for reference and integration with their systems.
Line 90: Line 119:
 
Specific use cases include:
 
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 scenario is currently being re-implemented, using this resource, as part of the EU wide SPOR project.
+
<u>Submission of products from drug companies and NCAs</u> (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 scenario is currently being re-implemented, using this resource, as part of the EU wide SPOR project.
  
Drug Manufacturing Quality information (aka PQ/CMC, Pharmaceutical Quality), as used by the FDA in the US. Specific plans to use this resource for that project.
+
The <u>Norwegian national project SAFEST</u>, has this scenario:
 +
 
 +
''The SAFEST project aims to deliver detailed packaging information in order to lay the groundwork for a “closed loop medication management”. A closed loop medication management requires bar codes on both the single dose administered by the patient and the outer packaging, in order to track the medicine from ordering, verifying, preparing to administering the medication.''
 +
 
 +
''The concept Packaged Medicinal Product holds information about each level of the package, including the place for the data carrier identifier for each level, and thus supports a closed loop medication management.''
 +
 
 +
''The concept Manufactured Item represent the medicinal product contained in the inner packaging, e.g «0,5 ml» in an ampoule with solution for injection.''
 +
 
 +
The <u>EU project Falsified Medicines Directive</u>
 +
 
 +
General background here: https://www.pharmaceutical-journal.com/news-and-analysis/infographics/falsified-medicines-directive-fmd-how-it-will-work/20204433.article?firstPass=false
 +
 
 +
It is key that the package and its elements are identified in a way that exactly represents what is printed on the box or in general on any of the components. This can then support use cases like falsified medicines, which is an EU wide business case (unrelated to EMA).
  
 
==Resource Relationships==
 
==Resource Relationships==
  
See diagram below. <!-- and also associated proposal: [[SubstanceSpecification_FHIR_Resource_Proposal]]-->
+
For the relationship to other resources, see the diagram below.
 +
 
 +
High level relationships of the main prescribing resources and the regulatory strata below:
 +
[[Image:Resources_sketch.png|center||Relationship to other resources]]
 +
 
 +
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]]
 +
 
 +
The PackagedProductDefinition references the manufactured items within it (ManufacturedItemDefinition) as well as any devices (DeviceDefinition).
 +
 
 +
The packaging is part of the range of packages that form the overall medicinal product, so MedicinalProductDefinition is referenced as a subject.
  
 
Some notable resource references:
 
Some notable resource references:
 +
 
Reference to Organization, for the manufacturer.
 
Reference to Organization, for the manufacturer.
Reference to RegulatedAuthorization for a pack specific legal authorization.
 
Reference to directly supporting resources such as RegulatedMedicinalProduct, that this is a packing instance of (definitional instance).
 
  
===RegulatedPackagedProduct and Medication===
+
Reference to RegulatedAuthorization, for a possible legal authorization at package level.
  
This resource is intended to complement the Medication resource, which is focused on what is commonly needed for medical/clinical use cases. RegulatedPackagedProduct adds information needed for regulatory use cases, of which there is little overlap to day to day prescribing.
+
So:
  
Most aspects of RegulatedPackagedProduct are not present in Medication at all, and are not current candidates for inclusion in the prescribe/dispense/administer workflow.
+
    MPD – as licenced
 +
      / \
 +
    /    \____PPD1  or  PPD2 – as supplied
 +
  /           / \
 +
APD  <--  MID1+MID2 (mixed)
 +
  \
 +
  as administered to the patient
  
===RegulatedPackagedProduct and MedicationKnowledge ===
+
MPD Medicinal Product (definition)
  
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 packaging information 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.
+
MID Manufactured Item (definition)
  
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]]
+
PPD Packaged Product (definition)
  
 
+
APD Administrable Product (definition)
High level relationships of the main prescribing resources and the regulatory strata below:
 
[[Image:Resources_sketch.png|center||Relationship to other resources]]
 
  
 
==Timelines==
 
==Timelines==
  
Draft content is modelled in the FHIR build (http://build.fhir.org/regulatedmedicinalproduct.html), with outline supporting documentation. Completion planned Q4 2019.
+
Draft content is modelled in the FHIR build [http://build.fhir.org/packagedproductdefinition.html PackagedProductDefinition], with outline supporting documentation. Completion planned Q4 2019.
  
 
==gForge Users==
 
==gForge Users==

Latest revision as of 19:54, 13 November 2019



RegulatedPackagedProduct

Draft resource in build:

Regulatedpackagedproduct

Owning work group name

BR&R

Committee Approval Date:

6th May 2019 (earlier approval as "MedicinalProductPackaged" 13th September 2017)

Contributing or Reviewing Work Groups

  • Pharmacy
  • Orders and Observations

FHIR Resource Development Project Insight ID

1367


Scope of coverage

PackagedProductDefinition is to be used when describing the package structure and physical packaging of a medicinal product.

This includes all "layers" from outer box to the inner carton, blister pack or bottle etc - down to whatever it is that touches the actual medication inside. It also covers (by references to ManufacturedItemDefinition) the items present at all levels, such as a cardboard packet containing a cream in a tube (metal with a plastic top), plus another carton containing a plastic and foil blister pack with a tablet inside.

It provides the link between the Medicinal Product and the various packaging options that may exist. These can be licensed either at product level (one authorization for all packs) or at package level (different authorizations for different).

New packages types can be created and updated with different life cycles to the overarching products that they belong to, so this information is suited to be being a standalone resource, rather than an component of another.

This detail would very rarely, be needed when prescribing – for which the correct resource is Medication. If you need to know package details (size, shape, material etc.) this resource has that level of detail. It also allows tracking which tablets are available in which package variations.

In scope:

Packaging structure, for all levels (inner and outer packaging), and references to the items contained in each (tablets, bottles, devices etc), with quantities.

Legal status (e.g. over the counter, or prescription only) and the relevant regulated authorization

Manufacturer

Materials used, physical characteristics, e.g. size

Not in scope:

For day to day prescribing, the resource to use is Medication. This covers basic drug information – code, form, strength, batch number.

Closely related scope:

Some other closely related information is in scope of other proposed resources, but not in scope of this resource:

MedicinalProductDefinition - the overarching medicine that can come in different pack types, and is typically the entity that is legally authorised for sale.

ManufacturedItemDefinition - the actual physical item of medication, not including any packaging. This however not always the unit that is administered, for which see AdminstrableProductDefinition, since the manufactured item may need combining (dissolving etc) in another item.

Pharmaceutical aspects of the product (AdminstrableProductDefinition) - can be created from one or more ManufacturedItemDefinitions (possibly mixed together)

Regulatory authorizations (RegulatedAuthorization) - legal aspects of the product as a whole (of which the manufactured item is a key component).

Details of ingredients (Ingredient) and their substances (SubstanceDefinition).

RIM scope

Similar in scope to the product parts of CPM. Entity: Material (EntityClass="MAT")

Resource appropriateness

There is an outstanding requirement to support the standardised exchange of detailed "Product" data, for regulatory and other use cases.

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

RegulatedPackagedProduct is intended to add an extra level of product specification detail, such as is typically used by regulators, and only indirectly used during normal medication related work flows (e.g. for look-ups of unfamiliar products).

Drug manufacturers currently submit this data electronically to regulators, when products are registered or altered, or marketing situations change.

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

Norwegian SAFEST project implementation https://github.com/HL7Norway/SAFEST

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 (https://www.ema.europa.eu/en/about-us/how-we-work/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, including the different packages that exist. The same "product" (drug, etc.) can be packaged in different way (20 tablet pack, 50 tablet pack etc), and may have different physical details and be licensed differently. Hence these are "addressable" entities, requiring a stand-alone resource.

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 scenario is currently being re-implemented, using this resource, as part of the EU wide SPOR project.

The Norwegian national project SAFEST, has this scenario:

The SAFEST project aims to deliver detailed packaging information in order to lay the groundwork for a “closed loop medication management”. A closed loop medication management requires bar codes on both the single dose administered by the patient and the outer packaging, in order to track the medicine from ordering, verifying, preparing to administering the medication.

The concept Packaged Medicinal Product holds information about each level of the package, including the place for the data carrier identifier for each level, and thus supports a closed loop medication management.

The concept Manufactured Item represent the medicinal product contained in the inner packaging, e.g «0,5 ml» in an ampoule with solution for injection.

The EU project Falsified Medicines Directive

General background here: https://www.pharmaceutical-journal.com/news-and-analysis/infographics/falsified-medicines-directive-fmd-how-it-will-work/20204433.article?firstPass=false

It is key that the package and its elements are identified in a way that exactly represents what is printed on the box or in general on any of the components. This can then support use cases like falsified medicines, which is an EU wide business case (unrelated to EMA).

Resource Relationships

For the relationship to other resources, see the diagram below.

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

Relationship to other resources

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

The PackagedProductDefinition references the manufactured items within it (ManufacturedItemDefinition) as well as any devices (DeviceDefinition).

The packaging is part of the range of packages that form the overall medicinal product, so MedicinalProductDefinition is referenced as a subject.

Some notable resource references:

Reference to Organization, for the manufacturer.

Reference to RegulatedAuthorization, for a possible legal authorization at package level.

So:

   MPD – as licenced 
     / \
   /    \____PPD1  or  PPD2 – as supplied
 /           /  \
APD   <--  MID1+MID2 (mixed)
 \
  as administered to the patient

MPD Medicinal Product (definition)

MID Manufactured Item (definition)

PPD Packaged Product (definition)

APD Administrable Product (definition)

Timelines

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

gForge Users

riksmithies

When Resource Proposal Is Complete

When you have completed your proposal, please send an email to FMGcontact@HL7.org

FMG Notes