Attachment 1 HL7 Conformance Profile Schema.xsd

An unambiguous specification of one or more standard HL7 messages that have been analyzed for a particular use case. It prescribes a set of precise constraints upon one or more standard HL7 messages.

Provides descriptive information about the life-cycle of the HL7v2xConformanceProfile, as well as authorship and control information.

Annotations provide a general description about how the profile is intended to be used, as well as hints on using or interpreting the profile.

Identifies all of the message encoding mechanisms supported by the profile. Non-traditional encoding mechanisms may be identified if desired.

Identifies one of the encoding mechanisms supported by the profile.

The dynamic definition is an interaction specification for a conversation between 2 or more systems.

Identifies when and if HL7 'Accept' acknowledgements are required. Allowed values are: AL (always), NE (never), SU (on success), ER (on error). Default is 'NE'.

Identifies when and if HL7 'Application' acknowledgements are required. Allowed values are: AL (always), NE (never), SU (on success), ER (on error). Default is 'AL'.

Identifies the type of acknowledgement expected by the sender of a message. Allowed values are: Immediate and Deferred. Default is Immediate.

Identifies whether the message is query-related, and if so, what type of query message it is. Allowed values are: NonQuery, Query, Response and Publish. Default is NonQuery.

Identifies the type of query being performed. Allowed values are: Batch, RealTime or Both.

The table library specifies a standardized format to organize the vocabulary and provides support to reference it (See section X.X.X ). In short, the table library is a container for a collection of tables.

Identifies the HL7 2.x version on which the profile is based and with which it is expected to comply.

Categorizes the profile into one of 3 types: HL7 - represents a specific HL7 published standard (may only be submitted by the HL7 Organization); Constrainable - May contain "Optional" elements which must be further constrained in order to create implementation profiles; Implementation - Fully constrained with no optionality (reflects the behavior of a runtime system)

A unique identifier for this specific version of this dynamic profile. If not specified, one will be assigned to the profile upon submission to a registry.

The schema version of the profile.

This represents a detailed profile of a single message. It provides a detailed breakdown of exactly what the message may contain, including optionality and cardinality.

Provides descriptive information about the life-cycle of the HL7 v2x Static Definition, as well as authorship and control information.

Documents the characteristics of a single HL7 segment within the context of a particular message or segment group.

The HL7 message type code, as identified in MSH-9.1 (see HL7 Table 0076 - Message type).

The HL7 event type code, as identified in MSH-9.2 (see HL7 Table 0003 - Event type)

The HL7 message structure code, as identified in MSH-9.3 (see HL7 Table 0354 - Message Structure Type).

The HL7 Order control code, as identified in ORC 1 (see HL7 Table 0119 - Order Control Codes).

A description of the event carried by this message.

A unique identifier for this specific version of this static definition. If not specified, one will be assigned to the profile upon submission to a registry.

Provides a name that clearly and concisely defines the message exchange being profiled.

Name of the organization that submitted the profile.

The version identifier assigned to this profile by the author. There is no prescribed version numbering scheme. However 'higher' versions should generally be interpreted to be more resent.

Status of this profile, as assigned by the author. There is no prescribed status scheme at this time. Possible values might include: 'Draft', 'Active', 'Superceded', 'Withdrawn'

This provides a list of key-words that relate to the profile and that may be useful in profile searches.

Identifies the Message Profile version on which the profile is based and with which it is expected to comply.

As defined, in the HL7 Policies and Procedures Manual, Affiliates will have decision-making authority. HL7 Affiliates control Realms. Realms do not have decision-making authority. Realms simply represent a partition of the solution space. Affiliates choose how the solution space is to be partitioned by authorizing the creation of zero to many (0..*) Realms.

Documents the characteristics of a grouping of HL7 segments within the context of a particular message or segment group.

This is the short, formal name for the group. It appears in the tag name when using the XML Encoding syntax.

Documents the characteristics of a single HL7 segment within the context of a particular message or segment group.

Documents the characteristics of a single HL7 field within the context of a particular message segment.

Documents the characteristics of a single component within the context of a field.

Documents the characteristics of a single sub-component within the context of a component.

The HL7-assigned item number corresponding with the semantic meaning of the field.

Specifies if order apply or not when profiling repeating fields.

Specifies the position of the component which value is referred to in the Occurrence element

This is the short, formal name for the segment. It is used to identify the segment in both ER7 and XML encodings.

The descriptive name for the field/component/sub-component

Identifies the HL7 datatype associated with the element.

Identifies the minimum allowed length for the content of the element.

Identifies the maximum allowed length for the content of the element.

The minimum length an application must be able to handle whether the truncation pattern does/may apply

Identifies the name of the table associated with the content of this element.

Identifies the fixed value associated with this element

This identifies the minimum number of repetitions of the element that are permitted in a message instance. This attribute should only be specified if the minimum number of repetitions is greater than 1, as the minimum for other elements is always '0'.

This identifies the maximum number of repetitions of the element that are permitted in a message instance. This attribute should only be specified if the maximum number of repetitions is greater than 1 and differs from the minimum attribute (i.e. the maximum number of repetitions is greater than the minimum number of repetitions). The special value '*' may be used to represent 'unlimited' repetitions.

Implementation Notes provide a general description about how the element is intended to be used, as well as hints on using or interpreting the it.

An explanation of the associated element.

An explanation of the meaning of the element.

Internal development notes about why particular design decisions were made, outstanding issues and remaining work. They may contain formatting markup. Not intended for external publication.

Additional content related to the element.

An example instance of the element.

Provides an explanation or definition of what the element represents.

Identifies external sources or other locations within the profile where additional information can be found about this item.

Identifies the conditionality rule for this element, if applicable

Identifies an individual example value.

This is the descriptive name for the element. It does not appear in any encodings.

Usage identifies the circumstances under which an element appears in a message. Possible values are:

R - Required (must always be present);

RE - Required or Empty (must be present if available);

O - Optional (no guidance on when the element should appear);

C - Conditional (the element is required or allowed to be present when the condition specified in the Predicate element is true);

X - Not supported (the element is not supported)

PredicateTrueUsage is used in combination with a conditional "C" usage . It specifies how the element usage should be interpreted when the condition predicate evaluates to TRUE. Possible values are :

RE - Required or Empty (must be present if available);

O - Optional (no guidance on when the element should appear);

PredicateTrueUsage is used in combination with a conditional "C" usage . It specifies how the element usage should be interpreted when the condition predicate evaluates to TRUE. Possible values are :

RE - Required or Empty (must be present if available);

O - Optional (no guidance on when the element should appear);

A table definition consists of metadata describing the table and specifies a list of code/value pairs. The table definition metadata consists of a table identifier, OID, name, type, version, and code system.

The name of the table library.

The organization that created the library.

The version of the table library.

The status of the table library.

A unique identifier for the table library.

A text description of the table library.

Table elements express code/value pairs and descriptive information about the code/value pair

The table identifier.

An OID that identify the table, not the codesystem.

A descriptive name of the table.

The type of the table as described in section 2.6.3.6 Valid identifiers for a table type are HL7, User, Local, External, and Imported.

The version of the table.

A code system as specified in HL7 table 0396

The code for the data value.

The long description of the code.

The source of the code/value pair.

Redefined means the code/display name has been changed from its original value.

SDO means Standard Development Organization.