description: A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification. package_name: hl7.fhir.r5.examples derivation: specialization name: TestScript type: TestScript elements: description: {isModifier: false, short: Natural language description of the test script, type: markdown, mustSupport: false, isSummary: false, index: 14} date: {isModifier: false, short: Date last changed, type: dateTime, mustSupport: false, isSummary: true, index: 11} variable: constraint: tst-3: {human: 'Variable can only contain one of expression, headerField or path.', source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: expression.empty() or headerField.empty() or path.empty()} isModifier: false short: Placeholder for evaluated elements index: 49 type: BackboneElement mustSupport: false array: true elements: name: {isModifier: false, short: Descriptive name for this variable, type: string, mustSupport: false, isSummary: false, index: 50} defaultValue: {isModifier: false, short: 'Default, hard-coded, or user-defined value for this variable', type: string, mustSupport: false, isSummary: false, index: 51} description: {isModifier: false, short: Natural language description of the variable, type: string, mustSupport: false, isSummary: false, index: 52} expression: {isModifier: false, short: The FHIRPath expression against the fixture body, type: string, mustSupport: false, isSummary: false, index: 53} headerField: {isModifier: false, short: HTTP header field name for source, type: string, mustSupport: false, isSummary: false, index: 54} hint: {isModifier: false, short: Hint help text for default value to enter, type: string, mustSupport: false, isSummary: false, index: 55} path: {isModifier: false, short: XPath or JSONPath against the fixture body, type: string, mustSupport: false, isSummary: false, index: 56} sourceId: {isModifier: false, short: Fixture Id of source expression or headerField within this variable, type: id, mustSupport: false, isSummary: false, index: 57} required: [name] isSummary: false publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), type: string, mustSupport: false, isSummary: true, index: 12} jurisdiction: isModifier: false short: Intended jurisdiction for test script (if applicable) type: CodeableConcept mustSupport: false array: true binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'} isSummary: true index: 16 purpose: {isModifier: false, short: Why this test script is defined, type: markdown, mustSupport: false, isSummary: false, index: 17} name: {isModifier: false, short: Name for this test script (computer friendly), type: string, mustSupport: false, isSummary: true, index: 7} copyrightLabel: {isModifier: false, short: Copyright holder and year(s), type: string, mustSupport: false, isSummary: false, index: 19} useContext: {isModifier: false, short: The context that the content is intended to support, type: UsageContext, mustSupport: false, array: true, isSummary: true, index: 15} copyright: {isModifier: false, short: Use and/or publishing restrictions, type: markdown, mustSupport: false, isSummary: false, index: 18} versionAlgorithm: isModifier: false short: How to compare versions mustSupport: false choices: [versionAlgorithmString, versionAlgorithmCoding] isSummary: true index: 4 experimental: {isModifier: false, short: 'For testing purposes, not real usage', type: boolean, mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 10} scope: isModifier: false short: Indication of the artifact(s) that are tested by this test case index: 40 type: BackboneElement mustSupport: false array: true elements: artifact: {isModifier: false, short: The specific conformance artifact being tested, type: canonical, mustSupport: false, isSummary: false, index: 41} conformance: isModifier: false short: required | optional | strict type: CodeableConcept mustSupport: false meaningWhenMissing: required binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/testscript-scope-conformance-codes'} isSummary: false index: 42 phase: isModifier: false short: unit | integration | production type: CodeableConcept mustSupport: false meaningWhenMissing: unit binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/testscript-scope-phase-codes'} isSummary: false index: 43 required: [artifact] isSummary: false title: {isModifier: false, short: Name for this test script (human friendly), type: string, mustSupport: false, isSummary: true, index: 8} setup: isModifier: false short: A series of required setup operations before tests are executed type: BackboneElement mustSupport: false isSummary: false index: 58 elements: action: constraint: tst-1: {human: Setup action SHALL contain either an operation or assert but not both., source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: operation.exists() xor assert.exists()} min: 1 isModifier: false short: A setup operation or assert to perform index: 59 type: BackboneElement mustSupport: false array: true elements: operation: constraint: tst-7: {human: Setup operation SHALL contain either sourceId or targetId or params or url., source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' |'search' | 'transaction' | 'history'))} isModifier: false short: The setup operation to perform index: 60 type: BackboneElement mustSupport: false elements: description: {isModifier: false, short: Tracking/reporting operation description, type: string, mustSupport: false, isSummary: false, index: 64} method: isModifier: false short: delete | get | options | patch | post | put | head type: code mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/http-operations|5.0.0-draft-final'} isSummary: false index: 69 targetId: {isModifier: false, short: 'Id of fixture used for extracting the [id], [type], and [vid] for GET requests', type: id, mustSupport: false, isSummary: false, index: 78} requestHeader: isModifier: false short: Each operation can have one or more header elements index: 72 type: BackboneElement mustSupport: false array: true elements: field: {isModifier: false, short: HTTP header field name, type: string, mustSupport: false, isSummary: false, index: 73} value: {isModifier: false, short: HTTP headerfield value, type: string, mustSupport: false, isSummary: false, index: 74} required: [value, field] isSummary: false params: {isModifier: false, short: Explicitly defined path parameters, type: string, mustSupport: false, isSummary: false, index: 71} type: isModifier: false short: The operation code type that will be executed type: Coding mustSupport: false binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/testscript-operation-codes'} isSummary: false index: 61 requestId: {isModifier: false, short: Fixture Id of mapped request, type: id, mustSupport: false, isSummary: false, index: 75} encodeRequestUrl: {isModifier: false, short: Whether or not to send the request url in encoded format, type: boolean, mustSupport: false, isSummary: false, index: 68} label: {isModifier: false, short: Tracking/logging operation label, type: string, mustSupport: false, isSummary: false, index: 63} resource: isModifier: false short: Resource type type: uri mustSupport: false binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/concrete-fhir-types'} isSummary: false index: 62 url: {isModifier: false, short: Request URL, type: string, mustSupport: false, isSummary: false, index: 79} origin: {isModifier: false, short: Server initiating the request, type: integer, mustSupport: false, isSummary: false, index: 70} contentType: isModifier: false short: Mime type of the request payload contents, with charset etc type: code mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/mimetypes|5.0.0-draft-final'} isSummary: false index: 66 sourceId: {isModifier: false, short: Fixture Id of body for PUT and POST requests, type: id, mustSupport: false, isSummary: false, index: 77} responseId: {isModifier: false, short: Fixture Id of mapped response, type: id, mustSupport: false, isSummary: false, index: 76} destination: {isModifier: false, short: Server responding to the request, type: integer, mustSupport: false, isSummary: false, index: 67} accept: isModifier: false short: Mime type to accept in the payload of the response, with charset etc type: code mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/mimetypes|5.0.0-draft-final'} isSummary: false index: 65 required: [encodeRequestUrl] isSummary: false assert: constraint: tst-12: {human: Setup action assert response and responseCode SHALL be empty when direction equals request, source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: (response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response'} tst-5: {human: Only a single assertion SHALL be present within setup action assert element., source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1) or (((expression.count() + minimumId.count() <=2) or (expression.count() + validateProfileId.count() <=2)) and (expression.count() + path.count() <=1) and (minimumId.count() + validateProfileId.count() <=1)) or (((path.count() + minimumId.count() <=2) or (path.count() + validateProfileId.count() <=2)) and (expression.count() + path.count() <=1) and (minimumId.count() + validateProfileId.count() <=1))} tst-10: {human: 'Setup action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.', source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists())} isModifier: false short: The assertion to perform index: 80 type: BackboneElement mustSupport: false elements: response: isModifier: false short: continue | switchingProtocols | okay | created | accepted | nonAuthoritativeInformation | noContent | resetContent | partialContent | multipleChoices | movedPermanently | found | seeOther | notModified | useProxy | temporaryRedirect | permanentRedirect | badRequest | unauthorized | paymentRequired | forbidden | notFound | methodNotAllowed | notAcceptable | proxyAuthenticationRequired | requestTimeout | conflict | gone | lengthRequired | preconditionFailed | contentTooLarge | uriTooLong | unsupportedMediaType | rangeNotSatisfiable | expectationFailed | misdirectedRequest | unprocessableContent | upgradeRequired | internalServerError | notImplemented | badGateway | serviceUnavailable | gatewayTimeout | httpVersionNotSupported type: code mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/assert-response-code-types|5.0.0-draft-final'} isSummary: false index: 98 description: {isModifier: false, short: Tracking/reporting assertion description, type: string, mustSupport: false, isSummary: false, index: 82} path: {isModifier: false, short: XPath or JSONPath expression, type: string, mustSupport: false, isSummary: false, index: 94} headerField: {isModifier: false, short: HTTP header field name, type: string, mustSupport: false, isSummary: false, index: 90} compareToSourceId: {isModifier: false, short: Id of the source fixture to be evaluated, type: string, mustSupport: false, isSummary: false, index: 84} requirement: isModifier: false short: Links or references to the testing requirements type: BackboneElement mustSupport: false array: true isSummary: false index: 105 elements: link: isModifier: false short: Link or reference to the testing requirement mustSupport: false choices: [linkUri, linkCanonical] isSummary: false index: 107 linkUri: {isModifier: false, short: Link or reference to the testing requirement, type: uri, mustSupport: false, choiceOf: link, isSummary: false, index: 108} linkCanonical: {isModifier: false, short: Link or reference to the testing requirement, type: canonical, mustSupport: false, choiceOf: link, isSummary: false, index: 109} expression: {isModifier: false, short: The FHIRPath expression to be evaluated, type: string, mustSupport: false, isSummary: false, index: 89} stopTestOnFail: {isModifier: false, short: 'If this assert fails, will the current test execution stop?', type: boolean, mustSupport: false, isSummary: false, index: 101} defaultManualCompletion: isModifier: false short: fail | pass | skip | stop type: code mustSupport: false meaningWhenMissing: If defaultManualCompletion is not specified, then the default manual completion outcome will be 'skip'. binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/assert-manual-completion-codes|5.0.0-draft-final'} isSummary: false index: 88 value: {isModifier: false, short: The value to compare to, type: string, mustSupport: false, isSummary: false, index: 103} warningOnly: {isModifier: false, short: 'Will this assert produce a warning only on error?', type: boolean, mustSupport: false, isSummary: false, index: 104} compareToSourceExpression: {isModifier: false, short: The FHIRPath expression to evaluate against the source fixture, type: string, mustSupport: false, isSummary: false, index: 85} label: {isModifier: false, short: Tracking/logging assertion label, type: string, mustSupport: false, isSummary: false, index: 81} resource: isModifier: false short: Resource type type: uri mustSupport: false binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/concrete-fhir-types'} isSummary: false index: 97 responseCode: {isModifier: false, short: HTTP response code to test, type: string, mustSupport: false, isSummary: false, index: 99} minimumId: {isModifier: false, short: Fixture Id of minimum content resource, type: string, mustSupport: false, isSummary: false, index: 91} operator: isModifier: false short: equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval | manualEval type: code mustSupport: false meaningWhenMissing: If operator is not specified, then the default conditional behavior is implemented as defined in the Testing FHIR page Assertions table - see Comments. binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/assert-operator-codes|5.0.0-draft-final'} isSummary: false index: 93 contentType: isModifier: false short: Mime type to compare against the 'Content-Type' header type: code mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/mimetypes|5.0.0-draft-final'} isSummary: false index: 87 compareToSourcePath: {isModifier: false, short: XPath or JSONPath expression to evaluate against the source fixture, type: string, mustSupport: false, isSummary: false, index: 86} validateProfileId: {isModifier: false, short: Profile Id of validation profile reference, type: id, mustSupport: false, isSummary: false, index: 102} sourceId: {isModifier: false, short: Fixture Id of source expression or headerField, type: id, mustSupport: false, isSummary: false, index: 100} requestMethod: isModifier: false short: delete | get | options | patch | post | put | head type: code mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/http-operations|5.0.0-draft-final'} isSummary: false index: 95 requestURL: {isModifier: false, short: Request URL comparison value, type: string, mustSupport: false, isSummary: false, index: 96} direction: isModifier: false short: response | request type: code mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/assert-direction-codes|5.0.0-draft-final'} isSummary: false index: 83 navigationLinks: {isModifier: false, short: 'Perform validation on navigation links?', type: boolean, mustSupport: false, isSummary: false, index: 92} required: [warningOnly, stopTestOnFail] isSummary: false isSummary: false required: [action] versionAlgorithmCoding: {isModifier: false, short: How to compare versions, type: Coding, mustSupport: false, choiceOf: versionAlgorithm, isSummary: true, index: 6} status: isModifier: true short: draft | active | retired | unknown index: 9 type: code mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|5.0.0-draft-final'} isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration isSummary: true url: constraint: cnl-1: {human: 'URL should not contain | or # - these characters make processing canonical references problematic', source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: warning, expression: 'exists() implies matches(''^[^|# ]+$'')'} isModifier: false short: Canonical identifier for this test script, represented as a URI (globally unique) type: uri mustSupport: false isSummary: true index: 0 identifier: {isModifier: false, short: Additional identifier for the test script, type: Identifier, mustSupport: false, array: true, isSummary: true, index: 1} versionAlgorithmString: {isModifier: false, short: How to compare versions, type: string, mustSupport: false, choiceOf: versionAlgorithm, isSummary: true, index: 5} origin: isModifier: false short: An abstract server representing a client or sender in a message exchange index: 20 type: BackboneElement mustSupport: false array: true elements: index: {isModifier: false, short: The index of the abstract origin server starting at 1, type: integer, mustSupport: false, isSummary: false, index: 21} profile: isModifier: false short: FHIR-Client | FHIR-SDC-FormFiller index: 22 type: Coding mustSupport: false meaningWhenMissing: FHIR-Client binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/testscript-profile-origin-types'} isSummary: false url: {isModifier: false, short: The url path of the origin server, type: url, mustSupport: false, isSummary: false, index: 23} required: [index, profile] isSummary: false fixture: isModifier: false short: Fixture in the test script - by reference (uri) index: 44 type: BackboneElement mustSupport: false array: true elements: autocreate: {isModifier: false, short: Whether or not to implicitly create the fixture during setup, type: boolean, mustSupport: false, isSummary: false, index: 45} autodelete: {isModifier: false, short: Whether or not to implicitly delete the fixture during teardown, type: boolean, mustSupport: false, isSummary: false, index: 46} resource: isModifier: false short: Reference of the resource refers: ['http://hl7.org/fhir/StructureDefinition/Resource'] type: Reference mustSupport: false isSummary: false index: 47 required: [autodelete, autocreate] isSummary: false version: {isModifier: false, short: Business version of the test script, type: string, mustSupport: false, isSummary: true, index: 2} teardown: isModifier: false short: A series of required clean up steps type: BackboneElement mustSupport: false isSummary: false index: 116 elements: action: min: 1 isModifier: false short: One or more teardown operations to perform index: 117 type: BackboneElement mustSupport: false array: true elements: operation: constraint: tst-9: {human: Teardown operation SHALL contain either sourceId or targetId or params or url., source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' | 'search' | 'transaction' | 'history'))} elementReference: ['http://hl7.org/fhir/StructureDefinition/TestScript', elements, setup, elements, action, elements, operation] isModifier: false short: The teardown operation to perform mustSupport: false isSummary: false index: 118 required: [operation] isSummary: false required: [action] contact: {isModifier: false, short: Contact details for the publisher, type: ContactDetail, mustSupport: false, array: true, isSummary: true, index: 13} metadata: constraint: tst-4: {human: TestScript metadata capability SHALL contain required or validated or both., source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: capability.required.exists() or capability.validated.exists()} isModifier: false short: Required capability that is assumed to function correctly on the FHIR server being tested index: 28 type: BackboneElement mustSupport: false elements: link: isModifier: false short: Links to the FHIR specification index: 29 type: BackboneElement mustSupport: false array: true elements: url: {isModifier: false, short: URL to the specification, type: uri, mustSupport: false, isSummary: false, index: 30} description: {isModifier: false, short: Short description, type: string, mustSupport: false, isSummary: false, index: 31} required: [url] isSummary: false capability: min: 1 isModifier: false short: Capabilities that are assumed to function correctly on the FHIR server being tested index: 32 type: BackboneElement mustSupport: false array: true elements: required: {isModifier: false, short: 'Are the capabilities required?', type: boolean, mustSupport: false, isSummary: false, index: 33} validated: {isModifier: false, short: 'Are the capabilities validated?', type: boolean, mustSupport: false, isSummary: false, index: 34} description: {isModifier: false, short: The expected capabilities of the server, type: string, mustSupport: false, isSummary: false, index: 35} origin: {isModifier: false, short: Which origin server these requirements apply to, type: integer, mustSupport: false, array: true, isSummary: false, index: 36} destination: {isModifier: false, short: Which server these requirements apply to, type: integer, mustSupport: false, isSummary: false, index: 37} link: {isModifier: false, short: Links to the FHIR specification, type: uri, mustSupport: false, array: true, isSummary: false, index: 38} capabilities: {isModifier: false, short: Required Capability Statement, type: canonical, mustSupport: false, isSummary: false, index: 39} required: [capabilities, required, validated] isSummary: false required: [capability] isSummary: false destination: isModifier: false short: An abstract server representing a destination or receiver in a message exchange index: 24 type: BackboneElement mustSupport: false array: true elements: index: {isModifier: false, short: The index of the abstract destination server starting at 1, type: integer, mustSupport: false, isSummary: false, index: 25} profile: isModifier: false short: FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor index: 26 type: Coding mustSupport: false meaningWhenMissing: FHIR-Server binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/testscript-profile-destination-types'} isSummary: false url: {isModifier: false, short: The url path of the destination server, type: url, mustSupport: false, isSummary: false, index: 27} required: [index, profile] isSummary: false test: isModifier: false short: A test in this script index: 110 type: BackboneElement mustSupport: false array: true elements: name: {isModifier: false, short: Tracking/logging name of this test, type: string, mustSupport: false, isSummary: false, index: 111} description: {isModifier: false, short: Tracking/reporting short description of the test, type: string, mustSupport: false, isSummary: false, index: 112} action: constraint: tst-2: {human: Test action SHALL contain either an operation or assert but not both., source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: operation.exists() xor assert.exists()} min: 1 isModifier: false short: A test operation or assert to perform index: 113 type: BackboneElement mustSupport: false array: true elements: operation: constraint: tst-8: {human: Test operation SHALL contain either sourceId or targetId or params or url., source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' | 'search' | 'transaction' | 'history'))} elementReference: ['http://hl7.org/fhir/StructureDefinition/TestScript', elements, setup, elements, action, elements, operation] isModifier: false short: The setup operation to perform mustSupport: false isSummary: false index: 114 assert: constraint: tst-11: {human: 'Test action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.', source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists())} tst-13: {human: Test action assert response and response and responseCode SHALL be empty when direction equals request, source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: (response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response'} tst-6: {human: Only a single assertion SHALL be present within test action assert element., source: 'http://hl7.org/fhir/StructureDefinition/TestScript', severity: error, expression: extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1) or (((expression.count() + minimumId.count() <=2) or (expression.count() + validateProfileId.count() <=2)) and (expression.count() + path.count() <=1) and (minimumId.count() + validateProfileId.count() <=1)) or (((path.count() + minimumId.count() <=2) or (path.count() + validateProfileId.count() <=2)) and (expression.count() + path.count() <=1) and (minimumId.count() + validateProfileId.count() <=1))} elementReference: ['http://hl7.org/fhir/StructureDefinition/TestScript', elements, setup, elements, action, elements, assert] isModifier: false short: The setup assertion to perform mustSupport: false isSummary: false index: 115 isSummary: false required: [action] isSummary: false profile: {isModifier: false, short: Reference of the validation profile, type: canonical, mustSupport: false, array: true, isSummary: false, index: 48} package_version: 5.0.0-draft-final class: resource kind: resource url: http://hl7.org/fhir/StructureDefinition/TestScript base: http://hl7.org/fhir/StructureDefinition/DomainResource version: 5.0.0-draft-final required: [name, status]