STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Testscript-example-search.xml

Raw XML (canonical form)

Search TestScript Example (id = "testscript-example-search")

<TestScript xmlns="http://hl7.org/fhir">
  <id value="testscript-example-search"/>

  <text><status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: testscript-example-search</p><p><b>url</b>: <a>http://hl7.org/fhir/TestScript/testscript-example-search</a></p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.9881</p><p><b>version</b>: 1.0</p><p><b>name</b>: TestScript Example Search</p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>publisher</b>: HL7</p><p><b>contact</b>: </p><p><b>date</b>: 26/09/2016</p><p><b>description</b>: TestScript example resource with simple Patient search test. The read tests will utilize
         user defined dynamic variables that will hold the Patient search parameter values.</p><p><b>jurisdiction</b>: United States of America (the) <span>(Details : {urn:iso:std:iso:3166 code 'US' = 'US', given as 'United States of America
           (the)'})</span></p><p><b>purpose</b>: Patient Search Operation</p><p><b>copyright</b>: © HL7.org 2011+</p><blockquote><p><b>metadata</b></p><h3>Capabilities</h3><table><tr><td>-</td><td><b>Required</b></td><td><b>Description</b></td><td><b>Link</b></td><td><b>Capabilities</b></td></tr><tr><td>*</td><td>true</td><td>Patient Search Operation</td><td><a>http://hl7.org/fhir/http.html#search</a></td><td><a>CapabilityStatement/example</a></td></tr></table></blockquote><h3>Fixtures</h3><table><tr><td>-</td><td><b>Resource</b></td></tr><tr><td>*</td><td><a>Peter Chalmers</a></td></tr></table><p><b>profile</b>: <a>http://hl7.org/fhir/StructureDefinition/Bundle</a></p><blockquote><p><b>variable</b></p><p><b>name</b>: PatientCreateLocation</p><p><b>headerField</b>: Location</p><p><b>sourceId</b>: PatientCreateResponse</p></blockquote><blockquote><p><b>variable</b></p><p><b>name</b>: PatientSearchFamilyName</p><p><b>description</b>: Enter patient search criteria for a known family name on the target system</p><p><b>hint</b>: [Family name]</p></blockquote><blockquote><p><b>variable</b></p><p><b>name</b>: PatientSearchGivenName</p><p><b>description</b>: Enter patient search criteria for a known given name on the target system</p><p><b>hint</b>: [Given name]</p></blockquote><blockquote><p><b>test</b></p><p><b>name</b>: Patient Create Search</p><p><b>description</b>: Create a Patient resource and capture the returned HTTP Header Location. Then search
           for (read) that Patient using the Location URL value and validate the response.</p><blockquote><p><b>action</b></p><h3>Operations</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Operations</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote></blockquote><blockquote><p><b>test</b></p><p><b>name</b>: Patient Search Dynamic</p><p><b>description</b>: Search for Patient resources using the user defined dynamic variables ${PatientSearchFamilyName}
           and ${PatientSearchGivenName} and validate response.</p><blockquote><p><b>action</b></p><h3>Operations</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote></blockquote></div></text><url value="http://hl7.org/fhir/TestScript/testscript-example-search"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:1.3.6.1.4.1.21367.2005.3.7.9881"/>
  </identifier>
  <version value="1.0"/>
  <name value="TestScript Example Search"/>
  <status value="draft"/>
  <experimental value="true"/>
  <publisher value="HL7"/>
  <contact>
    <name value="Support"/>
    <telecom>
      <system value="email"/>
      <value value="support@HL7.org"/>
      <use value="work"/>
    </telecom>
  </contact>
  <date value="2016-09-26"/>
  <description value="TestScript example resource with simple Patient search test. The read tests will utilize
   user defined dynamic variables that will hold the Patient search parameter values."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America (the)"/>
    </coding>
  </jurisdiction>
  <purpose value="Patient Search Operation"/>
  <copyright value="© HL7.org 2011+"/>

  <metadata>
    <capability>
      <required value="true"/>
      <description value="Patient Search Operation"/>
      <link value="http://hl7.org/fhir/http.html#search"/>
      <link value="http://hl7.org/fhir/patient.html"/>
      <capabilities>
        <reference value="CapabilityStatement/example"/>
      </capabilities>
    </capability>
  </metadata>

  <fixture id="fixture-patient-create">
    <resource>
      <reference value="Patient/example"/>
      <display value="Peter Chalmers"/>
    </resource>
  </fixture>

  <profile id="bundle-profile">
    <reference value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
  </profile>

  <variable>
    <name value="PatientCreateLocation"/>
    <headerField value="Location"/>
    <sourceId value="PatientCreateResponse"/>
  </variable>
  <variable>
    <name value="PatientSearchFamilyName"/>
    <description value="Enter patient search criteria for a known family name on the target system"/>
    <hint value="[Family name]"/>
  </variable>
  <variable>
    <name value="PatientSearchGivenName"/>
    <description value="Enter patient search criteria for a known given name on the target system"/>
    <hint value="[Given name]"/>
  </variable>

  <test id="01-PatientCreateSearch">
    <name value="Patient Create Search"/>
    <description value="Create a Patient resource and capture the returned HTTP Header Location. Then search for
     (read) that Patient using the Location URL value and validate the response."/>
    <action>
      <operation>
        <type>
          <system value="http://hl7.org/fhir/testscript-operation-codes"/>
          <code value="create"/>
        </type>
        <resource value="Patient"/>
        <description value="Create a Patient resource and capture the returned HTTP Header Location."/>
        <accept value="xml"/>
        <contentType value="xml"/>
        <responseId value="PatientCreateResponse"/>
        <sourceId value="fixture-patient-create"/>
      </operation>
    </action>
    <action>
      <assert>
        <description value="Confirm that the returned HTTP status is 201(Created)."/>
        <response value="created"/>
      </assert>
    </action>
    <action>
      <assert>
        <description value="Confirm that the returned HTTP Header Location is present."/>
        <direction value="response"/>
        <headerField value="Location"/>
        <operator value="notEmpty"/>
      </assert>
    </action>

    <action>
      <operation>
        <type>
          <system value="http://hl7.org/fhir/testscript-operation-codes"/>
          <code value="read"/>
        </type>
        <description value="Read the created Patient using the captured Location URL value."/>
        <accept value="xml"/>
        <url value="${PatientCreateLocation}"/>
      </operation>
    </action>
    <action>
      <assert>
        <description value="Confirm that the returned HTTP status is 200(OK)."/>
        <response value="okay"/>
      </assert>
    </action>
    <action>
      <assert>
        <description value="Confirm that the returned resource type is Patient."/>
        <resource value="Patient"/>
      </assert>
    </action>
  </test>

  <test id="02-PatientSearchDynamic">
    <name value="Patient Search Dynamic"/>
    <description value="Search for Patient resources using the user defined dynamic variables ${PatientSearchFamilyName}
     and ${PatientSearchGivenName} and validate response."/>
    <action>
      <operation>
        <type>
          <system value="http://hl7.org/fhir/testscript-operation-codes"/>
          <code value="search"/>
        </type>
        <resource value="Patient"/>
        <description value="Search for Patient resources on the destination test system."/>
        <accept value="xml"/>
        <params value="?family=${PatientSearchFamilyName}&amp;given=${PatientSearchGivenName}"/>
      </operation>
    </action>
    <action>
      <assert>
        <description value="Confirm that the returned HTTP status is 200(OK)."/>
        <response value="okay"/>
      </assert>
    </action>
    <action>
      <assert>
        <description value="Confirm that the returned format is XML."/>
        <contentType value="xml"/>
      </assert>
    </action>
    <action>
      <assert>
        <description value="Confirm that the returned resource type is Bundle."/>
        <resource value="Bundle"/>
      </assert>
    </action>
    <action>
      <assert>
        <description value="Confirm that the returned Bundle conforms to the base FHIR specification."/>
        <validateProfileId value="bundle-profile"/>
      </assert>
    </action>
    <action>
      <assert>
        <description value="Confirm that the returned Bundle type equals 'searchset'."/>
        <operator value="equals"/>
        <path value="fhir:Bundle/fhir:type/@value"/>
        <value value="searchset"/>
      </assert>
    </action>
  </test>
</TestScript>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.