Package | hl7.fhir.us.smp |
Type | CapabilityStatement |
Id | smp-server |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/smp/https://build.fhir.org/ig/HL7/smp-ig/CapabilityStatement-smp-server.html |
URL | http://hl7.org/fhir/us/smp/CapabilityStatement/smp-server |
Version | 1.0.0 |
Status | active |
Date | 2024-04-29T00:00:00-06:00 |
Name | SMP_Server |
Realm | us |
Authority | hl7 |
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. |
Kind | requirements |
No resources found
OperationDefinition | |
smp-operation-retrieve | SMP Operation Retrieve |
smp-operation-submit | SMP Operation Submit |
StructureDefinition | |
us-core-medicationrequest | US Core MedicationRequest Profile |
us-core-patient | US Core Patient Profile |
smp-bundle-transaction | Standardized Medication Profile - Bundle Medication List Maintenance |
smp-bundle | Standardized Medication Profile - Bundle Medication List |
smp-medication-list | Standardized Medication Profile - Medication List |
smp-medication | Standardized Medication Profile - Medication |
smp-medicationadministration | Standardized Medication Profile - MedicationAdministration |
smp-medicationstatement | Standardized Medication Profile - MedicationStatement |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement smp-server
json
, SHOULD support xml
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.
server
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
List | Supported Profiles Standardized Medication Profile - Medication List | y | y | y | patient, code | $smp-query , $smp-submit | |||
MedicationStatement | Supported Profiles Standardized Medication Profile - MedicationStatement | y | y | y | |||||
Medication | Supported Profiles Standardized Medication Profile - Medication | y | y | ||||||
MedicationRequest | Supported Profiles US Core MedicationRequest Profile | y | y | y | |||||
MedicationAdministration | Supported Profiles Standardized Medication Profile - MedicationAdministration | y | y | y | |||||
Patient | Supported Profiles US Core Patient Profile | y | |||||||
Bundle | Supported Profiles Standardized Medication Profile - Bundle Medication List Standardized Medication Profile - Bundle Medication List Maintenance | y | y |
read
Allows retrieval of medication list for the various point in time information.
update
Allows for the maintenance of the medication lists.
create
Allows for the creation of a medication list.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | Allows retrieving medication lists for the patient |
SHALL | code | token | Allows retrieving specific kinds of medication lists for the patient |
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 |
read
Allows retrieval of medication details.
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.)
read
Allows retrieval medication details
create
Allows for the creation of a medication.
read
Allows retrieval of .
create
Allows for the creation of a medication.
update
Allows for the maintenance of a MedicationRequest as required.
read
Allows retrieval medication details.
create
Allows for the creation of a medication.
update
Allows for the maintenance of a MedicationAdministration as required.
read
Required for identification and retrieval of patient medication information
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).
{ "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)." } ] } ] } ] }