FHIR IG Statistics: OperationDefinition/pdmp-history

Resources that use this resource

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType": "OperationDefinition",
  "id": "pdmp-history",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "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"
    }
  ]
}