Standardized Medication Profile (SMP) FHIR IG
1.0.0 - STU 1

Standardized Medication Profile (SMP) FHIR IG, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/smp-ig/ and changes regularly. See the Directory of published versions

## : SMP Operation Retrieve - XML Representation

Page standards status: Trial-use | Maturity Level: 1

Raw xml | Download

    <OperationDefinition xmlns="http://hl7.org/fhir">
      <id value="smp-operation-retrieve"/>
      <text>
        <status value="generated"/>
        <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>
    </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>
    </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>
    </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>
    </div></td></tr></table></div>
      </text>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="phx"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="1">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
            <valueCanonical
                            value="http://hl7.org/fhir/us/smp/ImplementationGuide/hl7.fhir.us.smp"/>
          </extension>
        </valueInteger>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
            <valueCanonical
                            value="http://hl7.org/fhir/us/smp/ImplementationGuide/hl7.fhir.us.smp"/>
          </extension>
        </valueCode>
      </extension>
      <url
           value="http://hl7.org/fhir/us/smp/OperationDefinition/smp-operation-retrieve"/>
      <version value="1.0.0"/>
      <name value="SMPOperationRetrieve"/>
      <title value="SMP Operation Retrieve"/>
      <status value="active"/>
      <kind value="operation"/>
      <date value="2025-01-07T00:00:00-05:00"/>
      <publisher value="HL7 International / Pharmacy"/>
      <contact>
        <name value="HL7 International / Pharmacy"/>
        <telecom>
          <system value="url"/>
          <value value="http://www.hl7.org/Special/committees/medication"/>
        </telecom>
        <telecom>
          <system value="email"/>
          <value value="pharmacylists@lists.hl7.org"/>
        </telecom>
      </contact>
      <contact>
        <name value="Andy Stechishin"/>
        <telecom>
          <system value="email"/>
          <value value="mailto:andy.stechishin@gmail.com"/>
        </telecom>
      </contact>
      <description
                   value="Optional operation to request an individual patient's medication history"/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="US"/>
          <display value="United States of America"/>
        </coding>
      </jurisdiction>
      <affectsState value="false"/>
      <code value="smp-query"/>
      <system value="true"/>
      <type value="false"/>
      <instance value="false"/>
      <inputProfile
                    value="http://hl7.org/fhir/us/smp/StructureDefinition/smp-parameters-query"/>
      <outputProfile
                     value="http://hl7.org/fhir/us/smp/StructureDefinition/smp-parameters-response"/>
      <parameter>
        <name value="patient"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="The patient whose medication history is desired"/>
        <type value="Patient"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/>
      </parameter>
      <parameter>
        <name value="list-type"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="Optional parameter to define the type of medication list to be retrieved"/>
        <type value="CodeableConcept"/>
      </parameter>
      <parameter>
        <name value="smp-medication-data"/>
        <use value="out"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="A Bundle of type 'collection' that contains medication  information for the requested patient (if found)"/>
        <type value="Bundle"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/smp/StructureDefinition/smp-bundle"/>
      </parameter>
      <parameter>
        <name value="outcome"/>
        <use value="out"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="An OperationOutcome resource containing processing information associated with the operation response, including error, warning and/or informational information"/>
        <type value="OperationOutcome"/>
      </parameter>
    </OperationDefinition>