This wiki has undergone a migration to Confluence found Here
Difference between revisions of "MedicationKnowledge FHIR Resource Proposal"
Jump to navigation
Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}") |
|||
(12 intermediate revisions by one other user not shown) | |||
Line 3: | Line 3: | ||
<div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div> | <div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div> | ||
<div style="background:#F0F0F0"> | <div style="background:#F0F0F0"> | ||
− | This page documents a [[:category: | + | 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: | + | [[Category:Approved FHIR Resource Proposal]] |
Line 14: | Line 14: | ||
=PutProposedResourceNameHere= | =PutProposedResourceNameHere= | ||
+ | MedicationKnowledge | ||
<!-- Resource names should meet the following characteristics: | <!-- Resource names should meet the following characteristics: | ||
Line 30: | Line 31: | ||
<!-- The name of the committee that is proposed to have responsibility for developing and maintaining the resources. --> | <!-- The name of the committee that is proposed to have responsibility for developing and maintaining the resources. --> | ||
− | [[ | + | [[Pharmacy Work Group]] |
==Committee Approval Date:== | ==Committee Approval Date:== | ||
− | < | + | <I>March 11, 2019 - see minutes on Confluence [https://confluence.hl7.org/pages/viewpage.action?pageId=44499679 Pharmacy Minutes 11-03-2019]</i> |
==Contributing or Reviewing Work Groups== | ==Contributing or Reviewing Work Groups== | ||
<!-- 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) --> | ||
− | * | + | * BR&R |
− | * | + | * O&O |
− | * | + | * Patient Care |
+ | * CDS | ||
==FHIR Resource Development Project Insight ID== | ==FHIR Resource Development Project Insight ID== | ||
+ | * Project Insight ID: 1409 | ||
<!-- Please specify the id of your work group’s PSS for doing FHIR work. (If submitted but not yet approved, just write “pending”.) The link to the PSS template can be found here: http://gforge.hl7.org/gf/download/docmanfileversion/6832/9398/HL7FHIR_DSTUballotPSS-20120529.doc --> | <!-- Please specify the id of your work group’s PSS for doing FHIR work. (If submitted but not yet approved, just write “pending”.) The link to the PSS template can be found here: http://gforge.hl7.org/gf/download/docmanfileversion/6832/9398/HL7FHIR_DSTUballotPSS-20120529.doc --> | ||
==Scope of coverage== | ==Scope of coverage== | ||
+ | *Identification and characteristics of a product consumed by patients | ||
+ | *The scope of a MedicationKnowledge resource encompasses all the products that are conventionally understood to be medications or products consumed by patients including non-prescribed medication, herbal products, diet supplements, illicit drugs, and even some products that may be classified as devices. This resource is intended to include attributes that describe the medication including, but not limited to type, colour, image, cost, formulary coverage, etc. | ||
+ | *This resource may be a kind of product as well as a specific instance of a product. | ||
+ | |||
+ | * The following diagram describes the scope of the various resources related to medication content. The Pharmacy Work Group has worked with Biomedical Research and Regulation (BR&R) Work Group to develop the diagram to describe the relationship between the various resources. | ||
+ | * These include: | ||
+ | ** Medication | ||
+ | ** MedicationKnowledge | ||
+ | ** MedicinalProduct (expect to be renamed) | ||
+ | ** MedicinalProductPackaged (expect to be renamed) | ||
+ | ** MedicinalProductPharmaceutical (expect to be renamed) | ||
+ | |||
+ | * Common Medication Model | ||
+ | [[File:Medication Common Model.png]] | ||
+ | |||
+ | The scope and boundary for each resource will be updated to clearly describe to implementers where the resources apply. | ||
+ | |||
+ | *The MedicationKnowledge resource: | ||
+ | ** is related to Medication, but contains additional attributes to fully describe a medication for different contexts - clinical decision support, payment/coverage, drug information. | ||
+ | ** contains a subset of the attributes in MedicinalProduct | ||
+ | ** contains additional attributes that are not in scope for MedicinalProduct | ||
+ | ** Will be used in multiple environment including community pharmacies, hospital pharmacies, hospitals, prescriber offices, etc | ||
<!-- Define the full scope of coverage for the resource. The scope must be clearly delineated such that it does not overlap with any other existing or expected resource. The scope will be used to govern "what is the set of potential applications to consider when evaluating what elements are 'core' – i.e. in the 80%" | <!-- Define the full scope of coverage for the resource. The scope must be clearly delineated such that it does not overlap with any other existing or expected resource. The scope will be used to govern "what is the set of potential applications to consider when evaluating what elements are 'core' – i.e. in the 80%" | ||
Line 62: | Line 87: | ||
<!-- Identify the formal RIM mapping for the root concept of the resource. The expectation is that the RIM mapping will be sufficiently precise so as to not overlap with any other resource definition. --> | <!-- Identify the formal RIM mapping for the root concept of the resource. The expectation is that the RIM mapping will be sufficiently precise so as to not overlap with any other resource definition. --> | ||
+ | *MedicationKnowledge corresponds to a manufactured product (MANU) role played by a manufactured material MMAT entity. The Common Product Model in the V3 ballot encompasses this scope but also provides much more. | ||
==Resource appropriateness== | ==Resource appropriateness== | ||
+ | *Products cannot be used if they cannot be identified and systems to establish and maintain queryable lists of products are widespread. For systems to interoperate they must have a shared basis for product identification as well as the characteristics of a medication. Characteristics can include attributes such as colour, markings, an image, as well as cost and formulary coverage. It may also be as broad as the clinical knowledge about a medication such as drug-drug interactions, dosing recommendations, and drug-allergy interactions. | ||
<!-- Does the resource meet the following characteristics? | <!-- Does the resource meet the following characteristics? | ||
Line 79: | Line 106: | ||
==Expected implementations== | ==Expected implementations== | ||
+ | *This resource is likely to be implemented by applications: | ||
+ | **Pharmacy Practice Management Systems | ||
+ | **Electronic Medical Records | ||
+ | **Clinical Decision Support systems | ||
+ | **Hospital Information Systems/EHRs | ||
+ | ** Drug Knowledge Bases | ||
<!--Key resources are justified by CCDA, for resources not deemed "key", what interest is there by implementers in using this particular resource. Provide named implementations if possible - ideally provide multiple independent implementations. --> | <!--Key resources are justified by CCDA, for resources not deemed "key", what interest is there by implementers in using this particular resource. Provide named implementations if possible - ideally provide multiple independent implementations. --> | ||
==Content sources== | ==Content sources== | ||
+ | |||
+ | *Existing normative V3 CPM RMIMs | ||
+ | *Existing specifications in Canada, The Netherlands and UK | ||
+ | *Some commercial systems | ||
<!-- List all of the specifications (beyond those in the "standard" (FHIR_Design_Requirements_Sources) list of source specifications) that you’re planning to consult | <!-- List all of the specifications (beyond those in the "standard" (FHIR_Design_Requirements_Sources) list of source specifications) that you’re planning to consult | ||
Line 89: | Line 126: | ||
==Example Scenarios== | ==Example Scenarios== | ||
+ | *A prescriber or dispenser wants to query to get information about the coverage and cost of a particular drug. This resource can be used to query for a drug or set of drugs coverage details in a particular formulary | ||
+ | *A prescriber or dispenser wants to query to get potential equivalent products – for example, they can search using the ingredient(s) and strength to return branded products that contain the same set of ingredient(s) and strength(s) | ||
+ | * A patient wants to query to determine if a drug is covered by an insurer and its' cost | ||
+ | * A patient wants to query to get information (side effects, etc) about a drug he or she is taking or has been prescribed). | ||
<!-- Provide a listing of the types of scenarios to be represented in the examples produced for this resource. They should demonstrate the full scope of the resource and allow exercising of the resources capabilities (full element coverage, inclusion & omission of optional elements, repeating and singleton repeating elements, etc.) --> | <!-- Provide a listing of the types of scenarios to be represented in the examples produced for this resource. They should demonstrate the full scope of the resource and allow exercising of the resources capabilities (full element coverage, inclusion & omission of optional elements, repeating and singleton repeating elements, etc.) --> | ||
==Resource Relationships== | ==Resource Relationships== | ||
+ | *MedicationKnowledge is expected to reference Substance, Organization, Medication, DocumentReference, Media. | ||
+ | * It will also reference draft resources: Contraindication, Indication, Interaction, UndesirableEffect - currently under development by BR&R but will be working with other WorkGroups (CDS, Patient Care) to fully define | ||
+ | *This resource may be referenced by other resources such as CatalogEntry in the future | ||
+ | |||
+ | [[File:Medication Resource Scope.jpeg]] | ||
<!-- What are the resources do you expect will reference this resource and in what context? | <!-- What are the resources do you expect will reference this resource and in what context? | ||
Line 104: | Line 150: | ||
==Timelines== | ==Timelines== | ||
+ | *Expect to be ready for Comment only ballot – September 2019 Ballot Cycle | ||
+ | * Maturity level 1 (or higher) in R5 | ||
<!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting --> | <!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting --> | ||
==gForge Users== | ==gForge Users== | ||
− | + | * Melva Peters | |
<!-- Identify the userids who will require commit access to gForge to maintain the resource. (Ensure all users have registered for gForge.) --> | <!-- Identify the userids who will require commit access to gForge to maintain the resource. (Ensure all users have registered for gForge.) --> | ||
Latest revision as of 21:11, 10 April 2019
Contents
- 1 PutProposedResourceNameHere
- 1.1 Owning work group name
- 1.2 Committee Approval Date:
- 1.3 Contributing or Reviewing Work Groups
- 1.4 FHIR Resource Development Project Insight ID
- 1.5 Scope of coverage
- 1.6 RIM scope
- 1.7 Resource appropriateness
- 1.8 Expected implementations
- 1.9 Content sources
- 1.10 Example Scenarios
- 1.11 Resource Relationships
- 1.12 Timelines
- 1.13 gForge Users
- 1.14 When Resource Proposal Is Complete
- 1.15 FMG Notes
PutProposedResourceNameHere
MedicationKnowledge
Owning work group name
Committee Approval Date:
March 11, 2019 - see minutes on Confluence Pharmacy Minutes 11-03-2019
Contributing or Reviewing Work Groups
- BR&R
- O&O
- Patient Care
- CDS
FHIR Resource Development Project Insight ID
- Project Insight ID: 1409
Scope of coverage
- Identification and characteristics of a product consumed by patients
- The scope of a MedicationKnowledge resource encompasses all the products that are conventionally understood to be medications or products consumed by patients including non-prescribed medication, herbal products, diet supplements, illicit drugs, and even some products that may be classified as devices. This resource is intended to include attributes that describe the medication including, but not limited to type, colour, image, cost, formulary coverage, etc.
- This resource may be a kind of product as well as a specific instance of a product.
- The following diagram describes the scope of the various resources related to medication content. The Pharmacy Work Group has worked with Biomedical Research and Regulation (BR&R) Work Group to develop the diagram to describe the relationship between the various resources.
- These include:
- Medication
- MedicationKnowledge
- MedicinalProduct (expect to be renamed)
- MedicinalProductPackaged (expect to be renamed)
- MedicinalProductPharmaceutical (expect to be renamed)
- Common Medication Model
The scope and boundary for each resource will be updated to clearly describe to implementers where the resources apply.
- The MedicationKnowledge resource:
- is related to Medication, but contains additional attributes to fully describe a medication for different contexts - clinical decision support, payment/coverage, drug information.
- contains a subset of the attributes in MedicinalProduct
- contains additional attributes that are not in scope for MedicinalProduct
- Will be used in multiple environment including community pharmacies, hospital pharmacies, hospitals, prescriber offices, etc
RIM scope
- MedicationKnowledge corresponds to a manufactured product (MANU) role played by a manufactured material MMAT entity. The Common Product Model in the V3 ballot encompasses this scope but also provides much more.
Resource appropriateness
- Products cannot be used if they cannot be identified and systems to establish and maintain queryable lists of products are widespread. For systems to interoperate they must have a shared basis for product identification as well as the characteristics of a medication. Characteristics can include attributes such as colour, markings, an image, as well as cost and formulary coverage. It may also be as broad as the clinical knowledge about a medication such as drug-drug interactions, dosing recommendations, and drug-allergy interactions.
Expected implementations
- This resource is likely to be implemented by applications:
- Pharmacy Practice Management Systems
- Electronic Medical Records
- Clinical Decision Support systems
- Hospital Information Systems/EHRs
- Drug Knowledge Bases
Content sources
- Existing normative V3 CPM RMIMs
- Existing specifications in Canada, The Netherlands and UK
- Some commercial systems
Example Scenarios
- A prescriber or dispenser wants to query to get information about the coverage and cost of a particular drug. This resource can be used to query for a drug or set of drugs coverage details in a particular formulary
- A prescriber or dispenser wants to query to get potential equivalent products – for example, they can search using the ingredient(s) and strength to return branded products that contain the same set of ingredient(s) and strength(s)
- A patient wants to query to determine if a drug is covered by an insurer and its' cost
- A patient wants to query to get information (side effects, etc) about a drug he or she is taking or has been prescribed).
Resource Relationships
- MedicationKnowledge is expected to reference Substance, Organization, Medication, DocumentReference, Media.
- It will also reference draft resources: Contraindication, Indication, Interaction, UndesirableEffect - currently under development by BR&R but will be working with other WorkGroups (CDS, Patient Care) to fully define
- This resource may be referenced by other resources such as CatalogEntry in the future
Timelines
- Expect to be ready for Comment only ballot – September 2019 Ballot Cycle
- Maturity level 1 (or higher) in R5
gForge Users
- Melva Peters
When Resource Proposal Is Complete
When you have completed your proposal, please send an email to FMGcontact@HL7.org