US Prescription Drug Monitoring Program (PDMP)
1.0.0-ballot - STU1 Ballot United States of America flag

US Prescription Drug Monitoring Program (PDMP), published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-pdmp/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

pdmp-client

This resource defines the expected capabilities of the PDMP Client actor when conforming to the PDMP IG and it is expected that it will be used in conjunction with the US Core CapabilityStatement. Together they describe the complete list of actual profiles, RESTful operations, and messaging capabilities supported by PDMP Clients. PDMP Client requirements may also be impacted by the rules of local jurisdictions or other contextual requirements.

pdmp-server

This resource defines the expected capabilities of the PDMP Server actor when conforming to the PDMP IG and it is expected that it will be used in conjunction with the US Core CapabilityStatement. Together they describe the complete list of specific profiles, RESTful operations, and messaging capabilities supported by PDMP Servers. PDMP Server requirements may also be impacted by the rules of local jurisdictions or other contextual requirements.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

PDMP Operation PDMP History

Operation returning an individual patient’s PDMP history

Behavior: Message Definitions

These define the types of messages that can be sent and/or received by systems conforming to this implementation guide.

PDMP Message Definition - Request

Message requesting information from a PDMP facilitator system about medication dispensations and administrations

PDMP Message Definition - Response

Response returning information from a PDMP facilitator system about medication dispensations and administrations

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

PDMP Bundle - History Result

This profile constrains a Bundle resource to carry the history details and/or processing outcome in a Prescription Drug Monitoring Program (PDMP) response

PDMP Bundle - Request Message

This profile constrains a Bundle resource for use as the request message to a PDMP–with a Parameters resource as the bundle’s message focus.

PDMP Bundle - Response Message

This profile constrains a Bundle resource for use as the response message from a PDMP–with a Parameters resource as the message’s message focus.

PDMP MedicationAdministration

Defines constraints and extensions on the MedicationAdministration resource when used by a Prescription Drug Monitoring Program (PDMP) to return an individual’s medication administration history.

PDMP MedicationDispense

Defines constraints and extensions on the MedicationDispense resource when used by a Prescription Drug Monitoring Program (PDMP) to return an individual’s medication dispense history.

PDMP MessageHeader - Request

This profile constrains a MessageHeader resource for use in a PDMP request data bundle. A Parameters resource is the focus.

PDMP MessageHeader - Response

This profile constrains a MessageHeader resource for use in a PDMP response data bundle. A Parameters resource is the focus.

PDMP Organization - Pharmacy

Defines constraints and extensions on the Organization resource when used by a Prescription Drug Monitoring Program (PDMP) to represent a dispensing pharmacy.

PDMP Parameters - Request

This profile tailors the Parameters resource to convey PDMP History operation inputs.

PDMP Parameters - Response

This profile tailors the Parameters resource to convey PDMP History operation outputs.

PDMP Patient

Defines constraints and extensions on the Patient resource when used by a Prescription Drug Monitoring Program (PDMP) to request or return an individual’s medication dispensation history.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

PDMP Extension - Activity Period

The date period (start/end) of the response returned by a Prescription Drug Monitoring Program (PDMP).

PDMP Extension - Header Timestamp

The date the request was sent to the PDMP Responder.

PDMP Extension - LME

LME - Lorazepam Milligram Equivalent. The lorazepam dose (mg) equivalent to the sedative dose of the prescription as dispensed.

PDMP Extension - MME

MME - Morphine Milligram Equivalent. The quantity of morphine (mg/day, except for fentanyl patchs use mcg/hr) equivalent to the daily opioid dose for the prescription as dispensed.

PDMP Extension - Method of Payment

A code representing the method of payment for the dispensation

PDMP Extension - Opioid Treatment Code

A code identifying the reason for an opioid prescription

PDMP Extension - Prescription Fill Number

The fill number of the prescription dispensed. The value representing a prescription’s initial fill is 1. The first refill is 2, etc.

PDMP Extension - Prescription Transmission Method

The method by which the prescription was trasmitted to the dispensing or administering party.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

PDMP Value Set - Method of Payment

This value set contains codes representing the method of payment for the dispensation

PDMP Value Set - Opioid Treatment Code

This value set contains codes the reason for the opioid treatment prescribed

PDMP Value Set - Patient Alert Category Code

A code identifying a kind of patient alert.

PDMP Value Set - Prescription Transmission Method

This value set contains codes for the methods by which a prescription was received by the dispensing or administering party.

PDMP Value Set - Response Status

This value set contains codes indicating the overall status of a PDMP response

PDMP Value Set - Species Type

This value set contains codes identifying the species type (human vs veterinary)

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

PDMP Response Status Codes (Temporary)

Codes indicating the overall status of a PDMP response. Intended to augment the PMIX Status Message code set

PMIX Method of Payment Code (Temporary)

A code identifying the method of payment

PMIX Opioid Treatment Code (Temporary)

A code identifying the reason for an opioid prescription

PMIX Patient Alert Category Code (Temporary)

A code identifying a kind of patient alert.

PMIX Response Status Codes (Temporary)

Code indicating the overall status of a PDMP response

PMIX Species Type Code (Temporary)

This code system defines codes identifying the species type of a patient (human vs veterinary)

PMIX Transmission Form Of Rx Origin Code (Temporary)

Code indicating how the pharmacy received the prescription

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

pdmp-bundle-history-result-1

Example of a Bundle resource used to transmit a patient’s PDMP history

pdmp-bundle-history-result-2

Example of a Bundle resource used to transmit a patient’s PDMP history, 2 dispenses, 2 patients, 2 pharmacies, 1 alert and from 2 different PDMPs

pdmp-bundle-request-message-1

Example of a PDMP request message

pdmp-bundle-response-message-1

Example of a PDMP response message

pdmp-history-input-parameters-1

Example of a Parameters resource used to request a patient’s PDMP history

pdmp-history-input-parameters-2-minimum

Example of the minimal Parameters resource population to request a patient’s PDMP history

pdmp-history-input-parameters-3-veterinary

Example of a PDMP operation request for an animal patient

pdmp-history-input-parameters-4-delegate

Example of a PDMP operation request submitted by a delegate

pdmp-history-output-parameters-1

Example of a Parameters resource used to respond to a request a patient’s PDMP history

pdmp-history-output-parameters-2-minimal-history

Example of minimal population of a Parameters resource used to respond when a patient has PDMP history

pdmp-history-output-parameters-3-patient-not-found

Example of population of the Parameters resource when the requested patient is not found and no PDMP history is returned

pdmp-history-output-parameters-4-link-response

Example of population of the Parameters resource when a link to the PDMP history is returned

pdmp-history-output-parameters-5-pre-stage-response

Example of population of the Parameters resource when pre-staging of PDMP history was requested

pdmp-history-output-parameters-6-non-fatal-warning

Example of population of the Parameters resource when a link to the PDMP history is returned with a warning

pdmp-history-output-parameters-7-fatal-error

Example of population of the Parameters resource when a fatal exception is encountered and processing doesn’t complete

pdmp-medadmin-1

Example of a PDMP medication administration

pdmp-meddispense-1

Example of a PDMP medication dispensation record with MME extension

pdmp-meddispense-2

Example of a PDMP medication dispensation record with LME extension

pdmp-patient-1

Example of a PDMP patient - as submitted in a request or returned in a response

pdmp-patient-2-veterinary

Example of a PDMP patient representing an animal

pdmp-patient-3

Example of a PDMP patient - similar to pdmp-patient-1, but may or may not be the same person

pdmp-pharmacy-1

Example of a PDMP dispensing pharmacy

relatedperson-2-veterinary

Example of the owner of an animal patient