TestReport - FHIR Resource (r4)

This TestReport Resource uses the FHIR API standard for access and structure.

Validate an TestReport FHIR Resource (r4)

TestReport Attributes

AttributeField is listTypeDescription

Description: External identifier

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": {
  "system": "urn:ietf:rfc:3986",
  "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.9878"
}

Learn more about the (TestReport) identifier FHIR attribute

Description: Informal name of the executed TestScript

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name": "TestReport Example for TestScript Example"

Learn more about the (TestReport) name FHIR attribute

Description: completed | in-progress | waiting | stopped | entered-in-error

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "completed"

Learn more about the (TestReport) status FHIR attribute

Description: Reference to the version-specific TestScript that was executed to produce this TestReport

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"testScript": {
  "reference": "TestScript/testscript-example"
}

Learn more about the (TestReport) testScript FHIR attribute

Description: pass | fail | pending

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"result": "pass"

Learn more about the (TestReport) result FHIR attribute

Description: The final score (percentage of tests passed) resulting from the execution of the TestScript

FHIR Version: r4

Attribute Type : decimal

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"score": 100

Learn more about the (TestReport) score FHIR attribute

Description: Name of the tester producing this report (Organization or individual)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"tester": "HL7 Execution Engine"

Learn more about the (TestReport) tester FHIR attribute

Description: When the TestScript was executed and this TestReport was generated

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"issued": "2016-10-07T08:25:34-05:00"

Learn more about the (TestReport) issued FHIR attribute

Description: A participant in the test execution, either the execution engine, a client, or a server

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"participant": [
  {
    "type": "test-engine",
    "uri": "http://projectcrucible.org",
    "display": "Crucible"
  },
  {
    "type": "server",
    "uri": "http://fhir3.healthintersections.com.au/open",
    "display": "HealthIntersections STU3"
  }
]

Learn more about the (TestReport) participant FHIR attribute

Description: The results of the series of required setup operations before the tests were executed

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"setup": {
  "action": [
    {
      "operation": {
        "result": "pass",
        "message": "DELETE Patient",
        "detail": "http://projectcrucible.org/permalink/1"
      }
    },
    {
      "assert": {
        "result": "pass",
        "message": "HTTP 204",
        "detail": "http://projectcrucible.org/permalink/1"
      }
    },
    {
      "operation": {
        "result": "pass",
        "message": "POST Patient/fixture-patient-create",
        "detail": "http://projectcrucible.org/permalink/1"
      }
    },
    {
      "assert": {
        "result": "pass",
        "message": "HTTP 201",
        "detail": "http://projectcrucible.org/permalink/1"
      }
    }
  ]
}

Learn more about the (TestReport) setup FHIR attribute

Description: A test executed from the test script

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"test": [
  {
    "id": "01-ReadPatient",
    "name": "Read Patient",
    "description": "Read a Patient and validate response.",
    "action": [
      {
        "operation": {
          "result": "pass",
          "message": "GET Patient/fixture-patient-create",
          "detail": "http://projectcrucible.org/permalink/2"
        }
      },
      {
        "assert": {
          "result": "pass",
          "message": "HTTP 200",
          "detail": "http://projectcrucible.org/permalink/2"
        }
      },
      {
        "assert": {
          "result": "pass",
          "message": "Last-Modified Present",
          "detail": "http://projectcrucible.org/permalink/2"
        }
      },
      {
        "assert": {
          "result": "pass",
          "message": "Response is Patient",
          "detail": "http://projectcrucible.org/permalink/2"
        }
      },
      {
        "assert": {
          "result": "pass",
          "message": "Response validates",
          "detail": "http://projectcrucible.org/permalink/2"
        }
      },
      {
        "assert": {
          "result": "pass",
          "message": "Patient.name.family 'Chalmers'",
          "detail": "http://projectcrucible.org/permalink/2"
        }
      },
      {
        "assert": {
          "result": "pass",
          "message": "Patient.name.given 'Peter'",
          "detail": "http://projectcrucible.org/permalink/2"
        }
      },
      {
        "assert": {
          "result": "pass",
          "message": "Patient.name.family 'Chalmers'",
          "detail": "http://projectcrucible.org/permalink/2"
        }
      },
      {
        "assert": {
          "result": "pass",
          "message": "Patient.name.family 'Chalmers'",
          "detail": "http://projectcrucible.org/permalink/2"
        }
      },
      {
        "assert": {
          "result": "pass",
          "message": "Patient expected values.",
          "detail": "http://projectcrucible.org/permalink/2"
        }
      }
    ]
  }
]

Learn more about the (TestReport) test FHIR attribute

Description: The results of running the series of required clean up steps

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"teardown": {
  "action": [
    {
      "operation": {
        "result": "pass",
        "message": "DELETE Patient/fixture-patient-create.",
        "detail": "http://projectcrucible.org/permalink/3"
      }
    }
  ]
}

Learn more about the (TestReport) teardown FHIR attribute

TestReport Example

{
  "resourceType": "TestReport",
  "id": "testreport-example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: testreport-example</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.9878</p><p><b>name</b>: TestReport Example for TestScript Example</p><p><b>status</b>: completed</p><p><b>testScript</b>: <a>TestScript/testscript-example</a></p><p><b>result</b>: pass</p><p><b>score</b>: 100.0</p><p><b>tester</b>: HL7 Execution Engine</p><p><b>issued</b>: 07/10/2016 8:25:34 AM</p><blockquote><p><b>participant</b></p><p><b>type</b>: test-engine</p><p><b>uri</b>: <a>http://projectcrucible.org</a></p><p><b>display</b>: Crucible</p></blockquote><blockquote><p><b>participant</b></p><p><b>type</b>: server</p><p><b>uri</b>: <a>http://fhir3.healthintersections.com.au/open</a></p><p><b>display</b>: HealthIntersections STU3</p></blockquote><blockquote><p><b>setup</b></p><blockquote><p><b>action</b></p><h3>Operations</h3><table><tr><td>-</td><td><b>Result</b></td><td><b>Message</b></td><td><b>Detail</b></td></tr><tr><td>*</td><td>pass</td><td>DELETE Patient</td><td><a>http://projectcrucible.org/permalink/1</a></td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td><td><b>Result</b></td><td><b>Message</b></td><td><b>Detail</b></td></tr><tr><td>*</td><td>pass</td><td>HTTP 204</td><td>http://projectcrucible.org/permalink/1</td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Operations</h3><table><tr><td>-</td><td><b>Result</b></td><td><b>Message</b></td><td><b>Detail</b></td></tr><tr><td>*</td><td>pass</td><td>POST Patient/fixture-patient-create</td><td><a>http://projectcrucible.org/permalink/1</a></td></tr></table></blockquote><blockquote><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td><td><b>Result</b></td><td><b>Message</b></td><td><b>Detail</b></td></tr><tr><td>*</td><td>pass</td><td>HTTP 201</td><td>http://projectcrucible.org/permalink/1</td></tr></table></blockquote></blockquote><blockquote><p><b>test</b></p><p><b>name</b>: Read Patient</p><p><b>description</b>: Read a 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><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><p><b>action</b></p><h3>Asserts</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote></blockquote><blockquote><p><b>teardown</b></p><blockquote><p><b>action</b></p><h3>Operations</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote></blockquote></div>"
  },
  "identifier": {
    "system": "urn:ietf:rfc:3986",
    "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.9878"
  },
  "name": "TestReport Example for TestScript Example",
  "status": "completed",
  "testScript": {
    "reference": "TestScript/testscript-example"
  },
  "result": "pass",
  "score": 100,
  "tester": "HL7 Execution Engine",
  "issued": "2016-10-07T08:25:34-05:00",
  "participant": [
    {
      "type": "test-engine",
      "uri": "http://projectcrucible.org",
      "display": "Crucible"
    },
    {
      "type": "server",
      "uri": "http://fhir3.healthintersections.com.au/open",
      "display": "HealthIntersections STU3"
    }
  ],
  "setup": {
    "action": [
      {
        "operation": {
          "result": "pass",
          "message": "DELETE Patient",
          "detail": "http://projectcrucible.org/permalink/1"
        }
      },
      {
        "assert": {
          "result": "pass",
          "message": "HTTP 204",
          "detail": "http://projectcrucible.org/permalink/1"
        }
      },
      {
        "operation": {
          "result": "pass",
          "message": "POST Patient/fixture-patient-create",
          "detail": "http://projectcrucible.org/permalink/1"
        }
      },
      {
        "assert": {
          "result": "pass",
          "message": "HTTP 201",
          "detail": "http://projectcrucible.org/permalink/1"
        }
      }
    ]
  },
  "test": [
    {
      "id": "01-ReadPatient",
      "name": "Read Patient",
      "description": "Read a Patient and validate response.",
      "action": [
        {
          "operation": {
            "result": "pass",
            "message": "GET Patient/fixture-patient-create",
            "detail": "http://projectcrucible.org/permalink/2"
          }
        },
        {
          "assert": {
            "result": "pass",
            "message": "HTTP 200",
            "detail": "http://projectcrucible.org/permalink/2"
          }
        },
        {
          "assert": {
            "result": "pass",
            "message": "Last-Modified Present",
            "detail": "http://projectcrucible.org/permalink/2"
          }
        },
        {
          "assert": {
            "result": "pass",
            "message": "Response is Patient",
            "detail": "http://projectcrucible.org/permalink/2"
          }
        },
        {
          "assert": {
            "result": "pass",
            "message": "Response validates",
            "detail": "http://projectcrucible.org/permalink/2"
          }
        },
        {
          "assert": {
            "result": "pass",
            "message": "Patient.name.family 'Chalmers'",
            "detail": "http://projectcrucible.org/permalink/2"
          }
        },
        {
          "assert": {
            "result": "pass",
            "message": "Patient.name.given 'Peter'",
            "detail": "http://projectcrucible.org/permalink/2"
          }
        },
        {
          "assert": {
            "result": "pass",
            "message": "Patient.name.family 'Chalmers'",
            "detail": "http://projectcrucible.org/permalink/2"
          }
        },
        {
          "assert": {
            "result": "pass",
            "message": "Patient.name.family 'Chalmers'",
            "detail": "http://projectcrucible.org/permalink/2"
          }
        },
        {
          "assert": {
            "result": "pass",
            "message": "Patient expected values.",
            "detail": "http://projectcrucible.org/permalink/2"
          }
        }
      ]
    }
  ],
  "teardown": {
    "action": [
      {
        "operation": {
          "result": "pass",
          "message": "DELETE Patient/fixture-patient-create.",
          "detail": "http://projectcrucible.org/permalink/3"
        }
      }
    ]
  }
}

TestReport Structure

{
  "resourceType" : "TestReport",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // External identifier
  "name" : "<string>", // Informal name of the executed TestScript
  "status" : "<code>", // R!  completed | in-progress | waiting | stopped | entered-in-error
  "testScript" : { Reference(TestScript) }, // R!  Reference to the  version-specific TestScript that was executed to produce this TestReport
  "result" : "<code>", // R!  pass | fail | pending
  "score" : <decimal>, // The final score (percentage of tests passed) resulting from the execution of the TestScript
  "tester" : "<string>", // Name of the tester producing this report (Organization or individual)
  "issued" : "<dateTime>", // When the TestScript was executed and this TestReport was generated
  "participant" : [{ // A participant in the test execution, either the execution engine, a client, or a server
    "type" : "<code>", // R!  test-engine | client | server
    "uri" : "<uri>", // R!  The uri of the participant. An absolute URL is preferred
    "display" : "<string>" // The display name of the participant
  }],
  "setup" : { // The results of the series of required setup operations before the tests were executed
    "action" : [{ // R!  A setup operation or assert that was executed
      "operation" : { // The operation to perform
        "result" : "<code>", // R!  pass | skip | fail | warning | error
        "message" : "<markdown>", // A message associated with the result
        "detail" : "<uri>" // A link to further details on the result
      },
      "assert" : { // The assertion to perform
        "result" : "<code>", // R!  pass | skip | fail | warning | error
        "message" : "<markdown>", // A message associated with the result
        "detail" : "<string>" // A link to further details on the result
      }
    }]
  },
  "test" : [{ // A test executed from the test script
    "name" : "<string>", // Tracking/logging name of this test
    "description" : "<string>", // Tracking/reporting short description of the test
    "action" : [{ // R!  A test operation or assert that was performed
      "operation" : { Content as for TestReport.setup.action.operation }, // The operation performed
      "assert" : { Content as for TestReport.setup.action.assert } // The assertion performed
    }]
  }],
  "teardown" : { // The results of running the series of required clean up steps
    "action" : [{ // R!  One or more teardown operations performed
      "operation" : { Content as for TestReport.setup.action.operation } // R!  The teardown operation performed
    }]
  }
}

TestReport Search Parameters

The following search parameters can be used to query TestReport resources. Just submit them like so:

https://api.1up.health/fhir/r4/TestReport?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`identifier`	`text`	`identifier`
`issued`	`date`	`issued`
`participant`	`uri`	`participant.uri`
`result`	`text`	`result`
`tester`	`text`	`tester`
`testscript`	`reference`	`testScript`