This page is part of the US Standardized Medication Profile (SMP) (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

• Narrative Content
• XML
• JSON
• TTL

: SMP Operation Retrieve - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "smp-operation-retrieve",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition smp-operation-retrieve</b></p><a name=\"smp-operation-retrieve\"> </a><a name=\"hcsmp-operation-retrieve\"> </a><a name=\"smp-operation-retrieve-en-US\"> </a><p>URL: [base]/$smp-query</p><p>Input parameters Profile:<a href=\"StructureDefinition-smp-parameters-query.html\">SMP Parameters - Query</a></p><p>Output parameters Profile:<a href=\"StructureDefinition-smp-parameters-response.html\">SMP 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=\"http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html\" title=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient\">US Core Patient Profile</a>)</td><td/><td><div><p>The patient whose medication history is desired</p>\n</div></td></tr><tr><td>IN</td><td>list-type</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td/><td><div><p>Optional parameter to define the type of medication list to be retrieved</p>\n</div></td></tr><tr><td>OUT</td><td>smp-medication-data</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a> (<a href=\"StructureDefinition-smp-bundle.html\" title=\"http://hl7.org/fhir/us/smp/StructureDefinition/smp-bundle\">Standardized Medication Profile - Bundle Medication List</a>)</td><td/><td><div><p>A Bundle of type 'collection' that contains medication  information for the requested patient (if found)</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/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 1,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/smp/ImplementationGuide/hl7.fhir.us.smp"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/smp/ImplementationGuide/hl7.fhir.us.smp"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/smp/OperationDefinition/smp-operation-retrieve",
  "version" : "1.0.0",
  "name" : "SMPOperationRetrieve",
  "title" : "SMP Operation Retrieve",
  "status" : "active",
  "kind" : "operation",
  "date" : "2025-01-07T00:00:00-05:00",
  "publisher" : "HL7 International / Pharmacy",
  "contact" : [
    {
      "name" : "HL7 International / Pharmacy",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/medication"
        },
        {
          "system" : "email",
          "value" : "pharmacylists@lists.hl7.org"
        }
      ]
    },
    {
      "name" : "Andy Stechishin",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:andy.stechishin@gmail.com"
        }
      ]
    }
  ],
  "description" : "Optional operation to request an individual patient's medication history",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "smp-query",
  "system" : true,
  "type" : false,
  "instance" : false,
  "inputProfile" : "http://hl7.org/fhir/us/smp/StructureDefinition/smp-parameters-query",
  "outputProfile" : "http://hl7.org/fhir/us/smp/StructureDefinition/smp-parameters-response",
  "parameter" : [
    {
      "name" : "patient",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The patient whose medication history is desired",
      "type" : "Patient",
      "targetProfile" : [
        🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
      ]
    },
    {
      "name" : "list-type",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Optional parameter to define the type of medication list to be retrieved",
      "type" : "CodeableConcept"
    },
    {
      "name" : "smp-medication-data",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "A Bundle of type 'collection' that contains medication  information for the requested patient (if found)",
      "type" : "Bundle",
      "targetProfile" : [
        🔗 "http://hl7.org/fhir/us/smp/StructureDefinition/smp-bundle"
      ]
    },
    {
      "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"
    }
  ]
}