US Prescription Drug Monitoring Program (PDMP)
1.0.0 - STU1 United States of America flag

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 in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: PDMP Operation PDMP History - TTL Representation

Active as of 2024-04-01

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

 a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "pdmp-history"] ; # 
  fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir: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>"
  ] ; # 
  fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
fhir:value [ fhir:v "phx" ]
  ] ) ; # 
  fhir:url [ fhir:v "http://hl7.org/fhir/us/pdmp/OperationDefinition/pdmp-history"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "1.0.0"] ; # 
  fhir:name [ fhir:v "PdmpOperationGetPdmpHistory"] ; # 
  fhir:title [ fhir:v "PDMP Operation PDMP History"] ; # 
  fhir:status [ fhir:v "active"] ; # 
  fhir:kind [ fhir:v "operation"] ; # 
  fhir:date [ fhir:v "2024-04-01T00:00:00-05:00"^^xsd:dateTime] ; # 
  fhir:publisher [ fhir:v "HL7 International / Pharmacy"] ; # 
  fhir:contact ( [
fhir:name [ fhir:v "HL7 International / Pharmacy" ] ;
    ( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/medication" ]     ] )
  ] [
fhir:name [ fhir:v "Frank McKinney" ] ;
    ( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "frank.mckinney@pocp.com" ]     ] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "fm@frankmckinney.com" ]     ] )
  ] [
fhir:name [ fhir:v "Scott Robertson" ] ;
    ( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "scott.robertson@pocp.com" ]     ] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "scott@BearHealthTech.consulting" ]     ] )
  ] ) ; # 
  fhir:description [ fhir:v "Operation returning an individual patient's PDMP history"] ; # 
  fhir:jurisdiction ( [
    ( fhir:coding [
fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
fhir:code [ fhir:v "US" ] ;
fhir:display [ fhir:v "United States of America" ]     ] )
  ] ) ; # 
  fhir:affectsState [ fhir:v "false"^^xsd:boolean] ; # 
  fhir:code [ fhir:v "pdmp-history"] ; # 
  fhir:system [ fhir:v "true"^^xsd:boolean] ; # 
  fhir:type [ fhir:v "false"^^xsd:boolean] ; # 
  fhir:instance [ fhir:v "false"^^xsd:boolean] ; # 
  fhir:inputProfile [
fhir:v "http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-parameters-request"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-parameters-request>
  ] ; # 
  fhir:outputProfile [
fhir:v "http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-parameters-response"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-parameters-response>
  ] ; # 
  fhir:parameter ( [
fhir:name [ fhir:v "patient" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The patient whose PDMP history is desired" ] ;
fhir:type [ fhir:v "Patient" ] ;
    ( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-patient"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-patient>     ] )
  ] [
fhir:name [ fhir:v "animal-owner" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "If the patient is an animal, this parameter reflects its owner's information" ] ;
fhir:type [ fhir:v "RelatedPerson" ] ;
    ( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson>     ] )
  ] [
fhir:name [ fhir:v "authorized-practitioner" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The Practitioner resource reflecting the provider who is authorized to view the returned PDMP information" ] ;
fhir:type [ fhir:v "Practitioner" ] ;
    ( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner>     ] )
  ] [
fhir:name [ fhir:v "authorized-practitioner-role" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The PractitionerRole resource reflecting the authorized provider's practice information" ] ;
fhir:type [ fhir:v "PractitionerRole" ] ;
    ( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole>     ] )
  ] [
fhir:name [ fhir:v "authorized-practitioner-organization" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "An Organization resource reflecting the authorized provider's organization" ] ;
fhir:type [ fhir:v "Organization" ] ;
    ( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization>     ] )
  ] [
fhir:name [ fhir:v "delegate-practitioner" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "A Practitioner resource reflecting a provider who is requesting the PDMP information on behalf of another party" ] ;
fhir:type [ fhir:v "Practitioner" ] ;
    ( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner>     ] )
  ] [
fhir:name [ fhir:v "delegate-practitioner-role" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "A PractitionerRole resource reflecting the delegate's practice information" ] ;
fhir:type [ fhir:v "PractitionerRole" ] ;
    ( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole>     ] )
  ] [
fhir:name [ fhir:v "delegate-organization" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "An Organization resource reflecting the delegate's organization" ] ;
fhir:type [ fhir:v "Organization" ] ;
    ( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization>     ] )
  ] [
fhir:name [ fhir:v "pre-stage-only" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "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)" ] ;
fhir:type [ fhir:v "boolean" ]
  ] [
fhir:name [ fhir:v "pre-stage-retrieval-key" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The pre-stage-retrieval-key returned from a previous operation call in which the pre-stage-only parameter was set to true" ] ;
fhir:type [ fhir:v "string" ]
  ] [
fhir:name [ fhir:v "pdmp-history-data" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "A Bundle of type 'collection' that contains medication dispensation and administration information for the requested patient (if found)" ] ;
fhir:type [ fhir:v "Bundle" ] ;
    ( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-bundle-history-result"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-bundle-history-result>     ] )
  ] [
fhir:name [ fhir:v "pdmp-history-link" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "A URL to access an external report containing a PDMP history for the requested patient" ] ;
fhir:type [ fhir:v "url" ]
  ] [
fhir:name [ fhir:v "pre-stage-retrieval-key" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "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" ] ;
fhir:type [ fhir:v "string" ]
  ] [
fhir:name [ fhir:v "outcome" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "An OperationOutcome resource containing processing information associated with the operation response, including error, warning and/or informational information" ] ;
fhir:type [ fhir:v "OperationOutcome" ]
  ] ) . #