This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). 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 R2
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
General TestScript Example
{ "resourceType" : "TestScript", "id" : "testscript-example", "text" : { "status" : "generated", "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: TestScript</b><a name=\"testscript-example\"> </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" </p></div><p><b>url</b>: <code>http://hl7.org/fhir/TestScript/testscript-example</code></p><p><b>identifier</b>: id: urn:oid:2.16.840.1.113883.4.642.12.4</p><p><b>version</b>: 1.0</p><p><b>name</b>: TestScriptExample</p><p><b>title</b>: TestScript Example</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 setup to delete if present and create a new instance of a Patient; and single test definition to read the created Patient with various asserts.</p><h3>UseContexts</h3><table class=\"grid\"><tr><td>-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td>*</td><td>Clinical Focus (Details: http://terminology.hl7.org/CodeSystem/usage-context-type code focus = 'Clinical Focus', stated as 'null')</td><td>positive <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-variant-state.html\">sequenceStatus</a>#positive)</span></td></tr><tr><td>*</td><td>Program (Details: http://terminology.hl7.org/CodeSystem/usage-context-type code program = 'Program', stated as 'null')</td><td>2018-? year</td></tr></table><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/4.0.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 Conditional Create (Update), Read and Delete Operations</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 Update, Read and Delete Operations</td><td><a href=\"http://hl7.org/fhir/http.html#delete\">http://hl7.org/fhir/http.html#delete</a>, <a href=\"http://hl7.org/fhir/http.html#read\">http://hl7.org/fhir/http.html#read</a>, <a href=\"http://hl7.org/fhir/http.html#update\">http://hl7.org/fhir/http.html#update</a></td><td><a href=\"http://hl7.org/fhir/CapabilityStatement/example\">http://hl7.org/fhir/CapabilityStatement/example</a></td></tr></table></blockquote><blockquote><p><b>fixture</b></p><p><b>autocreate</b>: false</p><p><b>autodelete</b>: false</p><p><b>resource</b>: <a href=\"patient-example.html\">Patient/example: Peter Chalmers</a> "Peter CHALMERS"</p></blockquote><blockquote><p><b>fixture</b></p><p><b>autocreate</b>: false</p><p><b>autodelete</b>: false</p><p><b>resource</b>: <a href=\"patient-example.html\">Patient/example: Peter Chalmers (minimum)</a> "Peter CHALMERS"</p></blockquote><p><b>profile</b>: <a href=\"patient.html\">Patient</a></p><h3>Variables</h3><table class=\"grid\"><tr><td>-</td><td><b>Name</b></td><td><b>Path</b></td><td><b>SourceId</b></td></tr><tr><td>*</td><td>createResourceId</td><td>Patient/id</td><td>fixture-patient-create</td></tr></table><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>Label</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>delete (Details: http://hl7.org/fhir/restful-interaction code delete = 'delete', stated as 'null')</td><td><a href=\"patient.html\">Patient</a></td><td>SetupDeletePatient</td><td>Execute a delete operation to insure the patient does not exist on the server.</td><td>json</td><td>true</td><td>/${createResourceId}</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>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) or 204(No Content).</td><td>response</td><td>in</td><td>200,204</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>Resource</b></td><td><b>Label</b></td><td><b>Description</b></td><td><b>Accept</b></td><td><b>ContentType</b></td><td><b>EncodeRequestUrl</b></td><td><b>Params</b></td><td><b>SourceId</b></td></tr><tr><td>*</td><td>update (Details: http://hl7.org/fhir/restful-interaction code update = 'update', stated as 'null')</td><td><a href=\"patient.html\">Patient</a></td><td>SetupCreatePatient</td><td>Create patient resource on test server using the contents of fixture-patient-create</td><td>json</td><td>json</td><td>true</td><td>/${createResourceId}</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>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 201(Created).</td><td>response</td><td>201</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>Resource</b></td><td><b>Description</b></td><td><b>EncodeRequestUrl</b></td><td><b>TargetId</b></td></tr><tr><td>*</td><td>read (Details: http://hl7.org/fhir/restful-interaction code read = 'read', stated as 'null')</td><td><a href=\"patient.html\">Patient</a></td><td>Read the created patient resource on the test server using the id from fixture-patient-create. Verify contents.</td><td>true</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>Direction</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>response</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>CompareToSourceId</b></td><td><b>CompareToSourceExpression</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 Patient contains the expected family name 'Chalmers'. Uses explicit compareToSourceId reference to fixture-patient-create used to create the Patient.</td><td>fixture-patient-create</td><td>Patient.name.first().family</td><td>equals</td><td>false</td><td>false</td></tr></table></blockquote></blockquote><blockquote><p><b>test</b></p><p><b>name</b>: Read Patient</p><p><b>description</b>: Read a Patient 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>EncodeRequestUrl</b></td><td><b>ResponseId</b></td><td><b>TargetId</b></td></tr><tr><td>*</td><td>read (Details: http://hl7.org/fhir/restful-interaction code read = 'read', stated as 'null')</td><td><a href=\"patient.html\">Patient</a></td><td>Read the patient resource on the test server using the id from fixture-patient-create. Prevent URL encoding of the request.</td><td>false</td><td>fixture-patient-read</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>Label</b></td><td><b>Description</b></td><td><b>Direction</b></td><td><b>Response</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td>*</td><td>01-ReadPatientOK</td><td>Confirm that the returned HTTP status is 200(OK).</td><td>response</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>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 Last-Modified is present. Warning only as the server might not support versioning.</td><td>response</td><td>Last-Modified</td><td>notEmpty</td><td>false</td><td>true</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><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 Patient conforms to the base FHIR specification.</td><td>false</td><td>patient-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>SourceId</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 Patient contains the expected family name 'Chalmers'. Uses explicit sourceId reference to read responseId fixture.</td><td>equals</td><td>fhir:Patient/fhir:name/fhir:family/@value</td><td>fixture-patient-read</td><td>false</td><td>Chalmers</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>SourceId</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 Patient contains the expected given name 'Peter'. Uses explicit sourceId reference to read responseId fixture.</td><td>equals</td><td>fhir:Patient/fhir:name/fhir:given/@value</td><td>fixture-patient-read</td><td>false</td><td>Peter</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>CompareToSourceId</b></td><td><b>CompareToSourcePath</b></td><td><b>Operator</b></td><td><b>Path</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td>*</td><td>Confirm that the returned Patient contains the expected family name 'Chalmers'. Uses explicit compareToSourceId reference to fixture-patient-create used to create the Patient and implicit reference to read response payload.</td><td>fixture-patient-create</td><td>fhir:Patient/fhir:name/fhir:family/@value</td><td>equals</td><td>fhir:Patient/fhir:name/fhir:family/@value</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>CompareToSourceId</b></td><td><b>CompareToSourcePath</b></td><td><b>Path</b></td><td><b>SourceId</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td>*</td><td>Confirm that the returned Patient contains the expected family name 'Chalmers'. Uses explicit compareToSourceId reference to fixture-patient-create used to create the Patient and explicit reference to read response payload and default operator of 'equals'.</td><td>fixture-patient-create</td><td>fhir:Patient/fhir:name/fhir:given/@value</td><td>fhir:Patient/fhir:name/fhir:given/@value</td><td>fixture-patient-read</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>MinimumId</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td>*</td><td>Confirm that the returned resource contains the expected retained elements and values. Warning only to provide users with reviewable results.</td><td>fixture-patient-minimum</td><td>false</td><td>true</td></tr></table></blockquote></blockquote><blockquote><p><b>teardown</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>EncodeRequestUrl</b></td><td><b>TargetId</b></td></tr><tr><td>*</td><td>delete (Details: http://hl7.org/fhir/restful-interaction code delete = 'delete', stated as 'null')</td><td><a href=\"patient.html\">Patient</a></td><td>Delete the patient resource on the test server using the id from fixture-patient-create.</td><td>true</td><td>fixture-patient-create</td></tr></table></blockquote></blockquote></div>" }, "url" : "http://hl7.org/fhir/TestScript/testscript-example", "identifier" : [{ "system" : "urn:ietf:rfc:3986", "value" : "urn:oid:2.16.840.1.113883.4.642.12.4" }], "version" : "1.0", "name" : "TestScriptExample", "title" : "TestScript Example", "status" : "draft", "experimental" : true, "date" : "2017-01-18", "publisher" : "HL7", "contact" : [{ "name" : "Support", "telecom" : [{ "system" : "email", "value" : "support@HL7.org", "use" : "work" }] }], "description" : "TestScript example resource with setup to delete if present and create a new instance of a Patient; and single test definition to read the created Patient with various asserts.", "useContext" : [{ "code" : { "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "focus" }, "valueCodeableConcept" : { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/variant-state", "code" : "positive" }] } }, { "code" : { "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "program" }, "valueRange" : { "low" : { "value" : 2018, "unit" : "year", "system" : "http://unitsofmeasure.org", "code" : "a" } } }], "jurisdiction" : [{ "coding" : [{ "system" : "urn:iso:std:iso:3166", "code" : "US", "display" : "United States of America (the)" }] }], "purpose" : "Patient Conditional Create (Update), Read and Delete Operations", "copyright" : "© HL7.org 2011+", "metadata" : { "link" : [{ "url" : "http://hl7.org/fhir/patient.html", "description" : "Demographics and other administrative information about an individual or animal receiving care or other health-related services." }], "capability" : [{ "required" : true, "validated" : false, "description" : "Patient Update, Read and Delete Operations", "link" : ["http://hl7.org/fhir/http.html#delete", "http://hl7.org/fhir/http.html#read", "http://hl7.org/fhir/http.html#update"], "capabilities" : "http://hl7.org/fhir/CapabilityStatement/example" }] }, "fixture" : [{ "id" : "fixture-patient-create", "autocreate" : false, "autodelete" : false, "resource" : { "reference" : "Patient/example", "display" : "Peter Chalmers" } }, { "id" : "fixture-patient-minimum", "autocreate" : false, "autodelete" : false, "resource" : { "reference" : "Patient/example", "display" : "Peter Chalmers (minimum)" } }], "profile" : ["http://hl7.org/fhir/StructureDefinition/Patient"], "_profile" : [{ "id" : "patient-profile" }], "variable" : [{ "name" : "createResourceId", "path" : "Patient/id", "sourceId" : "fixture-patient-create" }], "setup" : { "action" : [{ "operation" : { "type" : { "system" : "http://hl7.org/fhir/restful-interaction", "code" : "delete" }, "resource" : "Patient", "label" : "SetupDeletePatient", "description" : "Execute a delete operation to insure the patient does not exist on the server.", "accept" : "json", "encodeRequestUrl" : true, "params" : "/${createResourceId}" } }, { "assert" : { "description" : "Confirm that the returned HTTP status is 200(OK) or 204(No Content).", "direction" : "response", "operator" : "in", "responseCode" : "200,204", "stopTestOnFail" : false, "warningOnly" : false } }, { "operation" : { "type" : { "system" : "http://hl7.org/fhir/restful-interaction", "code" : "update" }, "resource" : "Patient", "label" : "SetupCreatePatient", "description" : "Create patient resource on test server using the contents of fixture-patient-create", "accept" : "json", "contentType" : "json", "encodeRequestUrl" : true, "params" : "/${createResourceId}", "sourceId" : "fixture-patient-create" } }, { "assert" : { "description" : "Confirm that the returned HTTP status is 201(Created).", "direction" : "response", "responseCode" : "201", "stopTestOnFail" : false, "warningOnly" : false } }, { "operation" : { "type" : { "system" : "http://hl7.org/fhir/restful-interaction", "code" : "read" }, "resource" : "Patient", "description" : "Read the created patient resource on the test server using the id from fixture-patient-create. Verify contents.", "encodeRequestUrl" : true, "targetId" : "fixture-patient-create" } }, { "assert" : { "description" : "Confirm that the returned HTTP status is 200(OK).", "direction" : "response", "response" : "okay", "stopTestOnFail" : false, "warningOnly" : false } }, { "assert" : { "description" : "Confirm that the returned Patient contains the expected family name 'Chalmers'. Uses explicit compareToSourceId reference to fixture-patient-create used to create the Patient.", "compareToSourceId" : "fixture-patient-create", "compareToSourceExpression" : "Patient.name.first().family", "operator" : "equals", "stopTestOnFail" : false, "warningOnly" : false } }] }, "test" : [{ "id" : "01-ReadPatient", "name" : "Read Patient", "description" : "Read a Patient and validate response.", "action" : [{ "operation" : { "type" : { "system" : "http://hl7.org/fhir/restful-interaction", "code" : "read" }, "resource" : "Patient", "description" : "Read the patient resource on the test server using the id from fixture-patient-create. Prevent URL encoding of the request.", "encodeRequestUrl" : false, "responseId" : "fixture-patient-read", "targetId" : "fixture-patient-create" } }, { "assert" : { "label" : "01-ReadPatientOK", "description" : "Confirm that the returned HTTP status is 200(OK).", "direction" : "response", "response" : "okay", "stopTestOnFail" : false, "warningOnly" : false } }, { "assert" : { "description" : "Confirm that the returned HTTP Header Last-Modified is present. Warning only as the server might not support versioning.", "direction" : "response", "headerField" : "Last-Modified", "operator" : "notEmpty", "stopTestOnFail" : false, "warningOnly" : true } }, { "assert" : { "description" : "Confirm that the returned resource type is Patient.", "resource" : "Patient", "stopTestOnFail" : false, "warningOnly" : false } }, { "assert" : { "description" : "Confirm that the returned Patient conforms to the base FHIR specification.", "stopTestOnFail" : false, "validateProfileId" : "patient-profile", "warningOnly" : false } }, { "assert" : { "description" : "Confirm that the returned Patient contains the expected family name 'Chalmers'. Uses explicit sourceId reference to read responseId fixture.", "operator" : "equals", "path" : "fhir:Patient/fhir:name/fhir:family/@value", "sourceId" : "fixture-patient-read", "stopTestOnFail" : false, "value" : "Chalmers", "warningOnly" : false } }, { "assert" : { "description" : "Confirm that the returned Patient contains the expected given name 'Peter'. Uses explicit sourceId reference to read responseId fixture.", "operator" : "equals", "path" : "fhir:Patient/fhir:name/fhir:given/@value", "sourceId" : "fixture-patient-read", "stopTestOnFail" : false, "value" : "Peter", "warningOnly" : false } }, { "assert" : { "description" : "Confirm that the returned Patient contains the expected family name 'Chalmers'. Uses explicit compareToSourceId reference to fixture-patient-create used to create the Patient and implicit reference to read response payload.", "compareToSourceId" : "fixture-patient-create", "compareToSourcePath" : "fhir:Patient/fhir:name/fhir:family/@value", "operator" : "equals", "path" : "fhir:Patient/fhir:name/fhir:family/@value", "stopTestOnFail" : false, "warningOnly" : false } }, { "assert" : { "description" : "Confirm that the returned Patient contains the expected family name 'Chalmers'. Uses explicit compareToSourceId reference to fixture-patient-create used to create the Patient and explicit reference to read response payload and default operator of 'equals'.", "compareToSourceId" : "fixture-patient-create", "compareToSourcePath" : "fhir:Patient/fhir:name/fhir:given/@value", "path" : "fhir:Patient/fhir:name/fhir:given/@value", "sourceId" : "fixture-patient-read", "stopTestOnFail" : false, "warningOnly" : false } }, { "assert" : { "description" : "Confirm that the returned resource contains the expected retained elements and values. Warning only to provide users with reviewable results.", "minimumId" : "fixture-patient-minimum", "stopTestOnFail" : false, "warningOnly" : true } }] }], "teardown" : { "action" : [{ "operation" : { "type" : { "system" : "http://hl7.org/fhir/restful-interaction", "code" : "delete" }, "resource" : "Patient", "description" : "Delete the patient resource on the test server using the id from fixture-patient-create.", "encodeRequestUrl" : true, "targetId" : "fixture-patient-create" } }] } }
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 hl7.fhir.core#5.0.0-draft-final generated on Wed, Mar 1, 2023 23:07+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change