US Prescription Drug Monitoring Program (PDMP)
1.0.0 - STU1
US Prescription Drug Monitoring Program (PDMP)
1.0.0 - STU1
This page is part of the US Prescription Drug Monitoring Program (PDMP) (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Active as of 2024-04-01 |
{
"resourceType" : "OperationDefinition",
"id" : "pdmp-history",
"text" : {
"status" : "generated",
"div" : "<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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "phx"
}
],
"url" : "http://hl7.org/fhir/us/pdmp/OperationDefinition/pdmp-history",
"version" : "1.0.0",
"name" : "PdmpOperationGetPdmpHistory",
"title" : "PDMP Operation PDMP History",
"status" : "active",
"kind" : "operation",
"date" : "2024-04-01T00:00:00-05:00",
"publisher" : "HL7 International / Pharmacy",
"contact" : [
{
"name" : "HL7 International / Pharmacy",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/medication"
}
]
},
{
"name" : "Frank McKinney",
"telecom" : [
{
"system" : "email",
"value" : "frank.mckinney@pocp.com"
},
{
"system" : "email",
"value" : "fm@frankmckinney.com"
}
]
},
{
"name" : "Scott Robertson",
"telecom" : [
{
"system" : "email",
"value" : "scott.robertson@pocp.com"
},
{
"system" : "email",
"value" : "scott@BearHealthTech.consulting"
}
]
}
],
"description" : "Operation returning an individual patient's PDMP history",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"affectsState" : false,
"code" : "pdmp-history",
"system" : true,
"type" : false,
"instance" : false,
"inputProfile" : "http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-parameters-request",
"outputProfile" : "http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-parameters-response",
"parameter" : [
{
"name" : "patient",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The patient whose PDMP history is desired",
"type" : "Patient",
"targetProfile" : [
🔗 "http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-patient"
]
},
{
"name" : "animal-owner",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "If the patient is an animal, this parameter reflects its owner's information",
"type" : "RelatedPerson",
"targetProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson"
]
},
{
"name" : "authorized-practitioner",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The Practitioner resource reflecting the provider who is authorized to view the returned PDMP information",
"type" : "Practitioner",
"targetProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
]
},
{
"name" : "authorized-practitioner-role",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The PractitionerRole resource reflecting the authorized provider's practice information",
"type" : "PractitionerRole",
"targetProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"
]
},
{
"name" : "authorized-practitioner-organization",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "An Organization resource reflecting the authorized provider's organization",
"type" : "Organization",
"targetProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
]
},
{
"name" : "delegate-practitioner",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A Practitioner resource reflecting a provider who is requesting the PDMP information on behalf of another party",
"type" : "Practitioner",
"targetProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
]
},
{
"name" : "delegate-practitioner-role",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A PractitionerRole resource reflecting the delegate's practice information",
"type" : "PractitionerRole",
"targetProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"
]
},
{
"name" : "delegate-organization",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "An Organization resource reflecting the delegate's organization",
"type" : "Organization",
"targetProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
]
},
{
"name" : "pre-stage-only",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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" : "boolean"
},
{
"name" : "pre-stage-retrieval-key",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The pre-stage-retrieval-key returned from a previous operation call in which the pre-stage-only parameter was set to true",
"type" : "string"
},
{
"name" : "pdmp-history-data",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "A Bundle of type 'collection' that contains medication dispensation and administration information for the requested patient (if found)",
"type" : "Bundle",
"targetProfile" : [
🔗 "http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-bundle-history-result"
]
},
{
"name" : "pdmp-history-link",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "A URL to access an external report containing a PDMP history for the requested patient",
"type" : "url"
},
{
"name" : "pre-stage-retrieval-key",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "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" : "string"
},
{
"name" : "outcome",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "An OperationOutcome resource containing processing information associated with the operation response, including error, warning and/or informational information",
"type" : "OperationOutcome"
}
]
}
IG © 2023+ HL7 International / Pharmacy. Package hl7.fhir.us.pdmp#1.0.0 based on FHIR 4.0.1. Generated 2024-10-15
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change