This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
Raw XML (canonical form + also see XML Format Specification)
Search TestScript Example (id = "testscript-example-search")
<?xml version="1.0" encoding="UTF-8"?> <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: TestScript</b><a name="testscript-example-search"></a></p><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">Resource TestScript "testscript-example-search" </p></div><p ><b >url</b>: <code >http://hl7.org/fhir/TestScript/testscript-example-search</code></p><p ><b >identifier</b>: id: urn:oid:2.16.840.1.113883.4.642.12.3</p><p ><b >version</b>: 1.0</p><p ><b >name</b>: TestScriptExampleSearch</p><p ><b >title</b>: TestScript Example Search</p><p ><b >status</b>: draft</p><p ><b >experimental</b>: true</p><p ><b >date</b>: 2017年01月18日</p><p ><b >publisher</b>: HL7</p><p ><b >contact</b>: Support: <a href="mailto:support@HL7.org">support@HL7.org</a></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 style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.1.0/CodeSystem-ISO3166Part1.html">ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code</a>#US)</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 >Links</h3><table class="grid"><tr ><td >-</td><td ><b >Url</b></td><td ><b >Description</b></td></tr><tr ><td >*</td><td ><a href="http://hl7.org/fhir/patient.html">http://hl7.org/fhir/patient.html</a></td><td >Demographics and other administrative information about an individual or animal receiving care or other health-related services.</td></tr></table><h3 >Capabilities</h3><table class="grid"><tr ><td >-</td><td ><b >Required</b></td><td ><b >Validated</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 >false</td><td >Patient Search Operation</td><td ><a href="http://hl7.org/fhir/http.html#search">http://hl7.org/fhir/http.html#search</a></td><td ><a href="http://hl7.org/fhir/CapabilityStatement/example">http://hl7.org/fhir/CapabilityStatement/example</a></td></tr></table></blockquote><h3 >Fixtures</h3><table class="grid"><tr ><td >-</td><td ><b >Autocreate</b></td><td ><b >Autodelete</b></td><td ><b >Resource</b></td></tr><tr ><td >*</td><td >false</td><td >false</td><td ><a href="patient-example.html">Patient/example: Peter Chalmers</a> "Peter CHALMERS"</td></tr></table><p ><b >profile</b>: <a href="bundle.html">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 >variable</b></p><p ><b >name</b>: PatientSearchBundleTotal</p><p ><b >description</b>: Evaluate the returned Patient searchset Bundle.total value</p><p ><b >expression</b>: Bundle.total.toInteger()</p></blockquote><blockquote ><p ><b >setup</b></p><blockquote ><p ><b >action</b></p><h3 >Operations</h3><table class="grid"><tr ><td >-</td><td ><b >Type</b></td><td ><b >Resource</b></td><td ><b >Description</b></td><td ><b >Accept</b></td><td ><b >EncodeRequestUrl</b></td><td ><b >Params</b></td></tr><tr ><td >*</td><td >search (Details: http://hl7.org/fhir/restful-interaction code search = 'search', stated as 'null')</td><td ><a href="patient.html">Patient</a></td><td >Test simple search to verify server support.</td><td >xml</td><td >true</td><td >?family=DONTEXPECTAMATCH&given=DONTEXPECTAMATCH</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >Direction</b></td><td ><b >Operator</b></td><td ><b >RequestURL</b></td><td ><b >StopTestOnFail</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the request url contains the family search parameter.</td><td >request</td><td >contains</td><td >family</td><td >false</td><td >false</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >Direction</b></td><td ><b >ResponseCode</b></td><td ><b >StopTestOnFail</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned HTTP status is 200(OK).</td><td >response</td><td >200</td><td >false</td><td >false</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >Resource</b></td><td ><b >StopTestOnFail</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned resource type is Bundle.</td><td ><a href="bundle.html">Bundle</a></td><td >false</td><td >false</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >NavigationLinks</b></td><td ><b >StopTestOnFail</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned Bundle correctly defines the navigation links.</td><td >true</td><td >false</td><td >false</td></tr></table></blockquote></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 class="grid"><tr ><td >-</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 >EncodeRequestUrl</b></td><td ><b >ResponseId</b></td><td ><b >SourceId</b></td></tr><tr ><td >*</td><td >create (Details: http://hl7.org/fhir/restful-interaction code create = 'create', stated as 'null')</td><td ><a href="patient.html">Patient</a></td><td >Create a Patient resource and capture the returned HTTP Header Location.</td><td >xml</td><td >xml</td><td >true</td><td >PatientCreateResponse</td><td >fixture-patient-create</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >Response</b></td><td ><b >StopTestOnFail</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned HTTP status is 201(Created).</td><td >created</td><td >false</td><td >false</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >Direction</b></td><td ><b >HeaderField</b></td><td ><b >Operator</b></td><td ><b >StopTestOnFail</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned HTTP Header Location is present.</td><td >response</td><td >Location</td><td >notEmpty</td><td >false</td><td >false</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Operations</h3><table class="grid"><tr ><td >-</td><td ><b >Type</b></td><td ><b >Description</b></td><td ><b >Accept</b></td><td ><b >EncodeRequestUrl</b></td><td ><b >Url</b></td></tr><tr ><td >*</td><td >read (Details: http://hl7.org/fhir/restful-interaction code read = 'read', stated as 'null')</td><td >Read the created Patient using the captured Location URL value.</td><td >xml</td><td >true</td><td >${PatientCreateLocation}</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >Response</b></td><td ><b >StopTestOnFail</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned HTTP status is 200(OK).</td><td >okay</td><td >false</td><td >false</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >Resource</b></td><td ><b >StopTestOnFail</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned resource type is Patient.</td><td ><a href="patient.html">Patient</a></td><td >false</td><td >false</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 ${PatientSearchFamily Name} and ${PatientSearchGivenName} and validate response.</p><blockquote ><p ><b >action</b></p><h3 >Operations</h3><table class="grid"><tr ><td >-</td><td ><b >Type</b></td><td ><b >Resource</b></td><td ><b >Description</b></td><td ><b >Accept</b></td><td ><b >EncodeRequestUrl</b></td><td ><b >Params</b></td></tr><tr ><td >*</td><td >search (Details: http://hl7.org/fhir/restful-interaction code search = 'search', stated as 'null')</td><td ><a href="patient.html">Patient</a></td><td >Search for Patient resources on the destination test system.</td><td >xml</td><td >true</td><td >?family=${PatientSearchFamilyName}&given=${PatientSearchGivenName}</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >Response</b></td><td ><b >StopTestOnFail</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned HTTP status is 200(OK).</td><td >okay</td><td >false</td><td >false</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >ContentType</b></td><td ><b >StopTestOnFail</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned format is XML.</td><td >xml</td><td >false</td><td >false</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >Resource</b></td><td ><b >StopTestOnFail</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned resource type is Bundle.</td><td ><a href="bundle.html">Bundle</a></td><td >true</td><td >false</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >StopTestOnFail</b></td><td ><b >ValidateProfileId</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned Bundle conforms to the base FHIR specification.</td><td >false</td><td >bundle-profile</td><td >false</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >Operator</b></td><td ><b >Path</b></td><td ><b >StopTestOnFail</b></td><td ><b >Value</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned Bundle type equals 'searchset'.</td><td >equals</td><td >fhir:Bundle/fhir:type/@value</td><td >false</td><td >searchset</td><td >false</td></tr></table></blockquote><blockquote ><p ><b >action</b></p><h3 >Asserts</h3><table class="grid"><tr ><td >-</td><td ><b >Description</b></td><td ><b >Expression</b></td><td ><b >StopTestOnFail</b></td><td ><b >WarningOnly</b></td></tr><tr ><td >*</td><td >Confirm that the returned Bundle total is greater than or equal to the number of returned entries.</td><td >Bundle.total.toInteger() >= entry.count()</td><td >false</td><td >false</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:2.16.840.1.113883.4.642.12.3"/></identifier><version value="1.0"/><name value="TestScriptExampleSearch"/><title value="TestScript Example Search"/><status value="draft"/><experimental value="true"/><date value="2017年01月18日"/><publisher value="HL7"/><contact ><name value="Support"/><telecom ><system value="email"/><value value="support@HL7.org"/><use value="work"/></telecom></contact><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 ><link ><url value="http://hl7.org/fhir/patient.html"/><description value="Demographics and other administrative information about an individual or animal receiving care or other health-related services."/></link><capability ><required value="true"/><validated value="false"/><description value="Patient Search Operation"/><link value="http://hl7.org/fhir/http.html#search"/><capabilities value="http://hl7.org/fhir/CapabilityStatement/example"/></capability></metadata><fixture id="fixture-patient-create"><autocreate value="false"/><autodelete value="false"/><resource ><reference value="Patient/example "/><display value="Peter Chalmers"/></resource></fixture><profile id="bundle-profile" value="http://hl7.org/fhir/StructureDefinition/Bundle"/><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><variable ><name value="PatientSearchBundleTotal"/><description value="Evaluate the returned Patient searchset Bundle.total value"/><expression value="Bundle.total.toInteger()"/></variable><setup ><action ><operation ><type ><system value="http://hl7.org/fhir/restful-interaction"/><code value="search"/></type><resource value="Patient"/><description value="Test simple search to verify server support."/><accept value="xml"/><encodeRequestUrl value="true"/><params value="?family=DONTEXPECTAMATCH&given=DONTEXPECTAMATCH"/></operation></action><action ><assert ><description value="Confirm that the request url contains the family search parameter."/><direction value="request"/><operator value="contains"/><requestURL value="family"/><stopTestOnFail value="false"/><warningOnly value="false"/></assert></action><action ><assert ><description value="Confirm that the returned HTTP status is 200(OK)."/><direction value="response"/><responseCode value="200"/><stopTestOnFail value="false"/><warningOnly value="false"/></assert></action><action ><assert ><description value="Confirm that the returned resource type is Bundle."/><resource value="Bundle"/><stopTestOnFail value="false"/><warningOnly value="false"/></assert></action><action ><assert ><description value="Confirm that the returned Bundle correctly defines the navigation links."/><navigationLinks value="true"/><stopTestOnFail value="false"/><warningOnly value="false"/></assert></action></setup><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/restful-interaction"/><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"/><encodeRequestUrl value="true"/><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"/><stopTestOnFail value="false"/><warningOnly value="false"/></assert></action><action ><assert ><description value="Confirm that the returned HTTP Header Location is present."/><direction value="response"/><headerField value="Location"/><operator value="notEmpty"/><stopTestOnFail value="false"/><warningOnly value="false"/></assert></action><action ><operation ><type ><system value="http://hl7.org/fhir/restful-interaction"/><code value="read"/></type><description value="Read the created Patient using the captured Location URL value."/><accept value="xml"/><encodeRequestUrl value="true"/><url value="${PatientCreateLocation}"/></operation></action><action ><assert ><description value="Confirm that the returned HTTP status is 200(OK)."/><response value="okay"/><stopTestOnFail value="false"/><warningOnly value="false"/></assert></action><action ><assert ><description value="Confirm that the returned resource type is Patient."/><resource value="Patient"/><stopTestOnFail value="false"/><warningOnly value="false"/></assert></action></test><test id="02-PatientSearchDynamic"><name value="Patient Search Dynamic"/><description value="Search for Patient resources using the user defined dynamic variables ${PatientSearchFamilyNa me} and ${PatientSearchGivenName} and validate response."/><action ><operation ><type ><system value="http://hl7.org/fhir/restful-interaction"/><code value="search"/></type><resource value="Patient"/><description value="Search for Patient resources on the destination test system."/><accept value="xml"/><encodeRequestUrl value="true"/><params value="?family=${PatientSearchFamilyName}&given=${PatientSearchGivenName}"/></operation></action><action ><assert ><description value="Confirm that the returned HTTP status is 200(OK)."/><response value="okay"/><stopTestOnFail value="false"/><warningOnly value="false"/></assert></action><action ><assert ><description value="Confirm that the returned format is XML."/><contentType value="xml"/><stopTestOnFail value="false"/><warningOnly value="false"/></assert></action><action ><assert ><description value="Confirm that the returned resource type is Bundle."/><resource value="Bundle"/><stopTestOnFail value="true"/><warningOnly value="false"/></assert></action><action ><assert ><description value="Confirm that the returned Bundle conforms to the base FHIR specification."/><stopTestOnFail value="false"/><validateProfileId value="bundle-profile"/><warningOnly value="false"/></assert></action><action ><assert ><description value="Confirm that the returned Bundle type equals 'searchset'."/><operator value="equals"/><path value="fhir:Bundle/fhir:type/@value"/><stopTestOnFail value="false"/><value value="searchset"/><warningOnly value="false"/></assert></action><action ><assert ><description value="Confirm that the returned Bundle total is greater than or equal to the number of returned entries."/><expression value="Bundle.total.toInteger() >= entry.count()"/><stopTestOnFail value="false"/><warningOnly value="false"/></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.