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

Scalable Consent Management Testing Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: FAST Consent fileConsent JSON - JSON Representation

Page standards status: Trial-use Maturity Level: 1

Raw json | Download

{
  "resourceType" : "TestScript",
  "id" : "fastconsentfileconsentjson",
  "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 fastconsentfileconsentjson</b></p><a name=\"fastconsentfileconsentjson\"> </a><a name=\"hcfastconsentfileconsentjson\"> </a><a name=\"fastconsentfileconsentjson-en-US\"> </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-fastconsentfileconsentjson.html\">TestScript FAST Consent fileConsent JSON</a></p><p><b>version</b>: 0.1.0</p><p><b>name</b>: FASTConsentFileConsentJSON</p><p><b>title</b>: FAST Consent fileConsent JSON</p><p><b>status</b>: Active</p><p><b>date</b>: 2025-05-22</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>Test a FAST Consent Management Server implementation of the $fileConsent operation using JSON Format</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) HL7 International / Community Based Collaborative Care 2025</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/6.3.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/6.3.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><blockquote><p><b>fixture</b></p><blockquote><p><b>id</b></p>fileconsent-parameters</blockquote><p><b>autocreate</b>: false</p><p><b>autodelete</b>: false</p><p><b>resource</b>: <code>./Parameters-fileconsent.json</code></p></blockquote><p><b>profile</b>: </p><ul><li><a href=\"file://D:\\GitHub\\HL7\\fhir-consent-management\\output/StructureDefinition-fileConsentParameters.html\">http://hl7.org/fhir/us/consent-management/StructureDefinition/fileConsentParameters</a></li><li><a href=\"http://hl7.org/fhir/R4/operationoutcome.html\">http://hl7.org/fhir/StructureDefinition/OperationOutcome</a></li></ul><h3>Variables</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Name</b></td><td><b>Expression</b></td><td><b>SourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>createConsentIdentifier</td><td>Parameters.parameter.where(name = 'consent').resource.identifier[0].value</td><td>fileconsent-parameters</td></tr></table><blockquote><p><b>test</b></p><blockquote><p><b>id</b></p>FASTConsentFileConsentJSON</blockquote><p><b>name</b>: FASTConsentFileConsentJSON</p><p><b>description</b>: Test a FAST Consent Management Server implementation of the $fileConsent operation using JSON Format against the destination server and assert successful response.</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>Accept</b></td><td><b>ContentType</b></td><td><b>Destination</b></td><td><b>EncodeRequestUrl</b></td><td><b>Origin</b></td><td><b>Params</b></td><td><b>SourceId</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"http://terminology.hl7.org/6.3.0/CodeSystem-testscript-operation-codes.html#testscript-operation-codes-fileConsent\">Test script operation code fileConsent</a>: fileConsent</td><td>Consent</td><td>Send a Consent $fileConsent operation</td><td>json</td><td>json</td><td>1</td><td>true</td><td>1</td><td>/$fileConsent</td><td>fileconsent-parameters</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Description</b></td><td><b>Direction</b></td><td><b>Resource</b></td><td><b>WarningOnly</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>Confirm that the sent request payload is a Parameters resource.</td><td>request</td><td>Parameters</td><td>true</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Description</b></td><td><b>Direction</b></td><td><b>ValidateProfileId</b></td><td><b>WarningOnly</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>Confirm that the sent Parameters conforms to the FAST Consent profile.</td><td>request</td><td>fileConsentParametersProfile</td><td>false</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Description</b></td><td><b>Direction</b></td><td><b>ResponseCode</b></td><td><b>WarningOnly</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>Confirm that the returned response code is 200 OK.</td><td>response</td><td>200</td><td>false</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Description</b></td><td><b>Direction</b></td><td><b>Resource</b></td><td><b>WarningOnly</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>Confirm that the returned response payload is an OperationOutcome resource.</td><td>response</td><td>OperationOutcome</td><td>true</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Description</b></td><td><b>Direction</b></td><td><b>ValidateProfileId</b></td><td><b>WarningOnly</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>Confirm that the returned OperationOutcome conforms to the base FHIR specification.</td><td>response</td><td>OperationOutcomeProfile</td><td>true</td></tr></table></blockquote></blockquote><blockquote><p><b>test</b></p><blockquote><p><b>id</b></p>FASTConsentSearchJSON</blockquote><p><b>name</b>: FASTConsentSearchJSON</p><p><b>description</b>: Test a FAST Consent Management Server to confirm successful creation of Consent from previous $fileConsent operation.</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>Accept</b></td><td><b>ContentType</b></td><td><b>Destination</b></td><td><b>EncodeRequestUrl</b></td><td><b>Origin</b></td><td><b>Params</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"http://terminology.hl7.org/6.3.0/CodeSystem-testscript-operation-codes.html#testscript-operation-codes-search\">Test script operation code search</a>: Search</td><td>Consent</td><td>Search for Consent from $fileConsent operation</td><td>json</td><td>json</td><td>1</td><td>true</td><td>1</td><td>?identifier=${createConsentIdentifier}</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Description</b></td><td><b>Direction</b></td><td><b>ResponseCode</b></td><td><b>WarningOnly</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>Confirm that the returned response code is 200 OK.</td><td>response</td><td>200</td><td>false</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Description</b></td><td><b>Direction</b></td><td><b>Resource</b></td><td><b>WarningOnly</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>Confirm that the returned response payload is a Bundle resource.</td><td>response</td><td>Bundle</td><td>true</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Description</b></td><td><b>Direction</b></td><td><b>Path</b></td><td><b>Value</b></td><td><b>WarningOnly</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>Confirm that the returned response payload is a searchset Bundle resource.</td><td>response</td><td>.type</td><td>searchset</td><td>true</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Description</b></td><td><b>Direction</b></td><td><b>Expression</b></td><td><b>Value</b></td><td><b>WarningOnly</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>Confirm that the returned searchset Bundle contains 1 match.</td><td>response</td><td>Bundle.entry.resource.count()</td><td>1</td><td>true</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Description</b></td><td><b>Direction</b></td><td><b>Expression</b></td><td><b>WarningOnly</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>Confirm that the returned searchset Bundle contains a Consent resource.</td><td>response</td><td>Bundle.entry.resource.as(Consent).exists()</td><td>true</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Description</b></td><td><b>Direction</b></td><td><b>Expression</b></td><td><b>Value</b></td><td><b>WarningOnly</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>Confirm that the returned searchset Bundle contains the created Consent resource.</td><td>response</td><td>Bundle.entry.resource.as(Consent).identifier[0].value</td><td>${createConsentIdentifier}</td><td>true</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/fastconsentfileconsentjson",
  "version" : "0.1.0",
  "name" : "FASTConsentFileConsentJSON",
  "title" : "FAST Consent fileConsent JSON",
  "status" : "active",
  "date" : "2025-05-22",
  "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" : "Test a FAST Consent Management Server implementation of the $fileConsent operation using JSON Format",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "copyright" : "(c) HL7 International / Community Based Collaborative Care 2025",
  "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"
      }
    }
  ],
  "fixture" : [
    {
      "id" : "fileconsent-parameters",
      "autocreate" : false,
      "autodelete" : false,
      "resource" : {
        "reference" : "./Parameters-fileconsent.json"
      }
    }
  ],
  "profile" : [
    {
      🔗 "id" : "fileConsentParametersProfile",
      "reference" : "http://hl7.org/fhir/us/consent-management/StructureDefinition/fileConsentParameters"
    },
    {
      🔗 "id" : "OperationOutcomeProfile",
      "reference" : "http://hl7.org/fhir/StructureDefinition/OperationOutcome"
    }
  ],
  "variable" : [
    {
      "name" : "createConsentIdentifier",
      "expression" : "Parameters.parameter.where(name = 'consent').resource.identifier[0].value",
      "sourceId" : "fileconsent-parameters"
    }
  ],
  "test" : [
    {
      "id" : "FASTConsentFileConsentJSON",
      "name" : "FASTConsentFileConsentJSON",
      "description" : "Test a FAST Consent Management Server implementation of the $fileConsent operation using JSON Format against the destination server and assert successful response.",
      "action" : [
        {
          "operation" : {
            "type" : {
              "system" : "http://terminology.hl7.org/CodeSystem/testscript-operation-codes",
              "code" : "fileConsent"
            },
            "resource" : "Consent",
            "description" : "Send a Consent $fileConsent operation",
            "accept" : "json",
            "contentType" : "json",
            "destination" : 1,
            "encodeRequestUrl" : true,
            "origin" : 1,
            "params" : "/$fileConsent",
            "sourceId" : "fileconsent-parameters"
          }
        },
        {
          "assert" : {
            "extension" : [
              {
                "url" : "http://touchstone.aegis.net/touchstone/fhir/testing/StructureDefinition/testscript-assert-stopTestOnFail",
                "valueBoolean" : false
              }
            ],
            "description" : "Confirm that the sent request payload is a Parameters resource.",
            "direction" : "request",
            "resource" : "Parameters",
            "warningOnly" : true
          }
        },
        {
          "assert" : {
            "extension" : [
              {
                "url" : "http://touchstone.aegis.net/touchstone/fhir/testing/StructureDefinition/testscript-assert-stopTestOnFail",
                "valueBoolean" : false
              }
            ],
            "description" : "Confirm that the sent Parameters conforms to the FAST Consent profile.",
            "direction" : "request",
            "validateProfileId" : "fileConsentParametersProfile",
            "warningOnly" : false
          }
        },
        {
          "assert" : {
            "extension" : [
              {
                "url" : "http://touchstone.aegis.net/touchstone/fhir/testing/StructureDefinition/testscript-assert-stopTestOnFail",
                "valueBoolean" : false
              }
            ],
            "description" : "Confirm that the returned response code is 200 OK.",
            "direction" : "response",
            "responseCode" : "200",
            "warningOnly" : false
          }
        },
        {
          "assert" : {
            "extension" : [
              {
                "url" : "http://touchstone.aegis.net/touchstone/fhir/testing/StructureDefinition/testscript-assert-stopTestOnFail",
                "valueBoolean" : false
              }
            ],
            "description" : "Confirm that the returned response payload is an OperationOutcome resource.",
            "direction" : "response",
            "resource" : "OperationOutcome",
            "warningOnly" : true
          }
        },
        {
          "assert" : {
            "extension" : [
              {
                "url" : "http://touchstone.aegis.net/touchstone/fhir/testing/StructureDefinition/testscript-assert-stopTestOnFail",
                "valueBoolean" : false
              }
            ],
            "description" : "Confirm that the returned OperationOutcome conforms to the base FHIR specification.",
            "direction" : "response",
            "validateProfileId" : "OperationOutcomeProfile",
            "warningOnly" : true
          }
        }
      ]
    },
    {
      "id" : "FASTConsentSearchJSON",
      "name" : "FASTConsentSearchJSON",
      "description" : "Test a FAST Consent Management Server to confirm successful creation of Consent from previous $fileConsent operation.",
      "action" : [
        {
          "operation" : {
            "type" : {
              "system" : "http://terminology.hl7.org/CodeSystem/testscript-operation-codes",
              "code" : "search"
            },
            "resource" : "Consent",
            "description" : "Search for Consent from $fileConsent operation",
            "accept" : "json",
            "contentType" : "json",
            "destination" : 1,
            "encodeRequestUrl" : true,
            "origin" : 1,
            "params" : "?identifier=${createConsentIdentifier}"
          }
        },
        {
          "assert" : {
            "extension" : [
              {
                "url" : "http://touchstone.aegis.net/touchstone/fhir/testing/StructureDefinition/testscript-assert-stopTestOnFail",
                "valueBoolean" : false
              }
            ],
            "description" : "Confirm that the returned response code is 200 OK.",
            "direction" : "response",
            "responseCode" : "200",
            "warningOnly" : false
          }
        },
        {
          "assert" : {
            "extension" : [
              {
                "url" : "http://touchstone.aegis.net/touchstone/fhir/testing/StructureDefinition/testscript-assert-stopTestOnFail",
                "valueBoolean" : false
              }
            ],
            "description" : "Confirm that the returned response payload is a Bundle resource.",
            "direction" : "response",
            "resource" : "Bundle",
            "warningOnly" : true
          }
        },
        {
          "assert" : {
            "extension" : [
              {
                "url" : "http://touchstone.aegis.net/touchstone/fhir/testing/StructureDefinition/testscript-assert-stopTestOnFail",
                "valueBoolean" : false
              }
            ],
            "description" : "Confirm that the returned response payload is a searchset Bundle resource.",
            "direction" : "response",
            "path" : ".type",
            "value" : "searchset",
            "warningOnly" : true
          }
        },
        {
          "assert" : {
            "extension" : [
              {
                "url" : "http://touchstone.aegis.net/touchstone/fhir/testing/StructureDefinition/testscript-assert-stopTestOnFail",
                "valueBoolean" : false
              }
            ],
            "description" : "Confirm that the returned searchset Bundle contains 1 match.",
            "direction" : "response",
            "expression" : "Bundle.entry.resource.count()",
            "value" : "1",
            "warningOnly" : true
          }
        },
        {
          "assert" : {
            "extension" : [
              {
                "url" : "http://touchstone.aegis.net/touchstone/fhir/testing/StructureDefinition/testscript-assert-stopTestOnFail",
                "valueBoolean" : false
              }
            ],
            "description" : "Confirm that the returned searchset Bundle contains a Consent resource.",
            "direction" : "response",
            "expression" : "Bundle.entry.resource.as(Consent).exists()",
            "warningOnly" : true
          }
        },
        {
          "assert" : {
            "extension" : [
              {
                "url" : "http://touchstone.aegis.net/touchstone/fhir/testing/StructureDefinition/testscript-assert-stopTestOnFail",
                "valueBoolean" : false
              }
            ],
            "description" : "Confirm that the returned searchset Bundle contains the created Consent resource.",
            "direction" : "response",
            "expression" : "Bundle.entry.resource.as(Consent).identifier[0].value",
            "value" : "${createConsentIdentifier}",
            "warningOnly" : true
          }
        }
      ]
    }
  ]
}