Scalable Consent Management Testing Guide
1.0.0-ballot - ci-build
Scalable Consent Management Testing Guide
1.0.0-ballot - ci-build
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
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These test plans are available to verify test coverage for this implementation guide
| Scalable Consent Management 1.0.0-ballot Test Plan |
The Scalable Consent Management Testing Guide defines the testing artifacts used to verify and validate implementations declaring conformance to and against the Scalable Consent Management Implementation Guide. |
These test definitions are available to FHIR test engines to verify systems are conforming to this implementation guide
| 00 Capabilities | 01 Obtain server CapabilityStatement |
Test a single server to verify support for the capabilities interaction 'HTTP GET metadata' and the return of a valid CapabilityStatement resource supporting the FAST Consent Management IG Version: CI. This scenario is generic and can be used with any FHIR format. Test System Details (in order of appearance): [Origin 1: Consent Client's RESTful client. System Under Test or Simulated: this can test an external test system, or choose Touchstone to simulate the client.] [Destination 1: Consent Admin Service's RESTful FHIR Server. System Under Test: this must be an external test system (not a mock).] |
| 00 Capabilities | 02 Obtain server CapabilityStatement - JSON |
Test a single server to verify support for the capabilities interaction 'HTTP GET metadata' and the return of a valid CapabilityStatement resource supporting the FAST Consent Management IG Version: CI, using JSON syntax. Test System Details (in order of appearance): [Origin 1: Consent Client's RESTful client. System Under Test or Simulated: this can test an external test system, or choose Touchstone to simulate the client.] [Destination 1: Consent Admin Service's RESTful FHIR Server. System Under Test: this must be an external test system (not a mock).] |
| 00 Capabilities | 03 Obtain server CapabilityStatement = XML |
Test a single server to verify support for the capabilities interaction 'HTTP GET metadata' and the return of a valid CapabilityStatement resource supporting the FAST Consent Management IG Version: CI, using XML syntax. Test System Details (in order of appearance): [Origin 1: Consent Client's RESTful client. System Under Test or Simulated: this can test an external test system, or choose Touchstone to simulate the client.] [Destination 1: Consent Admin Service's RESTful FHIR Server. System Under Test: this must be an external test system (not a mock).] |
| 01 Read Simple Search - All SUT | 01 Read a Consent |
Test a client and server to verify support for the Consent read interaction and the return of a valid Consent resource conforming to the FASTConsent profile. 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-1 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).] |
| 01 Read Simple Search - All SUT | 02 Search for a Consent |
Test a client and server to verify support for the Consent search interaction and the return of at least one valid Consent resource conforming to the FASTConsent profile. 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-2 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).] |
| 01 Read Simple Search - All SUT | 03 Read an AuditEvent |
Test a client and server to verify support for the AuditEvent read interaction and the return of a valid AuditEvent resource conforming to the FASTConsentAuditEvent profile. 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-141 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).] |
| 01 Read Simple Search - All SUT | 04 Search for an AuditEvent |
Test a client and server to verify support for the AuditEvent search interaction and the return of at least one valid AuditEvent resource conforming to the FASTConsentAuditEvent profile. 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-142 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).] |
| 01 Read Simple Search - All SUT | 05 Read a Subscription |
Test a client and server to verify support for the Subscription read interaction and the return of a valid Subscription resource conforming to the FASTSubscription profile. 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-199 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).] |
| 03 Operations - All SUT | 01 Operation: File a Consent |
Happy Path: Perform a successful Consent/$fileConsent operation. Test a client and server to verify support for the Consent $fileConsent operation, supporting the FAST Consent Management IG Version: CI. This scenario is generic and can be used with any FHIR format and query parameters. See https://wildfhir4.wildfhir.org/ig/fhir-consent-management-tg/rtm_test_cases.html#testcase-68 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).] [Origin 2: Touchstone's RESTful client. Simulated: this requires Touchstone to be chosen as the test system.] |
| 03 Operations - All SUT | 02 Operation: Revoke a Consent |
Happy Path: Perform a successful Consent/$revokeConsent operation. Test a client and server to verify support for the Consent $revokeConsent operation, supporting the FAST Consent Management IG Version: CI. This scenario is generic and can be used with any FHIR format and query parameters. See https://wildfhir4.wildfhir.org/ig/fhir-consent-management-tg/rtm_test_cases.html#testcase-70 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).] [Origin 2: Touchstone's RESTful client. Simulated: this requires Touchstone to be chosen as the test system.] |
| 03 Operations - All SUT | 03 Operation: Record a Disclosure |
Happy Path: Perform a successful AuditEvent/$recordDisclosure operation. Test a client and server to verify support for the AuditEvent $recordDisclosure operation, supporting the FAST Consent Management IG Version: CI. This scenario is generic and can be used with any FHIR format and query parameters. See https://wildfhir4.wildfhir.org/ig/fhir-consent-management-tg/rtm_test_cases.html#testcase-69 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).] |
| 04 Basic REST-hook Subs - All SUT | 01 Create subscription |
Happy Path: Create a Subscriptions R5 Backport REST-hook Subscription. Test a client and server to verify support for POST of a REST-hook 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).] |
| 04 Basic REST-hook Subs - All SUT | 02 Create subscription then handshake |
Alternate success: Create a Subscriptions R5 Backport REST-hook Subscription followed by a handshake. Test a client and server to verify support for POST of a REST-hook Subscription. This scenario includes the optional step of the Consent Server sending a handshake. 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).] [Origin 2: Consent Admin Service's Subscription REST-hook notification sender. System Under Test: this must be an external test system (not Touchstone).] [Destination 2: Consent Client's Subscription REST-hook notification endpoint. System Under Test: this must be an external test system (not a mock).] |
| 04 Basic REST-hook Subs - All SUT | 03 Create subscription then read |
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).] |
| 04 Basic REST-hook Subs - All SUT | 04 Create subscription then $status - Instance |
Alternate success: Create a Subscriptions R5 Backport REST-hook Subscription followed by a call to Subscription/$status. 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 calling Subscription/$status on 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).] |
| 04 Basic REST-hook Subs - All SUT | 05 Subscription Status - Resource |
Happy Path: Perform successful Subscription/$status operations. Test a client and server to verify support for the Subscription $status resource operation. 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-266 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).] |
| 04 Basic REST-hook Subs - All SUT | 06 Subscription Status - Instance |
Happy Path: Perform successful Subscription/[id]/$status operations. Test a client and server to verify support for the Subscription $status instance operation. 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-266 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).] |
| 04 Basic REST-hook Subs - All SUT | 07 Notify - event-notification |
Happy Path: Send a Subscriptions R5 Backport REST-hook Notification Bundle, event-notification 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).] |
| 04 Basic REST-hook Subs - All SUT | 08 Notify - heartbeat |
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).] |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| Consent-staged-consent-differentdate |
Consent with different date for FAST Consent testing |
| Consent-staged-consent-inactive |
Consent inactive status for FAST Consent testing |
| Consent-staged-consent-matched |
Consent for search to be matched for FAST Consent testing |
| Consent-staged-consent-unmatched |
Consent for search to not be matched for FAST Consent testing |
| DocumentReference-docref-example |
DocumentReference example for FAST Consent testing |
| Organization-staged-organization-consentactor |
Organization Consent actor for FAST Consent testing |
| Organization-staged-organization-controller |
Organization Consent controller for FAST Consent testing |
| Organization-staged-organization-grantee |
Organization Consent grantee for FAST Consent testing |
| Organization-staged-organization-manager |
Organization Consent manager for FAST Consent testing |
| Organization-staged-organization-unrelated |
Organization unrelated for FAST Consent testing |
| Patient-staged-patient-subject |
Patient subject of Consent for FAST Consent testing |
| Patient-staged-patient-unrelated |
Patient unrelated for FAST Consent testing |
IG © 2025+ HL7 International / Community Based Collaborative Care. Package hl7.fhir.us.consent-management-tg#1.0.0-ballot based on FHIR 4.0.1. Generated 2026-03-31
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change