1.0 Introduction

1.1 Service Collaboration Overview and Scope

The Knowledge and Vocabulary Service Collaboration provides the ability to retrieve medical knowledge and terminology. This Service Collaboration utilizes:

HITSP/T81 Retrieval of Medical Knowledge which enables the request and receipt of additional knowledge about a medical concept based on specific context parameters. This Transaction does not prescribe the knowledge content of the message returned but provides the specifications for the query and receipt of additional knowledge

HITSP/T66 Retrieve Value Set which enables the request and receipt of value set with the appropriate terminology or code system and a value set with an appropriate map from one terminology to another

For more information about the underlying capabilities, pre-conditions, post-conditions, data flows and other detailed information, please refer to the constructs that are used by this Service Collaboration.

The Service Collaboration document illustrates one internal view diagram and sequence table for each service interface. The diagrams are descriptive and the sequences are not mandatory. They may be affected by policy, chosen architecture, and implementation details. Conformance is measured against the underlying constructs.

1.2 Service Collaboration Invocation

Table 1-1 Service Collaboration Transactions and Data

Service Collaboration

Service Collaboration Description

Interface

Interface Optionality [1]

HITSP/SC111 - Knowledge and Vocabulary

Provides the ability to request medical knowledge from a knowledge repository

Request Medical Knowledge

R

HITSP/SC111 - Knowledge and Vocabulary

Provides the ability for a knowledge repository to respond to a request for medical knowledge

Respond Medical Knowledge

R

HITSP/SC111 - Knowledge and Vocabulary

Provides the ability to request a value set from a value set repository

Request Value Set

R

HITSP/SC111 - Knowledge and Vocabulary

Provides a value set repository the ability to respond to a value set request

Respond Value Set

R

1.3 External View (i.e.,black box diagram)

Figure 1-1 Knowledge and Vocabulary Service Collaboration External View Diagram

Unified Modeling Language (UML) diagram representing Knowledge and Vocabulary Service Collaboration External View

1.3.1 Service Collaboration Source Constructs

Table 1-2 List of Constructs

Construct

HITSP/T17 - Secured Communication Channel

HITSP/T66 - Retrieve Value Set

HITSP/T81 - Retrieval of Medical Knowledge

1.4 Internal View Diagram with Sequencing (i.e., white box diagram)

1.4.1 Interface: Request Medical Knowledge

Figure 1-2 Request Medical Knowledge Internal View

UML diagram representing Request Medical Knowledge Internal View

1.4.1.1 Sequence Details: Request Medical Knowledge

Table 1 - 3 Request Medical Knowledge Pre-conditions

Pre-conditions

Uses SC, T, TP or C

Interface

Purpose

A secure communications channel shall exist

HITSP/T17 - Secured Communication Channel

Secure Node

A secure communications channel must be open in order to protect the authenticity and integrity of the information being transmitted

Table 1 - 4 Request Medical Knowledge Sequence of Constructs

Step Number

Uses SC, T, TP or C

Interface

Purpose

1

HITSP/T81 - Retrieval of Medical Knowledge

Knowledge Requestor

To request knowledge from the knowledge resource

Table 1 - 5 Request Medical Knowledge Post-Conditions

Post-conditions

Uses SC, T, TP or C

Interface

Purpose

None

1.4.2 Interface: Respond Medical Knowledge

Figure 1-3 Respond Medical Knowledge Internal View

UML diagram representing Respond Medical Knowledge Internal View

1.4.2.1 Sequence Details: Respond Medical Knowledge

Table 1 - 6 Respond Medical Knowledge Pre-conditions

Pre-condition

Uses SC, T, TP or C

Interface

Purpose

A secure communications channel shall exist

HITSP/T17 - Secure Communications Channel

Secure Node

A secure communications channel must be open in order to protect the authenticity and integrity of the information being transmitted

Table 1 - 7 Respond Medical Knowledge Sequence of Constructs

Step Number

Uses SC, T, TP or C

Interface

Purpose

1

HITSP/T81 - Retrieval of Medical Knowledge

Knowledge Resource

To receive the request for knowledge

2

None

None

Look up the requested knowledge

3

HITSP/T81 - Retrieval of Medical Knowledge

Knowledge Resource

To return the requested knowledge

Table 1 - 8 Respond Medical Knowledge Post-conditions

Post-Condition

Uses SC, T, TP or C

Interface

Purpose

None

1.4.3 Interface: Request Value Set

Figure 1-4 Request Value Set Internal View

UML diagram representing Request Value Set Internval View

1.4.3.1 Sequence Details: Request Value Set

Table 1-9 Request Value Set Pre-conditions

Pre-condition

Uses SC, T, TP or C

Interface

Purpose

A secure communications channel shall exist

HITSP/T17 - Secured Communication Channel

Secure Node

A secure communications channel must be open in order to protect the authenticity and integrity of the information being transmitted

Table 1-10 Request Value Set Sequence of Constructs

Step Number

Uses SC, T, TP or C

Interface

Purpose

1

HITSP/T66 - Terminology Service

Value Set Consumer

To request value set from a value set repository

Table 1-11 Request Value Set Post-conditions

Post-Condition

Uses SC, T, TP or C

Interface

Purpose

None

1.4.4 Interface: Respond Value Set

Figure 1-5 Respond Value Set Internal View

UML diagram representing Respond Value Set Internal View

1.4.4.1 Sequence Details: Respond Value Set

Table 1 - 12 Respond Value Set Pre-conditions

Pre-condition

Uses SC, T, TP or C

Interface

Purpose

A secure communications channel shall exist

HITSP/T17 - Secured Communication Channel

Secure Node

A secure communications channel must be open in order to protect the authenticity and integrity of the information being transmitted

Table 1-13 Respond Value Set Sequence of Constructs

Step Number

Uses SC, T, TP or C

Interface

Purpose

1

HITSP/T66 - Retrieve Value Set

Value Set Repository

To receive the request for value set

2

None

None

Look up the requested value set

3

HITSP/T66 - Retrieve Value Set

Value Set Repository

To return the value set

Table 1-14 Respond Value Set Post-conditions

Post-Condition

Uses SC, T, TP or C

Interface

Purpose

Not applicable