GroupOrSegment

Construct representing a logical group or a segment.

JSON representation
{

  // Union field value can be only one of the following:
  "segment": {
    object(SchemaSegment)
  },
  "group": {
    object(SchemaGroup)
  }
  // End of list of possible types for union field value.
}
Fields

Union field value.

value can be only one of the following:

segment

object(SchemaSegment)

group

object(SchemaGroup)

SchemaSegment

An HL7v2 Segment.

JSON representation
{
  "type": string,
  "minOccurs": integer,
  "maxOccurs": integer
}
Fields
type

string

The Segment type. For example, "PID".

minOccurs

integer

The minimum number of times this segment can be present in this group.

maxOccurs

integer

The maximum number of times this segment can be present in this group. 0 or -1 means unbounded.

SchemaGroup

An HL7v2 logical group construct.

JSON representation
{
  "name": string,
  "choice": boolean,
  "minOccurs": integer,
  "maxOccurs": integer,
  "members": [
    {
      object(GroupOrSegment)
    }
  ]
}
Fields
name

string

The name of this group. For example, "ORDER_DETAIL".

choice

boolean

True indicates that this is a choice group, meaning that only one of its segments can exist in a given message.

minOccurs

integer

The minimum number of times this group must be present/repeated.

maxOccurs

integer

The maximum number of times this group can be repeated. 0 or -1 means unbounded.

members[]

object(GroupOrSegment)

Nested groups and/or segments.