FHIR Testing IG
0.1.0-SNAPSHOT - Draft
FHIR Testing IG
0.1.0-SNAPSHOT - Draft
FHIR Testing IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 0.1.0-SNAPSHOT built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-testing-ig/ and changes regularly. See the Directory of published versions
| Page standards status: Informative |
<TestScript xmlns="http://hl7.org/fhir">
<id value="testscript-example-readtest"/>
<language value="en"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><p class="res-header-id"><b>Generated Narrative: TestScript testscript-example-readtest</b></p><a name="testscript-example-readtest"> </a><a name="hctestscript-example-readtest"> </a><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">Language: en</p></div><p><b>url</b>: <a href="http://hl7.org/fhir/R5/testscript-example-readtest.html">http://hl7.org/fhir/TestScript/testscript-example-readtest</a></p><p><b>identifier</b>: <a href="http://terminology.hl7.org/7.0.1/NamingSystem-uri.html" title="As defined by RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt)(with many schemes defined in many RFCs). For OIDs and UUIDs, use the URN form (urn:oid:(note: lowercase) and urn:uuid:). See http://www.ietf.org/rfc/rfc3001.txt and http://www.ietf.org/rfc/rfc4122.txt
This oid is used as an identifier II.root to indicate the the extension is an absolute URI (technically, an IRI). Typically, this is used for OIDs and GUIDs. Note that when this OID is used with OIDs and GUIDs, the II.extension should start with urn:oid or urn:uuid:
Note that this OID is created to aid with interconversion between CDA and FHIR - FHIR uses urn:ietf:rfc:3986 as equivalent to this OID. URIs as identifiers appear more commonly in FHIR.
This OID may also be used in CD.codeSystem.">Uniform Resource Identifier (URI)</a>/urn:oid:2.16.840.1.113883.4.642.12.2</p><p><b>version</b>: 1.0</p><p><b>title</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>: Support: <a href="mailto:support@HL7.org">support@HL7.org</a></p><p><b>description</b>: </p><div><p>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>
</div><p><b>jurisdiction</b>: <span title="Codes:{urn:iso:std:iso:3166 US}">United States of America</span></p><p><b>purpose</b>: </p><div><p>Patient Read Operation</p>
</div><p><b>copyright</b>: </p><div><p>© HL7.org 2011+</p>
</div><blockquote><p><b>metadata</b></p><h3>Links</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Url</b></td><td><b>Description</b></td></tr><tr><td style="display: none">*</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 style="display: none">-</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 style="display: none">*</td><td>true</td><td>false</td><td>Patient Read Operation</td><td><a href="http://hl7.org/fhir/http.html#read">http://hl7.org/fhir/http.html#read</a></td><td><a href="http://hl7.org/fhir/R5/capabilitystatement-example.html">http://hl7.org/fhir/CapabilityStatement/example</a></td></tr></table></blockquote><h3>Scopes</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Artifact</b></td><td><b>Conformance</b></td><td><b>Phase</b></td></tr><tr><td style="display: none">*</td><td><a href="http://hl7.org/fhir/R5/patient.html">Patient</a></td><td><span title="Codes:{http://hl7.org/fhir/testscript-scope-conformance-codes optional}">Optional</span></td><td><span title="Codes:{http://hl7.org/fhir/testscript-scope-phase-codes unit}">Unit</span></td></tr></table><p><b>profile</b>: <a href="http://hl7.org/fhir/R5/patient.html">Patient</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><blockquote><p><b>id</b></p>R001</blockquote><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 class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td><td><b>Resource</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 style="display: none">*</td><td><a href="http://hl7.org/fhir/R5/codesystem-restful-interaction.html#restful-interaction-read">FHIR Restful Interactions: read</a> (read)</td><td><a href="http://hl7.org/fhir/R5/patient.html">http://hl7.org/fhir/StructureDefinition/Patient</a></td><td>Read the known Patient resource on the destination test system using the user defined dynamic variable ${KnownPatientResourceId}.</td><td>xml</td><td>true</td><td>/${KnownPatientResourceId}</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Description</b></td><td><b>Response</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td style="display: none">*</td><td>Confirm that the returned HTTP status is 200(OK).</td><td>OK</td><td>false</td><td>false</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Description</b></td><td><b>ContentType</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td style="display: none">*</td><td>Confirm that the returned format is XML.</td><td>xml</td><td>false</td><td>false</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Description</b></td><td><b>HeaderField</b></td><td><b>Operator</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td style="display: none">*</td><td>Confirm that the returned HTTP Header Last-Modified is present. Warning only as the server might not support versioning.</td><td>Last-Modified</td><td>notEmpty</td><td>false</td><td>true</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Description</b></td><td><b>Resource</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td style="display: none">*</td><td>Confirm that the returned resource type is Patient.</td><td><a href="http://hl7.org/fhir/R5/patient.html">http://hl7.org/fhir/StructureDefinition/Patient</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 style="display: none">-</td><td><b>Description</b></td><td><b>StopTestOnFail</b></td><td><b>ValidateProfileId</b></td><td><b>WarningOnly</b></td></tr><tr><td style="display: none">*</td><td>Confirm that the returned Patient conforms to the base FHIR specification.</td><td>false</td><td>patient-profile</td><td>false</td></tr></table></blockquote></blockquote><blockquote><p><b>test</b></p><blockquote><p><b>id</b></p>R002</blockquote><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 class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td><td><b>Resource</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 style="display: none">*</td><td><a href="http://hl7.org/fhir/R5/codesystem-restful-interaction.html#restful-interaction-read">FHIR Restful Interactions: read</a> (read)</td><td><a href="http://hl7.org/fhir/R5/patient.html">http://hl7.org/fhir/StructureDefinition/Patient</a></td><td>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.</td><td>xml</td><td>true</td><td>/1</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Description</b></td><td><b>Response</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td style="display: none">*</td><td>Confirm that the returned HTTP status is 404(Not Found).</td><td>Not Found</td><td>false</td><td>false</td></tr></table></blockquote></blockquote><blockquote><p><b>test</b></p><blockquote><p><b>id</b></p>R003</blockquote><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 class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td><td><b>Resource</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 style="display: none">*</td><td><a href="http://hl7.org/fhir/R5/codesystem-restful-interaction.html#restful-interaction-read">FHIR Restful Interactions: read</a> (read)</td><td><a href="http://hl7.org/fhir/R5/patient.html">http://hl7.org/fhir/StructureDefinition/Patient</a></td><td>Attempt to read the non-existing Patient resource on the destination test system using the user defined dynamic variable ${NonExistsPatientResourceId}.</td><td>xml</td><td>true</td><td>/${NonExistsPatientResourceId}</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Description</b></td><td><b>Response</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td style="display: none">*</td><td>Confirm that the returned HTTP status is 404(Not Found).</td><td>Not Found</td><td>false</td><td>false</td></tr></table></blockquote></blockquote><blockquote><p><b>test</b></p><blockquote><p><b>id</b></p>R004</blockquote><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 class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td><td><b>Resource</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 style="display: none">*</td><td><a href="http://hl7.org/fhir/R5/codesystem-restful-interaction.html#restful-interaction-read">FHIR Restful Interactions: read</a> (read)</td><td><a href="http://hl7.org/fhir/R5/patient.html">http://hl7.org/fhir/StructureDefinition/Patient</a></td><td>Attempt to read a Patient resource on the destination test system using known bad formatted resource id.</td><td>xml</td><td>true</td><td>/ID-may-not-contain-CAPITALS</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Description</b></td><td><b>Response</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td style="display: none">*</td><td>Confirm that the returned HTTP status is 400(Bad Request).</td><td>Bad Request</td><td>false</td><td>false</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:2.16.840.1.113883.4.642.12.2"/>
</identifier>
<version value="1.0"/>
<title 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"/>
</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="http://hl7.org/fhir/CapabilityStatement/example"/>
</capability>
</metadata>
<scope>
<artifact value="http://hl7.org/fhir/StructureDefinition/Patient"/>
<conformance>
<coding>
<system
value="http://hl7.org/fhir/testscript-scope-conformance-codes"/>
<code value="optional"/>
</coding>
</conformance>
<phase>
<coding>
<system value="http://hl7.org/fhir/testscript-scope-phase-codes"/>
<code value="unit"/>
</coding>
</phase>
</scope>
<profile value="http://hl7.org/fhir/StructureDefinition/Patient">🔗
<id value="patient-profile"/>
</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://hl7.org/fhir/restful-interaction"/>
<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"/>
<stopTestOnFail value="false"/>
<warningOnly value="false"/>
</assert>
</action>
<action>
<assert>
<description value="Confirm that the returned format is XML."/>
<contentType value="xml"/>
<stopTestOnFail value="false"/>
<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"/>
<stopTestOnFail value="false"/>
<warningOnly value="true"/>
</assert>
</action>
<action>
<assert>
<description
value="Confirm that the returned resource type is Patient."/>
<resource value="Patient"/>
<stopTestOnFail value="false"/>
<warningOnly value="false"/>
</assert>
</action>
<action>
<assert>
<description
value="Confirm that the returned Patient conforms to the base FHIR specification."/>
<stopTestOnFail value="false"/>
<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://hl7.org/fhir/restful-interaction"/>
<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"/>
<stopTestOnFail value="false"/>
<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://hl7.org/fhir/restful-interaction"/>
<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"/>
<stopTestOnFail value="false"/>
<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://hl7.org/fhir/restful-interaction"/>
<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="badRequest"/>
<stopTestOnFail value="false"/>
<warningOnly value="false"/>
</assert>
</action>
</test>
</TestScript>
IG © 2025+ HL7 International / FHIR Infrastructure.
Package hl7.fhir.uv.testing#0.1.0-SNAPSHOT based on FHIR 6.0.0-ballot3.
Generated
2025-12-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change