Standardized Medication Profile (SMP) FHIR IG
1.0.0 - STU 1
Standardized Medication Profile (SMP) FHIR IG
1.0.0 - STU 1
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
| Page standards status: Trial-use | Maturity Level: 1 |
{
"resourceType" : "CapabilityStatement",
"id" : "smp-client",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement smp-client</b></p><a name=\"smp-client\"> </a><a name=\"hcsmp-client\"> </a><a name=\"smp-client-en-US\"> </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>Supported Patch Formats: </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>client</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></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\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><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\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></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\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><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/STU6.1/StructureDefinition-us-core-medicationrequest.html\">US Core MedicationRequest Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></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\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Patient1-6\">Patient</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html\">US Core Patient Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Bundle1-7\">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></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></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 medication 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-list.html\">Standardized Medication Profile - Medication List</a></p></div></div><p/></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 medication 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-medicationstatement.html\">Standardized Medication Profile - MedicationStatement</a></p></div></div><p/></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. (Support is mandatory if the system supports Medications)</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: SHOULD </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 . (Support is mandatory if the system supports MedicationRequests)</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/STU6.1/StructureDefinition-us-core-medicationrequest.html\">US Core MedicationRequest Profile</a></p></div></div><p/></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: SHOULD </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. (Support is mandatory if the system supports MedicationAdministrations)</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></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-6\" 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/STU6.1/StructureDefinition-us-core-patient.html\">US Core Patient Profile</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Bundle1-7\" 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 using extended bundles and submission of new medication list to a repository.</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></p></div></div><p/></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-client",
"version" : "1.0.0",
"name" : "SMP_Client",
"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 clients. SMP Client 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" : "client",
"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 medication details."
}
]
},
{
"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 medication details."
}
]
},
{
"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. (Support is mandatory if the system supports Medications)"
}
]
},
{
"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 . (Support is mandatory if the system supports MedicationRequests)"
}
]
},
{
"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. (Support is mandatory if the system supports MedicationAdministrations)"
}
]
},
{
"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"
}
]
},
{
"type" : "Bundle",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/smp/StructureDefinition/smp-bundle"🔗 ,
"http://hl7.org/fhir/us/smp/StructureDefinition/smp-bundle-transaction"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "read",
"documentation" : "Allows retrieval using extended bundles and submission of new medication list to a repository."
}
]
}
]
}
]
}
IG © 2023+ HL7 International / Pharmacy. Package hl7.fhir.us.smp#1.0.0 based on FHIR 4.0.1. Generated 2025-05-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change