Testscript-example-rule.xml

Rule TestScript Example (id = "testscript-example-rule")

<TestScript xmlns="http://hl7.org/fhir">
  <id value="testscript-example-rule"/> 

  <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-rule</p> <p> <b> url</b> : <a> http://hl7.org/fhir/TestScript/testscript-example-rule</a> </p> <p> <b> identifier</b> : urn:oid:1.3.6.1.4.1.21367.2005.3.7.9880</p> <p> <b> version</b> : 1.0</p> <p> <b> name</b> : TestScript Example</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; and single test definition to read the created Patient with various asserts.
         The asserts now include example rule and ruleset definitions to execute.</p> <p> <b> jurisdiction</b> : United States of America (the) <span> (Details : {urn:iso:std:iso:3166 code 'US' = 'US', given as 'United States of America
           (the)'})</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> <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 Update, Read and Delete Operations</td> <td> <a> http://hl7.org/fhir/http.html#delete</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> Peter Chalmers (minimum)</a> </p> </blockquote> <p> <b> profile</b> : <a> http://hl7.org/fhir/StructureDefinition/Patient</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> rule</b> </p> <p> <b> resource</b> : <a> TestScript/testscript-example</a> </p> <h3> Params</h3> <table> <tr> <td> -</td> <td> <b> Name</b> </td> <td> <b> Value</b> </td> </tr> <tr> <td> *</td> <td> expectedStatusCode</td> <td> 200</td> </tr> </table> </blockquote> <blockquote> <p> <b> ruleset</b> </p> <p> <b> resource</b> : <a> TestScript/testscript-example</a> </p> <blockquote> <p> <b> rule</b> </p> <p> <b> ruleId</b> : RuleResponseContentType</p> <h3> Params</h3> <table> <tr> <td> -</td> <td> <b> Name</b> </td> <td> <b> Value</b> </td> </tr> <tr> <td> *</td> <td> expectedContentType</td> <td> json</td> </tr> </table> </blockquote> <blockquote> <p> <b> rule</b> </p> <p> <b> ruleId</b> : RuleResponseStatusCode</p> <h3> Params</h3> <table> <tr> <td> -</td> <td> <b> Name</b> </td> <td> <b> Value</b> </td> </tr> <tr> <td> *</td> <td> expectedStatusCode</td> <td> 200</td> </tr> </table> </blockquote> </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> Label</b> </td> <td> <b> Description</b> </td> <td> <b> Accept</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> /${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> </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> </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> 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> /${createResourceId}</td> <td> fixture-patient-create</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <blockquote> <p> <b> assert</b> </p> <p> <b> label</b> : Setup-RuleCreateOK</p> <p> <b> description</b> : Confirm that the returned HTTP status is 201(Created).</p> <p> <b> direction</b> : response</p> <blockquote> <p> <b> rule</b> </p> <p> <b> ruleId</b> : rule-responseStatusCode</p> <h3> Params</h3> <table> <tr> <td> -</td> <td> <b> Name</b> </td> <td> <b> Value</b> </td> </tr> <tr> <td> *</td> <td> expectedStatusCode</td> <td> 201</td> </tr> </table> </blockquote> </blockquote> </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> <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> <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-rule"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:1.3.6.1.4.1.21367.2005.3.7.9880"/> 
  </identifier> 
  <version value="1.0"/> 
  <name value="TestScript Example"/> 
  <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; and single test definition to read the created Patient with various asserts.
   The asserts now include example rule and ruleset definitions to execute."/> 
  <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), Read and Delete 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"/> 
      <description value="Patient Update, Read and Delete Operations"/> 
      <link value="http://hl7.org/fhir/http.html#delete"/> 
      <link value="http://hl7.org/fhir/http.html#read"/> 
      <link value="http://hl7.org/fhir/http.html#update"/> 
      <capabilities> 
        <reference value="CapabilityStatement/example"/> 
      </capabilities> 
    </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-minimum">
    <autocreate value="false"/> 
    <autodelete value="false"/> 
    <resource> 
      <reference value="Patient/example"/> 
      <display value="Peter Chalmers (minimum)"/> 
    </resource> 
  </fixture> 

  <profile id="patient-profile">
    <reference value="http://hl7.org/fhir/StructureDefinition/Patient"/> 
  </profile> 

  <variable> 
    <name value="createResourceId"/> 
    <path value="Patient/id"/> 
    <sourceId value="fixture-patient-create"/> 
  </variable> 

  <rule id="rule-responseStatusCode">
    <resource> 
      <reference value="TestScript/testscript-example"/> 
    </resource> 
    <param> 
      <name value="expectedStatusCode"/> 
      <value value="200"/> 
    </param> 
  </rule> 
  <ruleset id="ruleset-responseContentTypeStatusCode">
    <resource> 
      <reference value="TestScript/testscript-example"/> 
    </resource> 
    <rule> 
      <ruleId value="RuleResponseContentType"/> 
      <param> 
        <name value="expectedContentType"/> 
        <value value="json"/> 
      </param> 
    </rule> 
    <rule> 
      <ruleId value="RuleResponseStatusCode"/> 
      <param> 
        <name value="expectedStatusCode"/> 
        <value value="200"/> 
      </param> 
    </rule> 
  </ruleset> 

  <setup> 
    <action> 
      <operation> 
        <type> 
          <system value="http://hl7.org/fhir/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"/> 
        <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"/> 
      </assert> 
    </action> 

    <action> 
      <operation> 
        <type> 
          <system value="http://hl7.org/fhir/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"/> 
        <params value="/${createResourceId}"/> 
        <sourceId value="fixture-patient-create"/> 
      </operation> 
    </action> 
    <action> 
      <assert> 
        <label value="Setup-RuleCreateOK"/> 
        <description value="Confirm that the returned HTTP status is 201(Created)."/> 
        <direction value="response"/> 
        <rule> 
          <ruleId value="rule-responseStatusCode"/> 
          <param> 
            <name value="expectedStatusCode"/> 
            <value value="201"/> 
          </param> 
        </rule> 
      </assert> 
    </action> 
  </setup> 

  <test id="01-ReadPatient">
    <name value="Read Patient"/> 
    <description value="Read a patient and validate response."/> 
    <action> 
      <operation> 
        <type> 
          <system value="http://hl7.org/fhir/testscript-operation-codes"/> 
          <code value="read"/> 
        </type> 
        <resource value="Patient"/> 
        <description value="Read the patient resource on the test server using the id from fixture-patient-create.
         Prevent URL encoding of the request."/> 
        <encodeRequestUrl value="false"/> 
        <responseId value="fixture-patient-read"/> 
        <targetId value="fixture-patient-create"/> 
      </operation> 
    </action> 
    <action> 
      <assert> 
        <label value="01-RuleReadPatientOK"/> 
        <description value="Confirm that the returned HTTP status is 200(OK)."/> 
        <rule> 
          <ruleId value="rule-responseStatusCode"/> 
        </rule> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <label value="01-RuleReadPatientContentType"/> 
        <ruleset> 
          <rulesetId value="ruleset-responseResourcePatient"/> 
          <!--    We only need to overwrite one param value in the ruleset    -->
          <rule> 
            <ruleId value="RuleResponseContentType"/> 
            <param> 
              <name value="expectedContentType"/> 
              <value value="XML"/> 
            </param> 
          </rule> 
        </ruleset> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned HTTP Header Last-Modified is present. Warning only as the server
         might not support versioning."/> 
        <direction value="response"/> 
        <headerField value="Last-Modified"/> 
        <operator value="notEmpty"/> 
        <warningOnly value="true"/> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned resource type is Patient."/> 
        <resource value="Patient"/> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned Patient conforms to the base FHIR specification."/> 
        <validateProfileId value="patient-profile"/> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned Patient contains the expected family name 'Chalmers'. Uses explicit
         sourceId reference to read responseId fixture."/> 
        <operator value="equals"/> 
        <path value="fhir:Patient/fhir:name/fhir:family/@value"/> 
        <sourceId value="fixture-patient-read"/> 
        <value value="Chalmers"/> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned Patient contains the expected given name 'Peter'. Uses explicit
         sourceId reference to read responseId fixture."/> 
        <operator value="equals"/> 
        <path value="fhir:Patient/fhir:name/fhir:given/@value"/> 
        <sourceId value="fixture-patient-read"/> 
        <value value="Peter"/> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="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 value="fixture-patient-create"/> 
        <compareToSourcePath value="fhir:Patient/fhir:name/fhir:family/@value"/> 
        <operator value="equals"/> 
        <path value="fhir:Patient/fhir:name/fhir:family/@value"/> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="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 value="fixture-patient-create"/> 
        <compareToSourcePath value="fhir:Patient/fhir:name/fhir:given/@value"/> 
        <path value="fhir:Patient/fhir:name/fhir:given/@value"/> 
        <sourceId value="fixture-patient-read"/> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned resource contains the expected retained elements and values.
         Warning only to provide users with reviewable results."/> 
        <minimumId value="fixture-patient-minimum"/> 
        <warningOnly value="true"/> 
      </assert> 
    </action> 
  </test> 
</TestScript>