This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw Turtle (+ also see Turtle/RDF Format Specification)
General TestScript Example
@prefix fhir: <http://hl7.org/fhir/> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . # - resource ------------------------------------------------------------------- [] a fhir:TestScript; fhir:Resource.id [ fhir:value "testscript-example"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ] ]; fhir:TestScript.url [ fhir:value "http://hl7.org/fhir/TestScript/testscript-example"]; fhir:TestScript.identifier [ fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ]; fhir:Identifier.value [ fhir:value "urn:oid:1.3.6.1.4.1.21367.2005.3.7.9876" ] ]; fhir:TestScript.version [ fhir:value "1.0"]; fhir:TestScript.name [ fhir:value "TestScript Example"]; fhir:TestScript.status [ fhir:value "draft"]; fhir:TestScript.experimental [ fhir:value "true"]; fhir:TestScript.date [ fhir:value "2017-01-18"]; 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 read the created Patient with various asserts."]; fhir:TestScript.useContext [ fhir:index 0; fhir:UsageContext.code [ fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/usage-context-type" ]; fhir:Coding.code [ fhir:value "focus" ] ]; fhir:UsageContext.value [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/variant-state" ]; fhir:Coding.code [ fhir:value "positive" ] ] ] ]; 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), Read and Delete Operations"]; fhir:TestScript.copyright [ fhir:value "© HL7.org 2011+"]; fhir:TestScript.metadata [ fhir:TestScript.link [ fhir:index 0; fhir:TestScript.url [ fhir:value "http://hl7.org/fhir/patient.html" ]; fhir:TestScript.description [ fhir:value "Demographics and other administrative information about an individual or animal receiving care or other health-related services." ] ]; fhir:TestScript.capability [ fhir:index 0; fhir:TestScript.required [ fhir:value "true" ]; fhir:TestScript.validated [ fhir:value "false" ]; fhir:TestScript.description [ fhir:value "Patient Update, Read and Delete Operations" ]; fhir:TestScript.link [ fhir:value "http://hl7.org/fhir/http.html#delete"; fhir:index 0 ], [ fhir:value "http://hl7.org/fhir/http.html#read"; fhir:index 1 ], [ fhir:value "http://hl7.org/fhir/http.html#update"; fhir:index 2 ]; fhir:TestScript.capabilities [ fhir:value "http://hl7.org/fhir/CapabilityStatement/example" ] ] ]; fhir:TestScript.fixture [ fhir:index 0; fhir:Element.id [ fhir:value "fixture-patient-create" ]; fhir:TestScript.autocreate [ fhir:value "false" ]; fhir:TestScript.autodelete [ fhir:value "false" ]; fhir:TestScript.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-minimum" ]; fhir:TestScript.autocreate [ fhir:value "false" ]; fhir:TestScript.autodelete [ fhir:value "false" ]; fhir:TestScript.resource [ fhir:Reference.reference [ fhir:value "Patient/example" ]; fhir:Reference.display [ fhir:value "Peter Chalmers (minimum)" ] ] ]; fhir:TestScript.profile [ fhir:index 0; 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.name [ fhir:value "createResourceId" ]; fhir:TestScript.path [ fhir:value "Patient/id" ]; fhir:TestScript.sourceId [ fhir:value "fixture-patient-create" ] ]; fhir:TestScript.setup [ fhir:TestScript.action [ fhir:index 0; fhir:TestScript.operation [ fhir:TestScript.type [ fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/testscript-operation-codes" ]; fhir:Coding.code [ fhir:value "delete" ] ]; fhir:TestScript.resource [ fhir:value "Patient" ]; fhir:TestScript.label [ fhir:value "SetupDeletePatient" ]; fhir:TestScript.description [ fhir:value "Execute a delete operation to insure the patient does not exist on the server." ]; fhir:TestScript.accept [ fhir:value "json" ]; fhir:TestScript.encodeRequestUrl [ fhir:value "true" ]; fhir:TestScript.params [ fhir:value "/${createResourceId}" ] ] ], [ fhir:index 1; fhir:TestScript.assert [ fhir:TestScript.description [ fhir:value "Confirm that the returned HTTP status is 200(OK) or 204(No Content)." ]; fhir:TestScript.direction [ fhir:value "response" ]; fhir:TestScript.operator [ fhir:value "in" ]; fhir:TestScript.responseCode [ fhir:value "200,204" ]; fhir:TestScript.warningOnly [ fhir:value "false" ] ] ], [ fhir:index 2; fhir:TestScript.operation [ fhir:TestScript.type [ fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/testscript-operation-codes" ]; fhir:Coding.code [ fhir:value "update" ] ]; fhir:TestScript.resource [ fhir:value "Patient" ]; fhir:TestScript.label [ fhir:value "SetupCreatePatient" ]; fhir:TestScript.description [ fhir:value "Create patient resource on test server using the contents of fixture-patient-create" ]; fhir:TestScript.accept [ fhir:value "json" ]; fhir:TestScript.contentType [ fhir:value "json" ]; fhir:TestScript.encodeRequestUrl [ fhir:value "true" ]; fhir:TestScript.params [ fhir:value "/${createResourceId}" ]; fhir:TestScript.sourceId [ fhir:value "fixture-patient-create" ] ] ], [ fhir:index 3; fhir:TestScript.assert [ fhir:TestScript.description [ fhir:value "Confirm that the returned HTTP status is 201(Created)." ]; fhir:TestScript.direction [ fhir:value "response" ]; fhir:TestScript.responseCode [ fhir:value "201" ]; fhir:TestScript.warningOnly [ fhir:value "false" ] ] ], [ fhir:index 4; fhir:TestScript.operation [ fhir:TestScript.type [ fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/testscript-operation-codes" ]; fhir:Coding.code [ fhir:value "read" ] ]; fhir:TestScript.resource [ fhir:value "Patient" ]; fhir:TestScript.description [ fhir:value "Read the created patient resource on the test server using the id from fixture-patient-create. Verify contents." ]; fhir:TestScript.encodeRequestUrl [ fhir:value "true" ]; fhir:TestScript.targetId [ fhir:value "fixture-patient-create" ] ] ], [ fhir:index 5; fhir:TestScript.assert [ fhir:TestScript.description [ fhir:value "Confirm that the returned HTTP status is 200(OK)." ]; fhir:TestScript.direction [ fhir:value "response" ]; fhir:TestScript.response [ fhir:value "okay" ]; fhir:TestScript.warningOnly [ fhir:value "false" ] ] ], [ fhir:index 6; fhir:TestScript.assert [ fhir:TestScript.description [ fhir: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." ]; fhir:TestScript.compareToSourceId [ fhir:value "fixture-patient-create" ]; fhir:TestScript.compareToSourceExpression [ fhir:value "Patient.name.first().family" ]; fhir:TestScript.operator [ fhir:value "equals" ]; fhir:TestScript.warningOnly [ fhir:value "false" ] ] ] ]; fhir:TestScript.test [ fhir:index 0; fhir:Element.id [ fhir:value "01-ReadPatient" ]; fhir:TestScript.name [ fhir:value "Read Patient" ]; fhir:TestScript.description [ fhir:value "Read a Patient and validate response." ]; fhir:TestScript.action [ fhir:index 0; fhir:TestScript.operation [ fhir:TestScript.type [ fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/testscript-operation-codes" ]; fhir:Coding.code [ fhir:value "read" ] ]; fhir:TestScript.resource [ fhir:value "Patient" ]; fhir:TestScript.description [ fhir:value "Read the patient resource on the test server using the id from fixture-patient-create. Prevent URL encoding of the request." ]; fhir:TestScript.encodeRequestUrl [ fhir:value "false" ]; fhir:TestScript.responseId [ fhir:value "fixture-patient-read" ]; fhir:TestScript.targetId [ fhir:value "fixture-patient-create" ] ] ], [ fhir:index 1; fhir:TestScript.assert [ fhir:TestScript.label [ fhir:value "01-ReadPatientOK" ]; fhir:TestScript.description [ fhir:value "Confirm that the returned HTTP status is 200(OK)." ]; fhir:TestScript.direction [ fhir:value "response" ]; fhir:TestScript.response [ fhir:value "okay" ]; fhir:TestScript.warningOnly [ fhir:value "false" ] ] ], [ fhir:index 2; fhir:TestScript.assert [ fhir:TestScript.description [ fhir:value "Confirm that the returned HTTP Header Last-Modified is present. Warning only as the server might not support versioning." ]; fhir:TestScript.direction [ fhir:value "response" ]; fhir:TestScript.headerField [ fhir:value "Last-Modified" ]; fhir:TestScript.operator [ fhir:value "notEmpty" ]; fhir:TestScript.warningOnly [ fhir:value "true" ] ] ], [ fhir:index 3; fhir:TestScript.assert [ fhir:TestScript.description [ fhir:value "Confirm that the returned resource type is Patient." ]; fhir:TestScript.resource [ fhir:value "Patient" ]; fhir:TestScript.warningOnly [ fhir:value "false" ] ] ], [ fhir:index 4; fhir:TestScript.assert [ fhir:TestScript.description [ fhir:value "Confirm that the returned Patient conforms to the base FHIR specification." ]; fhir:TestScript.validateProfileId [ fhir:value "patient-profile" ]; fhir:TestScript.warningOnly [ fhir:value "false" ] ] ], [ fhir:index 5; fhir:TestScript.assert [ fhir:TestScript.description [ fhir:value "Confirm that the returned Patient contains the expected family name 'Chalmers'. Uses explicit sourceId reference to read responseId fixture." ]; fhir:TestScript.operator [ fhir:value "equals" ]; fhir:TestScript.path [ fhir:value "fhir:Patient/fhir:name/fhir:family/@value" ]; fhir:TestScript.sourceId [ fhir:value "fixture-patient-read" ]; fhir:TestScript.value [ fhir:value "Chalmers" ]; fhir:TestScript.warningOnly [ fhir:value "false" ] ] ], [ fhir:index 6; fhir:TestScript.assert [ fhir:TestScript.description [ fhir:value "Confirm that the returned Patient contains the expected given name 'Peter'. Uses explicit sourceId reference to read responseId fixture." ]; fhir:TestScript.operator [ fhir:value "equals" ]; fhir:TestScript.path [ fhir:value "fhir:Patient/fhir:name/fhir:given/@value" ]; fhir:TestScript.sourceId [ fhir:value "fixture-patient-read" ]; fhir:TestScript.value [ fhir:value "Peter" ]; fhir:TestScript.warningOnly [ fhir:value "false" ] ] ], [ fhir:index 7; fhir:TestScript.assert [ fhir:TestScript.description [ fhir: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." ]; fhir:TestScript.compareToSourceId [ fhir:value "fixture-patient-create" ]; fhir:TestScript.compareToSourcePath [ fhir:value "fhir:Patient/fhir:name/fhir:family/@value" ]; fhir:TestScript.operator [ fhir:value "equals" ]; fhir:TestScript.path [ fhir:value "fhir:Patient/fhir:name/fhir:family/@value" ]; fhir:TestScript.warningOnly [ fhir:value "false" ] ] ], [ fhir:index 8; fhir:TestScript.assert [ fhir:TestScript.description [ fhir: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'." ]; fhir:TestScript.compareToSourceId [ fhir:value "fixture-patient-create" ]; fhir:TestScript.compareToSourcePath [ fhir:value "fhir:Patient/fhir:name/fhir:given/@value" ]; fhir:TestScript.path [ fhir:value "fhir:Patient/fhir:name/fhir:given/@value" ]; fhir:TestScript.sourceId [ fhir:value "fixture-patient-read" ]; fhir:TestScript.warningOnly [ fhir:value "false" ] ] ], [ fhir:index 9; fhir:TestScript.assert [ fhir:TestScript.description [ fhir:value "Confirm that the returned resource contains the expected retained elements and values. Warning only to provide users with reviewable results." ]; fhir:TestScript.minimumId [ fhir:value "fixture-patient-minimum" ]; fhir:TestScript.warningOnly [ fhir:value "true" ] ] ] ]; fhir:TestScript.teardown [ fhir:TestScript.action [ fhir:index 0; fhir:TestScript.operation [ fhir:TestScript.type [ fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/testscript-operation-codes" ]; fhir:Coding.code [ fhir:value "delete" ] ]; fhir:TestScript.resource [ fhir:value "Patient" ]; fhir:TestScript.description [ fhir:value "Delete the patient resource on the test server using the id from fixture-patient-create." ]; fhir:TestScript.encodeRequestUrl [ fhir:value "true" ]; fhir:TestScript.targetId [ fhir:value "fixture-patient-create" ] ] ] ] . # -------------------------------------------------------------------------------------
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.