Provider Registry Use Cases

From IHRIS Wiki
Revision as of 11:15, 10 May 2012 by Litlfred (talk | contribs)

Use Cases for Provider Registry

These are use cases for interacting with the provider registry. Please see the requirements and web services.

Interoperability Layer/Web Services

Use Case: PR-WS-1 Query from a provider’s enterprise ID


This query takes in a unique ID for a provider and returns the enterprise ID associated with the provider who matches the given ID.

Primary Actor Interoperability Layer, potentially Point Of Care Application
Pre-Conditions The application must be authenticated to the system
Success Guarantee An enterprise id (EID) is returned to the requesting application
Main Success Scenario
  1. The actor submits a request with a given ID type and ID number
  2. The system returns the EID
Extensions
2.a The system does not find the provider and returns an error code.

Other Resources: Web Service:PR-WS-1

Use Case: PR-WS-2 Query for providers


ueries for HC Professional’s using a variety of possible parameter. This transaction returns a list of all professionals that match the criteria specified in the query parameters. Otherwise, if an error occurred, then an error is returned.

Primary Actor Interoperability Layer, Point Of Care Application?
Pre-Conditions The application must be authenticated to the system
Success Guarantee An list of enterprise ids (EIDs) is returned to the requesting application
Main Success Scenario
  1. The actor submits a request with a given query parameters
  2. The system returns a list of matching EIDs
Extensions
2.a The system does not find the provider and returns an error code.
2.b The requested search parameters are invalid and returns an error code.
Notes Not needed for Sept. 2012

Other Resources: Web Service:PR-WS-2 Use Case:PR-WS-3

User Interface

Use Case: PR-UI-1 Inserting a health care professional


Add a health care provider to the registry

Primary Actor Provider Registry Administrator
Pre-Conditions The user must be authenticated to the system
Success Guarantee A provider is successfully is added to the system and made available to be searched
Main Success Scenario
  1. The administrator enters the new health care professional data
  2. The system verifies if the data has been entered properly and performs necessary validations
  3. The system creates a unique EPID (enterprise provider ID) for the provider
  4. The system stores the health care professional data.
  5. The system returns to the previous screen
Notes Data fields should include these provider attributes

Use Case: PR-UI-2 Editing a health care professional


Edit an existing health care provider to the registry

Primary Actor Provider Registry Administrator
Pre-Conditions The user must be authenticated to the system. The user has searched for and found the health care professional to be edited
Success Guarantee A provider is successfully is edited in the system.
Main Success Scenario
  1. The administrator selects the health care professional record to be edited
  2. The administrator edits the health care professional record data.
  3. The system performs the necessary validations.
  4. The system updates the health care professional data.
  5. The system returns to the previous screen.
Notes Data fields should include these provider attributes

Use Case: PR-UI-3 Searching for a health care professional


Search for a health care provider to the registry

Primary Actor Provider Registry Administrator
Pre-Conditions The user must be authenticated to the system
Success Guarantee A provider is successfully found in the system.
Main Success Scenario
  1. The user enters the applicable search criteria
  2. The system searches for the corresponding health care professional and displays the result

Use Case: PR-UI-4 Deactivate a health care professional


Deactivate a health care provider from the registry

Primary Actor Provider Registry Administrator
Pre-Conditions The user must be authenticated to the system, the appropriate record has been located
Success Guarantee A provider is successfully is added to the system and made available to be searched
Main Success Scenario
  1. The administrator selects the health care professional to be deactivated
  2. The system requires the confirmation of the health care professional deactivation.
  3. The administrator confirms the deactivation of the health care professional
  4. The system deactivates the health care professional
  5. The system returns to the previous screen

Point-of-Care Interface

Use Case:PR-POC-1 Use Case:PR-POC-2