Release 5 Preview #3
Implementation SupportThis page is part of the FHIR Specification (v4.5.0: R5 Preview #3). 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
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
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</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> : id: 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> date</b> : 2017-01-18</p> <p> <b> publisher</b> : HL7</p> <p> <b> contact</b> : Support: support@HL7.org(WORK)</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> : <span> 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> Links</h3> <table> <tr> <td> -</td> <td> <b> Url</b> </td> <td> <b> Description</b> </td> </tr> <tr> <td> *</td> <td> <a> 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> <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> http://hl7.org/fhir/http.html#search</a> </td> <td> <a> http://hl7.org/fhir/CapabilityStatement/example</a> </td> </tr> </table> </blockquote> <h3> Fixtures</h3> <table> <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> Peter Chalmers. Generated Summary: id: example; Medical record number: 12345 (USUAL); active; Peter James Chalmers (OFFICIAL), Jim , Peter James Windsor (MAIDEN); -unknown-(HOME), ph: (03) 5555 6473(WORK), ph: (03) 3410 5613(MOBILE), ph: (03) 5555 8834(OLD); gender: male; birthDate: 1974-12-25; </a> </td> </tr> </table> <p> <b> profile</b> : <a> Generated Summary: id: Bundle; url: http://hl7.org/fhir/StructureDefinition/Bundle; version: 4.5.0; name: Bundle; ACTIVE; date: 20/08/2020 5:41:31 PM; publisher: Health Level Seven International (FHIR Infrastructure); http://hl7.org/fhir, http://www.hl7.org/Special/committees/fiwg /index.cfm; description: A container for a collection of resources.; 4.5.0; RESOURCE; type: Bundle; baseDefinition: http://hl7.org/fhir/StructureDefinition/Resource; SPECIALIZATION</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> <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> <span> Search</span> </td> <td> Patient</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> <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> 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> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> Direction</b> </td> <td> <b> ResponseCode</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> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> Resource</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> Confirm that the returned resource type is Bundle.</td> <td> Bundle</td> <td> false</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> NavigationLinks</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> </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> <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> <span> Create</span> </td> <td> Patient</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> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> Response</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> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <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> 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> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Operations</h3> <table> <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> <span> Read</span> </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> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> Response</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> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> Resource</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> Confirm that the returned resource type is Patient.</td> <td> Patient</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 ${PatientSearchFamilyName} and ${PatientSearchGivenName} and validate response.</p> <blockquote> <p> <b> action</b> </p> <h3> Operations</h3> <table> <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> <span> Search</span> </td> <td> Patient</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> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> Response</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> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> ContentType</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> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> Resource</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> Confirm that the returned resource type is Bundle.</td> <td> Bundle</td> <td> false</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</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> bundle-profile</td> <td> false</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> Operator</b> </td> <td> <b> Path</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> searchset</td> <td> false</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> Expression</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> </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"/> <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"> <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> <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://terminology.hl7.org/CodeSystem/testscript-operation-codes"/> <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"/> <warningOnly value="false"/> </assert> </action> <action> <assert> <description value="Confirm that the returned HTTP status is 200(OK)."/> <direction value="response"/> <responseCode value="200"/> <warningOnly value="false"/> </assert> </action> <action> <assert> <description value="Confirm that the returned resource type is Bundle."/> <resource value="Bundle"/> <warningOnly value="false"/> </assert> </action> <action> <assert> <description value="Confirm that the returned Bundle correctly defines the navigation links."/> <navigationLinks value="true"/> <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://terminology.hl7.org/CodeSystem/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"/> <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"/> <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"/> <warningOnly value="false"/> </assert> </action> <action> <operation> <type> <system value="http://terminology.hl7.org/CodeSystem/testscript-operation-codes"/> <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"/> <warningOnly value="false"/> </assert> </action> <action> <assert> <description value="Confirm that the returned resource type is Patient."/> <resource value="Patient"/> <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 ${PatientSearchFamilyName} and ${PatientSearchGivenName} and validate response."/> <action> <operation> <type> <system value="http://terminology.hl7.org/CodeSystem/testscript-operation-codes"/> <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"/> <warningOnly value="false"/> </assert> </action> <action> <assert> <description value="Confirm that the returned format is XML."/> <contentType value="xml"/> <warningOnly value="false"/> </assert> </action> <action> <assert> <description value="Confirm that the returned resource type is Bundle."/> <resource value="Bundle"/> <warningOnly value="false"/> </assert> </action> <action> <assert> <description value="Confirm that the returned Bundle conforms to the base FHIR specification."/> <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"/> <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()"/> <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.
FHIR ®© HL7.org 2011+. FHIR R5 Preview #3 hl7.fhir.core#4.5.0 generated on Thu, Aug 20, 2020 17:46+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change