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.
May not have elements with a Usage of 'O' in an Implementation profile.
Provides descriptive information about the life-cycle of the HL7v2xConformanceProfile, as well as authorship and control information.
Implementation Notes provide a general description about how the profile is intended to be used, as well as hints on using or interpreting the profile.
A use case model documents the scope and requirements for an HL7 message profile or set of message profiles.
Must have at least a Description or EventFlows in a use-case.
Identifies the reason and/or objectives for the usecase
Descriptive text for the use-case. In cases where the use-case is not broken down into component elements, this will include the complete details of the usecase. Otherwise, it will contain a basic overview.
Identifies and defines the entities involved in the use-case. This includes the sending and receiving applications
Identifies a circumstance that must hold true prior to the use-case being invoked.
Identifies a circumstance that will hold true after the successful completion of the use-case.
Identifies a step within the chain of occurrences that lead to the successful completion of the use-case. This includes the exchange of messages between applications.
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.
May only have a QueryMode when QueryMessageType is not 'NonQuery'.
Must have a QueryMode when QueryMessageType is not 'NonQuery'.
Identifies when and if HL7 'Accept' acknowledgments are required. Allowed values are: AL (always), NE (never), SU (on success), ER (on error). Default is 'NE'.
Identifies when and if HL7 'Application' acknowledgments are required. Allowed values are: AL (always), NE (never), SU (on success), ER (on error). Default is 'AL'.
Identifies the type of acknowledgment 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.
Provides an identifier reference to the static definition for one of the messages used by the profile.
The identifier for the static definition being referenced.
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.
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.
MsgStructID must be present for HL7 versions 2.3.1 and higher.
MsgStructID must not be present for HL7 versions prior to 2.3.1
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.
Identifies whether the profile is constructed from the perspective of the message generator (Sender) or parser (Receiver). Default is 'Sender'.
The unique name or number associated with a particular use-case element.
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.
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.
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 maximum allowed length for the content of the element.
Identifies the name of the table associated with the content of this element.
Identifies the fixed value associated with this element
ConstantValues may only be specified for items with no components or sub-components.
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.
Min may not be greater than Max.
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.
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
May not have a Predicate unless the Usage is 'C' or 'CE'.
Provides a list of possible example values for the element.
DataValues may only be specified for items with no components or sub-components.
Identifies an individual example value.
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);
CE - Conditional or Empty (the element is required or allowed to be present when the condition specified in the Predicate element is true and the information is available)
X - Not supported (the element will not be sent)
Must have a Predicate when Usage is 'C' or 'CE'.
Must have at least one supported Component or Sub-Component (Usage not 'X') when element is marked as supported.
This is the descriptive name for the element. It does not appear in any encodings.