Skip to main content

TestScript

Trial Use 2 Specialized — Quality & Testing

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/TestScript
InteractionMethodPath
ReadGET/fhir/R4/TestScript/[id]
VreadGET/fhir/R4/TestScript/[id]/_history/[vid]
UpdatePUT/fhir/R4/TestScript/[id]
PatchPATCH/fhir/R4/TestScript/[id]
DeleteDELETE/fhir/R4/TestScript/[id]
CreatePOST/fhir/R4/TestScript
SearchGET/fhir/R4/TestScript
HistoryGET/fhir/R4/TestScript/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
urluri1..1Canonical identifier for this test script, represented as a URI (globally unique)
identifierIdentifier0..1Additional identifier for the test script
versionstring0..1Business version of the test script
namestring1..1Name for this test script (computer friendly)
titlestring0..1Name for this test script (human friendly)
statuscode1..1draft | active | retired | unknown modifier
experimentalboolean0..1For testing purposes, not real usage
datedateTime0..1Date last changed
publisherstring0..1Name of the publisher (organization or individual)
contactContactDetail0..*Contact details for the publisher
descriptionmarkdown0..1Natural language description of the test script
useContextUsageContext0..*The context that the content is intended to support
jurisdictionCodeableConcept0..*Intended jurisdiction for test script (if applicable)
purposemarkdown0..1Why this test script is defined
copyrightmarkdown0..1Use and/or publishing restrictions
originBackboneElement0..*An abstract server representing a client or sender in a message exchange
destinationBackboneElement0..*An abstract server representing a destination or receiver in a message exchange
metadataBackboneElement0..1Required capability that is assumed to function correctly on the FHIR server being tested
fixtureBackboneElement0..*Fixture in the test script - by reference (uri)
profileReference0..*Reference of the validation profile
variableBackboneElement0..*Placeholder for evaluated elements
setupBackboneElement0..1A series of required setup operations before tests are executed
testBackboneElement0..*A test in this script
teardownBackboneElement0..1A series of required clean up steps

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
contextstringhttp://hl7.org/fhir/SearchParameter/TestScript-context
context-quantitystringhttp://hl7.org/fhir/SearchParameter/TestScript-context-quantity
context-typestringhttp://hl7.org/fhir/SearchParameter/TestScript-context-type
context-type-quantitystringhttp://hl7.org/fhir/SearchParameter/TestScript-context-type-quantity
context-type-valuestringhttp://hl7.org/fhir/SearchParameter/TestScript-context-type-value
datestringhttp://hl7.org/fhir/SearchParameter/TestScript-date
descriptionstringhttp://hl7.org/fhir/SearchParameter/TestScript-description
identifierstringhttp://hl7.org/fhir/SearchParameter/TestScript-identifier
jurisdictionstringhttp://hl7.org/fhir/SearchParameter/TestScript-jurisdiction
namestringhttp://hl7.org/fhir/SearchParameter/TestScript-name
publisherstringhttp://hl7.org/fhir/SearchParameter/TestScript-publisher
statusstringhttp://hl7.org/fhir/SearchParameter/TestScript-status
testscript-capabilitystringhttp://hl7.org/fhir/SearchParameter/TestScript-testscript-capability
titlestringhttp://hl7.org/fhir/SearchParameter/TestScript-title
urlstringhttp://hl7.org/fhir/SearchParameter/TestScript-url
versionstringhttp://hl7.org/fhir/SearchParameter/TestScript-version

Reference​

  • Official FHIR R4 spec: TestScript
  • Maturity: Trial Use 2 (FMM 2).