Standardized Medication Profile (SMP) FHIR IG
1.0.0 - STU 1 United States of America flag

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

CapabilityStatement: smp-server

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

Generated Narrative: CapabilityStatement smp-server

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support json, SHOULD support xml
  • Supported Patch Formats:
  • Published on: 2024-04-29 00:00:00-0600
  • Published by: HL7 International / Pharmacy

Note 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.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)

Resource Conformance: SHALL List

Core FHIR Resource
List
Reference Policy
Interaction summary
  • SHALL support
    read

    Allows retrieval of medication list for the various point in time information.

  • SHOULD support
    update

    Allows for the maintenance of the medication lists.

    create

    Allows for the creation of a medication list.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Allows retrieving medication lists for the patient

SHALLcodetoken

Allows retrieving specific kinds of medication lists for the patient

 
Extended Operations
ConformanceOperationDocumentation
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

Resource Conformance: SHALL MedicationStatement

Core FHIR Resource
MedicationStatement
Reference Policy
Interaction summary
  • SHALL support
    read

    Allows retrieval of medication details.

  • SHOULD support
    update

    Allows for the maintenance of the medication details.

    create

    Allows for the creation of a medication details. (Mandatory if creation of Medication lists enabled.)

Resource Conformance: SHOULD Medication

Core FHIR Resource
Medication
Reference Policy
Interaction summary
  • SHOULD support
    read

    Allows retrieval medication details

  • MAY support
    create

    Allows for the creation of a medication.

Resource Conformance: SHOULD MedicationRequest

Core FHIR Resource
MedicationRequest
Reference Policy
Interaction summary
  • SHOULD support
    read

    Allows retrieval of .

  • MAY support
    create

    Allows for the creation of a medication.

    update

    Allows for the maintenance of a MedicationRequest as required.

Resource Conformance: SHOULD MedicationAdministration

Core FHIR Resource
MedicationAdministration
Reference Policy
Interaction summary
  • SHOULD support
    read

    Allows retrieval medication details.

  • MAY support
    create

    Allows for the creation of a medication.

    update

    Allows for the maintenance of a MedicationAdministration as required.

Resource Conformance: SHALL Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • SHALL support
    read

    Required for identification and retrieval of patient medication information

Supported Profiles

US Core Patient Profile

Resource Conformance: MAY Bundle

Core FHIR Resource
Bundle
Reference Policy
Interaction summary
  • MAY support
    read

    Allows retrieval using extended bundles of a medication list from a repository (if the smp-query operation on List is implemented, the Bundle Medication List profile becomes mandatory).

    create

    Allows submission of new medication list to a repository (if the smp-submit operation on List is implemented, the Bundle Medication List Maintenance profile becomes mandatory).