FHIR Release 3 (STU)
Implementation SupportThis page is part of the FHIR Specification (v3.0.2: STU 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 | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
Search TestScript Example
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
<http://hl7.org/fhir/TestScript/testscript-example-search> a fhir:TestScript;
fhir:nodeRole fhir:treeRoot;
fhir:Resource.id [ fhir:value "testscript-example-search"];
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "generated" ];
fhir:Narrative.div "<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>date</b>: 18/01/2017</p><p><b>publisher</b>: HL7</p><p><b>contact</b>: </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' = 'United States', 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>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>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>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>Params</b></td></tr><tr><td>*</td><td>Search (Details: http://hl7.org/fhir/testscript-operation-codes code search = 'Search', stated as 'null')</td><td>Patient</td><td>Test simple search to verify server support.</td><td>xml</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></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></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></tr><tr><td>*</td><td>Confirm that the returned HTTP status is 200(OK).</td><td>response</td><td>200</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></tr><tr><td>*</td><td>Confirm that the returned resource type is Bundle.</td><td>Bundle</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></tr><tr><td>*</td><td>Confirm that the returned Bundle correctly defines the navigation links.</td><td>true</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></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><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote></blockquote></div>"
];
fhir:TestScript.url [ fhir:value "http://hl7.org/fhir/TestScript/testscript-example-search"];
fhir:TestScript.identifier [
fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ];
fhir:Identifier.value [ fhir:value "urn:oid:1.3.6.1.4.1.21367.2005.3.7.9881" ]
];
fhir:TestScript.version [ fhir:value "1.0"];
fhir:TestScript.name [ fhir:value "TestScript Example Search"];
fhir:TestScript.status [ fhir:value "draft"];
fhir:TestScript.experimental [ fhir:value "true"^^xsd:boolean];
fhir:TestScript.date [ fhir:value "2017-01-18"^^xsd:date];
fhir:TestScript.publisher [ fhir:value "HL7"];
fhir:TestScript.contact [
fhir:index 0;
fhir:ContactDetail.name [ fhir:value "Support" ];
fhir:ContactDetail.telecom [
fhir:index 0;
fhir:ContactPoint.system [ fhir:value "email" ];
fhir:ContactPoint.value [ fhir:value "support@HL7.org" ];
fhir:ContactPoint.use [ fhir:value "work" ]
]
];
fhir:TestScript.description [ fhir: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."];
fhir:TestScript.jurisdiction [
fhir:index 0;
fhir:CodeableConcept.coding [
fhir:index 0;
fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ];
fhir:Coding.code [ fhir:value "US" ];
fhir:Coding.display [ fhir:value "United States of America (the)" ]
]
];
fhir:TestScript.purpose [ fhir:value "Patient Search Operation"];
fhir:TestScript.copyright [ fhir:value "© HL7.org 2011+"];
fhir:TestScript.metadata [
fhir:TestScript.metadata.link [
fhir:index 0;
fhir:TestScript.metadata.link.url [ fhir:value "http://hl7.org/fhir/patient.html" ];
fhir:TestScript.metadata.link.description [ fhir:value "Demographics and other administrative information about an individual or animal receiving care or other health-related services." ]
];
fhir:TestScript.metadata.capability [
fhir:index 0;
fhir:TestScript.metadata.capability.required [ fhir:value "true"^^xsd:boolean ];
fhir:TestScript.metadata.capability.description [ fhir:value "Patient Search Operation" ];
fhir:TestScript.metadata.capability.link [
fhir:value "http://hl7.org/fhir/http.html#search";
fhir:index 0
];
fhir:TestScript.metadata.capability.capabilities [
fhir:link <http://hl7.org/fhir/CapabilityStatement/example>;
fhir:Reference.reference [ fhir:value "CapabilityStatement/example" ]
]
]
];
fhir:TestScript.fixture [
fhir:index 0;
fhir:Element.id [ fhir:value "fixture-patient-create" ];
fhir:TestScript.fixture.resource [
fhir:link <http://hl7.org/fhir/Patient/example>;
fhir:Reference.reference [ fhir:value "Patient/example" ];
fhir:Reference.display [ fhir:value "Peter Chalmers" ]
]
];
fhir:TestScript.profile [
fhir:index 0;
fhir:link <http://hl7.org/fhir/StructureDefinition/Bundle>;
fhir:Element.id [ fhir:value "bundle-profile" ];
fhir:Reference.reference [ fhir:value "http://hl7.org/fhir/StructureDefinition/Bundle" ]
];
fhir:TestScript.variable [
fhir:index 0;
fhir:TestScript.variable.name [ fhir:value "PatientCreateLocation" ];
fhir:TestScript.variable.headerField [ fhir:value "Location" ];
fhir:TestScript.variable.sourceId [ fhir:value "PatientCreateResponse" ]
], [
fhir:index 1;
fhir:TestScript.variable.name [ fhir:value "PatientSearchFamilyName" ];
fhir:TestScript.variable.description [ fhir:value "Enter patient search criteria for a known family name on the target system" ];
fhir:TestScript.variable.hint [ fhir:value "[Family name]" ]
], [
fhir:index 2;
fhir:TestScript.variable.name [ fhir:value "PatientSearchGivenName" ];
fhir:TestScript.variable.description [ fhir:value "Enter patient search criteria for a known given name on the target system" ];
fhir:TestScript.variable.hint [ fhir:value "[Given name]" ]
], [
fhir:index 3;
fhir:TestScript.variable.name [ fhir:value "PatientSearchBundleTotal" ];
fhir:TestScript.variable.description [ fhir:value "Evaluate the returned Patient searchset Bundle.total value" ];
fhir:TestScript.variable.expression [ fhir:value "Bundle.total.toInteger()" ]
];
fhir:TestScript.setup [
fhir:TestScript.setup.action [
fhir:index 0;
fhir:TestScript.setup.action.operation [
fhir:TestScript.setup.action.operation.type [
fhir:Coding.system [ fhir:value "http://hl7.org/fhir/testscript-operation-codes" ];
fhir:Coding.code [ fhir:value "search" ]
];
fhir:TestScript.setup.action.operation.resource [ fhir:value "Patient" ];
fhir:TestScript.setup.action.operation.description [ fhir:value "Test simple search to verify server support." ];
fhir:TestScript.setup.action.operation.accept [ fhir:value "xml" ];
fhir:TestScript.setup.action.operation.params [ fhir:value "?family=DONTEXPECTAMATCH&given=DONTEXPECTAMATCH" ]
]
], [
fhir:index 1;
fhir:TestScript.setup.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the request url contains the family search parameter." ];
fhir:TestScript.setup.action.assert.direction [ fhir:value "request" ];
fhir:TestScript.setup.action.assert.operator [ fhir:value "contains" ];
fhir:TestScript.setup.action.assert.requestURL [ fhir:value "family" ]
]
], [
fhir:index 2;
fhir:TestScript.setup.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP status is 200(OK)." ];
fhir:TestScript.setup.action.assert.direction [ fhir:value "response" ];
fhir:TestScript.setup.action.assert.responseCode [ fhir:value "200" ]
]
], [
fhir:index 3;
fhir:TestScript.setup.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned resource type is Bundle." ];
fhir:TestScript.setup.action.assert.resource [ fhir:value "Bundle" ]
]
], [
fhir:index 4;
fhir:TestScript.setup.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned Bundle correctly defines the navigation links." ];
fhir:TestScript.setup.action.assert.navigationLinks [ fhir:value "true"^^xsd:boolean ]
]
]
];
fhir:TestScript.test [
fhir:index 0;
fhir:Element.id [ fhir:value "01-PatientCreateSearch" ];
fhir:TestScript.test.name [ fhir:value "Patient Create Search" ];
fhir:TestScript.test.description [ fhir: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." ];
fhir:TestScript.test.action [
fhir:index 0;
fhir:TestScript.test.action.operation [
fhir:TestScript.setup.action.operation.type [
fhir:Coding.system [ fhir:value "http://hl7.org/fhir/testscript-operation-codes" ];
fhir:Coding.code [ fhir:value "create" ]
];
fhir:TestScript.setup.action.operation.resource [ fhir:value "Patient" ];
fhir:TestScript.setup.action.operation.description [ fhir:value "Create a Patient resource and capture the returned HTTP Header Location." ];
fhir:TestScript.setup.action.operation.accept [ fhir:value "xml" ];
fhir:TestScript.setup.action.operation.contentType [ fhir:value "xml" ];
fhir:TestScript.setup.action.operation.responseId [ fhir:value "PatientCreateResponse" ];
fhir:TestScript.setup.action.operation.sourceId [ fhir:value "fixture-patient-create" ]
]
], [
fhir:index 1;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP status is 201(Created)." ];
fhir:TestScript.setup.action.assert.response [ fhir:value "created" ]
]
], [
fhir:index 2;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP Header Location is present." ];
fhir:TestScript.setup.action.assert.direction [ fhir:value "response" ];
fhir:TestScript.setup.action.assert.headerField [ fhir:value "Location" ];
fhir:TestScript.setup.action.assert.operator [ fhir:value "notEmpty" ]
]
], [
fhir:index 3;
fhir:TestScript.test.action.operation [
fhir:TestScript.setup.action.operation.type [
fhir:Coding.system [ fhir:value "http://hl7.org/fhir/testscript-operation-codes" ];
fhir:Coding.code [ fhir:value "read" ]
];
fhir:TestScript.setup.action.operation.description [ fhir:value "Read the created Patient using the captured Location URL value." ];
fhir:TestScript.setup.action.operation.accept [ fhir:value "xml" ];
fhir:TestScript.setup.action.operation.url [ fhir:value "${PatientCreateLocation}" ]
]
], [
fhir:index 4;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP status is 200(OK)." ];
fhir:TestScript.setup.action.assert.response [ fhir:value "okay" ]
]
], [
fhir:index 5;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned resource type is Patient." ];
fhir:TestScript.setup.action.assert.resource [ fhir:value "Patient" ]
]
]
], [
fhir:index 1;
fhir:Element.id [ fhir:value "02-PatientSearchDynamic" ];
fhir:TestScript.test.name [ fhir:value "Patient Search Dynamic" ];
fhir:TestScript.test.description [ fhir:value "Search for Patient resources using the user defined dynamic variables ${PatientSearchFamilyName} and ${PatientSearchGivenName} and validate response." ];
fhir:TestScript.test.action [
fhir:index 0;
fhir:TestScript.test.action.operation [
fhir:TestScript.setup.action.operation.type [
fhir:Coding.system [ fhir:value "http://hl7.org/fhir/testscript-operation-codes" ];
fhir:Coding.code [ fhir:value "search" ]
];
fhir:TestScript.setup.action.operation.resource [ fhir:value "Patient" ];
fhir:TestScript.setup.action.operation.description [ fhir:value "Search for Patient resources on the destination test system." ];
fhir:TestScript.setup.action.operation.accept [ fhir:value "xml" ];
fhir:TestScript.setup.action.operation.params [ fhir:value "?family=${PatientSearchFamilyName}&given=${PatientSearchGivenName}" ]
]
], [
fhir:index 1;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP status is 200(OK)." ];
fhir:TestScript.setup.action.assert.response [ fhir:value "okay" ]
]
], [
fhir:index 2;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned format is XML." ];
fhir:TestScript.setup.action.assert.contentType [ fhir:value "xml" ]
]
], [
fhir:index 3;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned resource type is Bundle." ];
fhir:TestScript.setup.action.assert.resource [ fhir:value "Bundle" ]
]
], [
fhir:index 4;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned Bundle conforms to the base FHIR specification." ];
fhir:TestScript.setup.action.assert.validateProfileId [ fhir:value "bundle-profile" ]
]
], [
fhir:index 5;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned Bundle type equals 'searchset'." ];
fhir:TestScript.setup.action.assert.operator [ fhir:value "equals" ];
fhir:TestScript.setup.action.assert.path [ fhir:value "fhir:Bundle/fhir:type/@value" ];
fhir:TestScript.setup.action.assert.value [ fhir:value "searchset" ]
]
], [
fhir:index 6;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned Bundle total is greater than or equal to the number of returned entries." ];
fhir:TestScript.setup.action.assert.expression [ fhir:value "Bundle.total.toInteger() >= entry.count()" ]
]
]
] .
<http://hl7.org/fhir/CapabilityStatement/example> a fhir:CapabilityStatement .
<http://hl7.org/fhir/Patient/example> a fhir:Patient .
<http://hl7.org/fhir/StructureDefinition/Bundle> a fhir:StructureDefinition .
# - ontology header ------------------------------------------------------------
<http://hl7.org/fhir/TestScript/testscript-example-search.ttl> a owl:Ontology;
owl:imports fhir:fhir.ttl;
owl:versionIRI <http://hl7.org/fhir/STU3/TestScript/testscript-example-search.ttl> .
# -------------------------------------------------------------------------------------
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.
®© HL7.org 2011+. FHIR Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change