USLabReport Receiver

(Requirements Definition)

Published: 2014-12-02 (draft)

Published by: Published by: HL7 Orders and Observation Workgroup Primary Author: Eric Haas Health eData Inc

This profile defines the expected capabilities of the USLabReport Receiver actor when conforming to the The US Receiver Report Implementation (USLabReport). This actor is the receiver of a laboratory test report and declares conformance to RESTful FHIR and FHIR profiles defined in this guide. The order reference one or more FHIR resources conforming to profiles outlined in the USLabReport guide.

General

FHIR Version: 0.8
Supported formats: xml, json

REST behavior

Mode: Server

This conformance resource assumes the USLabReport Receiver is the server, in other words, operating in 'Pull' or 'Push/Pull' RESTful interface. The USLabReport Receiver MUST support querying one or more resources outlined by the USLabReport Guide. The USLabReport Receiver MUST use all the vocabularies and value set constraints defined by the individual resource profiles used by USLabReport. The USLabReport Receiver MUST implement REST behavior according to the FHIR specification and MUST be able to handle errors gracefully from Query Responders who may not support the submitted query.

Security:

Implementations must meet the security requirements documented in the USLabReport Guide assumptions.

Summary

Resource Search Read Read Version Instance History Resource History Validate Create Update Delete
DiagnosticReport Yes Yes Yes Yes Yes Yes Yes


DiagnosticReport

Interactions

Name Description
  search-type

Allows a user to search for existing DiagnosticReport

  read

Allows retrieval of a specific known DiagnosticReport

  vread

Allows retrieval of a specific version of a DiagnosticReport

  history-instance

Allows review of changes to a DiagnosticReport over time

  create

Allows defining a new DiagnosticReport

  update

Allows editing of an existing DiagnosticReport. Servers may choose to prohibit certain types of edits, instead requiring the creation of a new DiagnosticReport (and potentially the retiring of the existing DiagnosticReport). Servers may also limit who can change particular DiagnosticReport.

  validate

Allows a client to verify whether a particular new DiagnosticReport or revision of an existing DiagnosticReport would be accepted based on validation and other business rules. Useful for some workflows

Search

Supported Includes: DiagnosticReport.subject, DiagnosticReport.performer, DiagnosticReport.request, DiagnosticReport.specimen, DiagnosticReport.report

REST behavior

Mode: Server

The following conformance rules assumes the USLabReport Receiver is the client, in other words, operating in 'Push' RESTful interface. The USLabReport Receiver MUST support querying one or more resources outlined by the USLabReport Guide. The USLabReport Receiver MUST use all the vocabularies and value set constraints defined by the individual resource profiles used by USLabReport. The USLabReport Receiver MUST implement REST behavior according to the FHIR specification and MUST be able to handle errors gracefully from Query Responders who may not support the submitted query.

Security:

Implementations must meet the security requirements documented in the USLabReport Guide assumptions.

Summary

Resource Search Read Read Version Instance History Resource History Validate Create Update Delete
DiagnosticReport Yes Yes Yes Yes Yes Yes Yes


DiagnosticReport

Interactions

Name Description
  search-type

Allows a user to search for existing DiagnosticReport

  read

Allows retrieval of a specific known DiagnosticReport

  vread

Allows retrieval of a specific version of a DiagnosticReport

  history-instance

Allows review of changes to a DiagnosticReport over time

  create

Allows defining a new DiagnosticReport

  update

Allows editing of an existing DiagnosticReport. Servers may choose to prohibit certain types of edits, instead requiring the creation of a new DiagnosticReport (and potentially the retiring of the existing DiagnosticReport). Servers may also limit who can change particular DiagnosticReport.

  validate

Allows a client to verify whether a particular new DiagnosticReport or revision of an existing DiagnosticReport would be accepted based on validation and other business rules. Useful for some workflows

Search

Supported Includes: DiagnosticReport.subject, DiagnosticReport.performer, DiagnosticReport.request, DiagnosticReport.specimen, DiagnosticReport.report