FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/smp-server

Packagehl7.fhir.us.smp
TypeCapabilityStatement
Idsmp-server
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/smp/https://build.fhir.org/ig/HL7/smp-ig/CapabilityStatement-smp-server.html
URLhttp://hl7.org/fhir/us/smp/CapabilityStatement/smp-server
Version1.0.0
Statusactive
Date2024-04-29T00:00:00-06:00
NameSMP_Server
Realmus
Authorityhl7
DescriptionThis 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.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

OperationDefinition
smp-operation-retrieveSMP Operation Retrieve
smp-operation-submitSMP Operation Submit
StructureDefinition
us-core-medicationrequestUS Core MedicationRequest Profile
us-core-patientUS Core Patient Profile
smp-bundle-transactionStandardized Medication Profile - Bundle Medication List Maintenance
smp-bundleStandardized Medication Profile - Bundle Medication List
smp-medication-listStandardized Medication Profile - Medication List
smp-medicationStandardized Medication Profile - Medication
smp-medicationadministrationStandardized Medication Profile - MedicationAdministration
smp-medicationstatementStandardized Medication Profile - MedicationStatement

Narrative

Note: links and images are rebased to the (stated) source

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


Source

{
  "resourceType": "CapabilityStatement",
  "id": "smp-server",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "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": "SHALL"
                }
              ],
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type": "token",
              "documentation": "Allows retrieving specific kinds of medication lists for the patient"
            }
          ],
          "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.)"
            }
          ]
        },
        {
          "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."
            }
          ]
        },
        {
          "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."
            }
          ]
        },
        {
          "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 of a medication list from a repository (if the smp-query operation on List is implemented, the Bundle Medication List profile becomes mandatory)."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "create",
              "documentation": "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)."
            }
          ]
        }
      ]
    }
  ]
}