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

FHIR IG Statistics: CapabilityStatement/smp-client

Packagehl7.fhir.us.smp
TypeCapabilityStatement
Idsmp-client
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/smp/https://build.fhir.org/ig/HL7/smp-ig/CapabilityStatement-smp-client.html
URLhttp://hl7.org/fhir/us/smp/CapabilityStatement/smp-client
Version1.0.0
Statusactive
Date2024-04-29T00:00:00-06:00
NameSMP_Client
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 clients. SMP Client 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

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-client

  • 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: client

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 TypeProfileRSUCSearches_include_revincludeOperations
ListSupported Profiles
  Standardized Medication Profile - Medication List		y
MedicationStatementSupported Profiles
  Standardized Medication Profile - MedicationStatement		y
MedicationSupported Profiles
  Standardized Medication Profile - Medication		y
MedicationRequestSupported Profiles
  US Core MedicationRequest Profile		y
MedicationAdministrationSupported Profiles
  Standardized Medication Profile - MedicationAdministration		y
PatientSupported Profiles
  US Core Patient Profile		y
BundleSupported Profiles
  Standardized Medication Profile - Bundle Medication List
  Standardized Medication Profile - Bundle Medication List Maintenance		y

Resource Conformance: SHALL List

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

    Allows retrieval medication details.

Supported Profiles

Standardized Medication Profile - Medication List

Resource Conformance: SHALL MedicationStatement

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

    Allows retrieval medication details.

Supported Profiles

Standardized Medication Profile - MedicationStatement

Resource Conformance: SHOULD Medication

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

    Allows retrieval medication details. (Support is mandatory if the system supports Medications)

Supported Profiles

Standardized Medication Profile - Medication

Resource Conformance: SHOULD MedicationRequest

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

    Allows retrieval . (Support is mandatory if the system supports MedicationRequests)

Supported Profiles

US Core MedicationRequest Profile

Resource Conformance: SHOULD MedicationAdministration

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

    Allows retrieval medication details. (Support is mandatory if the system supports MedicationAdministrations)

Supported Profiles

Standardized Medication Profile - MedicationAdministration

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 and submission of new medication list to a repository.

Supported Profiles

Standardized Medication Profile - Bundle Medication List
Standardized Medication Profile - Bundle Medication List Maintenance

Source

{
  "resourceType": "CapabilityStatement",
  "id": "smp-client",
  "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-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."
            }
          ]
        }
      ]
    }
  ]
}