Scalable Consent Management Testing Guide - Local Development build (v1.0.0-ballot) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/consent-management-tg/TestScript/08-Notify-heartbeat | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: Test_08_Notify_heartbeat | ||
Copyright/Legal: (c) AEGIS.net, Inc. 2026 |
||||
Happy Path: Send a Subscriptions R5 Backport REST-hook Notification Bundle, heartbeat type. Test a client and server to verify support for POST of a REST-hook Notification Bundle. This scenario is generic and can be used with any FHIR format and query parameters. Test case supporting the FAST Consent Management IG Version: CI. See https://wildfhir4.wildfhir.org/ig/fhir-consent-management-tg/rtm_test_cases.html#testcase-265 Test System Details (in order of appearance): [Origin 1: Consent Admin Service's Subscription REST-hook notification sender. System Under Test: this must be an external test system (not Touchstone).] [Destination 1: Consent Client's Subscription REST-hook notification endpoint. System Under Test: this must be an external test system (not a mock).]
AEGIS Touchstone Testing TestScript Rule Extension
- ruleId: AssertBodyExists
- path: /FHIRCommon/_reference/rule/AssertBodyExists.groovy
StructureDefinition Work Group: cbcc
url: TestScript 04 Basic REST-hook Subs - All SUT | 08 Notify - heartbeat
version: 1.0.0-ballot
name: Test_08_Notify_heartbeat
title: 04 Basic REST-hook Subs - All SUT | 08 Notify - heartbeat
status: Active
date: 2026-03-30
publisher: HL7 International / Community Based Collaborative Care
contact: HL7 International / Community Based Collaborative Care: http://www.hl7.org/Special/committees/cbcc
description:
Happy Path: Send a Subscriptions R5 Backport REST-hook Notification Bundle, heartbeat type. Test a client and server to verify support for POST of a REST-hook Notification Bundle. This scenario is generic and can be used with any FHIR format and query parameters. Test case supporting the FAST Consent Management IG Version: CI. See https://wildfhir4.wildfhir.org/ig/fhir-consent-management-tg/rtm_test_cases.html#testcase-265 Test System Details (in order of appearance): [Origin 1: Consent Admin Service's Subscription REST-hook notification sender. System Under Test: this must be an external test system (not Touchstone).] [Destination 1: Consent Client's Subscription REST-hook notification endpoint. System Under Test: this must be an external test system (not a mock).]
jurisdiction: United States of America
copyright:
(c) AEGIS.net, Inc. 2026
| Index | Profile |
| 1 | Test script profile origin type: FHIR-Client (FHIR Client) |
| Index | Profile |
| 1 | Test script profile destination type: FHIR-Server (FHIR Server) |
profile: http://hl7.org/fhir/StructureDefinition/Bundle
| Name | Description | Hint |
| dest-1-FHIRR5BackportNotification-1-needed-notification-endpoint | Consent Client's 's REST Hook Subscription notification endpoint, available at Destination 1. | [Enter Consent Client's 's REST Hook Subscription notification endpoint, available at Destination 1] |
test
name: Step_001_Send_Subscription_notification
description: Consent Admin Service sends a Subscription notification to Consent Client's notification endpoint.
action
operation
type: AEGIS Touchstone Testing FHIR Operation Codes: post (POST)
resource: Bundle
description: POST a Subscriptions R5 Backport REST-hook Notification Bundle.
contentType: json
destination: 1
encodeRequestUrl: true
method: POST
origin: 1
RequestHeaders
Field Value Authorization none requestId: dest-1-FHIRR5BackportNotification-1-request
responseId: dest-1-FHIRR5BackportNotification-1-response
url: ${dest-1-FHIRR5BackportNotification-1-needed-notification-endpoint}
action
Asserts
Extension Description Direction Operator ResponseCode SourceId WarningOnly Confirm that the returned HTTP status is 200 OK. response in 200 dest-1-FHIRR5BackportNotification-1-response false action
Asserts
Extension Description Direction WarningOnly Confirm that the request body exists. request false action
Asserts
Extension Description Direction Resource WarningOnly Confirm that the request resource type is Bundle. request Bundle false action
Asserts
Extension Description Direction ValidateProfileId WarningOnly Confirm that the request Bundle conforms to the base FHIR Bundle profile. This also validates the contents against any declared profiles. request Bundle-profile false action
Asserts
Extension Description Direction Expression Operator Value WarningOnly Confirm that the request Bundle type is history. request Bundle.type equals history false action
Asserts
Extension Description Direction Expression WarningOnly Confirm that the request Bundle declares the backport-subscription-notification-r4 profile. request Bundle.where('http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification-r4' in meta.profile).exists() false action
Asserts
Extension Description Direction Expression Operator SourceId Value WarningOnly Confirm that the Notification type is heartbeat. request Bundle.entry.resource.ofType(Parameters).parameter.where(name='type').value = 'heartbeat' equals dest-1-FHIRR5BackportNotification-1-request true false action
Asserts
Extension Description Direction Expression Operator SourceId Value WarningOnly Confirm that every Consent resource in the request declares the FASTConsent profile. request Bundle.entry.resource.where(resourceType = 'Consent').all('https://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent' in meta.profile) equals dest-1-FHIRR5BackportNotification-1-request true false