Testscript-example-search

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example TestScript/testscript-example-search (Narrative)

FHIR Infrastructure Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: No defined compartments

This is the narrative for the resource. See also the XML, JSON or Turtle format. This example conforms to the profile TestScript.

Generated Narrative: TestScript

Resource TestScript "testscript-example-search"

url: http://hl7.org/fhir/TestScript/testscript-example-search

identifier: id: urn:oid:2.16.840.1.113883.4.642.12.3

version: 1.0

name: TestScriptExampleSearch

title: TestScript Example Search

status: draft

experimental: true

date: 2017-01-18

publisher: HL7

contact: Support: support@HL7.org

description: 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: United States of America (the) (ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code#US)

purpose: Patient Search Operation

copyright: © HL7.org 2011+

metadata
Links
- Url Description
* http://hl7.org/fhir/patient.html Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Capabilities
- Required Validated Description Link Capabilities
* true false Patient Search Operation http://hl7.org/fhir/http.html#search http://hl7.org/fhir/CapabilityStatement/example

Fixtures

Autocreate

Autodelete

Resource

false

Patient/example: Peter Chalmers "Peter CHALMERS"

profile: Bundle

variable
name: PatientCreateLocation
headerField: Location
sourceId: PatientCreateResponse

variable
name: PatientSearchFamilyName
description: Enter patient search criteria for a known family name on the target system
hint: [Family name]

variable
name: PatientSearchGivenName
description: Enter patient search criteria for a known given name on the target system
hint: [Given name]

variable
name: PatientSearchBundleTotal
description: Evaluate the returned Patient searchset Bundle.total value
expression: Bundle.total.toInteger()

setup
action
Operations
- Type Resource Description Accept EncodeRequestUrl Params
* search (Details: http://hl7.org/fhir/restful-interaction code search = 'search', stated as 'null') Patient Test simple search to verify server support. xml true ?family=DONTEXPECTAMATCH&given=DONTEXPECTAMATCH
action
Asserts
- Description Direction Operator RequestURL StopTestOnFail WarningOnly
* Confirm that the request url contains the family search parameter. request contains family false false
action
Asserts
- Description Direction ResponseCode StopTestOnFail WarningOnly
* Confirm that the returned HTTP status is 200(OK). response 200 false false
action
Asserts
- Description Resource StopTestOnFail WarningOnly
* Confirm that the returned resource type is Bundle. Bundle false false
action
Asserts
- Description NavigationLinks StopTestOnFail WarningOnly
* Confirm that the returned Bundle correctly defines the navigation links. true false false

test
name: Patient Create Search
description: 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
Operations
- Type Resource Description Accept ContentType EncodeRequestUrl ResponseId SourceId
* create (Details: http://hl7.org/fhir/restful-interaction code create = 'create', stated as 'null') Patient Create a Patient resource and capture the returned HTTP Header Location. xml xml true PatientCreateResponse fixture-patient-create
action
Asserts
- Description Response StopTestOnFail WarningOnly
* Confirm that the returned HTTP status is 201(Created). created false false
action
Asserts
- Description Direction HeaderField Operator StopTestOnFail WarningOnly
* Confirm that the returned HTTP Header Location is present. response Location notEmpty false false
action
Operations
- Type Description Accept EncodeRequestUrl Url
* read (Details: http://hl7.org/fhir/restful-interaction code read = 'read', stated as 'null') Read the created Patient using the captured Location URL value. xml true ${PatientCreateLocation}
action
Asserts
- Description Response StopTestOnFail WarningOnly
* Confirm that the returned HTTP status is 200(OK). okay false false
action
Asserts
- Description Resource StopTestOnFail WarningOnly
* Confirm that the returned resource type is Patient. Patient false false

test
name: Patient Search Dynamic
description: Search for Patient resources using the user defined dynamic variables ${PatientSearchFamilyName} and ${PatientSearchGivenName} and validate response.
action
Operations
- Type Resource Description Accept EncodeRequestUrl Params
* search (Details: http://hl7.org/fhir/restful-interaction code search = 'search', stated as 'null') Patient Search for Patient resources on the destination test system. xml true ?family=${PatientSearchFamilyName}&given=${PatientSearchGivenName}
action
Asserts
- Description Response StopTestOnFail WarningOnly
* Confirm that the returned HTTP status is 200(OK). okay false false
action
Asserts
- Description ContentType StopTestOnFail WarningOnly
* Confirm that the returned format is XML. xml false false
action
Asserts
- Description Resource StopTestOnFail WarningOnly
* Confirm that the returned resource type is Bundle. Bundle true false
action
Asserts
- Description StopTestOnFail ValidateProfileId WarningOnly
* Confirm that the returned Bundle conforms to the base FHIR specification. false bundle-profile false
action
Asserts
- Description Operator Path StopTestOnFail Value WarningOnly
* Confirm that the returned Bundle type equals 'searchset'. equals fhir:Bundle/fhir:type/@value false searchset false
action
Asserts
- Description Expression StopTestOnFail WarningOnly
* Confirm that the returned Bundle total is greater than or equal to the number of returned entries. Bundle.total.toInteger() >= entry.count() false false

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.