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
Active as of 2024-04-01 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="pdmp-history"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition pdmp-history</b></p><a name="pdmp-history"> </a><a name="hcpdmp-history"> </a><a name="pdmp-history-en-US"> </a><p>URL: [base]/$pdmp-history</p><p>Input parameters Profile:<a href="StructureDefinition-pdmp-parameters-request.html">PDMP Parameters - Request</a></p><p>Output parameters Profile:<a href="StructureDefinition-pdmp-parameters-response.html">PDMP Parameters - Response</a></p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>patient</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/patient.html">Patient</a> (<a href="StructureDefinition-pdmp-patient.html" title="http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-patient">PDMP Patient</a>)</td><td/><td><div><p>The patient whose PDMP history is desired</p>
</div></td></tr><tr><td>IN</td><td>animal-owner</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/relatedperson.html">RelatedPerson</a> (<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-relatedperson.html" title="http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson">US Core RelatedPerson Profile</a>)</td><td/><td><div><p>If the patient is an animal, this parameter reflects its owner's information</p>
</div></td></tr><tr><td>IN</td><td>authorized-practitioner</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/practitioner.html">Practitioner</a> (<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-practitioner.html" title="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner">US Core Practitioner Profile</a>)</td><td/><td><div><p>The Practitioner resource reflecting the provider who is authorized to view the returned PDMP information</p>
</div></td></tr><tr><td>IN</td><td>authorized-practitioner-role</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/practitionerrole.html">PractitionerRole</a> (<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-practitionerrole.html" title="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole">US Core PractitionerRole Profile</a>)</td><td/><td><div><p>The PractitionerRole resource reflecting the authorized provider's practice information</p>
</div></td></tr><tr><td>IN</td><td>authorized-practitioner-organization</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/organization.html">Organization</a> (<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-organization.html" title="http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization">US Core Organization Profile</a>)</td><td/><td><div><p>An Organization resource reflecting the authorized provider's organization</p>
</div></td></tr><tr><td>IN</td><td>delegate-practitioner</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/practitioner.html">Practitioner</a> (<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-practitioner.html" title="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner">US Core Practitioner Profile</a>)</td><td/><td><div><p>A Practitioner resource reflecting a provider who is requesting the PDMP information on behalf of another party</p>
</div></td></tr><tr><td>IN</td><td>delegate-practitioner-role</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/practitionerrole.html">PractitionerRole</a> (<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-practitionerrole.html" title="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole">US Core PractitionerRole Profile</a>)</td><td/><td><div><p>A PractitionerRole resource reflecting the delegate's practice information</p>
</div></td></tr><tr><td>IN</td><td>delegate-organization</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/organization.html">Organization</a> (<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-organization.html" title="http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization">US Core Organization Profile</a>)</td><td/><td><div><p>An Organization resource reflecting the delegate's organization</p>
</div></td></tr><tr><td>IN</td><td>pre-stage-only</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>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)</p>
</div></td></tr><tr><td>IN</td><td>pre-stage-retrieval-key</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The pre-stage-retrieval-key returned from a previous operation call in which the pre-stage-only parameter was set to true</p>
</div></td></tr><tr><td>OUT</td><td>pdmp-history-data</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a> (<a href="StructureDefinition-pdmp-bundle-history-result.html" title="http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-bundle-history-result">PDMP Bundle - History Result</a>)</td><td/><td><div><p>A Bundle of type 'collection' that contains medication dispensation and administration information for the requested patient (if found)</p>
</div></td></tr><tr><td>OUT</td><td>pdmp-history-link</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#url">url</a></td><td/><td><div><p>A URL to access an external report containing a PDMP history for the requested patient</p>
</div></td></tr><tr><td>OUT</td><td>pre-stage-retrieval-key</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>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</p>
</div></td></tr><tr><td>OUT</td><td>outcome</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/operationoutcome.html">OperationOutcome</a></td><td/><td><div><p>An OperationOutcome resource containing processing information associated with the operation response, including error, warning and/or informational information</p>
</div></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="phx"/>
</extension>
<url value="http://hl7.org/fhir/us/pdmp/OperationDefinition/pdmp-history"/>
<version value="1.0.0"/>
<name value="PdmpOperationGetPdmpHistory"/>
<title value="PDMP Operation PDMP History"/>
<status value="active"/>
<kind value="operation"/>
<date value="2024-04-01T00:00:00-05:00"/>
<publisher value="HL7 International / Pharmacy"/>
<contact>
<name value="HL7 International / Pharmacy"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/medication"/>
</telecom>
</contact>
<contact>
<name value="Frank McKinney"/>
<telecom>
<system value="email"/>
<value value="frank.mckinney@pocp.com"/>
</telecom>
<telecom>
<system value="email"/>
<value value="fm@frankmckinney.com"/>
</telecom>
</contact>
<contact>
<name value="Scott Robertson"/>
<telecom>
<system value="email"/>
<value value="scott.robertson@pocp.com"/>
</telecom>
<telecom>
<system value="email"/>
<value value="scott@BearHealthTech.consulting"/>
</telecom>
</contact>
<description
value="Operation returning an individual patient's PDMP history"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<affectsState value="false"/>
<code value="pdmp-history"/>
<system value="true"/>
<type value="false"/>
<instance value="false"/>
<inputProfile
value="http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-parameters-request"/>
<outputProfile
value="http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-parameters-response"/>
<parameter>
<name value="patient"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="The patient whose PDMP history is desired"/>
<type value="Patient"/>
<targetProfile
value="http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-patient"/>
</parameter>
<parameter>
<name value="animal-owner"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="If the patient is an animal, this parameter reflects its owner's information"/>
<type value="RelatedPerson"/>
<targetProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson"/>
</parameter>
<parameter>
<name value="authorized-practitioner"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The Practitioner resource reflecting the provider who is authorized to view the returned PDMP information"/>
<type value="Practitioner"/>
<targetProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"/>
</parameter>
<parameter>
<name value="authorized-practitioner-role"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The PractitionerRole resource reflecting the authorized provider's practice information"/>
<type value="PractitionerRole"/>
<targetProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"/>
</parameter>
<parameter>
<name value="authorized-practitioner-organization"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="An Organization resource reflecting the authorized provider's organization"/>
<type value="Organization"/>
<targetProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"/>
</parameter>
<parameter>
<name value="delegate-practitioner"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="A Practitioner resource reflecting a provider who is requesting the PDMP information on behalf of another party"/>
<type value="Practitioner"/>
<targetProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"/>
</parameter>
<parameter>
<name value="delegate-practitioner-role"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="A PractitionerRole resource reflecting the delegate's practice information"/>
<type value="PractitionerRole"/>
<targetProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"/>
</parameter>
<parameter>
<name value="delegate-organization"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="An Organization resource reflecting the delegate's organization"/>
<type value="Organization"/>
<targetProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"/>
</parameter>
<parameter>
<name value="pre-stage-only"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="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)"/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="pre-stage-retrieval-key"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The pre-stage-retrieval-key returned from a previous operation call in which the pre-stage-only parameter was set to true"/>
<type value="string"/>
</parameter>
<parameter>
<name value="pdmp-history-data"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="A Bundle of type 'collection' that contains medication dispensation and administration information for the requested patient (if found)"/>
<type value="Bundle"/>
<targetProfile
value="http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-bundle-history-result"/>
</parameter>
<parameter>
<name value="pdmp-history-link"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="A URL to access an external report containing a PDMP history for the requested patient"/>
<type value="url"/>
</parameter>
<parameter>
<name value="pre-stage-retrieval-key"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="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"/>
<type value="string"/>
</parameter>
<parameter>
<name value="outcome"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="An OperationOutcome resource containing processing information associated with the operation response, including error, warning and/or informational information"/>
<type value="OperationOutcome"/>
</parameter>
</OperationDefinition>