Draft Website - For Review Purposes Only

10 Computable Document Definitions

10.1 Document Definitions Layout

The structure of the implementation guide, message profile, vocabulary definitions, and their descendants are expressed in a computable format using the XML schema language. Specific instances of each document type are expressed in XML. The document definitions are independent but have relationship among them. Additionally, ancillary documents are defined separately to facilitate document management and processing. The XML schema definitions can be accessed at https://v2.hl7.org/conformance/profileschemas.

Figure 10.1: Implementation Guide Document Definition
Figure 10.1: Implementation Guide Document Definition

Figure 10.1 provides a high-level overview of the implementation guide document definition. The definition contains meta data and one or more message profiles. The implementation guide document definition contains references to other document definitions. This allows reuse of the fundamental building block components such as data type definitions.

A message profile is normatively expressed as an XML instance document that contains the HL7 v2 message structure along with message element requirements. The XML instance document is governed by the message profile schema (XSD) document that provides the rules for expressing the requirements given in the normative clauses in this document.

Figure 10.2: Message Profile Document Definition
Figure 10.2: Message Profile Document Definition

Figure 10.2 illustrates the components of a message profile in the context of an implementation guide document definition. The message profiles contain segment groups and segments. The segment references segments definitions which in turn contains the fields along with constraint attributes.

Figure 10.3: Data Type Library Document Definition
Figure 10.3: Data Type Library Document Definition

Figure 10.3 shows the definition of the data type library that is referenced in field and components. The data type library contains base level data types and data type flavors used in the implementation guide.

Figure 10.4: Value Set Library Document Definition
Figure 10.4: Value Set Library Document Definition

Figure 10.4 shows the value set library document definition. The value set library contains a list of value set definitions that provides the meta data and constraint attributes for each value set definition. Additionally, the value set definition contains the list of code values and their references to a code system.

Figure 10.5: Vocabulary Binding Document Definition
Figure 10.5: Vocabulary Binding Document Definition

Figure 10.5 shows the vocabulary binding document definition. The definition provides the link between the vocabulary definition and the element.

Figure 10.6: Condition Predicate, Conformance Statement and Co-constraints Document Definition
Figure 10.6: Condition Predicate, Conformance Statement and Co-constraints Document Definition

Figure 10.6 shows the document definition for the Condition Predicate, Conformance Statement, and Co-constraints. The definition provides a set of constraint types that can be applied to a given element at various levels in message profile structure definition (e.g., segment).

Figure 10.7: Profile Construction Components Relationships
Figure 10.7: Profile Construction Components Relationships

Figure 10.7 shows the relationships among the message profiles and how a message profile can be constructed. A complete document definition can be contained in a message profile. However, a message profile may be constructed using various parts. A core profile and one or more profile components can be combined to create a composite profile, which is a message profile.

Figure 10.8: Slicing Document Definition
Figure 10.8: Slicing Document Definition

Figure 10.8 shows the document definition for the Slicing mechanism.

10.2 Meta Data

Meta data is provided for both an implementation guide and message profile.

10.2.1 Implementation Guide Meta Data

Table 10.1 provides a list of the meta data and definition for an HL7 v2 implementation guide. The attribute name, definition, type, and use are given. Type indicates how the value of the attribute is represented. Use indicates whether the meta data is Required (R) Optional (O), or Conditional (C). Date Format is YYYYMMDD.

Table 10.1: Implementation Guide Meta Data

Attribute

Definition

Type

Use

Name

The natural language name of the implementation guide. Commonly used as the title of the implementation guide.

String

R

IG Version

The version of the implementation guide as decided by the author. There is no prescribed format.

String

O

Organization

The name/identification of the organization or owner of the implementation guide.

String

R

Author

List of authors that created the implementation guide.

String

O

HL7 Version

List of HL7 profile versions included in the implementation guide. Generally, most implementation guides include message profiles of the same HL7 version.

String

O

Create Date

The date the implementation guide was created.

Date Format

O

Last Update Date

The date the implementation guide was last updated.

Date Format

O

Status

The status of the implementation guide. Can be draft, published, superseded, or withdrawn.

Enum

R

Publish Date

If the status is “published”, this is the date the implementation guide was published. Once published, the IG version is static.

Date Format

C

Description

Provides a short summary and intended use of the implementation guide

String

O

Figure 10.9 shows the life cycle of an implementation guide.

Figure 10.9: Implementation Guide Life Cycle
Figure 10.9: Implementation Guide Life Cycle

10.2.2 Message Profile Meta Data

Table 10.2 provides a list of the meta data and definition for an HL7 v2 message profile. The attribute name, definition, type, and use are given. Type indicates how the value of the attribute is represented. Use indicates whether the meta data is Required (R), Optional (O), or Conditional (C). Date Format is YYYYMMDD.

Table 10.2: Message Profile Meta Data

Attribute

Definition

Type

Use

Name

The natural language name of the message profile. Commonly used as the title of the implementation guide.

String

R

HL7 Version

The HL7 foundational version of the message profile; i.e., the version of the HL7 v2 abstract message definition. Corresponds to MSH-12.1. Value is obtained from table HL70104.

Enum

R

Organization

The name/identification of the organization or owner of the message profile.

String

O

Author

List of authors that created the message profile.

String

O

Message Code

The HL7 v2 Message Code (e.g., ADT). Corresponds to MSH-9.1. Value is obtained from table HL70076.

Enum

R

Trigger Event

The HL7 v2 Trigger Event (e.g., A04). Corresponds to MSH-9.2. Value is obtained from table HL70003.

Enum

R

Message Structure

The HL7 v2 Message Structure (e.g., ADT_A01). Corresponds to MSH-9.3. Value is obtained from table HL70354.

Enum

R

Level

The type (level) of message profiles (HL7, Constrainable, Implementation).

Enum

R

Role

The role (perspective) of the message profile (Sender, Receiver, or Both).

Enum

O

Create Date

The date the message profile was created.

Date Format

O

Last Update Date

The date the message profile was last updated.

Date Format

O

Status

The status of the message profile. Can be draft, published, superseded, or withdrawn.

Enum

R

Publish Date

If the status is “published”, this is the date the message profile was published. Once published, the message profile version is static.

Date Format

C

Description

Provides a short summary and intended use of the message profile.

String

O

Message Profile Identifier

The Message Profile Identifier meta data is consisted with the definition of MSH-21 (Message Profile Identifier) specified in the message profile. The Message Profile Identifier Element may have an unlimited number of occurrences.

EI Data Type

R

Profile Type

Indicates the type of profile represented. Can be (profile, profile component, composite profile, or value set collection).

Enum

R