Release 5
Implementation SupportThis 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
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: No defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
History TestScript Example
{
"resourceType" : "TestScript",
"id" : "testscript-example-history",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: TestScript</b><a name=\"testscript-example-history\"> </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-history" </p></div><p><b>url</b>: <code>http://hl7.org/fhir/TestScript/testscript-example-history</code></p><p><b>identifier</b>: id:\u00a0urn:oid:2.16.840.1.113883.4.642.12.1</p><p><b>version</b>: 1.0</p><p><b>name</b>: TestScriptExampleHistory</p><p><b>title</b>: TestScript Example History</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 then update that Patient to create a minimum history; and single test definition to get the history of that Patient with various asserts.</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 (Conditional) Create, Update, Delete and History (Instance) 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, Delete and History (Instance) Operations</td><td><a href=\"http://hl7.org/fhir/http.html#update\">http://hl7.org/fhir/http.html#update</a>, <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#history\">http://hl7.org/fhir/http.html#history</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-a.html\">Patient/pat1: Donald Duck</a> "Donald DUCK"</p></blockquote><p><b>profile</b>: <a href=\"bundle.html\">Bundle</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>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>SetupUpdatePatient</td><td>Update patient resource on test server using the contents of fixture-patient-update</td><td>json</td><td>json</td><td>true</td><td>/${createResourceId}</td><td>fixture-patient-update</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><blockquote><p><b>test</b></p><p><b>name</b>: History Patient</p><p><b>description</b>: Get the history for a known 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>Accept</b></td><td><b>ContentType</b></td><td><b>EncodeRequestUrl</b></td><td><b>TargetId</b></td></tr><tr><td>*</td><td>history (Details: http://hl7.org/fhir/restful-interaction code history = 'history', stated as 'null')</td><td><a href=\"patient.html\">Patient</a></td><td>Get the Patient history on the test server using the id from fixture-patient-create.</td><td>json</td><td>json</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>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>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 'history'.</td><td>equals</td><td>fhir:Bundle/fhir:type/@value</td><td>false</td><td>history</td><td>false</td></tr></table></blockquote></blockquote></div>"
},
"url" : "http://hl7.org/fhir/TestScript/testscript-example-history",
"identifier" : [{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.12.1"
}],
"version" : "1.0",
"name" : "TestScriptExampleHistory",
"title" : "TestScript Example History",
"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 then update that Patient to create a minimum history; and single test definition to get the history of that Patient with various asserts.",
"jurisdiction" : [{
"coding" : [{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America (the)"
}]
}],
"purpose" : "Patient (Conditional) Create, Update, Delete and History (Instance) 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, Delete and History (Instance) Operations",
"link" : ["http://hl7.org/fhir/http.html#update",
"http://hl7.org/fhir/http.html#delete",
"http://hl7.org/fhir/http.html#history"],
"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-update",
"autocreate" : false,
"autodelete" : false,
"resource" : {
"reference" : "Patient/pat1",
"display" : "Donald Duck"
}
}],
"profile" : ["http://hl7.org/fhir/StructureDefinition/Bundle"],
"_profile" : [{
"id" : "bundle-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" : "update"
},
"resource" : "Patient",
"label" : "SetupUpdatePatient",
"description" : "Update patient resource on test server using the contents of fixture-patient-update",
"accept" : "json",
"contentType" : "json",
"encodeRequestUrl" : true,
"params" : "/${createResourceId}",
"sourceId" : "fixture-patient-update"
}
},
{
"assert" : {
"description" : "Confirm that the returned HTTP status is 200(OK).",
"direction" : "response",
"responseCode" : "200",
"stopTestOnFail" : false,
"warningOnly" : false
}
}]
},
"test" : [{
"id" : "01-HistoryPatient",
"name" : "History Patient",
"description" : "Get the history for a known Patient and validate response.",
"action" : [{
"operation" : {
"type" : {
"system" : "http://hl7.org/fhir/restful-interaction",
"code" : "history"
},
"resource" : "Patient",
"description" : "Get the Patient history on the test server using the id from fixture-patient-create.",
"accept" : "json",
"contentType" : "json",
"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 resource type is Bundle.",
"resource" : "Bundle",
"stopTestOnFail" : false,
"warningOnly" : false
}
},
{
"assert" : {
"description" : "Confirm that the returned Bundle conforms to the base FHIR specification.",
"stopTestOnFail" : false,
"validateProfileId" : "bundle-profile",
"warningOnly" : false
}
},
{
"assert" : {
"description" : "Confirm that the returned Bundle type equals 'history'.",
"operator" : "equals",
"path" : "fhir:Bundle/fhir:type/@value",
"stopTestOnFail" : false,
"value" : "history",
"warningOnly" : 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.
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:26+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change