US Prescription Drug Monitoring Program (PDMP)
1.0.0 - STU1 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 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

Example Bundle: pdmp-bundle-response-message-1

Example data content

expand all | contract allBundle
id@value:  pdmp-bundle-response-message-1
metaprofile@value:  http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-bundle-response-message
type@value:  message
timestamp@value:  2020-03-11T08:10:17-05:00entry[1]fullUrl@value:  urn:uuid:b5000d0c-fed9-4746-ac26-b5ce0111a2b7
resourceMessageHeader
id@value:  b5000d0c-fed9-4746-ac26-b5ce0111a2b7
metaprofile@value:  http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-messageheader-response
textstatus@value:  generatedEvent = the canonical URL for the pdmp-history operation. Focus is the Parameters resource holding response content.
eventCodingsystem@value:  urn:ietf:rfc:3986code@value:  http://hl7.org/fhir/us/pdmp/OperationDefinition/pdmp-historydisplay@value:  pdmp-history
sourcename@value:  MyPDMPServerendpoint@value:  https://pdmp1.testpdmp.org/
responseidentifier@value:  messageheader-req-op-1code@value:  ok
focusreference@value:  urn:uuid:aecbb129-9a73-4b59-9d66-ff5cdb3f3164
entry[2]fullUrl@value:  urn:uuid:aecbb129-9a73-4b59-9d66-ff5cdb3f3164
resourceParameters
id@value:  aecbb129-9a73-4b59-9d66-ff5cdb3f3164
metaprofile@value:  http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-parameters-response
parameterextension[1]@url:  http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-header-timestamp-extensionvalueDateTime@value:  2023-12-01
extension[2]@url:  http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-activity-period-extensionvaluePeriodstart@value:  2021-12-02end@value:  2023-12-01name@value:  pdmp-history-data
resourceBundleid@value:  bundle-history-data-in-msg-1metaprofile@value:  http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-bundle-history-resulttype@value:  collectionentry[1]@id:  meddispense-res-1fullUrl@value:  urn:uuid:9ce2a97b-5cab-4986-814f-4734016e6084
resourceMedicationDispense
metasource@value:  http://example.org/ma-pdmpprofile@value:  http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-medicationdispense
textstatus@value:  generatedA record of a medication that was dispensed to the patient identified in the PDMP request: August Samuels
extension@url:  http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-extension-rx-fill-numbervaluePositiveInt@value:  1
status@value:  completed
medicationCodeableConceptcoding[1]system@value:  http://www.nlm.nih.gov/research/umls/rxnormcode@value:  993781display@value:  acetaminophen 300 MG / codeine phosphate 30 MG Oral TabletuserSelected@value:  true
coding[2]system@value:  http://hl7.org/fhir/sid/ndccode@value:  00093015001text@value:  Acetaminophen 300 mg / Codeine 30 mg oral tablet
subjectreference@value:  urn:uuid:53a1e123-5b56-44ae-b7e8-36e0b9800f57display@value:  August Samuels
performeractorreference@value:  urn:uuid:82ae67e4-f23a-4c17-b80a-9076a37f5d6eidentifiersystem@value:  http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumbervalue@value:  999017
display@value:  Our Pharmacy
authorizingPrescriptionidentifiertypecodingsystem@value:  http://terminology.hl7.org/CodeSystem/v2-0203code@value:  FILLdisplay@value:  Filler Identifier
system@value:  http://mypharmacysystem.com/prescriptionnumbervalue@value:  065046045550
quantityvalue@value:  10unit@value:  each
daysSupplyvalue@value:  5
whenPrepared@value:  2023-06-05
whenHandedOverextension@url:  http://hl7.org/fhir/StructureDefinition/data-absent-reasonvalueCode@value:  unknown
dosageInstructionsequence@value:  1text@value:  1 tab tid prn pain
entry[2]fullUrl@value:  urn:uuid:53a1e123-5b56-44ae-b7e8-36e0b9800f57
resourcePatient
id@value:  patient-res-1-1
metasource@value:  http://example.org/ma-pdmpprofile@value:  http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
textstatus@value:  generatedThe PDMP Responder's patient record for the patient identified in the PDMP request: August Samuels
identifiertypecodingsystem@value:  http://terminology.hl7.org/CodeSystem/v2-0203code@value:  SS
system@value:  http://hl7.org/fhir/sid/us-ssnvalue@value:  120-35-2435
namefamily@value:  Samuelsgiven@value:  John
gender@value:  male
birthDate@value:  1989-03-12
addressline@value:  202 2nd Avenuecity@value:  North Amherststate@value:  MApostalCode@value:  01059
entry[3]fullUrl@value:  urn:uuid:82ae67e4-f23a-4c17-b80a-9076a37f5d6e
resourceOrganization
id@value:  pharmacy-res-1-1
metasource@value:  http://example.org/ma-pdmpprofile@value:  http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-organization-pharmacy
textstatus@value:  generatedThe pharmacy that dispensed the reported medication: Our Pharmacyidentifier[1]system@value:  http://hl7.org/fhir/sid/us-npivalue@value:  1669512349
identifier[2]system@value:  http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumbervalue@value:  999017active@value:  true
name@value:  Our Pharmacytelecom[1]system@value:  phonevalue@value:  952-555-5555
telecom[2]system@value:  emailvalue@value:  contact-our-pharmacy@email.orgaddressline@value:  220 Oak Stcity@value:  Minneapolisstate@value:  MNpostalCode@value:  55008country@value:  USA

</div>

Generated Narrative: Bundle pdmp-bundle-response-message-1

Bundle pdmp-bundle-response-message-1 of type message

Entry 1 - fullUrl = urn:uuid:b5000d0c-fed9-4746-ac26-b5ce0111a2b7

Resource MessageHeader:

Event = the canonical URL for the pdmp-history operation. Focus is the Parameters resource holding response content.

Entry 2 - fullUrl = urn:uuid:aecbb129-9a73-4b59-9d66-ff5cdb3f3164

Resource Parameters:

Generated Narrative: Parameters aecbb129-9a73-4b59-9d66-ff5cdb3f3164

Parameters

pdmp-history-data

Bundle/bundle-history-data-in-msg-1

Generated Narrative: Bundle bundle-history-data-in-msg-1

Bundle bundle-history-data-in-msg-1 of type collection

Entry 1 - fullUrl = urn:uuid:9ce2a97b-5cab-4986-814f-4734016e6084

Resource MedicationDispense:

A record of a medication that was dispensed to the patient identified in the PDMP request: August Samuels

Entry 2 - fullUrl = urn:uuid:53a1e123-5b56-44ae-b7e8-36e0b9800f57

Resource Patient:

The PDMP Responder's patient record for the patient identified in the PDMP request: August Samuels

Entry 3 - fullUrl = urn:uuid:82ae67e4-f23a-4c17-b80a-9076a37f5d6e

Resource Organization:

The pharmacy that dispensed the reported medication: Our Pharmacy