Standardized Medication Profile (SMP) FHIR IG
1.0.0 - STU 1
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
| Page standards status: Trial-use | Maturity Level: 1 |
{
"resourceType" : "CapabilityStatement",
"id" : "smp-server",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement smp-server</b></p><a name=\"smp-server\"> </a><a name=\"hcsmp-server\"> </a><h2 id=\"title\"/><ul><li>Implementation Guide Version: 1.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <strong>SHALL</strong> support <code>json</code>, <strong>SHOULD</strong> support <code>xml</code></li><li>Published on: 2024-04-29 00:00:00-0600 </li><li>Published by: HL7 International / Pharmacy </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"/></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#List1-1\">List</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-smp-medication-list.html\">Standardized Medication Profile - Medication List</a></td><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"/><td class=\"text-center\"><span title=\"SHOULD\">Y</span></td><td class=\"text-center\"><span title=\"SHOULD\">Y</span></td><td>patient, code</td><td/><td/><td><code>$smp-query</code>, <code>$smp-submit</code></td></tr><tr><td><a href=\"#MedicationStatement1-2\">MedicationStatement</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-smp-medicationstatement.html\">Standardized Medication Profile - MedicationStatement</a></td><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"/><td class=\"text-center\"><span title=\"SHOULD\">Y</span></td><td class=\"text-center\"><span title=\"SHOULD\">Y</span></td><td>patient, status</td><td/><td/><td/></tr><tr><td><a href=\"#Medication1-3\">Medication</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-smp-medication.html\">Standardized Medication Profile - Medication</a></td><td class=\"text-center\"><span title=\"SHOULD\">Y</span></td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"><span title=\"MAY\">y?</span></td><td/><td/><td/><td/></tr><tr><td><a href=\"#MedicationRequest1-4\">MedicationRequest</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"http://hl7.org/fhir/us/core/STU8/StructureDefinition-us-core-medicationrequest.html\">US Core MedicationRequest Profile</a></td><td class=\"text-center\"><span title=\"SHOULD\">Y</span></td><td class=\"text-center\"/><td class=\"text-center\"><span title=\"MAY\">y?</span></td><td class=\"text-center\"><span title=\"MAY\">y?</span></td><td>patient, intent, status</td><td/><td/><td/></tr><tr><td><a href=\"#MedicationAdministration1-5\">MedicationAdministration</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-smp-medicationadministration.html\">Standardized Medication Profile - MedicationAdministration</a></td><td class=\"text-center\"><span title=\"SHOULD\">Y</span></td><td class=\"text-center\"/><td class=\"text-center\"><span title=\"MAY\">y?</span></td><td class=\"text-center\"><span title=\"MAY\">y?</span></td><td>patient, status</td><td/><td/><td/></tr><tr><td><a href=\"#CarePlan1-6\">CarePlan</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-smp-medication-action-plan.html\">Standardized Medication Profile - Medication Action Plan</a></td><td class=\"text-center\"><span title=\"SHOULD\">Y</span></td><td class=\"text-center\"/><td class=\"text-center\"><span title=\"MAY\">y?</span></td><td class=\"text-center\"><span title=\"MAY\">y?</span></td><td>patient</td><td/><td/><td/></tr><tr><td><a href=\"#DetectedIssue1-7\">DetectedIssue</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-smp-medication-action-plan-detected-issue.html\">Standardized Medication Profile - Medication Action Plan Detected Issue</a></td><td class=\"text-center\"><span title=\"SHOULD\">Y</span></td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td>patient</td><td/><td/><td/></tr><tr><td><a href=\"#Patient1-8\">Patient</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"http://hl7.org/fhir/us/core/STU8/StructureDefinition-us-core-patient.html\">US Core Patient Profile</a></td><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td>_id</td><td/><td/><td/></tr><tr><td><a href=\"#Bundle1-9\">Bundle</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-smp-bundle.html\">Standardized Medication Profile - Bundle Medication List</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-smp-bundle-transaction.html\">Standardized Medication Profile - Bundle Medication List Maintenance</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-smp-medication-action-plan-bundle.html\">Standardized Medication Profile - Bundle Medication Action Plan</a></td><td class=\"text-center\"><span title=\"MAY\">y?</span></td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"List1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>List</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/list.html\">List</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows retrieval of medication list for the various point in time information.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>update</code><div><p>Allows for the maintenance of the medication lists.</p>\n</div><code>create</code><div><p>Allows for the creation of a medication list.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-smp-medication-list.html\">Standardized Medication Profile - Medication List</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/list.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows retrieving medication lists for the patient</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/list.html#search\">code</a></td><td><code>token</code></td><td><div><p>Allows retrieving specific kinds of medication lists</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>MAY</b></td><td><a href=\"OperationDefinition-smp-operation-retrieve.html\">$smp-query</a></td><td><div><p>Operation used to retrieve individual patient's medication history</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"OperationDefinition-smp-operation-submit.html\">$smp-submit</a></td><td><div><p>Operation used to submit individual patient's medication list for storage</p>\n</div></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationStatement1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>MedicationStatement</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/medicationstatement.html\">MedicationStatement</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows retrieval of medication details.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>update</code><div><p>Allows for the maintenance of the medication details.</p>\n</div><code>create</code><div><p>Allows for the creation of a medication details. (Mandatory if creation of Medication lists enabled.)</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-smp-medicationstatement.html\">Standardized Medication Profile - MedicationStatement</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationstatement.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows retrieving medication statements for a patient</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationstatement.html#search\">status</a></td><td><code>token</code></td><td><div><p>Allows filtering by medication statement status</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Medication1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Medication</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/medication.html\">Medication</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <br/><code>read</code><div><p>Allows retrieval medication details</p>\n</div></li><li><strong>MAY</strong> support <br/><code>create</code><div><p>Allows for the creation of a medication.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-smp-medication.html\">Standardized Medication Profile - Medication</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationRequest1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>MedicationRequest</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/medicationrequest.html\">MedicationRequest</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <br/><code>read</code><div><p>Allows retrieval of .</p>\n</div></li><li><strong>MAY</strong> support <br/><code>create</code><div><p>Allows for the creation of a medication.</p>\n</div><code>update</code><div><p>Allows for the maintenance of a MedicationRequest as required.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/core/STU8/StructureDefinition-us-core-medicationrequest.html\">US Core MedicationRequest Profile</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows retrieving medication requests for a patient</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">intent</a></td><td><code>token</code></td><td><div><p>Allows filtering by medication request intent</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">status</a></td><td><code>token</code></td><td><div><p>Allows filtering by medication request status</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationAdministration1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>MedicationAdministration</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/medicationadministration.html\">MedicationAdministration</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <br/><code>read</code><div><p>Allows retrieval medication details.</p>\n</div></li><li><strong>MAY</strong> support <br/><code>create</code><div><p>Allows for the creation of a medication.</p>\n</div><code>update</code><div><p>Allows for the maintenance of a MedicationAdministration as required.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-smp-medicationadministration.html\">Standardized Medication Profile - MedicationAdministration</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationadministration.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows retrieving medication administrations for a patient</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationadministration.html#search\">status</a></td><td><code>token</code></td><td><div><p>Allows filtering by medication administration status</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"CarePlan1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>CarePlan</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/careplan.html\">CarePlan</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <br/><code>read</code><div><p>Allows retrieval medication action plan details.</p>\n</div></li><li><strong>MAY</strong> support <br/><code>create</code><div><p>Allows for the creation of a medication action plan.</p>\n</div><code>update</code><div><p>Allows for the maintenance of a CarePlan as required.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-smp-medication-action-plan.html\">Standardized Medication Profile - Medication Action Plan</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/careplan.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows retrieving medication action plans for a patient</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DetectedIssue1-7\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>DetectedIssue</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/detectedissue.html\">DetectedIssue</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <br/><code>read</code><div><p>Allows retrieval medication action plan detected issue details.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-smp-medication-action-plan-detected-issue.html\">Standardized Medication Profile - Medication Action Plan Detected Issue</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/detectedissue.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows retrieving medication action plans for a patient</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-8\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Required for identification and retrieval of patient medication information</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/core/STU8/StructureDefinition-us-core-patient.html\">US Core Patient Profile</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieval of patient by id. Aligns with US Core requirement and FHIR base spec.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Bundle1-9\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: MAY </span>Bundle</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>MAY</strong> support <br/><code>read</code><div><p>Allows retrieval of collection-type medication list bundles from a repository. Does NOT apply to transaction bundles which are ephemeral. If the smp-query operation on List is implemented, this capability becomes mandatory.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-smp-bundle.html\">Standardized Medication Profile - Bundle Medication List</a><br/><a href=\"StructureDefinition-smp-bundle-transaction.html\">Standardized Medication Profile - Bundle Medication List Maintenance</a><br/><a href=\"StructureDefinition-smp-medication-action-plan-bundle.html\">Standardized Medication Profile - Bundle Medication Action Plan</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Supports three Bundle profiles: (1) Bundle Medication List profile (type=collection) for retrieving medication lists with supporting resources - supports read interaction; (2) Bundle Medication List Maintenance profile (type=transaction) for submitting create/update operations - transaction bundles are ephemeral processing instructions and are not stored as resources, so the read interaction does not apply to them; (3) Bundle Medication Action Plan (type=document) for submitting a medication action plan consisting of detected issues and an unstructured document attachment.</p>\n</div></blockquote></div></div></div></div></div></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/CapabilityStatement/smp-server",
"version" : "1.0.0",
"name" : "SMP_Server",
"status" : "active",
"date" : "2024-04-29T00:00:00-06: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" : "This resource defines the expected capabilities of the SMP Server actor when conforming to the SMP IG and It is expected that it will be used in conjunction with the US Core CapabilityStatement. Together they describe the complete list of actual profiles and RESTful operations supported by SMP servers. SMP Server requirements may also be impacted by the rules of local jurisdictions or other contextual requirements.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"_format" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"type" : "List",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/smp/StructureDefinition/smp-medication-list"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of medication list for the various point in time information."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows for the maintenance of the medication lists."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Allows for the creation of a medication list."
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/List-subject",
"type" : "reference",
"documentation" : "Allows retrieving medication lists for the patient"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Allows retrieving specific kinds of medication lists"
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "smp-query",
"definition" : "http://hl7.org/fhir/us/smp/OperationDefinition/smp-operation-retrieve",
"documentation" : "Operation used to retrieve individual patient's medication history"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "smp-submit",
"definition" : "http://hl7.org/fhir/us/smp/OperationDefinition/smp-operation-submit",
"documentation" : "Operation used to submit individual patient's medication list for storage"
}
]
},
{
"type" : "MedicationStatement",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/smp/StructureDefinition/smp-medicationstatement"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of medication details."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows for the maintenance of the medication details."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Allows for the creation of a medication details. (Mandatory if creation of Medication lists enabled.)"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows retrieving medication statements for a patient"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "Allows filtering by medication statement status"
}
]
},
{
"type" : "Medication",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/smp/StructureDefinition/smp-medication"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval medication details"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create",
"documentation" : "Allows for the creation of a medication."
}
]
},
{
"type" : "MedicationRequest",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval of ."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create",
"documentation" : "Allows for the creation of a medication."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update",
"documentation" : "Allows for the maintenance of a MedicationRequest as required."
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows retrieving medication requests for a patient"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "intent",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-intent",
"type" : "token",
"documentation" : "Allows filtering by medication request intent"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "Allows filtering by medication request status"
}
]
},
{
"type" : "MedicationAdministration",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/smp/StructureDefinition/smp-medicationadministration"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval medication details."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create",
"documentation" : "Allows for the creation of a medication."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update",
"documentation" : "Allows for the maintenance of a MedicationAdministration as required."
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows retrieving medication administrations for a patient"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "Allows filtering by medication administration status"
}
]
},
{
"type" : "CarePlan",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/smp/StructureDefinition/smp-medication-action-plan"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval medication action plan details."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create",
"documentation" : "Allows for the creation of a medication action plan."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update",
"documentation" : "Allows for the maintenance of a CarePlan as required."
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows retrieving medication action plans for a patient"
}
]
},
{
"type" : "DetectedIssue",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/smp/StructureDefinition/smp-medication-action-plan-detected-issue"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval medication action plan detected issue details."
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows retrieving medication action plans for a patient"
}
]
},
{
"type" : "Patient",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Required for identification and retrieval of patient medication information"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieval of patient by id. Aligns with US Core requirement and FHIR base spec."
}
]
},
{
"type" : "Bundle",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/smp/StructureDefinition/smp-bundle"🔗 ,
"http://hl7.org/fhir/us/smp/StructureDefinition/smp-bundle-transaction"🔗 ,
"http://hl7.org/fhir/us/smp/StructureDefinition/smp-medication-action-plan-bundle"
],
"documentation" : "Supports three Bundle profiles: (1) Bundle Medication List profile (type=collection) for retrieving medication lists with supporting resources - supports read interaction; (2) Bundle Medication List Maintenance profile (type=transaction) for submitting create/update operations - transaction bundles are ephemeral processing instructions and are not stored as resources, so the read interaction does not apply to them; (3) Bundle Medication Action Plan (type=document) for submitting a medication action plan consisting of detected issues and an unstructured document attachment.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "read",
"documentation" : "Allows retrieval of collection-type medication list bundles from a repository. Does NOT apply to transaction bundles which are ephemeral. If the smp-query operation on List is implemented, this capability becomes mandatory."
}
]
}
]
}
]
}
IG © 2023+ HL7 International / Pharmacy. Package hl7.fhir.us.smp#1.0.0 based on FHIR 4.0.1. Generated 2026-01-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change