Release 5 Preview #3
Implementation SupportThis page is part of the FHIR Specification (v4.5.0: R5 Preview #3). 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 R2
| 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)
General TestScript Example (id = "testscript-example")
<?xml version="1.0" encoding="UTF-8"?> <TestScript xmlns="http://hl7.org/fhir"> <id value="testscript-example"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative</b> </p> <p> <b> id</b> : testscript-example</p> <p> <b> url</b> : <a> http://hl7.org/fhir/TestScript/testscript-example</a> </p> <p> <b> identifier</b> : id: urn:oid:1.3.6.1.4.1.21367.2005.3.7.9876</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> : 2017-01-18</p> <p> <b> publisher</b> : HL7</p> <p> <b> contact</b> : Support: support@HL7.org(WORK)</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.</p> <p> <b> useContext</b> : </p> <p> <b> jurisdiction</b> : <span> 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> 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, Read and Delete Operations</td> <td> <a> http://hl7.org/fhir/http.html#delete</a> </td> <td> <a> http://hl7.org/fhir/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. Generated Summary: id: example; Medical record number: 12345 (USUAL); active; Peter James Chalmers (OFFICIAL), Jim , Peter James Windsor (MAIDEN); -unknown-(HOME), ph: (03) 5555 6473(WORK), ph: (03) 3410 5613(MOBILE), ph: (03) 5555 8834(OLD); gender: male; birthDate: 1974-12-25; </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). Generated Summary: id: example; Medical record number: 12345 (USUAL); active; Peter James Chalmers (OFFICIAL), Jim , Peter James Windsor (MAIDEN); -unknown-(HOME), ph: (03) 5555 6473(WORK), ph: (03) 3410 5613(MOBILE), ph: (03) 5555 8834(OLD); gender: male; birthDate: 1974-12-25; </a> </p> </blockquote> <p> <b> profile</b> : <a> Generated Summary: id: Patient; url: http://hl7.org/fhir/StructureDefinition/Patient; version: 4.5.0; name: Patient; ACTIVE; date: 20/08/2020 5:41:31 PM; publisher: Health Level Seven International (Patient Administration); http://hl7.org/fhir, http://www.hl7.org/Special/ committees/pafm/index.cfm; 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.5.0; RESOURCE; type: Patient; baseDefinition: http://hl7.org/fhir/StructureDefinition/DomainResource; 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> <span> Delete</span> </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> <span> Update</span> </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> Description</b> </td> <td> <b> EncodeRequestUrl</b> </td> <td> <b> TargetId</b> </td> </tr> <tr> <td> *</td> <td> <span> Read</span> </td> <td> Patient</td> <td> Read the created patient resource on the test server using the id from fixture-patient-create. Verify contents.</td> <td> true</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> Response</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> okay</td> <td> false</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> CompareToSourceId</b> </td> <td> <b> CompareToSourceExpression</b> </td> <td> <b> Operator</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> Confirm that the returned Patient contains the expected family name 'Chalmers'. Uses explicit compareToSourceId reference to fixture-patient-create used to create the Patient.</td> <td> fixture-patient-create</td> <td> Patient.name.first().family</td> <td> equals</td> <td> false</td> </tr> </table> </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> <td> <b> Type</b> </td> <td> <b> Resource</b> </td> <td> <b> Description</b> </td> <td> <b> EncodeRequestUrl</b> </td> <td> <b> ResponseId</b> </td> <td> <b> TargetId</b> </td> </tr> <tr> <td> *</td> <td> <span> Read</span> </td> <td> Patient</td> <td> Read the patient resource on the test server using the id from fixture-patient-create. Prevent URL encoding of the request.</td> <td> false</td> <td> fixture-patient-read</td> <td> fixture-patient-create</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Label</b> </td> <td> <b> Description</b> </td> <td> <b> Direction</b> </td> <td> <b> Response</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> 01-ReadPatientOK</td> <td> Confirm that the returned HTTP status is 200(OK).</td> <td> response</td> <td> okay</td> <td> false</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> HeaderField</b> </td> <td> <b> Operator</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> Confirm that the returned HTTP Header Last-Modified is present. Warning only as the server might not support versioning.</td> <td> response</td> <td> Last-Modified</td> <td> notEmpty</td> <td> true</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> Resource</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> Confirm that the returned resource type is Patient.</td> <td> Patient</td> <td> false</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> ValidateProfileId</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> Confirm that the returned Patient conforms to the base FHIR specification.</td> <td> patient-profile</td> <td> false</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> Operator</b> </td> <td> <b> Path</b> </td> <td> <b> SourceId</b> </td> <td> <b> Value</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> Confirm that the returned Patient contains the expected family name 'Chalmers'. Uses explicit sourceId reference to read responseId fixture.</td> <td> equals</td> <td> fhir:Patient/fhir:name/fhir:family/@value</td> <td> fixture-patient-read</td> <td> Chalmers</td> <td> false</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> Operator</b> </td> <td> <b> Path</b> </td> <td> <b> SourceId</b> </td> <td> <b> Value</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> Confirm that the returned Patient contains the expected given name 'Peter'. Uses explicit sourceId reference to read responseId fixture.</td> <td> equals</td> <td> fhir:Patient/fhir:name/fhir:given/@value</td> <td> fixture-patient-read</td> <td> Peter</td> <td> false</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> CompareToSourceId</b> </td> <td> <b> CompareToSourcePath</b> </td> <td> <b> Operator</b> </td> <td> <b> Path</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> 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.</td> <td> fixture-patient-create</td> <td> fhir:Patient/fhir:name/fhir:family/@value</td> <td> equals</td> <td> fhir:Patient/fhir:name/fhir:family/@value</td> <td> false</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> CompareToSourceId</b> </td> <td> <b> CompareToSourcePath</b> </td> <td> <b> Path</b> </td> <td> <b> SourceId</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> 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'.</td> <td> fixture-patient-create</td> <td> fhir:Patient/fhir:name/fhir:given/@value</td> <td> fhir:Patient/fhir:name/fhir:given/@value</td> <td> fixture-patient-read</td> <td> false</td> </tr> </table> </blockquote> <blockquote> <p> <b> action</b> </p> <h3> Asserts</h3> <table> <tr> <td> -</td> <td> <b> Description</b> </td> <td> <b> MinimumId</b> </td> <td> <b> WarningOnly</b> </td> </tr> <tr> <td> *</td> <td> Confirm that the returned resource contains the expected retained elements and values. Warning only to provide users with reviewable results.</td> <td> fixture-patient-minimum</td> <td> true</td> </tr> </table> </blockquote> </blockquote> <blockquote> <p> <b> teardown</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> Description</b> </td> <td> <b> EncodeRequestUrl</b> </td> <td> <b> TargetId</b> </td> </tr> <tr> <td> *</td> <td> <span> Delete</span> </td> <td> Patient</td> <td> Delete the patient resource on the test server using the id from fixture-patient-create.</td> <td> true</td> <td> fixture-patient-create</td> </tr> </table> </blockquote> </blockquote> </div> </text> <url value="http://hl7.org/fhir/TestScript/testscript-example"/> <identifier> <system value="urn:ietf:rfc:3986"/> <value value="urn:oid:1.3.6.1.4.1.21367.2005.3.7.9876"/> </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."/> <useContext> <code> <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/> <code value="focus"/> </code> <valueCodeableConcept> <coding> <system value="http://terminology.hl7.org/CodeSystem/variant-state"/> <code value="positive"/> </coding> </valueCodeableConcept> </useContext> <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"/> <validated value="false"/> <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 value="http://hl7.org/fhir/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-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> <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="read"/> </type> <resource value="Patient"/> <description value="Read the created patient resource on the test server using the id from fixture-patient-create. Verify contents."/> <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 Patient contains the expected family name 'Chalmers'. Uses explicit compareToSourceId reference to fixture-patient-create used to create the Patient."/> <compareToSourceId value="fixture-patient-create"/> <compareToSourceExpression value="Patient.name.first().family"/> <operator value="equals"/> <warningOnly value="false"/> </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://terminology.hl7.org/CodeSystem/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-ReadPatientOK"/> <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 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"/> <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> <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"/> <warningOnly value="false"/> </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"/> <warningOnly value="false"/> </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"/> <warningOnly value="false"/> </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"/> <warningOnly value="false"/> </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> <teardown> <action> <operation> <type> <system value="http://terminology.hl7.org/CodeSystem/testscript-operation-codes"/> <code value="delete"/> </type> <resource value="Patient"/> <description value="Delete the patient resource on the test server using the id from fixture-patient-create."/> <encodeRequestUrl value="true"/> <targetId value="fixture-patient-create"/> </operation> </action> </teardown> </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.
FHIR ®© HL7.org 2011+. FHIR R5 Preview #3 hl7.fhir.core#4.5.0 generated on Thu, Aug 20, 2020 17:46+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change