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
| 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)
Read 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 -------------------------------------------------------------------
<http://hl7.org/fhir/TestScript/testscript-example-readtest> a fhir:TestScript;
fhir:nodeRole fhir:treeRoot;
fhir:Resource.id [ fhir:value "testscript-example-readtest"];
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "generated" ];
fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</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>: id: 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>: Support: support@HL7.org(WORK)</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>: <span>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>http://hl7.org/fhir/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.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><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><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>*</td><td><span>Read</span></td><td>Patient</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><tr><td>-</td><td><b>Description</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>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>ContentType</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></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td><td><b>Description</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>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><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><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>*</td><td><span>Read</span></td><td>Patient</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><tr><td>-</td><td><b>Description</b></td><td><b>Response</b></td><td><b>WarningOnly</b></td></tr><tr><td>*</td><td>Confirm that the returned HTTP status is 404(Not Found).</td><td>notFound</td><td>false</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><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>*</td><td><span>Read</span></td><td>Patient</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><tr><td>-</td><td><b>Description</b></td><td><b>Response</b></td><td><b>WarningOnly</b></td></tr><tr><td>*</td><td>Confirm that the returned HTTP status is 404(Not Found).</td><td>notFound</td><td>false</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><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>*</td><td><span>Read</span></td><td>Patient</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><tr><td>-</td><td><b>Description</b></td><td><b>Response</b></td><td><b>WarningOnly</b></td></tr><tr><td>*</td><td>Confirm that the returned HTTP status is 400(Bad Request).</td><td>bad</td><td>false</td></tr></table></blockquote></blockquote></div>"
];
fhir:TestScript.url [ fhir:value "http://hl7.org/fhir/TestScript/testscript-example-readtest"];
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.9879" ]
];
fhir:TestScript.version [ fhir:value "1.0"];
fhir:TestScript.name [ fhir:value "TestScript Example Read Test"];
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 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."];
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 Read Operation"];
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 Read Operation" ];
fhir:TestScript.metadata.capability.link [
fhir:value "http://hl7.org/fhir/http.html#read";
fhir:index 0
];
fhir:TestScript.metadata.capability.capabilities [
fhir:value "http://hl7.org/fhir/CapabilityStatement/example";
fhir:link <http://hl7.org/fhir/CapabilityStatement/example>
]
]
];
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 "KnownPatientResourceId" ];
fhir:TestScript.variable.defaultValue [ fhir:value "example" ]
], [
fhir:index 1;
fhir:TestScript.variable.name [ fhir:value "NonExistsPatientResourceId" ];
fhir:TestScript.variable.defaultValue [ fhir:value "does-not-exist" ]
];
fhir:TestScript.test [
fhir:index 0;
fhir:Element.id [ fhir:value "R001" ];
fhir:TestScript.test.name [ fhir:value "Sprinkler Read Test R001" ];
fhir:TestScript.test.description [ fhir:value "Read a known 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://terminology.hl7.org/CodeSystem/testscript-operation-codes" ];
fhir:Coding.code [ fhir:value "read" ]
];
fhir:TestScript.setup.action.operation.resource [ fhir:value "Patient" ];
fhir:TestScript.setup.action.operation.description [ fhir:value "Read the known Patient resource on the destination test system using the user defined dynamic variable ${KnownPatientResourceId}." ];
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 "/${KnownPatientResourceId}" ]
]
], [
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.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.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.warningOnly [ fhir:value "true"^^xsd:boolean ]
]
], [
fhir:index 4;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned resource type is Patient." ];
fhir:TestScript.setup.action.assert.resource [ fhir:value "Patient" ];
fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "false"^^xsd:boolean ]
]
], [
fhir:index 5;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned Patient conforms to the base FHIR specification." ];
fhir:TestScript.setup.action.assert.validateProfileId [ fhir:value "patient-profile" ];
fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "false"^^xsd:boolean ]
]
]
], [
fhir:index 1;
fhir:Element.id [ fhir:value "R002" ];
fhir:TestScript.test.name [ fhir:value "Sprinkler Read Test R002" ];
fhir:TestScript.test.description [ fhir:value "Read an unknown Resource Type 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://terminology.hl7.org/CodeSystem/testscript-operation-codes" ];
fhir:Coding.code [ fhir:value "read" ]
];
fhir:TestScript.setup.action.operation.resource [ fhir:value "Patient" ];
fhir:TestScript.setup.action.operation.description [ fhir: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." ];
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 "/1" ]
]
], [
fhir:index 1;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP status is 404(Not Found)." ];
fhir:TestScript.setup.action.assert.response [ fhir:value "notFound" ];
fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "false"^^xsd:boolean ]
]
]
], [
fhir:index 2;
fhir:Element.id [ fhir:value "R003" ];
fhir:TestScript.test.name [ fhir:value "Sprinkler Read Test R003" ];
fhir:TestScript.test.description [ fhir:value "Read a known, non-existing 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://terminology.hl7.org/CodeSystem/testscript-operation-codes" ];
fhir:Coding.code [ fhir:value "read" ]
];
fhir:TestScript.setup.action.operation.resource [ fhir:value "Patient" ];
fhir:TestScript.setup.action.operation.description [ fhir:value "Attempt to read the non-existing Patient resource on the destination test system using the user defined dynamic variable ${NonExistsPatientResourceId}." ];
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 "/${NonExistsPatientResourceId}" ]
]
], [
fhir:index 1;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP status is 404(Not Found)." ];
fhir:TestScript.setup.action.assert.response [ fhir:value "notFound" ];
fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "false"^^xsd:boolean ]
]
]
], [
fhir:index 3;
fhir:Element.id [ fhir:value "R004" ];
fhir:TestScript.test.name [ fhir:value "Sprinkler Read Test R004" ];
fhir:TestScript.test.description [ fhir:value "Read a Patient using a known bad formatted resource id 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://terminology.hl7.org/CodeSystem/testscript-operation-codes" ];
fhir:Coding.code [ fhir:value "read" ]
];
fhir:TestScript.setup.action.operation.resource [ fhir:value "Patient" ];
fhir:TestScript.setup.action.operation.description [ fhir:value "Attempt to read a Patient resource on the destination test system using known bad formatted resource id." ];
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 "/ID-may-not-contain-CAPITALS" ]
]
], [
fhir:index 1;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP status is 400(Bad Request)." ];
fhir:TestScript.setup.action.assert.response [ fhir:value "bad" ];
fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "false"^^xsd:boolean ]
]
]
] .
<http://hl7.org/fhir/StructureDefinition/Patient> a fhir:StructureDefinition .
# - ontology header ------------------------------------------------------------
<http://hl7.org/fhir/TestScript/testscript-example-readtest.ttl> a owl:Ontology;
owl:imports fhir:fhir.ttl;
owl:versionIRI <http://build.fhir.org/TestScript/testscript-example-readtest.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.
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