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
Official URL: http://hl7.org/fhir/us/pdmp/OperationDefinition/pdmp-history | Version: 1.0.0-ballot | |||
Active as of 2024-04-01 | Computable Name: PdmpOperationGetPdmpHistory | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.35.33.1 |
Operation returning an individual patient’s PDMP history
Notes:
Examples:
An example of the Parameters resource submitted to this operation:
An example of the Parameters resource returned by this operation:
URL: [base]/$pdmp-history
Input parameters Profile:PDMP Parameters - Request
Output parameters Profile:PDMP Parameters - Response
Parameters
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | patient | 1..1 | Patient | The patient whose PDMP history is desired | ||
IN | animal-owner | 0..1 | RelatedPerson | If the patient is an animal, this parameter reflects its owner's information | ||
IN | authorized-practitioner | 1..1 | Practitioner | The Practitioner resource reflecting the provider who is authorized to view the returned PDMP information | ||
IN | authorized-practitioner-role | 1..1 | PractitionerRole | The PractitionerRole resource reflecting the authorized provider's practice information | ||
IN | authorized-practitioner-organization | 0..1 | Organization | An Organization resource reflecting the authorized provider's organization | ||
IN | delegate-practitioner | 0..1 | Practitioner | A Practitioner resource reflecting a provider who is requesting the PDMP information on behalf of another party | ||
IN | delegate-practitioner-role | 0..1 | PractitionerRole | A PractitionerRole resource reflecting the delegate's practice information | ||
IN | delegate-organization | 0..1 | Organization | An Organization resource reflecting the delegate's organization | ||
IN | pre-stage-only | 0..1 | boolean | Indicates that the PDMP Responder is expected to gather the requested information and stage it for future retrieval (via a subsequent invocation of this operation) | ||
IN | pre-stage-retrieval-key | 0..1 | string | The pre-stage-retrieval-key returned from a previous operation call in which the pre-stage-only parameter was set to true | ||
OUT | pdmp-history-data | 0..1 | Bundle | A Bundle of type 'collection' that contains medication dispensation and administration information for the requested patient (if found) | ||
OUT | pdmp-history-link | 0..1 | url | A URL to access an external report containing a PDMP history for the requested patient | ||
OUT | pre-stage-retrieval-key | 0..1 | string | This parameter is used only when responding to an invocation in which the pre-stage-only parameter was set to true. This element may be populated with a string value that the requester is to submit in the pre-stage-retrieval-key parameter of the subsequent invocation that retrieves the staged information | ||
OUT | outcome | 0..1 | OperationOutcome | An OperationOutcome resource containing processing information associated with the operation response, including error, warning and/or informational information |