Release 5 Preview #1

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-readtest.xml

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

Raw XML (canonical form + also see XML Format Specification)

Jump past Narrative

Read TestScript Example (id = "testscript-example-readtest")

<?xml version="1.0" encoding="UTF-8"?>

<TestScript xmlns="http://hl7.org/fhir">
  <id value="testscript-example-readtest"/> 
  <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-readtest</p> <p> <b> url</b> : <a> http://hl7.org/fhir/TestScript/testscript-example-readtest</a> </p> <p> <b> identifier</b> : urn:oid:1.3.6.1.4.1.21367.2005.3.7.9879</p> <p> <b> version</b> : 1.0</p> <p> <b> name</b> : TestScript Example Read Test</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 ported Sprinkler basic read tests R001, R002, R003,
         R004. The read tests will utilize user defined dynamic variables that will hold the Patient
         resource id values.</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 Read Operation</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 Read Operation</td> <td> <a> http://hl7.org/fhir/http.html#read</a> </td> <td> <a> CapabilityStatement/example</a> </td> </tr> </table> </blockquote> <p> <b> profile</b> : <a> Generated Summary: id: Patient; url: http://hl7.org/fhir/StructureDefinition/Patient;
           version: 4.2.0; name: Patient; ACTIVE; date: 31 Dec. 2019, 9:03:40 pm; publisher: Health
           Level Seven International (Patient Administration); description: Demographics and other
           administrative information about an individual or animal receiving care or other health-related
           services.; purpose: Tracking patient is the center of the healthcare process.; 4.2.0;
           RESOURCE; type: Patient; baseDefinition: http://hl7.org/fhir/StructureDefinition/DomainResource;
           SPECIALIZATION</a> </p> <blockquote> <p> <b> variable</b> </p> <p> <b> name</b> : KnownPatientResourceId</p> <p> <b> defaultValue</b> : example</p> </blockquote> <blockquote> <p> <b> variable</b> </p> <p> <b> name</b> : NonExistsPatientResourceId</p> <p> <b> defaultValue</b> : does-not-exist</p> </blockquote> <blockquote> <p> <b> test</b> </p> <p> <b> name</b> : Sprinkler Read Test R001</p> <p> <b> description</b> : Read 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> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> </tr> <tr> <td> *</td> </tr> </table> </blockquote> </blockquote> <blockquote> <p> <b> test</b> </p> <p> <b> name</b> : Sprinkler Read Test R002</p> <p> <b> description</b> : Read an unknown Resource Type 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> <blockquote> <p> <b> test</b> </p> <p> <b> name</b> : Sprinkler Read Test R003</p> <p> <b> description</b> : Read a known, non-existing 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> <blockquote> <p> <b> test</b> </p> <p> <b> name</b> : Sprinkler Read Test R004</p> <p> <b> description</b> : Read a Patient using a known bad formatted resource id 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> </div> </text> <url value="http://hl7.org/fhir/TestScript/testscript-example-readtest"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:1.3.6.1.4.1.21367.2005.3.7.9879"/> 
  </identifier> 
  <version value="1.0"/> 
  <name value="TestScript Example Read Test"/> 
  <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 ported Sprinkler basic read tests R001, R002, R003, R004.
   The read tests will utilize user defined dynamic variables that will hold the Patient
   resource id values."/> 
  <jurisdiction> 
    <coding> 
      <system value="urn:iso:std:iso:3166"/> 
      <code value="US"/> 
      <display value="United States of America (the)"/> 
    </coding> 
  </jurisdiction> 
  <purpose value="Patient Read Operation"/> 
  <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 Read Operation"/> 
      <link value="http://hl7.org/fhir/http.html#read"/> 
      <capabilities value="CapabilityStatement/example"/> 
    </capability> 
  </metadata> 
  <profile id="patient-profile">
    <reference value="http://hl7.org/fhir/StructureDefinition/Patient"/> 
  </profile> 
  <variable> 
    <name value="KnownPatientResourceId"/> 
    <defaultValue value="example"/> 
  </variable> 
  <variable> 
    <name value="NonExistsPatientResourceId"/> 
    <defaultValue value="does-not-exist"/> 
  </variable> 
  <test id="R001">
    <name value="Sprinkler Read Test R001"/> 
    <description value="Read a known Patient and validate response."/> 
    <action> 
      <operation> 
        <type> 
          <system value="http://terminology.hl7.org/CodeSystem/testscript-operation-codes"/> 
          <code value="read"/> 
        </type> 
        <resource value="Patient"/> 
        <description value="Read the known Patient resource on the destination test system using the user defined
         dynamic variable ${KnownPatientResourceId}."/> 
        <accept value="xml"/> 
        <encodeRequestUrl value="true"/> 
        <params value="/${KnownPatientResourceId}"/> 
      </operation> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned HTTP status is 200(OK)."/> 
        <response value="okay"/> 
        <warningOnly value="false"/> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned format is XML."/> 
        <contentType value="xml"/> 
        <warningOnly value="false"/> 
      </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."/> 
        <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"/> 
        <warningOnly value="false"/> 
      </assert> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned Patient conforms to the base FHIR specification."/> 
        <validateProfileId value="patient-profile"/> 
        <warningOnly value="false"/> 
      </assert> 
    </action> 
  </test> 
  <test id="R002">
    <name value="Sprinkler Read Test R002"/> 
    <description value="Read an unknown Resource Type and validate response."/> 
    <action> 
      <operation> 
        <type> 
          <system value="http://terminology.hl7.org/CodeSystem/testscript-operation-codes"/> 
          <code value="read"/> 
        </type> 
        <resource value="Patient"/> 
        <description value="Attempt to read the Parameters resource type. What we really want here is an illegal type
         but the build process won't allow that. Parameters is a valid resource which doesn't have
         an end-point so, this should fail."/> 
        <accept value="xml"/> 
        <encodeRequestUrl value="true"/> 
        <params value="/1"/> 
      </operation> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned HTTP status is 404(Not Found)."/> 
        <response value="notFound"/> 
        <warningOnly value="false"/> 
      </assert> 
    </action> 
  </test> 
  <test id="R003">
    <name value="Sprinkler Read Test R003"/> 
    <description value="Read a known, non-existing Patient and validate response."/> 
    <action> 
      <operation> 
        <type> 
          <system value="http://terminology.hl7.org/CodeSystem/testscript-operation-codes"/> 
          <code value="read"/> 
        </type> 
        <resource value="Patient"/> 
        <description value="Attempt to read the non-existing Patient resource on the destination test system using
         the user defined dynamic variable ${NonExistsPatientResourceId}."/> 
        <accept value="xml"/> 
        <encodeRequestUrl value="true"/> 
        <params value="/${NonExistsPatientResourceId}"/> 
      </operation> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned HTTP status is 404(Not Found)."/> 
        <response value="notFound"/> 
        <warningOnly value="false"/> 
      </assert> 
    </action> 
  </test> 
  <test id="R004">
    <name value="Sprinkler Read Test R004"/> 
    <description value="Read a Patient using a known bad formatted resource id and validate response."/> 
    <action> 
      <operation> 
        <type> 
          <system value="http://terminology.hl7.org/CodeSystem/testscript-operation-codes"/> 
          <code value="read"/> 
        </type> 
        <resource value="Patient"/> 
        <description value="Attempt to read a Patient resource on the destination test system using known bad formatted
         resource id."/> 
        <accept value="xml"/> 
        <encodeRequestUrl value="true"/> 
        <params value="/ID-may-not-contain-CAPITALS"/> 
      </operation> 
    </action> 
    <action> 
      <assert> 
        <description value="Confirm that the returned HTTP status is 400(Bad Request)."/> 
        <response value="bad"/> 
        <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.