Scalable Consent Management Testing Guide
1.0.0-ballot - ci-build United States of America flag

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

TestScript: 04 Basic REST-hook Subs - All SUT | 03 Create subscription then read

Official URL: http://hl7.org/fhir/us/consent-management-tg/TestScript/03-Create-subscription-then-read Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: Test_03_Create_subscription_then_read

Copyright/Legal: (c) AEGIS.net, Inc. 2026

Alternate success: Create a Subscriptions R5 Backport REST-hook Subscription followed by a read. Test a client and server to verify support for POST of a REST-hook Subscription. This scenario includes the optional step of the Consent Client reading the new Subscription. 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-232 Test System Details (in order of appearance): [Origin 1: Consent Client's RESTful client. System Under Test: this must be an external test system (not Touchstone).] [Destination 1: Consent Admin Service's RESTful FHIR Server. 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 | 03 Create subscription then read

version: 1.0.0-ballot

name: Test_03_Create_subscription_then_read

title: 04 Basic REST-hook Subs - All SUT | 03 Create subscription then read

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:

Alternate success: Create a Subscriptions R5 Backport REST-hook Subscription followed by a read. Test a client and server to verify support for POST of a REST-hook Subscription. This scenario includes the optional step of the Consent Client reading the new Subscription. 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-232 Test System Details (in order of appearance): [Origin 1: Consent Client's RESTful client. System Under Test: this must be an external test system (not Touchstone).] [Destination 1: Consent Admin Service's RESTful FHIR Server. System Under Test: this must be an external test system (not a mock).]

jurisdiction: United States of America

copyright:

(c) AEGIS.net, Inc. 2026

Origins

-IndexProfile
*1Test script profile origin type: FHIR-Client (FHIR Client)

Destinations

-IndexProfile
*1Test script profile destination type: FHIR-Server (FHIR Server)

profile:

Variables

-NameExpressionSourceId
*dest-1-FHIRCreate-1-Subscription_idSubscription.iddest-1-FHIRCreate-1-response

test

name: Step_001_POST_Subscription_create

description: Consent Client creates with POST a Subscription resource at Consent Admin Service.

action

Operations

-TypeResourceDescriptionDestinationEncodeRequestUrlMethodOriginRequestIdResponseIdUrl
*Test script operation code: create (Create)SubscriptionCreate a Subscription resource.1truePOST1dest-1-FHIRCreate-1-requestdest-1-FHIRCreate-1-response${dest1SystemConfig.baseUrl}/Subscription

action

Asserts

-ExtensionDescriptionDirectionWarningOnly
*Confirm that the request body exists.requestfalse

action

Asserts

-ExtensionDescriptionDirectionResourceWarningOnly
*Confirm that the request body is a Subscription resource.requestSubscriptionfalse

action

Asserts

-ExtensionDescriptionDirectionValidateProfileIdWarningOnly
*Confirm that the request body conforms to the base FHIR Subscription profile. This also checks any declared profiles within.requestSubscription-profilefalse

action

Asserts

-ExtensionDescriptionDirectionOperatorResponseCodeSourceIdWarningOnly
*Confirm that the returned HTTP status is 201 Created.responsein201dest-1-FHIRCreate-1-responsefalse

action

Asserts

-ExtensionDescriptionDirectionWarningOnly
*Confirm that the response body exists.responsefalse

action

Asserts

-ExtensionDescriptionDirectionResourceWarningOnly
*Confirm that the response body is a Subscription resource.responseSubscriptiontrue

action

Asserts

-ExtensionDescriptionDirectionValidateProfileIdWarningOnly
*Confirm that the response body conforms to the base FHIR Subscription profile. This also checks any declared profiles within.responseSubscription-profiletrue

action

Asserts

-ExtensionDescriptionDirectionExpressionOperatorSourceIdValueWarningOnly
*Confirm that the request body is a Subscription resource that should declare the FASTSubscription profile.requestSubscription.meta.profile contains 'https://hl7.org/fhir/us/consent-management/StructureDefinition/FASTSubscription'equalsdest-1-FHIRCreate-1-requesttruetrue

action

Asserts

-ExtensionDescriptionDirectionExpressionValidateProfileIdWarningOnly
*Confirm that the resource(s) in the request body at FHIRPath 'Subscription' should conform to profile 'FASTSubscription'.requestSubscriptionFASTSubscriptiontrue

test

name: Step_002_Subscription_read

description: Consent Client reads a Subscription resource at Consent Admin Service.

action

Operations

-TypeResourceDescriptionDestinationEncodeRequestUrlMethodOriginParamsRequestIdResponseId
*Test script operation code: read (Read)SubscriptionRead a Subscription resource.1trueGET1/${dest-1-FHIRCreate-1-Subscription_id}dest-1-FHIRRead-1-requestdest-1-FHIRRead-1-response

action

Asserts

-ExtensionDescriptionDirectionOperatorResponseCodeSourceIdWarningOnly
*Confirm that the returned HTTP status is 200 OK.responsein200dest-1-FHIRRead-1-responsefalse

action

Asserts

-ExtensionDescriptionDirectionWarningOnly
*Confirm that the response body exists.responsefalse

action

Asserts

-ExtensionDescriptionDirectionResourceWarningOnly
*Confirm that the response body is a Subscription resource.responseSubscriptionfalse

action

Asserts

-ExtensionDescriptionDirectionValidateProfileIdWarningOnly
*Confirm that the response body conforms to the base FHIR Subscription profile. This also checks any declared profiles within.responseSubscription-profilefalse