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

: 04 Basic REST-hook Subs - All SUT | 06 Subscription Status - Instance - JSON Representation

Page standards status: Trial-use Maturity Level: 1

Raw json | Download

{
  "resourceType" : "TestScript",
  "id" : "06-Subscription-Status-Instance",
  "meta" : {
    "profile" : [
      🔗 "http://touchstone.aegis.net/touchstone/fhir/testing/StructureDefinition/testscript"
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: TestScript 06-Subscription-Status-Instance</b></p><a name=\"06-Subscription-Status-Instance\"> </a><a name=\"hc06-Subscription-Status-Instance\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"file://D:\\GitHub\\Touchstone\\testing-ig\\output/StructureDefinition-testscript.html\">AEGIS Touchstone Testing TestScript Profile</a></p></div><p><b>StructureDefinition Work Group</b>: cbcc</p><p><b>url</b>: <a href=\"TestScript-06-Subscription-Status-Instance.html\">TestScript 04 Basic REST-hook Subs - All SUT | 06 Subscription Status - Instance</a></p><p><b>version</b>: 1.0.0-ballot</p><p><b>name</b>: Test_06_Subscription_Status_Instance</p><p><b>title</b>: 04 Basic REST-hook Subs - All SUT | 06 Subscription Status - Instance</p><p><b>status</b>: Active</p><p><b>date</b>: 2026-03-30</p><p><b>publisher</b>: HL7 International / Community Based Collaborative Care</p><p><b>contact</b>: HL7 International / Community Based Collaborative Care: <a href=\"http://www.hl7.org/Special/committees/cbcc\">http://www.hl7.org/Special/committees/cbcc</a></p><p><b>description</b>: </p><div><p>Happy Path: Perform successful Subscription/[id]/$status operations.\nTest a client and server to verify support for the Subscription $status\ninstance operation.\nTest case supporting the FAST Consent Management IG Version: CI.\nSee https://wildfhir4.wildfhir.org/ig/fhir-consent-management-tg/rtm_test_cases.html#testcase-266\nTest System Details (in order of appearance):\n[Origin 1: Consent Client's RESTful client. System Under Test: this must be an external test system (not Touchstone).]\n[Destination 1: Consent Admin Service's RESTful FHIR Server. System Under Test: this must be an external test system (not a mock).]</p>\n</div><p><b>jurisdiction</b>: <span title=\"Codes:{urn:iso:std:iso:3166 US}\">United States of America</span></p><p><b>copyright</b>: </p><div><p>(c) AEGIS.net, Inc. 2026</p>\n</div><h3>Origins</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Index</b></td><td><b>Profile</b></td></tr><tr><td style=\"display: none\">*</td><td>1</td><td><a href=\"http://terminology.hl7.org/7.1.0/CodeSystem-testscript-profile-origin-types.html#testscript-profile-origin-types-FHIR-Client\">Test script profile origin type: FHIR-Client</a> (FHIR Client)</td></tr></table><h3>Destinations</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Index</b></td><td><b>Profile</b></td></tr><tr><td style=\"display: none\">*</td><td>1</td><td><a href=\"http://terminology.hl7.org/7.1.0/CodeSystem-testscript-profile-destination-types.html#testscript-profile-destination-types-FHIR-Server\">Test script profile destination type: FHIR-Server</a> (FHIR Server)</td></tr></table><h3>Variables</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Name</b></td><td><b>Description</b></td><td><b>Hint</b></td></tr><tr><td style=\"display: none\">*</td><td>dest-1-FHIRExtendedOperation-1-needed-Subscription_id</td><td>Consent Admin Service's Id of Subscription to use, available at Destination 1.</td><td>[Enter Consent Admin Service's Id of Subscription to use, available at Destination 1]</td></tr></table><blockquote><p><b>test</b></p><p><b>name</b>: Step_001_Subscription_slash_id_slash_dollar_status_operation</p><p><b>description</b>: Consent Client invokes the Subscription/[id]/$status operation at Consent Admin Service.</p><blockquote><p><b>action</b></p><h3>Operations</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Type</b></td><td><b>Resource</b></td><td><b>Description</b></td><td><b>Destination</b></td><td><b>EncodeRequestUrl</b></td><td><b>Method</b></td><td><b>Origin</b></td><td><b>Params</b></td><td><b>RequestId</b></td><td><b>ResponseId</b></td></tr><tr><td style=\"display: none\">*</td><td>testscript-operation-codes-extended: post (post)</td><td>Subscription</td><td>Subscription/[id]/$status operation.</td><td>1</td><td>true</td><td>POST</td><td>1</td><td>/${dest-1-FHIRExtendedOperation-1-needed-Subscription_id}/$status</td><td>dest-1-FHIRExtendedOperation-1-request</td><td>dest-1-FHIRExtendedOperation-1-response</td></tr></table></blockquote></blockquote></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cbcc"
    }
  ],
  "url" : "http://hl7.org/fhir/us/consent-management-tg/TestScript/06-Subscription-Status-Instance",
  "version" : "1.0.0-ballot",
  "name" : "Test_06_Subscription_Status_Instance",
  "title" : "04 Basic REST-hook Subs - All SUT | 06 Subscription Status - Instance",
  "status" : "active",
  "date" : "2026-03-30",
  "publisher" : "HL7 International / Community Based Collaborative Care",
  "contact" : [
    {
      "name" : "HL7 International / Community Based Collaborative Care",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cbcc"
        }
      ]
    }
  ],
  "description" : "Happy Path: Perform successful Subscription/[id]/$status operations.\r\nTest a client and server to verify support for the Subscription $status\r\ninstance operation.\r\nTest case supporting the FAST Consent Management IG Version: CI.\r\nSee https://wildfhir4.wildfhir.org/ig/fhir-consent-management-tg/rtm_test_cases.html#testcase-266\r\n Test System Details (in order of appearance):\r\n [Origin 1: Consent Client's RESTful client. System Under Test: this must be an external test system (not Touchstone).]\r\n [Destination 1: Consent Admin Service's RESTful FHIR Server. System Under Test: this must be an external test system (not a mock).]",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "copyright" : "(c) AEGIS.net, Inc. 2026",
  "origin" : [
    {
      "index" : 1,
      "profile" : {
        "system" : "http://terminology.hl7.org/CodeSystem/testscript-profile-origin-types",
        "code" : "FHIR-Client"
      }
    }
  ],
  "destination" : [
    {
      "index" : 1,
      "profile" : {
        "system" : "http://terminology.hl7.org/CodeSystem/testscript-profile-destination-types",
        "code" : "FHIR-Server"
      }
    }
  ],
  "variable" : [
    {
      "name" : "dest-1-FHIRExtendedOperation-1-needed-Subscription_id",
      "description" : "Consent Admin Service's Id of Subscription to use, available at Destination 1.",
      "hint" : "[Enter Consent Admin Service's Id of Subscription to use, available at Destination 1]"
    }
  ],
  "test" : [
    {
      "name" : "Step_001_Subscription_slash_id_slash_dollar_status_operation",
      "description" : "Consent Client invokes the Subscription/[id]/$status operation at Consent Admin Service.",
      "action" : [
        {
          "operation" : {
            "type" : {
              "system" : "http://touchstone.com/fhir/testscript-operation-codes-extended",
              "code" : "post"
            },
            "resource" : "Subscription",
            "description" : "Subscription/[id]/$status operation.",
            "destination" : 1,
            "encodeRequestUrl" : true,
            "method" : "post",
            "origin" : 1,
            "params" : "/${dest-1-FHIRExtendedOperation-1-needed-Subscription_id}/$status",
            "requestId" : "dest-1-FHIRExtendedOperation-1-request",
            "responseId" : "dest-1-FHIRExtendedOperation-1-response"
          }
        }
      ]
    }
  ]
}