This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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 |
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 with Details</b></p><p><b>id</b>: testscript-example-history</p><p><b>url</b>: <a>http://hl7.org/fhir/TestScript/testscript-example-history</a></p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.9877</p><p><b>version</b>: 1.0</p><p><b>name</b>: TestScript Example History</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 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>(Details : {urn:iso:std:iso:3166 code 'US' = 'United States of America', given as 'United States of America (the)'})</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><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 Update, Delete and History (Instance) Operations</td><td><a>http://hl7.org/fhir/http.html#update</a></td><td><a>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>Peter Chalmers</a></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>Donald Duck</a></p></blockquote><p><b>profile</b>: <a>Generated Summary: url: http://hl7.org/fhir/StructureDefinition/Bundle; name: Bundle; DRAFT; date: 03/04/2018 12:05:46 PM; publisher: Health Level Seven International (FHIR Infrastructure); description: A container for a collection of resources.; url: http://hl7.org/fhir/StructureDefinition/Bundle; name: Bundle; DRAFT; date: 03/04/2018 12:05:46 PM; publisher: Health Level Seven International (FHIR Infrastructure); description: A container for a collection of resources.; fhirVersion: 3.3.0; RESOURCE; type: Bundle; baseDefinition: http://hl7.org/fhir/StructureDefinition/Resource; SPECIALIZATION</a></p><h3>Variables</h3><table><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><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/testscript-operation-codes code delete = 'Delete', stated as 'null')</td><td>Patient</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><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>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></tr></table></blockquote><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>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/testscript-operation-codes code update = 'Update', stated as 'null')</td><td>Patient</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><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 201(Created).</td><td>response</td><td>201</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>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/testscript-operation-codes code update = 'Update', stated as 'null')</td><td>Patient</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><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><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><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>" }, "url": "http://hl7.org/fhir/TestScript/testscript-example-history", "identifier": { "system": "urn:ietf:rfc:3986", "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.9877" }, "version": "1.0", "name": "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": "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": [ { "id": "bundle-profile", "reference": "http://hl7.org/fhir/StructureDefinition/Bundle" } ], "variable": [ { "name": "createResourceId", "path": "Patient/id", "sourceId": "fixture-patient-create" } ], "setup": { "action": [ { "operation": { "type": { "system": "http://hl7.org/fhir/testscript-operation-codes", "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", "warningOnly": false } }, { "operation": { "type": { "system": "http://hl7.org/fhir/testscript-operation-codes", "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", "warningOnly": false } }, { "operation": { "type": { "system": "http://hl7.org/fhir/testscript-operation-codes", "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", "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/testscript-operation-codes", "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", "warningOnly": false } }, { "assert": { "description": "Confirm that the returned resource type is Bundle.", "resource": "Bundle", "warningOnly": false } }, { "assert": { "description": "Confirm that the returned Bundle conforms to the base FHIR specification.", "validateProfileId": "bundle-profile", "warningOnly": false } }, { "assert": { "description": "Confirm that the returned Bundle type equals 'history'.", "operator": "equals", "path": "fhir:Bundle/fhir:type/@value", "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.