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