Order Request Manager Conceptual Specification

Link back to solution specification

Overview

Service Description and Purpose

  Comment
	What is the service? Why do we care? Articulation of the Business purpose of the specification 	Description of the functional capabilities in business terms

Scope

  Comment
    Describe the overall potential scope of the service.  Are any items being specifically excluded from the scope?  Why?

Reason why the service is necessary

  Comment
    Rationale for creating this specification. Consumer viewpoint and the value offered by the work product

Links to Use Cases/ Storyboards

• (optional, depending on detail in interop business scenario section

Structure of the Service

The Order Manager Conceptual Diagram is shown below. Individual functional profiles have not yet been identified as we still need to work through the more complex use cases and identify the need for different profiles to support different contexts.

Organization

 Comment
   Elaborate any logical groupings that emerge from the usage scenarios

Assumptions and Dependencies

 Comment
   Upon what services does this specification depend (underpinning infrastructure, other HL7 services,  etc. Are there any key assumptions that are being made?

Implementation Considerations

  Comment
    Relevant and representative examples of deployment scenarios. Consider representation formalism and the intended audience, not necessarily rigorously expressing the content in UML. This specification in the real world (e.g., relationships to existing infrastructure, other deployed services, dependencies, etc.). Consider the ways that information bindings will be realized through the operations. If necessary, outline a strategy for this binding.

Detailed Functional Model for Each Operation

Create Order

• Description: Allows the client to create an order for a service

• Pre-Conditions: The client has sufficient information to create the request

• Conceptual Information Objects
  • Inputs: Order
  • Outputs: Order

• Post-Conditions: The returned order structure has been updated with order identifier

• Exception Conditions

• Aspects left for Technical Bindings (optional)

• Reference to Functional Profiles (optional)

• Notes

Revise Order

• Description: Allows the client to submit a change to an existing Order.

• Pre-Conditions:
  • An order exists and the identifier is known to the client
  • The order is currently active

• Conceptual Information Objects
  • Inputs: Order, Order Identifier
  • Outputs: Order

• Post-Conditions: The order referenced by order identifier has been updated to match the requirements in the input order. The modified order is returned.

• Exception Conditions

• Aspects left for Technical Bindings (optional)

• Reference to Functional Profiles (optional)

• Notes

Cancel Order

• Description:

• Pre-Conditions:

• Conceptual Information Objects
  • Inputs:
  • Outputs:

• Post-Conditions

• Exception Conditions

• Aspects left for Technical Bindings (optional)

• Reference to Functional Profiles (optional)

• Notes

Query Orders

• Description:

• Pre-Conditions:

• Conceptual Information Objects
  • Inputs: Subject
  • Outputs: a list of Orders

• Post-Conditions

• Exception Conditions

• Aspects left for Technical Bindings (optional)

• Reference to Functional Profiles (optional)

• Notes

Retrieve Result

• Description:

• Pre-Conditions:

• Conceptual Information Objects

• • Inputs:

• • Outputs:

• Post-Conditions

• Exception Conditions

• Aspects left for Technical Bindings (optional)

• Reference to Functional Profiles (optional)

• Notes

Update Request Status

• Description: Allows the client to identify a change in status of the request

• Pre-Conditions:

• Conceptual Information Objects

• • Inputs: Request Identifier, Status

• • Outputs: Request

• Post-Conditions: The request status has been changed to the new value

• Exception Conditions: The request identifier cannot be found.
  The status change request is an invalid state transition

• Aspects left for Technical Bindings (optional)

• Reference to Functional Profiles (optional)

• Notes

Update Result Status

• Description:

• Pre-Conditions:

• Conceptual Information Objects

• • Inputs:

• • Outputs:

• Post-Conditions

• Exception Conditions

• Aspects left for Technical Bindings (optional)

• Reference to Functional Profiles (optional)

• Notes

Profiles

Information Profiles

  Comment
    - describe any information profiles applicable to this service, and the related state transitions