$pdmp-history

PDMP Operation PDMP History

activePDMP1.0.0operation10 inputs4 outputs

Operation returning an individual patient's PDMP history

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/us/pdmp/OperationDefinition/pdmp-history
Code
$pdmp-history
Kind
operation
Affects State
No
Publisher
HL7 International / Pharmacy

Invocation Context

Can be invoked at:
System Level
Affects State:No

Input Parameters (10)

NameTypeCard.Description
patient*Patient1..1The patient whose PDMP history is desired
animal-ownerRelatedPerson0..1If the patient is an animal, this parameter reflects its owner's information
authorized-practitioner*Practitioner1..1The Practitioner resource reflecting the provider who is authorized to view the returned PDMP information
authorized-practitioner-role*PractitionerRole1..1The PractitionerRole resource reflecting the authorized provider's practice information
authorized-practitioner-organizationOrganization0..1An Organization resource reflecting the authorized provider's organization
delegate-practitionerPractitioner0..1A Practitioner resource reflecting a provider who is requesting the PDMP information on behalf of another party
delegate-practitioner-rolePractitionerRole0..1A PractitionerRole resource reflecting the delegate's practice information
delegate-organizationOrganization0..1An Organization resource reflecting the delegate's organization
pre-stage-onlyboolean0..1Indicates that the PDMP Responder is expected to gather the requested information and stage it for future retrieval (via a subsequent invocation of this operation)
pre-stage-retrieval-keystring0..1The pre-stage-retrieval-key returned from a previous operation call in which the pre-stage-only parameter was set to true

Output Parameters (4)

NameTypeCard.Description
pdmp-history-dataBundle0..1A Bundle of type 'collection' that contains medication dispensation and administration information for the requested patient (if found)
pdmp-history-linkurl0..1A URL to access an external report containing a PDMP history for the requested patient
pre-stage-retrieval-keystring0..1This 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
outcomeOperationOutcome0..1An OperationOutcome resource containing processing information associated with the operation response, including error, warning and/or informational information

Additional Information

Version
1.0.0
Date
2024-04-01T00:00:00-05:00