subscriptions_test_kit 0.9.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad5fae1148d468463f60e61a0e7c273b90eac5294b1c8d19b588288d3d53ca77
-  data.tar.gz: 62507f2c4a5cc9e39c1906bbb10032d1baa00b8ec33055762016c5ce2d22722c
+  metadata.gz: 33ac6bc935b44cb7bc9e03e4d8d5c3fecb0626f72afe303a2fbda58c59c89bf9
+  data.tar.gz: 99a87dfe4745fdb7f658ed01e133f63b392d2341db636c1f65a1289c1e9fa2f6
 SHA512:
-  metadata.gz: bad58bc3cdcb1c451bcb28f5dfbe8a5492e5cc8fff49b00f99d35d93588cec7936feeedee3c24984d6c1090ade8f92b35da4c89d83fd8036586f539cd0296ad7
-  data.tar.gz: f26d5875e051b95b24dabc7f45cdba4b9bda8631f76f022aa1e753569e89be8fd264b052ac9662855023c2f685ad9b4ac5473732b8d7538b32d7a2db819e2e6b
+  metadata.gz: 6d38fca0fc6b0714be01b3f33273dbd6df9dd5001dc294d0a602bd93ebafd02fa3dd0166f1e7f35e624f3f3627e7a720f00eb33bc84631b0115eb1bfde89b120
+  data.tar.gz: 58a359a599bb089ce6bdae13f6a343d489138f482b65f0348fcb5bbdb71be7eba5ec1d913914351a979bbfd001c9d20dca86ddfd2dfbb16f2a59c6c27501ea4b

data/config/presets/subscription_client_empty_preset.json.erb

@@ -0,0 +1,15 @@
+{
+  "title": "Inferno Subscription R4 Client Empty Preset",
+  "id": "inferno-subscriptions_r5_backport_r4_client_empty",
+  "test_suite_id": "subscriptions_r5_backport_r4_client",
+  "inputs": [
+    {
+      "name": "access_token",
+      "value": "SAMPLE_TOKEN"
+    },
+    {
+      "name": "notification_bundle",
+      "value": "{\n  \"resourceType\" : \"Bundle\",\n  \"id\" : \"r4-notification-empty\",\n  \"meta\" : {\n    \"profile\" : [\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification-r4\"]\n  },\n  \"type\" : \"history\",\n  \"timestamp\" : \"2020-05-29T11:44:13.1882432-05:00\",\n  \"entry\" : [{\n    \"fullUrl\" : \"urn:uuid:9e41ff6d-5be6-4e6a-8b85-abd4e7f58400\",\n    \"resource\" : {\n      \"resourceType\" : \"Parameters\",\n      \"id\" : \"9e41ff6d-5be6-4e6a-8b85-abd4e7f58400\",\n      \"meta\" : {\n        \"profile\" : [\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-status-r4\"]\n      },\n      \"parameter\" : [{\n        \"name\" : \"subscription\",\n        \"valueReference\" : {\n          \"reference\" : \"https://example.org/fhir/Subscription/admission\"\n        }\n      },\n      {\n        \"name\" : \"topic\",\n        \"valueCanonical\" : \"http://hl7.org/SubscriptionTopic/admission\"\n      },\n      {\n        \"name\" : \"status\",\n        \"valueCode\" : \"active\"\n      },\n      {\n        \"name\" : \"type\",\n        \"valueCode\" : \"event-notification\"\n      },\n      {\n        \"name\" : \"events-since-subscription-start\",\n        \"valueString\" : \"1\"\n      },\n      {\n        \"name\" : \"notification-event\",\n        \"part\" : [{\n          \"name\" : \"event-number\",\n          \"valueString\" : \"1\"\n        },\n        {\n          \"name\" : \"timestamp\",\n          \"valueInstant\" : \"2020-05-29T11:44:13.1882432-05:00\"\n        }]\n      }]\n    },\n    \"request\" : {\n      \"method\" : \"GET\",\n      \"url\" : \"https://example.org/fhir/Subscription/admission/$status\"\n    },\n    \"response\" : {\n      \"status\" : \"200\"\n    }\n  }]\n}"
+    }
+  ]
+}

data/config/presets/subscription_client_full_resource_preset.json.erb

@@ -0,0 +1,15 @@
+{
+  "title": "Inferno Subscription R4 Client Full-Resource Preset",
+  "id": "inferno-subscriptions_r5_backport_r4_client_full_resource",
+  "test_suite_id": "subscriptions_r5_backport_r4_client",
+  "inputs": [
+    {
+      "name": "access_token",
+      "value": "SAMPLE_TOKEN"
+    },
+    {
+      "name": "notification_bundle",
+      "value": "{\n  \"resourceType\" : \"Bundle\",\n  \"id\" : \"r4-notification-full-resource\",\n  \"meta\" : {\n    \"profile\" : [\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification-r4\"]\n  },\n  \"type\" : \"history\",\n  \"timestamp\" : \"2020-05-29T11:44:13.1882432-05:00\",\n  \"entry\" : [{\n    \"fullUrl\" : \"urn:uuid:2d5afc69-6ef2-420f-a8d1-8500c99eb96c\",\n    \"resource\" : {\n      \"resourceType\" : \"Parameters\",\n      \"id\" : \"2d5afc69-6ef2-420f-a8d1-8500c99eb96c\",\n      \"meta\" : {\n        \"profile\" : [\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-status-r4\"]\n      },\n      \"parameter\" : [{\n        \"name\" : \"subscription\",\n        \"valueReference\" : {\n          \"reference\" : \"https://example.org/fhir/Subscription/admission\"\n        }\n      },\n      {\n        \"name\" : \"topic\",\n        \"valueCanonical\" : \"http://hl7.org/SubscriptionTopic/admission\"\n      },\n      {\n        \"name\" : \"status\",\n        \"valueCode\" : \"active\"\n      },\n      {\n        \"name\" : \"type\",\n        \"valueCode\" : \"event-notification\"\n      },\n      {\n        \"name\" : \"events-since-subscription-start\",\n        \"valueString\" : \"1\"\n      },\n      {\n        \"name\" : \"notification-event\",\n        \"part\" : [{\n          \"name\" : \"event-number\",\n          \"valueString\" : \"1\"\n        },\n        {\n          \"name\" : \"timestamp\",\n          \"valueInstant\" : \"2020-05-29T11:44:13.1882432-05:00\"\n        },\n        {\n          \"name\" : \"focus\",\n          \"valueReference\" : {\n            \"reference\" : \"https://example.org/fhir/Encounter/86009987-eabe-42bf-8c02-b112b18cb616\"\n          }\n        }]\n      }]\n    },\n    \"request\" : {\n      \"method\" : \"GET\",\n      \"url\" : \"https://example.org/fhir/Subscription/admission/$status\"\n    },\n    \"response\" : {\n      \"status\" : \"200\"\n    }\n  },\n  {\n    \"fullUrl\" : \"https://fhirserver.org/fhir/Encounter/86009987-eabe-42bf-8c02-b112b18cb616\",\n    \"resource\" : {\n      \"resourceType\" : \"Encounter\",\n      \"id\" : \"86009987-eabe-42bf-8c02-b112b18cb616\",\n      \"status\" : \"in-progress\",\n      \"class\" : {\n        \"system\" : \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n        \"code\" : \"VR\"\n      },\n      \"subject\" : {\n        \"reference\" : \"https://fhirserver.org/fhir/Patient/1599eb66-431a-447c-a3de-6897fe9ae9a1\",\n        \"display\" : \"Example Patient\"\n      }\n    },\n    \"request\" : {\n      \"method\" : \"POST\",\n      \"url\" : \"Encounter\"\n    },\n    \"response\" : {\n      \"status\" : \"201\"\n    }\n  }]\n}"
+    }
+  ]
+}

data/config/presets/subscription_client_id_only_preset.json.erb

@@ -0,0 +1,15 @@
+{
+  "title": "Inferno Subscription R4 Client Id-Only Preset",
+  "id": "inferno-subscriptions_r5_backport_r4_client_id_only",
+  "test_suite_id": "subscriptions_r5_backport_r4_client",
+  "inputs": [
+    {
+      "name": "access_token",
+      "value": "SAMPLE_TOKEN"
+    },
+    {
+      "name": "notification_bundle",
+      "value": "{\n  \"resourceType\" : \"Bundle\",\n  \"id\" : \"r4-notification-id-only\",\n  \"meta\" : {\n    \"profile\" : [\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification-r4\"]\n  },\n  \"type\" : \"history\",\n  \"timestamp\" : \"2020-05-29T11:44:13.1882432-05:00\",\n  \"entry\" : [{\n    \"fullUrl\" : \"urn:uuid:292d3c72-edc1-4d8a-afaa-d85e19c7f563\",\n    \"resource\" : {\n      \"resourceType\" : \"Parameters\",\n      \"id\" : \"292d3c72-edc1-4d8a-afaa-d85e19c7f563\",\n      \"meta\" : {\n        \"profile\" : [\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-status-r4\"]\n      },\n      \"parameter\" : [{\n        \"name\" : \"subscription\",\n        \"valueReference\" : {\n          \"reference\" : \"https://example.org/fhir/Subscription/admission\"\n        }\n      },\n      {\n        \"name\" : \"topic\",\n        \"valueCanonical\" : \"http://hl7.org/SubscriptionTopic/admission\"\n      },\n      {\n        \"name\" : \"status\",\n        \"valueCode\" : \"active\"\n      },\n      {\n        \"name\" : \"type\",\n        \"valueCode\" : \"event-notification\"\n      },\n      {\n        \"name\" : \"events-since-subscription-start\",\n        \"valueString\" : \"1\"\n      },\n      {\n        \"name\" : \"notification-event\",\n        \"part\" : [{\n          \"name\" : \"event-number\",\n          \"valueString\" : \"1\"\n        },\n        {\n          \"name\" : \"timestamp\",\n          \"valueInstant\" : \"2020-05-29T11:44:13.1882432-05:00\"\n        },\n        {\n          \"name\" : \"focus\",\n          \"valueReference\" : {\n            \"reference\" : \"https://example.org/fhir/Encounter/86009987-eabe-42bf-8c02-b112b18cb616\"\n          }\n        }]\n      }]\n    },\n    \"request\" : {\n      \"method\" : \"GET\",\n      \"url\" : \"https://example.org/fhir/Subscription/admission/$status\"\n    },\n    \"response\" : {\n      \"status\" : \"200\"\n    }\n  }]\n}"
+    }
+  ]
+}

data/config/presets/subscription_server_preset_empty.json.erb

@@ -0,0 +1,23 @@
+{
+  "title": "Empty Notifications Against The Subscriptions Client Suite",
+  "id": "inferno-subscriptions_r5_backport_r4_server_preset_empty",
+  "test_suite_id": "subscriptions_r5_backport_r4_server",
+  "inputs": [
+    {
+      "name": "url",
+      "value": "<%= Inferno::Application['base_url'] %>/custom/subscriptions_r5_backport_r4_client/fhir"
+    },
+    {
+      "name": "credentials",
+      "value": "{\"access_token\":\"SAMPLE_TOKEN\"}"
+    },
+    {
+      "name": "subscription_resource",
+      "value": "{\n  \"resourceType\" : \"Subscription\",\n  \"meta\" : {\n    \"profile\" : [\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription\"]\n  },\n  \"status\" : \"requested\",\n  \"end\" : \"2020-12-31T12:00:00Z\",\n  \"reason\" : \"R4 Topic-Based Workflow Subscription for Patient Admission\",\n  \"criteria\" : \"https://inferno.healthit.gov/suites/custom/subscriptions_r5_backport_r4_client/topics/patient-admission\",\n  \"_criteria\" : {\n    \"extension\" : [{\n      \"url\" : \"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria\",\n      \"valueString\" : \"Encounter.patient=Patient/123\"\n    }]\n  },\n  \"channel\" : {\n    \"extension\" : [{\n      \"url\" : \"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout\",\n      \"valueUnsignedInt\" : 60\n    },\n    {\n      \"url\" : \"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count\",\n      \"valuePositiveInt\" : 20\n    }],\n    \"type\" : \"rest-hook\",\n    \"header\": [\"Authorization: Bearer SAMPLE_TOKEN\"],\n    \"endpoint\" : \"<%= Inferno::Application['base_url'] %>/custom/subscriptions_r5_backport_r4_server/subscription/channel/notification_listener\",\n    \"payload\" : \"application/fhir+json\",\n    \"_payload\" : {\n      \"extension\" : [{\n        \"url\" : \"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content\",\n        \"valueCode\" : \"empty\"\n      }]\n    }\n  }\n}"
+    },
+    {
+      "name": "access_token",
+      "value": "SAMPLE_TOKEN"
+    }
+  ]
+}

data/config/presets/subscription_server_preset_full_resource.json.erb

@@ -0,0 +1,23 @@
+{
+  "title": "Full Resource Notifications Against The Subscriptions Client Suite",
+  "id": "inferno-subscriptions_r5_backport_r4_server_preset_full_resource",
+  "test_suite_id": "subscriptions_r5_backport_r4_server",
+  "inputs": [
+    {
+      "name": "url",
+      "value": "<%= Inferno::Application['base_url'] %>/custom/subscriptions_r5_backport_r4_client/fhir"
+    },
+    {
+      "name": "credentials",
+      "value": "{\"access_token\":\"SAMPLE_TOKEN\"}"
+    },
+    {
+      "name": "subscription_resource",
+      "value": "{\n  \"resourceType\" : \"Subscription\",\n  \"meta\" : {\n    \"profile\" : [\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription\"]\n  },\n  \"status\" : \"requested\",\n  \"end\" : \"2020-12-31T12:00:00Z\",\n  \"reason\" : \"R4 Topic-Based Workflow Subscription for Patient Admission\",\n  \"criteria\" : \"https://inferno.healthit.gov/suites/custom/subscriptions_r5_backport_r4_client/topics/patient-admission\",\n  \"_criteria\" : {\n    \"extension\" : [{\n      \"url\" : \"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria\",\n      \"valueString\" : \"Encounter.patient=Patient/123\"\n    }]\n  },\n  \"channel\" : {\n    \"extension\" : [{\n      \"url\" : \"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout\",\n      \"valueUnsignedInt\" : 60\n    },\n    {\n      \"url\" : \"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count\",\n      \"valuePositiveInt\" : 20\n    }],\n    \"type\" : \"rest-hook\",\n    \"header\": [\"Authorization: Bearer SAMPLE_TOKEN\"],\n    \"endpoint\" : \"<%= Inferno::Application['base_url'] %>/custom/subscriptions_r5_backport_r4_server/subscription/channel/notification_listener\",\n    \"payload\" : \"application/fhir+json\",\n    \"_payload\" : {\n      \"extension\" : [{\n        \"url\" : \"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content\",\n        \"valueCode\" : \"full-resource\"\n      }]\n    }\n  }\n}"
+    },
+    {
+      "name": "access_token",
+      "value": "SAMPLE_TOKEN"
+    }
+  ]
+}

data/config/presets/subscription_server_preset_id_only.json.erb

@@ -0,0 +1,23 @@
+{
+  "title": "Id Only Notifications Against The Subscriptions Client Suite",
+  "id": "inferno-subscriptions_r5_backport_r4_server_preset_id_only",
+  "test_suite_id": "subscriptions_r5_backport_r4_server",
+  "inputs": [
+    {
+      "name": "url",
+      "value": "<%= Inferno::Application['base_url'] %>/custom/subscriptions_r5_backport_r4_client/fhir"
+    },
+    {
+      "name": "credentials",
+      "value": "{\"access_token\":\"SAMPLE_TOKEN\"}"
+    },
+    {
+      "name": "subscription_resource",
+      "value": "{\n  \"resourceType\" : \"Subscription\",\n  \"meta\" : {\n    \"profile\" : [\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription\"]\n  },\n  \"status\" : \"requested\",\n  \"end\" : \"2020-12-31T12:00:00Z\",\n  \"reason\" : \"R4 Topic-Based Workflow Subscription for Patient Admission\",\n  \"criteria\" : \"https://inferno.healthit.gov/suites/custom/subscriptions_r5_backport_r4_client/topics/patient-admission\",\n  \"_criteria\" : {\n    \"extension\" : [{\n      \"url\" : \"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria\",\n      \"valueString\" : \"Encounter.patient=Patient/123\"\n    }]\n  },\n  \"channel\" : {\n    \"extension\" : [{\n      \"url\" : \"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout\",\n      \"valueUnsignedInt\" : 60\n    },\n    {\n      \"url\" : \"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count\",\n      \"valuePositiveInt\" : 20\n    }],\n    \"type\" : \"rest-hook\",\n    \"header\": [\"Authorization: Bearer SAMPLE_TOKEN\"],\n    \"endpoint\" : \"<%= Inferno::Application['base_url'] %>/custom/subscriptions_r5_backport_r4_server/subscription/channel/notification_listener\",\n    \"payload\" : \"application/fhir+json\",\n    \"_payload\" : {\n      \"extension\" : [{\n        \"url\" : \"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content\",\n        \"valueCode\" : \"id-only\"\n      }]\n    }\n  }\n}"
+    },
+    {
+      "name": "access_token",
+      "value": "SAMPLE_TOKEN"
+    }
+  ]
+}

data/lib/subscriptions_test_kit/common/notification_conformance_verification.rb

@@ -127,7 +127,7 @@ module SubscriptionsTestKit
       return if empty_req_check
 
       add_message('error', %(
-            When populating the SubscriptionStatus.notificationEvent structure for a notification with an empty
+            When populating the SubscriptionStatus.notificationEvent structure for an event notification with an empty
             payload, a server SHALL NOT include references to resources))
     end
 
@@ -150,8 +150,14 @@ module SubscriptionsTestKit
     end
 
     def check_bundle_entry_reference(bundle_entries, reference)
+      check_full_url = reference.start_with?('urn:')
+
       referenced_entry = bundle_entries.find do |entry|
-        reference.include?("#{entry.resource.resourceType}/#{entry.resource.id}")
+        if check_full_url
+          reference == entry.fullUrl
+        else
+          reference.include?("#{entry.resource.resourceType}/#{entry.resource.id}")
+        end
       end
       referenced_entry.present?
     end
@@ -226,15 +232,6 @@ module SubscriptionsTestKit
           resource in the entry.resource element.))
     end
 
-    def subscription_criteria(subscription)
-      return unless subscription['_criteria']
-
-      criteria_extension = subscription['_criteria']['extension'].find do |ext|
-        ext['url'].ends_with?('/backport-filter-criteria')
-      end
-      criteria_extension['valueString'].split('?').first
-    end
-
     def empty_event_notification_verification(notification_bundle)
       assert_valid_json(notification_bundle)
       bundle = FHIR.from_contents(notification_bundle)

data/lib/subscriptions_test_kit/common/subscription_conformance_verification.rb

@@ -37,15 +37,29 @@ module SubscriptionsTestKit
       end
     end
 
+    def valid_url?(url)
+      uri = URI.parse(url)
+      uri.is_a?(URI::HTTP) && !uri.host.nil?
+    rescue URI::InvalidURIError
+      false
+    end
+
     def subscription_verification(subscription_resource)
       assert_valid_json(subscription_resource)
       subscription = JSON.parse(subscription_resource)
 
       subscription_channel = subscription['channel']
       assert(channel_field_matches?(subscription_channel, 'type', 'rest-hook'), %(
-        The `type` field on the Subscription resource must be set to `rest-hook`, the `#{subscription_channel['type']}`
-        channel type is unsupported.))
+        The `type` element on the Subscription resource must be set to `rest-hook`,
+        the `#{subscription_channel['type']}` channel type is unsupported.))
 
+      unless subscription['criteria'].present? && valid_url?(subscription['criteria'])
+        add_message('error',
+                    %(
+                      'The `criteria` element SHALL be populated and contain the canonical
+                      URL for the Subscription Topic.'
+                    ))
+      end
       subscription_resource = FHIR.from_contents(subscription.to_json)
       assert_resource_type('Subscription', resource: subscription_resource)
       assert_valid_resource(resource: subscription_resource,
@@ -64,10 +78,17 @@ module SubscriptionsTestKit
         subscription_channel['endpoint'] = subscription_channel_url
       end
 
-      unless channel_field_matches?(subscription_channel, 'payload', 'application/json')
+      unless channel_field_matches?(subscription_channel, 'payload', 'application/fhir+json')
+        update_message = if channel_field_matches?(subscription_channel, 'payload', 'application/json')
+                           ''
+                         else
+                           subscription_channel['payload'] = 'application/fhir+json'
+                           ' The requested Subscription has been updated to use this value.'
+                         end
+
         add_message('warning', %(
-          The `type` field on the Subscription resource should be set to `application/json`. Inferno will only accept
-          resources in requests with this content type.
+          The `payload` element on the Subscription resource should be set to `application/fhir+json`, which is the
+          [correct mime type for FHIR JSON](https://hl7.org/fhir/R4/http.html#mime-type).#{update_message}
         ))
       end
 
@@ -77,8 +98,8 @@ module SubscriptionsTestKit
           Added the Authorization header field with a Bearer token set to #{access_token} to the `header` field on the
           Subscription resource in order to connect successfully with the Inferno subscription channel.
         ))
-        subscription['header'] = [] unless subscription['header'].present?
-        subscription['header'].append("Authorization: Bearer #{access_token}")
+        subscription_channel['header'] = [] unless subscription_channel['header'].present?
+        subscription_channel['header'].append("Authorization: Bearer #{access_token}")
       end
       subscription['channel'] = subscription_channel
       subscription

data/lib/subscriptions_test_kit/docs/samples/Subscription_empty.json

@@ -11,7 +11,7 @@
     "_criteria" : {
       "extension" : [{
         "url" : "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria",
-        "valueString" : "Encounter?patient=Patient/123"
+        "valueString" : "Encounter.patient=Patient/123"
       }]
     },
     "channel" : {
@@ -26,7 +26,7 @@
       "type" : "rest-hook",
       "header": ["Authorization: Bearer SAMPLE_TOKEN"],
       "endpoint" : "http://inferno.healthit.gov/suites/custom/subscriptions_r5_backport_r4_server/subscription/channel/notification_listener",
-      "payload" : "application/json",
+      "payload" : "application/fhir+json",
       "_payload" : {
         "extension" : [{
           "url" : "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content",

data/lib/subscriptions_test_kit/docs/samples/Subscription_full-resource.json

@@ -11,7 +11,7 @@
     "_criteria" : {
       "extension" : [{
         "url" : "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria",
-        "valueString" : "Encounter?patient=Patient/123"
+        "valueString" : "Encounter.patient=Patient/123"
       }]
     },
     "channel" : {
@@ -26,7 +26,7 @@
       "type" : "rest-hook",
       "header": ["Authorization: Bearer SAMPLE_TOKEN"],
       "endpoint" : "http://inferno.healthit.gov/suites/custom/subscriptions_r5_backport_r4_server/subscription/channel/notification_listener",
-      "payload" : "application/json",
+      "payload" : "application/fhir+json",
       "_payload" : {
         "extension" : [{
           "url" : "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content",

data/lib/subscriptions_test_kit/docs/samples/Subscription_id-only.json

@@ -12,7 +12,7 @@
     "_criteria" : {
       "extension" : [{
         "url" : "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria",
-        "valueString" : "Encounter?patient=Patient/123"
+        "valueString" : "Encounter.patient=Patient/123"
       }]
     },
     "channel" : {
@@ -27,7 +27,7 @@
       "type" : "rest-hook",
       "header": ["Authorization: Bearer SAMPLE_TOKEN"],
       "endpoint" : "http://inferno.healthit.gov/suites/custom/subscriptions_r5_backport_r4_server/subscription/channel/notification_listener",
-      "payload" : "application/json",
+      "payload" : "application/fhir+json",
       "_payload" : {
         "extension" : [{
           "url" : "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content",

data/lib/subscriptions_test_kit/docs/subscriptions_r5_backport_r4_client_suite_description.md

@@ -117,4 +117,10 @@ Specific limitations to highlight include
   [provide feedback](https://github.com/inferno-framework/subscriptions-test-kit/issues) to that effect.
 - Inferno does not test delivery error handling and recovery scenarios, including
   the optional `$events` API and event numbering details.
-- Inferno does not support sending heartbeat notifications.
+- Inferno does not support sending heartbeat notifications.
+- Inferno does not verify that the shape and content of notifications are appropriate for the triggering
+  Subscription because those details, e.g., the resource types that can be a focus of the notification, 
+  are defined within the SubscriptionTopic which is not available in FHIR R4.
+- When sending notifications, Inferno supports only JSON payloads and will always use `application/fhir+json`
+  as the value of the `content-type` HTTP header, unless the client system explicitly asks for
+  `application/json` using the `Subscription.channel.payload` element.

data/lib/subscriptions_test_kit/docs/subscriptions_r5_backport_r4_server_suite_description.md

@@ -167,4 +167,14 @@ Specific limitations to highlight include
   If there is a channel type that you would like to see verified, please 
   [provide feedback](https://github.com/inferno-framework/subscriptions-test-kit/issues) to that effect.
 - Inferno does not test delivery error handling and recovery scenarios, including
-  the optional `$events` API and event numbering details.
+  the optional `$events` API and event numbering details.
+- Inferno does not verify that the shape and content of notifications are appropriate for the triggering
+  Subscription because those details, e.g., the resource types that can be a focus of the notification, 
+  are defined within the SubscriptionTopic which is not available in FHIR R4.
+- When accepting notifications, Inferno supports only JSON payloads with a
+  `content-type` HTTP header of `application/fhir+json` or `application/json`.
+  Inferno will always request that `application/fhir+json` appear in `content-type`
+  header using the `Subscription.channel.payload` element. Testers may instruct
+  Inferno to request that `application/json` be used instead by placing it in the
+  `Subscription.channel.payload` element of the Subscription they provide for Inferno
+  to use.

data/lib/subscriptions_test_kit/endpoints/subscription_status_endpoint.rb

@@ -30,7 +30,7 @@ module SubscriptionsTestKit
           return
         end
 
-        unless subscription_params_match?(params)
+        unless subscription_params_match?(params, subscription)
           not_found
           return
         end
@@ -38,21 +38,22 @@ module SubscriptionsTestKit
 
       notification_json = notification_bundle_input(result)
       subscription_url = "#{base_subscription_url}/#{subscription.id}"
+      subscription_topic = subscription.criteria
       status_code = determine_subscription_status_code(subscription_id)
       event_count = determine_event_count(test_run.test_session_id)
       response.status = 200
-      response.body = derive_status_bundle(notification_json, subscription_url, status_code, event_count,
-                                           request.url).to_json
+      response.body = derive_status_bundle(notification_json, subscription_url, subscription_topic, status_code,
+                                           event_count, request.url).to_json
     end
 
-    def subscription_params_match?(params)
+    def subscription_params_match?(params, subscription)
       id_params = find_params(params, 'id')
 
       return false if id_params&.any? && id_params&.none? { |p| p.valueString == subscription.id }
 
       status_params = find_params(params, 'status')
       subscription_status = determine_subscription_status_code(subscription.id)
-      status_params.nil? || status_params.none? || status_params.any { p.valueString == subscription_status }
+      status_params.blank? || status_params.any? { |p| p.valueString == subscription_status }
     end
 
     def tags

data/lib/subscriptions_test_kit/jobs/send_subscription_notifications.rb

@@ -74,6 +74,10 @@ module SubscriptionsTestKit
         @authorization_header ||= @bearer_token.present? ? { 'Authorization' => "Bearer #{@bearer_token}" } : {}
       end
 
+      def subscription_topic
+        @subscription_topic ||= subscription&.criteria
+      end
+
       def test_still_waiting?
         results_repo.find_waiting_result(test_run_id: @test_run_id)
       end
@@ -83,14 +87,15 @@ module SubscriptionsTestKit
       end
 
       def send_handshake_notification
-        handshake_json = derive_handshake_notification(@notification_json, @subscription_url).to_json
+        handshake_json = derive_handshake_notification(@notification_json, @subscription_url,
+                                                       subscription_topic).to_json
         response = send_notification(handshake_json)
         persist_notification_request(response, [REST_HOOK_HANDSHAKE_NOTIFICATION_TAG])
         resume_inferno_test unless response.status == 200
       end
 
       def send_event_notification
-        event_json = derive_event_notification(@notification_json, @subscription_url, 1).to_json
+        event_json = derive_event_notification(@notification_json, @subscription_url, subscription_topic, 1).to_json
         response = send_notification(event_json)
         persist_notification_request(response, [REST_HOOK_EVENT_NOTIFICATION_TAG])
       end

data/lib/subscriptions_test_kit/metadata.rb

@@ -0,0 +1,92 @@
+require_relative 'version'
+
+module SubscriptionsTestKit
+  class Metadata < Inferno::TestKit
+    id :subscriptions_test_kit
+    title 'Subscription Test Kit'
+    description <<~DESCRIPTION
+      The Subscriptions Test Suite verifies the conformance of systems to the FHIR Subscriptions
+      framework as specified in the [HL7® FHIR® R5 version](https://www.hl7.org/fhir/R5/subscriptions.html)
+      and above. For systems using the R4 and R4B releases of FHIR, it verifies Subscription
+      functionality against the [Subscriptions R5 Backport
+      IG](https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/) that specifies how to use R5 Subscriptions
+      functionality within those earlier versions.
+
+      <!-- break -->
+
+      ## Status
+
+      These tests are a **DRAFT** intended to allow implementers to perform
+      preliminary checks of their systems against Subscriptions capabilities backported
+      from FHIR R5 to R4 and [provide feedback](https://github.com/inferno-framework/subscriptions-test-kit/issues)
+      on the tests. Future versions of these tests may verify other
+      requirements and may change the test verification logic. The test kit currently
+      includes suites for systems implementing FHIR R4 only.
+
+      ## Test Scope and Limitations
+
+      The Subscriptions Test Kit includes suites for the following Subscriptions actors
+      and versions:
+      - **Subscriptions R4 Client Test Suite**:
+        Verifies that a FHIR R4 system implements FHIR R5
+        Subscriptions client capabilities as specified in the [Subscriptions R5 Backport
+        IG](https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/), namely the ability
+        to request a Subscription and receive notifications.
+      - **Subscriptions R4 Server Test Suite**:
+        Verifies that a FHIR R4 system implements FHIR R5
+        Subscriptions server capabilities as specified in the [Subscriptions R5 Backport
+        IG](https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/), namely the ability
+        to receive Subscription requests and send notifications.
+
+      Documentation of the current tests and their limitations can be found in each
+      suite's description when the tests are run and can also be viewed in the
+      source code:
+      - [Subscriptions R4 Client Test Suite Documentation](https://github.com/inferno-framework/subscriptions-test-kit/blob/main/lib/subscriptions_test_kit/docs/dsubscriptions_r5_backport_r4_client_suite_description.md)
+      - [Subscriptions R4 Server Test Suite Documentation](https://github.com/inferno-framework/subscriptions-test-kit/blob/main/lib/subscriptions_test_kit/docs/subscriptions_r5_backport_r4_server_suite_description.md)
+
+      ### Test Scope
+
+      To validate the behavior of the system under test, Inferno will act as an
+      exchange partner. Specifically,
+
+      - **When testing a Subscriptions client**: Inferno will simulate a Subscriptions
+        server by responding to Subscription API requests (e.g., `create` interactions and
+        the `$status` operation) and sending notifications as directed by
+        created Subscription instances.
+      - **When testing a Subscriptions server**: Inferno will simulate a Subscriptions
+        client by requesting a Subscription with notifications delivered to an Inferno-hosted
+        endpoint and responding to notifications sent to that endpoint by the server under test.
+
+      ### Known Limitations
+
+      This test kit is still in draft form and does not test all of the requirements and features
+      described in the [R5 Subscriptions framework](https://www.hl7.org/fhir/R5/subscriptions.html)
+      or its [backport to R4](https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/).
+      You can find information on the requirements that the test kit covers and does not cover in the [Requirements
+      Coverage](https://github.com/inferno-framework/subscriptions-test-kit/blob/main/lib/subscriptions_test_kit/requirements/generated/subscriptions-test-kit_requirements_coverage.csv)
+      CSV document.
+
+      Specific current limitations to highlight include:
+      - *Channels*: Inferno only supports the `rest-hook` notification delivery channel.
+      - *Error Handling and Recovery*: Inferno does not test error handling and the ability
+        to recover from errors or missed notifications, including the `$events` operation.
+      - *Heartbeat Notifications*: Inferno will not send heartbeat notifications when simulating
+        a Subscriptions server for the client test suite.
+      - *FHIR Versions*: Inferno only supports verification of FHIR R4 systems.
+
+      ## Reporting Issues
+
+      Please report any issues with this set of tests in the [GitHub
+      Issues](https://github.com/inferno-framework/subscriptions-test-kit/issues)
+      section of the
+      [open-source code repository](https://github.com/inferno-framework/subscriptions-test-kit).
+    DESCRIPTION
+    suite_ids [:subscriptions_r5_backport_r4_client, :subscriptions_r5_backport_r4_server]
+    tags ['Subscriptions']
+    last_updated LAST_UPDATED
+    version VERSION
+    maturity 'Low'
+    authors ['Karl Naden', 'Emily Semple', 'Tom Strassner']
+    repo 'https://github.com/inferno-framework/subscriptions-test-kit'
+  end
+end