This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). 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
Testscript-example-history.xml

FHIR Infrastructure Work Group
Maturity Level: N/A
Standards Status: Informative
Compartments: Not linked to any defined compartments
Raw XML (canonical form + also see XML Format Specification)
Jump past Narrative
History TestScript Example (id = "testscript-example-history")
<?xml version="1.0" encoding="UTF-8"?>

<TestScript xmlns="http://hl7.org/fhir">
  <id value="testscript-example-history"/> 
  <text> <status value="generated"/> <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> : 2017-01-18</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: id: Bundle; url: http://hl7.org/fhir/StructureDefinition/Bundle; version:
           4.2.0; name: Bundle; ACTIVE; date: 31 Dec. 2019, 9:03:40 pm; publisher: Health Level Seven
           International (FHIR Infrastructure); description: A container for a collection of resources.;
           4.2.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://terminology.hl7.org/CodeSystem/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://terminology.hl7.org/CodeSystem/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://terminology.hl7.org/CodeSystem/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> </text> <url value="http://hl7.org/fhir/TestScript/testscript-example-history"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:1.3.6.1.4.1.21367.2005.3.7.9877"/> 
  </identifier> 
  <version value="1.0"/> 
  <name value="TestScript Example History"/> 
  <status value="draft"/> 
  <experimental value="true"/> 
  <date value="2017-01-18"/> 
  <publisher value="HL7"/> 
  <contact> 
    <name value="Support"/> 
    <telecom> 
      <system value="email"/> 
      <value value="support@HL7.org"/> 
      <use value="work"/> 
    </telecom> 
  </contact> 
  <description value="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 value="urn:iso:std:iso:3166"/> 
      <code value="US"/> 
      <display value="United States of America (the)"/> 
    </coding> 
  </jurisdiction> 
  <purpose value="Patient (Conditional) Create, Update, Delete and History (Instance) Operations"/> 
  <copyright value="Â© HL7.org 2011+"/> 
  <metadata> 
    <link> 
      <url value="http://hl7.org/fhir/patient.html"/> 
      <description value="Demographics and other administrative information about an individual or animal receiving
       care or other health-related services."/> 
    </link> 
    <capability> 
      <required value="true"/> 
      <validated value="false"/> 
      <description value="Patient Update, Delete and History (Instance) Operations"/> 
      <link value="http://hl7.org/fhir/http.html#update"/> 
      <link value="http://hl7.org/fhir/http.html#delete"/> 
      <link value="http://hl7.org/fhir/http.html#history"/> 
      <capabilities value="CapabilityStatement/example"/> 
    </capability> 
  </metadata> 
  <fixture id="fixture-patient-create">
    <autocreate value="false"/> 
    <autodelete value="false"/> 
    <resource> 
      <reference value="Patient/example"/> 
      <display value="Peter Chalmers"/> 
    </resource> 
  </fixture> 
  <fixture id="fixture-patient-update">
    <autocreate value="false"/> 
    <autodelete value="false"/> 
    <resource> 
      <reference value="Patient/pat1"/> 
      <display value="Donald Duck"/> 
    </resource> 
  </fixture> 
  <profile id="bundle-profile">
    <reference value="http://hl7.org/fhir/StructureDefinition/Bundle"/> 
  </profile> 
  <variable> 
    <name value="createResourceId"/> 
    <path value="Patient/id"/> 
    <sourceId value="fixture-patient-create"/> 
  </variable> 
  <setup> 
    <action> 
      <operation> 
        <type> 
          <system value="http://terminology.hl7.org/CodeSystem/testscript-operation-codes"/> 
          <code value="delete"/> 
        </type> 
        <resource value="Patient"/> 
        <label value="SetupDeletePatient"/> 
        <description value="Execute a delete operation to insure the patient does not exist on the server."/> 
        <accept value="json"/> 
        <encodeRequestUrl value="true"/> 
        <params value="/${createResourceId}"/> 
      </operation> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned HTTP status is 200(OK) or 204(No Content)."/> 
        <direction value="response"/> 
        <operator value="in"/> 
        <responseCode value="200,204"/> 
        <warningOnly value="false"/> 
      </assert> 
    </action> 
    <action> 
      <operation> 
        <type> 
          <system value="http://terminology.hl7.org/CodeSystem/testscript-operation-codes"/> 
          <code value="update"/> 
        </type> 
        <resource value="Patient"/> 
        <label value="SetupCreatePatient"/> 
        <description value="Create patient resource on test server using the contents of fixture-patient-create"/> 
        <accept value="json"/> 
        <contentType value="json"/> 
        <encodeRequestUrl value="true"/> 
        <params value="/${createResourceId}"/> 
        <sourceId value="fixture-patient-create"/> 
      </operation> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned HTTP status is 201(Created)."/> 
        <direction value="response"/> 
        <responseCode value="201"/> 
        <warningOnly value="false"/> 
      </assert> 
    </action> 
    <action> 
      <operation> 
        <type> 
          <system value="http://terminology.hl7.org/CodeSystem/testscript-operation-codes"/> 
          <code value="update"/> 
        </type> 
        <resource value="Patient"/> 
        <label value="SetupUpdatePatient"/> 
        <description value="Update patient resource on test server using the contents of fixture-patient-update"/> 
        <accept value="json"/> 
        <contentType value="json"/> 
        <encodeRequestUrl value="true"/> 
        <params value="/${createResourceId}"/> 
        <sourceId value="fixture-patient-update"/> 
      </operation> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned HTTP status is 200(OK)."/> 
        <direction value="response"/> 
        <responseCode value="200"/> 
        <warningOnly value="false"/> 
      </assert> 
    </action> 
  </setup> 
  <test id="01-HistoryPatient">
    <name value="History Patient"/> 
    <description value="Get the history for a known Patient and validate response."/> 
    <action> 
      <operation> 
        <type> 
          <system value="http://terminology.hl7.org/CodeSystem/testscript-operation-codes"/> 
          <code value="history"/> 
        </type> 
        <resource value="Patient"/> 
        <description value="Get the Patient history on the test server using the id from fixture-patient-create."/> 
        <accept value="json"/> 
        <contentType value="json"/> 
        <encodeRequestUrl value="true"/> 
        <targetId value="fixture-patient-create"/> 
      </operation> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned HTTP status is 200(OK)."/> 
        <direction value="response"/> 
        <response value="okay"/> 
        <warningOnly value="false"/> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned resource type is Bundle."/> 
        <resource value="Bundle"/> 
        <warningOnly value="false"/> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned Bundle conforms to the base FHIR specification."/> 
        <validateProfileId value="bundle-profile"/> 
        <warningOnly value="false"/> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned Bundle type equals 'history'."/> 
        <operator value="equals"/> 
        <path value="fhir:Bundle/fhir:type/@value"/> 
        <value value="history"/> 
        <warningOnly value="false"/> 
      </assert> 
    </action> 
  </test> 
</TestScript>
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.