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
| Official URL: http://hl7.org/fhir/us/smp/CapabilityStatement/smp-server | Version: 1.0.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: SMP_Server | ||
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.
Raw OpenAPI-Swagger Definition file | Download
json, SHOULD support xmlNote to Implementers: FHIR Capabilities
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.
serverThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revincludereadAllows retrieval of medication list for the various point in time information.
updateAllows for the maintenance of the medication lists.
createAllows for the creation of a medication list.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Allows retrieving medication lists for the patient |
| SHOULD | code | token | Allows retrieving specific kinds of medication lists |
| Conformance | Operation | Documentation |
|---|---|---|
| MAY | $smp-query | Operation used to retrieve individual patient's medication history |
| MAY | $smp-submit | Operation used to submit individual patient's medication list for storage |
readAllows retrieval of medication details.
updateAllows for the maintenance of the medication details.
createAllows for the creation of a medication details. (Mandatory if creation of Medication lists enabled.)
readAllows retrieval medication details
createAllows for the creation of a medication.
readAllows retrieval of .
createAllows for the creation of a medication.
updateAllows for the maintenance of a MedicationRequest as required.
readAllows retrieval medication details.
createAllows for the creation of a medication.
updateAllows for the maintenance of a MedicationAdministration as required.
readAllows retrieval medication action plan details.
createAllows for the creation of a medication action plan.
updateAllows for the maintenance of a CarePlan as required.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Allows retrieving medication action plans for a patient |
readAllows retrieval medication action plan detected issue details.
Standardized Medication Profile - Medication Action Plan Detected Issue
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Allows retrieving medication action plans for a patient |
readRequired for identification and retrieval of patient medication information
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieval of patient by id. Aligns with US Core requirement and FHIR base spec. |
readAllows 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.
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.
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