Package | ihe.iti.dsubm |
Type | CapabilityStatement |
Id | IHE.DSUBm.ResourceNotificationSubscriber.Folder.Upd |
FHIR Version | R4 |
Source | https://profiles.ihe.net/ITI/DSUBm/https://build.fhir.org/ig/IHE/ITI.DSUBm/CapabilityStatement-IHE.DSUBm.ResourceNotificationSubscriber.Folder.Upd.html |
URL | https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationSubscriber.Folder.Upd |
Version | 1.0.1-current |
Status | active |
Date | 2023-10-27 |
Name | IHE_DSUBm_ResourceNotificationSubscriber_Folder_Upd |
Title | IHE DSUBm ResourceNotificationSubscriber Folder Upd |
Realm | uv |
Authority | ihe |
Description | The DSUBm Resource Notification Subscriber Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing DocumentReference Subscription for Update Option. - Using FHIR R4 - SHALL support both json and xml encoding - SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/) - SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic - SHALL be able to support the Subscription defined in Section [2:3.110.4.1.2.1.5 Subscription with Folder Subscription for Update option](ITI-110.html#2311041215-subscription-with-folder-subscription-for-update-option), and the related SubscriptionTopic - SHOULD implement the ITI-113 transaction; if implemented: - [Search Parameters that SHOULD be supported](ITI-113.html#23113412-message-semantics) - _id - status - url - filter-criteria - topic - SHOULD support the DSUBm $status operation - SHOULD support the DSUBm $events operation - SHOULD implement the ITI-114 transaction; if implemented: - [Search Parameters that SHALL be supported](ITI-114.html#23114412-message-semantics) - code - [Search Parameters that SHOULD be supported](ITI-114.html#23114412-message-semantics) - _id - resource - derived-or-self - status - url |
Kind | requirements |
No resources found
OperationDefinition | |
backport-subscription-events | Subscription Events Operation |
backport-subscription-status | Subscription Status Operation |
backport-subscription-events | R5SubscriptionEvents |
backport-subscription-status | R5SubscriptionStatus |
SearchParameter | |
Subscription-filter-criteria | SubscriptionFilterCriteriaSearchParameter |
Subscription-topic | SubscriptionTopicSearchParameter |
Subscription-filter-criteria | SubscriptionFilterCriteriaSearchParameter |
Subscription-topic | SubscriptionTopicSearchParameter |
StructureDefinition | |
DSUBm-DocumentReference-MultiPatient-Subscription | Subscription for DocumentReference Multi-Patient |
DSUBm-DocumentReference-PatientDependent-Subscription | Subscription for DocumentReference Patient-Dependent |
DSUBm-Folder-Subscription-UpdateOpt | Subscription for Folder Patient-Dependent with Folder Subscription for Update Option |
DSUBm-SubmissionSet-MultiPatient-Subscription | Subscription for SubmissionSet Multi-Patient |
DSUBm-SubmissionSet-PatientDependent-Subscription | Subscription for SubmissionSet Patient-Dependent |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement IHE.DSUBm.ResourceNotificationSubscriber.Folder.Upd
application/fhir+xml
, application/fhir+json
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.
client
DSUBm Resource Notification subscriber provides capability to create/deactivate subscription and optionally to search for Subscription and SubscritptionTopic resources
Recommend ATNA, encouraged IHE-IUA or SMART-app-launch
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 |
---|---|---|---|---|---|---|---|---|---|
Subscription | Supported Profiles Subscription for DocumentReference Patient-Dependent Subscription for DocumentReference Multi-Patient Subscription for SubmissionSet Patient-Dependent Subscription for SubmissionSet Multi-Patient Subscription for Folder Patient-Dependent with Folder Subscription for Update Option | y | y | y | y | _id, status, url, filter-criteria, topic | $events , $status | ||
Basic | y | y | code, _id, resource, derived-or-self, status, url |
read
, create
, update
, search-type
.Resource Subscription [ITI-110] and Resource Subscription Search [ITI-113]
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | string | The id of the Subscription |
SHALL | status | token | The current state of the subscription |
SHALL | url | uri | The URI that will receive the notifications |
SHALL | filter-criteria | string | This SearchParameter enables query of subscriptions by filter criteria |
SHALL | topic | uri | This SearchParameter enables query of subscriptions by canonical topic-url |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $events | This operation is OPTIONAL for the RESOURCE NOTIFICATION SUBSCRIBER; if supported, the Resource Notification Subscriber SHALL support in response a Bundle that is conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-EventsOperation-Bundle |
SHALL | $status | This operation is OPTIONAL for the RESOURCE NOTIFICATION SUBSCRIBER; if supported, the Resource Notification Subscriber SHALL support in response a Bundle that is conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-StatusOperation-Bundle |
Resource SubscriptionTopic Search [ITI-114]
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | code | token | Kind of Resource |
SHOULD | _id | string | The id of the SubscriptionTopic |
SHOULD | resource | uri | Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches. |
SHOULD | derived-or-self | uri | A server defined search that matches either the url or derivedFrom |
SHOULD | status | token | SHOULD be valued with |
SHOULD | url | uri | Logical canonical URL to reference this SubscriptionTopic (globally unique) |
{ "resourceType": "CapabilityStatement", "id": "IHE.DSUBm.ResourceNotificationSubscriber.Folder.Upd", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "url": "https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationSubscriber.Folder.Upd", "version": "1.0.1-current", "name": "IHE_DSUBm_ResourceNotificationSubscriber_Folder_Upd", "title": "IHE DSUBm ResourceNotificationSubscriber Folder Upd", "status": "active", "experimental": false, "date": "2023-10-27", "publisher": "IHE IT Infrastructure Technical Committee", "contact": [ { "telecom": [ { "system": "url", "value": "https://www.ihe.net/ihe_domains/it_infrastructure/" } ] }, { "telecom": [ { "system": "email", "value": "iti@ihe.net" } ] }, { "name": "IHE IT Infrastructure Technical Committee", "telecom": [ { "system": "email", "value": "iti@ihe.net" } ] } ], "description": "The DSUBm Resource Notification Subscriber Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing DocumentReference Subscription for Update Option.\n\n- Using FHIR R4\n- SHALL support both json and xml encoding\n- SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)\n- SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic\n- SHALL be able to support the Subscription defined in Section [2:3.110.4.1.2.1.5 Subscription with Folder Subscription for Update option](ITI-110.html#2311041215-subscription-with-folder-subscription-for-update-option), and the related SubscriptionTopic\n- SHOULD implement the ITI-113 transaction; if implemented: \n - [Search Parameters that SHOULD be supported](ITI-113.html#23113412-message-semantics)\n - _id\n - status\n - url\n - filter-criteria\n - topic\n - SHOULD support the DSUBm $status operation \n - SHOULD support the DSUBm $events operation \n- SHOULD implement the ITI-114 transaction; if implemented: \n - [Search Parameters that SHALL be supported](ITI-114.html#23114412-message-semantics)\n - code\n - [Search Parameters that SHOULD be supported](ITI-114.html#23114412-message-semantics)\n - _id\n - resource\n - derived-or-self\n - status\n - url\n\n", "jurisdiction": [ { "coding": [ { "system": "http://unstats.un.org/unsd/methods/m49/m49.htm", "code": "001" } ] } ], "kind": "requirements", "fhirVersion": "4.0.1", "format": [ "application/fhir+xml", "application/fhir+json" ], "rest": [ { "mode": "client", "documentation": "DSUBm Resource Notification subscriber provides capability to create/deactivate subscription and optionally to search for Subscription and SubscritptionTopic resources", "security": { "description": "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)" }, "resource": [ { "type": "Subscription", "supportedProfile": [ "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-PatientDependent-Subscription", "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-MultiPatient-Subscription", "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-PatientDependent-Subscription", "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-MultiPatient-Subscription", "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-Folder-Subscription-UpdateOpt" ], "documentation": "Resource Subscription [ITI-110] and Resource Subscription Search [ITI-113]", "interaction": [ { "code": "read" }, { "code": "create" }, { "code": "update" }, { "code": "search-type" } ], "searchParam": [ { "name": "_id", "type": "string", "documentation": "The id of the Subscription" }, { "name": "status", "type": "token", "documentation": "The current state of the subscription" }, { "name": "url", "type": "uri", "documentation": "The URI that will receive the notifications" }, { "name": "filter-criteria", "definition": "http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-filter-criteria", "type": "string", "documentation": "This SearchParameter enables query of subscriptions by filter criteria" }, { "name": "topic", "definition": "http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-topic", "type": "uri", "documentation": "This SearchParameter enables query of subscriptions by canonical topic-url" } ], "operation": [ { "name": "$events", "definition": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events", "documentation": "This operation is OPTIONAL for the RESOURCE NOTIFICATION SUBSCRIBER; if supported, the Resource Notification Subscriber SHALL support in response a Bundle that is conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-EventsOperation-Bundle " }, { "name": "$status", "definition": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status", "documentation": "This operation is OPTIONAL for the RESOURCE NOTIFICATION SUBSCRIBER; if supported, the Resource Notification Subscriber SHALL support in response a Bundle that is conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-StatusOperation-Bundle " } ] }, { "type": "Basic", "documentation": "Resource SubscriptionTopic Search [ITI-114]", "interaction": [ { "code": "read" }, { "code": "search-type" } ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "code", "type": "token", "documentation": "Kind of Resource" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "name": "_id", "type": "string", "documentation": "The id of the SubscriptionTopic" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "name": "resource", "type": "uri", "documentation": "Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches." }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "name": "derived-or-self", "type": "uri", "documentation": "A server defined search that matches either the url or derivedFrom" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "name": "status", "type": "token", "documentation": "SHOULD be valued with `active`" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "name": "url", "type": "uri", "documentation": "Logical canonical URL to reference this SubscriptionTopic (globally unique)" } ] } ] } ] }