 HL7 V3 ME DKBQ, R1-2012 (Retired 2021) HL7 Version 3 Standard: Medication: Knowledge-Base Query, Release 1 Retired 9/29/2021 |
Content Last Edited: 2014-01-23T09:06:58
5.2 Storyboards
5.3 Application Roles
5.4 Trigger Events
5.5 Refined Message Information Models
5.6 Hierarchical Message Descriptions
5.7 Interactions
This topic covers the issuing of queries to medication knowledge base applications for such information as medication monographs, regimens and therapies.
|
||||||||||
|
For details on the interpretation of this section, see the storyboard discussion in the Version 3 Guide.
The purpose of this storyboard is to illustrate how a medication knowledge base could provide detailed clinical information in a Clinical setting.
| Medication product detail query |  PORX_IN070050UV02 |
| Medication product detail query response | PORX_IN070060UV02 |
This storyboard illustrates how a medication knowledge base can provide a list of medications that meet a particular set of criteria.
| Medication search query | PORX_IN070070UV02 |
| Medication search query response | PORX_IN070080UV02 |
The purpose of this storyboard is to illustrate how a medication knowledge base could be used in a Pharmacy setting to provide a set of documents about a medicine.
Eve Everywoman is an 87-year-old woman with multiple medical problems. She lives alone and is finding it difficult to manage her health care properly. Her daughter has offered to care for her in her home and will help manage her medications until such time as Eve is ready for a long term health care facility or managed care.
To prepare for the move to her daughter's house, Eve has decided to obtain as much educational materials on her medications as possible. She visits her pharmacist, Sue Script at Good Neighbor Pharmacy and requests documentation on all her medications. Sue is pleased to oblige and requests a medication profile for Eve from the ePrescribing system. This provides a list of current medications. Sue Script then issues a request to a medication knowledge base applicaton that provides short-form educational materials (Medication Document Query (PORX_IN070010UV)). She gets a response (Medication Document Query Response (PORX_IN070020UV)) and prints off the information, explains their contents to Eve and asks her to give them to her daughter.
The entire transaction follows a simple request response pattern. If there are no matching documents available no response will be sent.
| Medication document query | PORX_IN070010UV02 |
| Medication document query response | PORX_IN070020UV02 |
The interaction is triggered (Response to request for medication document(s) (PORX_TE070040UV)) by the preceeding interaction (Medication document query (PORX_IN070010UV)) which caused the receiving system to assemble a set of one or more documents that match the request criteria and then to assemble these documents into the response message (Medication Document Response (PORP_MT050032UV)) which is sent back to the original requestor.
The interaction is triggered by a user request (Request for medication document(s) (PORX_TE070090UV)) and subsequent transmission of a message (Medication Document Query (PORX_MT010050UV)) which can specify the type of document required and the identity of the medication concerned.
|
||||||||
|
For details on the interpretation of this section, see the discussion of application roles and their relationships in the Version 3 Guide.
This is any system which can query a medication knowledge base system for information about medication.
This is a system which provides information (knowledge) about medications including, but not limited to, monographs and drug-to-drug interactions.
|
||||||||||||||||
|
For details on the interpretation of this section, see the discussion of trigger events in the Version 3 Guide.
| Type: | User request |
A user or system has requested documents about a medication or indication.
| Type: | User request |
A user or system requires detailed information about a medication.
| Type: | User request |
A user or system requires information about medications matching a set of criteria.
| Type: | Interaction based |
An application responds to a request for a document about a medication or indication.
| Type: | Interaction based |
An application responds to a request for detailed information about a medication.
| Type: | Interaction based |
An application responds to a request for information about medications matching a set of criteria.
|
||||||||||||
|
For details on the interpretation of this section, see the description of RMIMs in the Version 3 Guide.
| Parent: | Pharmacy (PORX_DM000000UV) |
All responses to queries are done via a CMET (R_ProductListed (POCP_RM010100UV) from the Common Product Model. The available message wrappers require an entry point to the message payload to be an Act. To enable this the entry point is an Act with classCode fixed to "ACT" and moodCode fixed to "EVN". This then connects to the CMET via a participationType fixed to "participationType".
CMET Outline
The full description of the CMET should be read in the (Common Product Model: R_ProductListed (POCP_RM010100UV)) section of the ballot. The aim of the CMET is to represent a Product Kind in the role of a manufactured product. It describes the relationship of the medicinal product to its component parts (if any) and to its ingredients and to a generic equivalent. It also describes the packaging and manufacture. Each of the major roles has links to observations or to other CMETs which allow representation of the formal documents (such as the Structured Product Label) which can provide more freee text description in addition to coded forms.
| Medication Detail Query | PORX_HD010030UV01 |
| Parent: | Pharmacy (PORX_DM000000UV) |
Allows retrieval of monograph and protocol documents. The criteria are specified using the various classes.
Medication Code and PrescribingIndicationCode - are both optional and if specified the results returned must match those items that have been specified. The code for both medication and indication will be whatever code system is used locally.
Medicaton Document Type and ID - optional, use this pair to specify the document which must be found. If there is no specific document specified then all available docuemnts will be returned.
| Medication Document Query | PORX_HD010050UV01 |
| Parent: | Pharmacy (PORX_DM000000UV) |
Allows retrieval of a list of medications which meet user-specified criteria. The criteria are specified using the various classes.
Medication Code, Name, Form, Route and Manufacturer Name - are all optional and if specified the results returned must match those items that have been specified.
Characteristic Type and Value although the Characteristic grouping is optional, if it is specified, then the type and value parameters are mandatory. This pair is used to specify the actual characteristic and the value of that characteristic for which matching data must be found. If there is no specific characteristic required (for instance a search by name) then use one of the other parameters.
| Medication Lookup Query | PORX_HD010090UV01 |
| Parent: | Pharmacy (PORX_DM000000UV) |
| Medication Lookup Response | PORX_HD010100UV01 |
|
||||||||||||
|
For details on the interpretation of this section, see the description of HMDs in the Version 3 Guide.
Allows for the request for retrieval of detailed information and knowledge about a medication
| Medication Detail Query | PORX_MT010030UV01 | |
Allows retrieval of monograph and protocol documents
| Medication Document Query | PORX_MT010050UV01 | |
Allows retrieval of a list of medications which meet user-specified criteria
| Medication Lookup Query | PORX_MT010090UV01 | |
Returns general information about a medication. The query response can provide for multiple medications by repeating the payload, which is a single medication.
| R_ProductListedListed | POCP_MT010100UV |
| Medication Lookup Response | PORX_MT010100UV01 | |
|
||||||||||||||||
|
For details on the interpretation of this section, see the definition of Interactions in the Version 3 Guide.
Requests retrieval of a specific monograph or set of monographs for a particular medication (specified by identifier or indication). The type of monograph (provider, patient, long, short, etc.) may be specified.
| Trigger Event | Request for medication document(s) | PORX_TE070090UV02 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Query Control Act Request : Parameter List | QUQI_MT020001UV01 |
| Message Type | Medication Document Query | PORX_MT010050UV01 |
| Reason | Trigger Event | Interaction |
| Return the specific monograph or set of monographs requested. | PORX_TE070040UV02 | PORX_IN070010UV02 |
| Sender | Medication Knowledge Seeker (Medication) | PORX_AR990105UV02 |
| Receiver | Medication Knowledge Base System (Medication) | PORX_AR990108UV02 |
Returns a specific monpgraph or set of monographs for for a particular medication (specified by identifier or indication)
| Trigger Event | Response to request for medication documentation | PORX_TE070040UV02 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Query Control Act Response / Acknowledgement | QUQI_MT120001UV01 |
| Query Response Type | PORP_MT050032UV | |
| Query Definition | Medication Document Query | PORX_MT010050UV01 |
| Sender | Medication Knowledge Base System (Medication) | PORX_AR990108UV02 |
| Receiver | Medication Knowledge Seeker (Medication) | PORX_AR990105UV02 |
Requests retrieval of a lists of candidate medications based on various search criteria such as name, route, code, manufacturer, appearance, etc.
| Trigger Event | Request for matching medications | PORX_TE070100UV02 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Query Control Act Request : Parameter List | QUQI_MT020001UV01 |
| Message Type | Medication Lookup Query | PORX_MT010090UV01 |
| Reason | Trigger Event | Interaction |
| Return the list of candidate medications based on the search criteria. | PORX_TE070050UV02 | PORX_IN070080UV02 |
| Sender | Medication Knowledge Seeker (Medication) | PORX_AR990105UV02 |
| Receiver | Medication Knowledge Base System (Medication) | PORX_AR990108UV02 |
Requests retrieval of detailed information about a single medication product by product code.
| Trigger Event | Request for detailed medication information | PORX_TE070070UV02 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Query Control Act Request : Parameter List | QUQI_MT020001UV01 |
| Message Type | Medication Detail Query | PORX_MT010030UV01 |
| Reason | Trigger Event | Interaction |
| Return the detailed information about the single medication requested. | PORX_TE070020UV02 | PORX_IN070060UV02 |
| Sender | Medication Knowledge Seeker (Medication) | PORX_AR990105UV02 |
| Receiver | Medication Knowledge Base System (Medication) | PORX_AR990108UV02 |
Returns a list of basic identifying and descriptive information about one or more medications.
| Trigger Event | Response to request for matching medications | PORX_TE070050UV02 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Query Control Act Response / Acknowledgement | QUQI_MT120001UV01 |
| Query Response Type | Medication Lookup Response | PORX_MT010100UV01 |
| Query Definition | Medication Lookup Query | PORX_MT010090UV01 |
| Sender | Medication Knowledge Base System (Medication) | PORX_AR990108UV02 |
| Receiver | Medication Knowledge Seeker (Medication) | PORX_AR990105UV02 |
Returns detailed information about a single medication product.
| Trigger Event | Response to request for detailed medication info | PORX_TE070020UV02 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Query Control Act Response / Acknowledgement | QUQI_MT120001UV01 |
| Query Response Type | Medication Lookup Response | PORX_MT010100UV01 |
| Query Definition | Medication Detail Query | PORX_MT010030UV01 |
| Sender | Medication Knowledge Base System (Medication) | PORX_AR990108UV02 |
| Receiver | Medication Knowledge Seeker (Medication) | PORX_AR990105UV02 |
| Return to top of page |