Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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

Example TestScript/testscript-example-update (Turtle)

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

Raw Turtle (+ also see Turtle/RDF Format Specification)

Update TestScript Example

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

[a fhir:TestScript;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "testscript-example-update"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: TestScript</b><a name=\"testscript-example-update\"> </a></p><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\">Resource TestScript &quot;testscript-example-update&quot; </p></div><p><b>url</b>: <code>http://hl7.org/fhir/TestScript/testscript-example-update</code></p><p><b>identifier</b>: id: urn:oid:2.16.840.1.113883.4.642.12.5</p><p><b>version</b>: 1.0</p><p><b>name</b>: TestScript Example Update</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>: TestScript example resource with setup to delete if present and create a new instance of a Patient; and single test definition to update that Patient with various asserts.</p><p><b>jurisdiction</b>: United States of America (the) <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (unknown#US)</span></p><p><b>purpose</b>: Patient (Conditional) Create, Update, Delete Operations</p><p><b>copyright</b>: © HL7.org 2011+</p><blockquote><p><b>metadata</b></p><h3>Links</h3><table class=\"grid\"><tr><td>-</td><td><b>Url</b></td><td><b>Description</b></td></tr><tr><td>*</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>-</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 and Delete Operations</td><td><a href=\"http://hl7.org/fhir/http.html#update\">http://hl7.org/fhir/http.html#update</a>, <a href=\"http://hl7.org/fhir/http.html#delete\">http://hl7.org/fhir/http.html#delete</a></td><td><a href=\"http://hl7.org/fhir/CapabilityStatement/example\">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 href=\"patient-example.html\">Patient/example: Peter Chalmers</a> &quot;Peter CHALMERS&quot;</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 href=\"patient-example-a.html\">Patient/pat1: Donald Duck</a> &quot;Donald DUCK&quot;</p></blockquote><p><b>profile</b>: <a href=\"http://hl7.org/fhir/StructureDefinition/Patient\">http://hl7.org/fhir/StructureDefinition/Patient</a> &quot;Patient&quot;</p><h3>Variables</h3><table class=\"grid\"><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 class=\"grid\"><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://hl7.org/fhir/restful-interaction code delete = 'delete', stated as 'null')</td><td><a href=\"patient.html\">Patient</a></td><td>SetupDeletePatient</td><td>Execute a delete operation to insure the patient does not exist on the server.</td><td>xml</td><td>true</td><td>/${createResourceId}</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><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>StopTestOnFail</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><td>false</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Operations</h3><table class=\"grid\"><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://hl7.org/fhir/restful-interaction code update = 'update', stated as 'null')</td><td><a href=\"patient.html\">Patient</a></td><td>SetupCreatePatient</td><td>Create patient resource on test server using the contents of fixture-patient-create</td><td>xml</td><td>xml</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 class=\"grid\"><tr><td>-</td><td><b>Description</b></td><td><b>Direction</b></td><td><b>ResponseCode</b></td><td><b>StopTestOnFail</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><td>false</td></tr></table></blockquote></blockquote><blockquote><p><b>test</b></p><p><b>name</b>: Update Patient</p><p><b>description</b>: Update a Patient and validate response.</p><blockquote><p><b>action</b></p><h3>Operations</h3><table class=\"grid\"><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://hl7.org/fhir/restful-interaction code update = 'update', stated as 'null')</td><td><a href=\"patient.html\">Patient</a></td><td>SetupUpdatePatient</td><td>Update patient resource on test server using the contents of fixture-patient-update</td><td>xml</td><td>xml</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 class=\"grid\"><tr><td>-</td><td><b>Description</b></td><td><b>Response</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td>*</td><td>Confirm that the returned HTTP status is 200(OK).</td><td>okay</td><td>false</td><td>false</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table class=\"grid\"><tr><td>-</td><td><b>Description</b></td><td><b>ContentType</b></td><td><b>StopTestOnFail</b></td><td><b>WarningOnly</b></td></tr><tr><td>*</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>-</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>*</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></div>"
  ];
  fhir:TestScript.url [ fhir:value "http://hl7.org/fhir/TestScript/testscript-example-update"];
  fhir:TestScript.identifier [
     fhir:index 0;
     fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ];
     fhir:Identifier.value [ fhir:value "urn:oid:2.16.840.1.113883.4.642.12.5" ]
  ];
  fhir:TestScript.version [ fhir:value "1.0"];
  fhir:TestScript.name [ fhir:value "TestScript Example Update"];
  fhir:TestScript.status [ fhir:value "draft"];
  fhir:TestScript.experimental [ fhir:value "true"^^xsd:boolean];
  fhir:TestScript.date [ fhir:value "2017-01-18"^^xsd:date];
  fhir:TestScript.publisher [ fhir:value "HL7"];
  fhir:TestScript.contact [
     fhir:index 0;
     fhir:ContactDetail.name [ fhir:value "Support" ];
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "email" ];
       fhir:ContactPoint.value [ fhir:value "support@HL7.org" ];
       fhir:ContactPoint.use [ fhir:value "work" ]
     ]
  ];
  fhir:TestScript.description [ fhir:value "TestScript example resource with setup to delete if present and create a new instance of a Patient; and single test definition to update that Patient with various asserts."];
  fhir:TestScript.jurisdiction [
     fhir:index 0;
     fhir:CodeableConcept.coding [
       fhir:index 0;
       fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ];
       fhir:Coding.code [ fhir:value "US" ];
       fhir:Coding.display [ fhir:value "United States of America (the)" ]
     ]
  ];
  fhir:TestScript.purpose [ fhir:value "Patient (Conditional) Create, Update, Delete Operations"];
  fhir:TestScript.copyright [ fhir:value "© HL7.org 2011+"];
  fhir:TestScript.metadata [
     fhir:TestScript.metadata.link [
       fhir:index 0;
       fhir:TestScript.metadata.link.url [ fhir:value "http://hl7.org/fhir/patient.html" ];
       fhir:TestScript.metadata.link.description [ fhir:value "Demographics and other administrative information about an individual or animal receiving care or other health-related services." ]
     ];
     fhir:TestScript.metadata.capability [
       fhir:index 0;
       fhir:TestScript.metadata.capability.required [ fhir:value "true"^^xsd:boolean ];
       fhir:TestScript.metadata.capability.validated [ fhir:value "false"^^xsd:boolean ];
       fhir:TestScript.metadata.capability.description [ fhir:value "Patient Update and Delete Operations" ];
       fhir:TestScript.metadata.capability.link [
         fhir:value "http://hl7.org/fhir/http.html#update";
         fhir:index 0
       ], [
         fhir:value "http://hl7.org/fhir/http.html#delete";
         fhir:index 1
       ];
       fhir:TestScript.metadata.capability.capabilities [
         fhir:value "http://hl7.org/fhir/CapabilityStatement/example";
         fhir:link <http://hl7.org/fhir/CapabilityStatement/example>
       ]
     ]
  ];
  fhir:TestScript.fixture [
     fhir:index 0;
     fhir:Element.id [ fhir:value "fixture-patient-create" ];
     fhir:TestScript.fixture.autocreate [ fhir:value "false"^^xsd:boolean ];
     fhir:TestScript.fixture.autodelete [ fhir:value "false"^^xsd:boolean ];
     fhir:TestScript.fixture.resource [
       fhir:Reference.reference [ fhir:value "Patient/example" ];
       fhir:Reference.display [ fhir:value "Peter Chalmers" ]
     ]
  ], [
     fhir:index 1;
     fhir:Element.id [ fhir:value "fixture-patient-update" ];
     fhir:TestScript.fixture.autocreate [ fhir:value "false"^^xsd:boolean ];
     fhir:TestScript.fixture.autodelete [ fhir:value "false"^^xsd:boolean ];
     fhir:TestScript.fixture.resource [
       fhir:Reference.reference [ fhir:value "Patient/pat1" ];
       fhir:Reference.display [ fhir:value "Donald Duck" ]
     ]
  ];
  fhir:TestScript.profile [
     fhir:index 0;
     fhir:link <http://hl7.org/fhir/StructureDefinition/Patient>;
     fhir:Element.id [ fhir:value "patient-profile" ];
     fhir:Reference.reference [ fhir:value "http://hl7.org/fhir/StructureDefinition/Patient" ]
  ];
  fhir:TestScript.variable [
     fhir:index 0;
     fhir:TestScript.variable.name [ fhir:value "createResourceId" ];
     fhir:TestScript.variable.path [ fhir:value "Patient/id" ];
     fhir:TestScript.variable.sourceId [ fhir:value "fixture-patient-create" ]
  ];
  fhir:TestScript.setup [
     fhir:TestScript.setup.action [
       fhir:index 0;
       fhir:TestScript.setup.action.operation [
         fhir:TestScript.setup.action.operation.type [
           fhir:Coding.system [ fhir:value "http://hl7.org/fhir/restful-interaction" ];
           fhir:Coding.code [ fhir:value "delete" ]
         ];
         fhir:TestScript.setup.action.operation.resource [ fhir:value "Patient" ];
         fhir:TestScript.setup.action.operation.label [ fhir:value "SetupDeletePatient" ];
         fhir:TestScript.setup.action.operation.description [ fhir:value "Execute a delete operation to insure the patient does not exist on the server." ];
         fhir:TestScript.setup.action.operation.accept [ fhir:value "xml" ];
         fhir:TestScript.setup.action.operation.encodeRequestUrl [ fhir:value "true"^^xsd:boolean ];
         fhir:TestScript.setup.action.operation.params [ fhir:value "/${createResourceId}" ]
       ]
     ], [
       fhir:index 1;
       fhir:TestScript.setup.action.assert [
         fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP status is 200(OK) or 204(No Content)." ];
         fhir:TestScript.setup.action.assert.direction [ fhir:value "response" ];
         fhir:TestScript.setup.action.assert.operator [ fhir:value "in" ];
         fhir:TestScript.setup.action.assert.responseCode [ fhir:value "200,204" ];
         fhir:TestScript.setup.action.assert.stopTestOnFail [ fhir:value "false"^^xsd:boolean ];
         fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "false"^^xsd:boolean ]
       ]
     ], [
       fhir:index 2;
       fhir:TestScript.setup.action.operation [
         fhir:TestScript.setup.action.operation.type [
           fhir:Coding.system [ fhir:value "http://hl7.org/fhir/restful-interaction" ];
           fhir:Coding.code [ fhir:value "update" ]
         ];
         fhir:TestScript.setup.action.operation.resource [ fhir:value "Patient" ];
         fhir:TestScript.setup.action.operation.label [ fhir:value "SetupCreatePatient" ];
         fhir:TestScript.setup.action.operation.description [ fhir:value "Create patient resource on test server using the contents of fixture-patient-create" ];
         fhir:TestScript.setup.action.operation.accept [ fhir:value "xml" ];
         fhir:TestScript.setup.action.operation.contentType [ fhir:value "xml" ];
         fhir:TestScript.setup.action.operation.encodeRequestUrl [ fhir:value "true"^^xsd:boolean ];
         fhir:TestScript.setup.action.operation.params [ fhir:value "/${createResourceId}" ];
         fhir:TestScript.setup.action.operation.sourceId [ fhir:value "fixture-patient-create" ]
       ]
     ], [
       fhir:index 3;
       fhir:TestScript.setup.action.assert [
         fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP status is 201(Created)." ];
         fhir:TestScript.setup.action.assert.direction [ fhir:value "response" ];
         fhir:TestScript.setup.action.assert.responseCode [ fhir:value "201" ];
         fhir:TestScript.setup.action.assert.stopTestOnFail [ fhir:value "false"^^xsd:boolean ];
         fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "false"^^xsd:boolean ]
       ]
     ]
  ];
  fhir:TestScript.test [
     fhir:index 0;
     fhir:Element.id [ fhir:value "01-UpdatePatient" ];
     fhir:TestScript.test.name [ fhir:value "Update Patient" ];
     fhir:TestScript.test.description [ fhir:value "Update a Patient and validate response." ];
     fhir:TestScript.test.action [
       fhir:index 0;
       fhir:TestScript.test.action.operation [
         fhir:TestScript.setup.action.operation.type [
           fhir:Coding.system [ fhir:value "http://hl7.org/fhir/restful-interaction" ];
           fhir:Coding.code [ fhir:value "update" ]
         ];
         fhir:TestScript.setup.action.operation.resource [ fhir:value "Patient" ];
         fhir:TestScript.setup.action.operation.label [ fhir:value "SetupUpdatePatient" ];
         fhir:TestScript.setup.action.operation.description [ fhir:value "Update patient resource on test server using the contents of fixture-patient-update" ];
         fhir:TestScript.setup.action.operation.accept [ fhir:value "xml" ];
         fhir:TestScript.setup.action.operation.contentType [ fhir:value "xml" ];
         fhir:TestScript.setup.action.operation.encodeRequestUrl [ fhir:value "true"^^xsd:boolean ];
         fhir:TestScript.setup.action.operation.params [ fhir:value "/${createResourceId}" ];
         fhir:TestScript.setup.action.operation.sourceId [ fhir:value "fixture-patient-update" ]
       ]
     ], [
       fhir:index 1;
       fhir:TestScript.test.action.assert [
         fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP status is 200(OK)." ];
         fhir:TestScript.setup.action.assert.response [ fhir:value "okay" ];
         fhir:TestScript.setup.action.assert.stopTestOnFail [ fhir:value "false"^^xsd:boolean ];
         fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "false"^^xsd:boolean ]
       ]
     ], [
       fhir:index 2;
       fhir:TestScript.test.action.assert [
         fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned format is XML." ];
         fhir:TestScript.setup.action.assert.contentType [ fhir:value "xml" ];
         fhir:TestScript.setup.action.assert.stopTestOnFail [ fhir:value "false"^^xsd:boolean ];
         fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "false"^^xsd:boolean ]
       ]
     ], [
       fhir:index 3;
       fhir:TestScript.test.action.assert [
         fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP Header Last-Modified is present. Warning only as the server might not support versioning." ];
         fhir:TestScript.setup.action.assert.headerField [ fhir:value "Last-Modified" ];
         fhir:TestScript.setup.action.assert.operator [ fhir:value "notEmpty" ];
         fhir:TestScript.setup.action.assert.stopTestOnFail [ fhir:value "false"^^xsd:boolean ];
         fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "true"^^xsd:boolean ]
       ]
     ]
  ]] .

<http://hl7.org/fhir/StructureDefinition/Patient> a fhir:StructureDefinition .

# - ontology header ------------------------------------------------------------

[a owl:Ontology;
  owl:imports fhir:fhir.ttl] .

# -------------------------------------------------------------------------------------


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.