cdac.medinfo.sdk.hl7282.hl7model.messages.patientadministration

## Class ADT_A44_Common

- java.lang.Object
- - cdac.medinfo.sdk.hl7282.baselibs.messages.Message
  - - cdac.medinfo.sdk.hl7282.hl7model.messages.patientadministration.ADT_A44_Common

- Direct Known Subclasses:
    ADT_A47

      public abstract class ADT_A44_Common
      extends Message

  ADT_A44 - Move Account Information - Patient Account Number (Event A44). This event is use to signal a change of an incorrectly assigned PID-3 - Patient Identifier List value.

  Represents a ADT_A44 message structure (see chapter 3.2.44). This structure contains the following elements:

  0: MSH (Message Header Segment) SINGLE_COMPULSARY
  1: SFT (Software Segment) MULTIPLE_OPTIONAL
  2: UAC (User Authentication Credential) SINGLE OPTIONAL
  3: EVN (Event Type Segment) SINGLE_COMPULSARY
  4: PATIENT (a Group of segments in ADT_A47 message) MULTIPLE_COMPULSARY
  This class provides mechanism to validate message against HL7 v 2.8.2 standard. The class provides accessors & mutators for the elements mentioned above. These elements can be easily populated & populated values can be easily retrieved. The class has validate method which validates Message against HL7 v 2.8.2 standard.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ADT_A44_Common(IMap objMessageMap, java.lang.String strMessageCode, java.lang.String strTriggerEvent, java.lang.String strMessageStructure)` Construct the A47 message.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addPatientGroup(IGroup objGroup)` Adds PATIENT GROUP to this message.
    `void` | `addPatientGroups(ISingleCollection<IGroup> objSingleCollection)` Adds Collection of PATIENT GROUP to this message.
    `void` | `addSoftwareSegment(ISingleCollection<SFT> objSFTSegmentCollection)` Adds collection of Software Segment(SFT) to this message.
    `void` | `addSoftwareSegment(SFT objSFT)` Adds Software Segment(SFT) to this message.
    `EVN` | `getEventTypeSegment()` Retrieves Event Type(EVN) segment present in this message
    `ISingleCollection<IGroup>` | `getPatientGroups()` Retrieves Collection of PATIENT GROUP present in this message.
    `ISingleCollection<SFT>` | `getSoftwareSegments()` Retrieves Collection of Software Segments(SFT) present in this message.
    `UAC` | `getUserAuthenticationCredentialSegment()` Retrieves User Authentication Credential(UAC) segment present in this message
    `void` | `setEventTypeSegment(EVN objEVN)` Sets value of Event Type segment for this message,overwrites if already present.
    `void` | `setUserAuthenticationCredentialSegment(UAC objUAC)` Sets value of User Authentication Credential segment for this message,overwrites if already present.

    - ### Methods inherited from class cdac.medinfo.sdk.hl7282.baselibs.messages.Message

      `contains, dumpMessage, dumpMessage, getACKMode, getGroup, getGroupMap, getHeader, getMessageCode, getMessageControlID, getMessageStructure, getQueryUserParameters, getSegment, getSegmentSet, getSubscriptionType, getTriggerEvent, isQuery, isResponse, populate, removeGroup, removeSegment, removeSegment, removeSegmentAttribute, removeSegmentAttribute, removeSegmentAttribute, removeSegments, setHeader, setSubscriptionType, updateSegmentAttribute, updateSegmentAttribute, validate, writeToXML, writeToXML`

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### ADT_A44_Common

          public ADT_A44_Common(IMap objMessageMap,
                        java.lang.String strMessageCode,
                        java.lang.String strTriggerEvent,
                        java.lang.String strMessageStructure)

      Construct the A47 message.

  - ### Method Detail

    - #### addSoftwareSegment

          public void addSoftwareSegment(SFT objSFT)

      Adds Software Segment(SFT) to this message.
      Parameters:
        `objSFT` - Specified Software Segment(SFT)to be added in message.

    - #### addSoftwareSegment

          public void addSoftwareSegment(ISingleCollection<SFT> objSFTSegmentCollection)

      Adds collection of Software Segment(SFT) to this message.
      Parameters:
        `objSFTSegmentCollection` - Collection of Software Segments to add in this message

    - #### getSoftwareSegments

          public ISingleCollection<SFT> getSoftwareSegments()

      Retrieves Collection of Software Segments(SFT) present in this message.
      Returns:
        ISingleCollection - Collection of Software Segments(SFT) present in this message.

    - #### getUserAuthenticationCredentialSegment

          public UAC getUserAuthenticationCredentialSegment()

      Retrieves User Authentication Credential(UAC) segment present in this message
      Returns:
        UAC - Specified UAC Segment

    - #### setUserAuthenticationCredentialSegment

          public void setUserAuthenticationCredentialSegment(UAC objUAC)

      Sets value of User Authentication Credential segment for this message,overwrites if already present.
      Parameters:
        `objUAC` - Specified UAC Segment

    - #### getEventTypeSegment

          public EVN getEventTypeSegment()

      Retrieves Event Type(EVN) segment present in this message
      Returns:
        EVN - EVN Segment

    - #### setEventTypeSegment

          public void setEventTypeSegment(EVN objEVN)

      Sets value of Event Type segment for this message,overwrites if already present.
      Parameters:
        `objEVN` - Specified EVN Segment

    - #### getPatientGroups

          public ISingleCollection<IGroup> getPatientGroups()

      Retrieves Collection of PATIENT GROUP present in this message.
      Returns:
        ISingleCollection - Collection of PATIENT Group present in this Message.

    - #### addPatientGroups

          public void addPatientGroups(ISingleCollection<IGroup> objSingleCollection)

      Adds Collection of PATIENT GROUP to this message.
      Parameters:
        `objSingleCollection` - - Specified PATIENT GROUP Collection.

    - #### addPatientGroup

          public void addPatientGroup(IGroup objGroup)

      Adds PATIENT GROUP to this message.
      Parameters:
        `objGroup` - Specified PATIENT GROUP.