Release 4B Ballot #1
Implementation SupportThis page is part of the FHIR Specification (v4.1.0: Release 4B Ballot #1). 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)
History 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-history> a fhir:TestScript;
fhir:nodeRole fhir:treeRoot;
fhir:Resource.id [ fhir:value "testscript-example-history"];
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>url</b>: <a>http://hl7.org/fhir/TestScript/testscript-example-history</a></p><p><b>identifier</b>: id: urn:oid:1.3.6.1.4.1.21367.2005.3.7.9877</p><p><b>version</b>: 1.0</p><p><b>name</b>: TestScript Example History</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>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 then update that Patient to create a minimum history; and single test definition to get the history of that Patient with various asserts.</p><p><b>jurisdiction</b>: <span>United States of America (the)</span></p><p><b>purpose</b>: Patient (Conditional) Create, Update, Delete and History (Instance) 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, Delete and History (Instance) Operations</td><td><a>http://hl7.org/fhir/http.html#update</a>, <a>http://hl7.org/fhir/http.html#delete</a>, <a>http://hl7.org/fhir/http.html#history</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: Medical record number: 12345 (USUAL); active; Peter James Chalmers (OFFICIAL), Jim , Peter James Windsor (MAIDEN); , Phone: (03) 5555 6473, Phone: (03) 3410 5613, Phone: (03) 5555 8834; 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>Donald Duck. Generated Summary: Medical record number: 654321 (USUAL); active; Duck Donald (OFFICIAL); gender: male</a></p></blockquote><p><b>profile</b>: <a>Generated Summary: url: http://hl7.org/fhir/StructureDefinition/Bundle; version: 4.1.0; name: Bundle; ACTIVE; date: 11 Mar. 2021, 5:06:20 pm; publisher: Health Level Seven International (FHIR Infrastructure); http://hl7.org/fhir, http://www.hl7.org/Special/com...; 4.1.0; RESOURCE; type: Bundle; baseDefinition: http://hl7.org/fhir/StructureDefinition/Resource; 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>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>SetupUpdatePatient</td><td>Update patient resource on test server using the contents of fixture-patient-update</td><td>json</td><td>json</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><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 200(OK).</td><td>response</td><td>200</td><td>false</td></tr></table></blockquote></blockquote><blockquote><p><b>test</b></p><p><b>name</b>: History Patient</p><p><b>description</b>: Get the history for a known Patient and validate response.</p><blockquote><p><b>action</b></p><h3>Operations</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote></blockquote></div>"
];
fhir:TestScript.url [ fhir:value "http://hl7.org/fhir/TestScript/testscript-example-history"];
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.9877" ]
];
fhir:TestScript.version [ fhir:value "1.0"];
fhir:TestScript.name [ fhir:value "TestScript Example History"];
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 then update that Patient to create a minimum history; and single test definition to get the history of 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 and History (Instance) 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, Delete and History (Instance) 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:value "http://hl7.org/fhir/http.html#history";
fhir:index 2
];
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:link <http://hl7.org/fhir/Patient/example>;
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:link <http://hl7.org/fhir/Patient/pat1>;
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/Bundle>;
fhir:Element.id [ fhir:value "bundle-profile" ];
fhir:Reference.reference [ fhir:value "http://hl7.org/fhir/StructureDefinition/Bundle" ]
];
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://terminology.hl7.org/CodeSystem/testscript-operation-codes" ];
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 "json" ];
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.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://terminology.hl7.org/CodeSystem/testscript-operation-codes" ];
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 "json" ];
fhir:TestScript.setup.action.operation.contentType [ fhir:value "json" ];
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.warningOnly [ fhir:value "false"^^xsd:boolean ]
]
], [
fhir:index 4;
fhir:TestScript.setup.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 "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 "json" ];
fhir:TestScript.setup.action.operation.contentType [ fhir:value "json" ];
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 5;
fhir:TestScript.setup.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned HTTP status is 200(OK)." ];
fhir:TestScript.setup.action.assert.direction [ fhir:value "response" ];
fhir:TestScript.setup.action.assert.responseCode [ fhir:value "200" ];
fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "false"^^xsd:boolean ]
]
]
];
fhir:TestScript.test [
fhir:index 0;
fhir:Element.id [ fhir:value "01-HistoryPatient" ];
fhir:TestScript.test.name [ fhir:value "History Patient" ];
fhir:TestScript.test.description [ fhir:value "Get the history for 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 "history" ]
];
fhir:TestScript.setup.action.operation.resource [ fhir:value "Patient" ];
fhir:TestScript.setup.action.operation.description [ fhir:value "Get the Patient history on the test server using the id from fixture-patient-create." ];
fhir:TestScript.setup.action.operation.accept [ fhir:value "json" ];
fhir:TestScript.setup.action.operation.contentType [ fhir:value "json" ];
fhir:TestScript.setup.action.operation.encodeRequestUrl [ fhir:value "true"^^xsd:boolean ];
fhir:TestScript.setup.action.operation.targetId [ fhir:value "fixture-patient-create" ]
]
], [
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.direction [ fhir:value "response" ];
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 resource type is Bundle." ];
fhir:TestScript.setup.action.assert.resource [ fhir:value "Bundle" ];
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 Bundle conforms to the base FHIR specification." ];
fhir:TestScript.setup.action.assert.validateProfileId [ fhir:value "bundle-profile" ];
fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "false"^^xsd:boolean ]
]
], [
fhir:index 4;
fhir:TestScript.test.action.assert [
fhir:TestScript.setup.action.assert.description [ fhir:value "Confirm that the returned Bundle type equals 'history'." ];
fhir:TestScript.setup.action.assert.operator [ fhir:value "equals" ];
fhir:TestScript.setup.action.assert.path [ fhir:value "fhir:Bundle/fhir:type/@value" ];
fhir:TestScript.setup.action.assert.value [ fhir:value "history" ];
fhir:TestScript.setup.action.assert.warningOnly [ fhir:value "false"^^xsd:boolean ]
]
]
] .
<http://hl7.org/fhir/Patient/example> a fhir:Patient .
<http://hl7.org/fhir/Patient/pat1> a fhir:Patient .
<http://hl7.org/fhir/StructureDefinition/Bundle> a fhir:StructureDefinition .
# - ontology header ------------------------------------------------------------
<http://hl7.org/fhir/TestScript/testscript-example-history.ttl> a owl:Ontology;
owl:imports fhir:fhir.ttl;
owl:versionIRI <http://build.fhir.org/TestScript/testscript-example-history.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 R4B Ballot #1 hl7.fhir.core#4.1.0 generated on Thu, Mar 11, 2021 17:11+1100.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change