ca.uhn.hl7v2.model.v22.segment.MSH Maven / Gradle / Ivy
/*
* This class is an auto-generated source file for a HAPI
* HL7 v2.x standard structure class.
*
* For more information, visit: http://hl7api.sourceforge.net/
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
* specific language governing rights and limitations under the License.
*
* The Original Code is "[file_name]". Description:
* "[one_line_description]"
*
* The Initial Developer of the Original Code is University Health Network. Copyright (C)
* 2012. All Rights Reserved.
*
* Contributor(s): ______________________________________.
*
* Alternatively, the contents of this file may be used under the terms of the
* GNU General Public License (the "GPL"), in which case the provisions of the GPL are
* applicable instead of those above. If you wish to allow use of your version of this
* file only under the terms of the GPL and not to allow others to use your version
* of this file under the MPL, indicate your decision by deleting the provisions above
* and replace them with the notice and other provisions required by the GPL License.
* If you do not delete the provisions above, a recipient may use your version of
* this file under either the MPL or the GPL.
*
*/
package ca.uhn.hl7v2.model.v22.segment;
// import ca.uhn.hl7v2.model.v22.group.*;
import ca.uhn.hl7v2.model.v22.datatype.*;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
import ca.uhn.hl7v2.model.AbstractMessage;
import ca.uhn.hl7v2.model.Group;
import ca.uhn.hl7v2.model.Type;
import ca.uhn.hl7v2.model.AbstractSegment;
import ca.uhn.hl7v2.model.Varies;
/**
*Represents an HL7 MSH message segment (MESSAGE HEADER).
* This segment has the following fields:
*
* - MSH-1: Field separator (ST)
*
- MSH-2: Encoding characters (ST)
*
- MSH-3: Sending application (ST) optional
*
- MSH-4: Sending facility (ST) optional
*
- MSH-5: Receiving application (ST) optional
*
- MSH-6: Receiving facility (ST) optional
*
- MSH-7: Date / Time of message (TS) optional
*
- MSH-8: Security (ST) optional
*
- MSH-9: Message type (CM_MSG)
*
- MSH-10: Message Control ID (ST)
*
- MSH-11: Processing ID (ID)
*
- MSH-12: Version ID (ID)
*
- MSH-13: Sequence number (NM) optional
*
- MSH-14: Continuation pointer (ST) optional
*
- MSH-15: Accept acknowledgement type (ID) optional
*
- MSH-16: Application acknowledgement type (ID) optional
*
- MSH-17: Country code (ID) optional
*
*/
@SuppressWarnings("unused")
public class MSH extends AbstractSegment {
/**
* Creates a new MSH segment
*/
public MSH(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(ST.class, true, 1, 1, new Object[]{ getMessage() }, "Field separator");
this.add(ST.class, true, 1, 4, new Object[]{ getMessage() }, "Encoding characters");
this.add(ST.class, false, 1, 15, new Object[]{ getMessage() }, "Sending application");
this.add(ST.class, false, 1, 20, new Object[]{ getMessage() }, "Sending facility");
this.add(ST.class, false, 1, 30, new Object[]{ getMessage() }, "Receiving application");
this.add(ST.class, false, 1, 30, new Object[]{ getMessage() }, "Receiving facility");
this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Date / Time of message");
this.add(ST.class, false, 1, 40, new Object[]{ getMessage() }, "Security");
this.add(CM_MSG.class, true, 1, 7, new Object[]{ getMessage() }, "Message type");
this.add(ST.class, true, 1, 20, new Object[]{ getMessage() }, "Message Control ID");
this.add(ID.class, true, 1, 1, new Object[]{ getMessage(), new Integer(103) }, "Processing ID");
this.add(ID.class, true, 1, 8, new Object[]{ getMessage(), new Integer(104) }, "Version ID");
this.add(NM.class, false, 1, 15, new Object[]{ getMessage() }, "Sequence number");
this.add(ST.class, false, 1, 180, new Object[]{ getMessage() }, "Continuation pointer");
this.add(ID.class, false, 1, 2, new Object[]{ getMessage(), new Integer(155) }, "Accept acknowledgement type");
this.add(ID.class, false, 1, 2, new Object[]{ getMessage(), new Integer(155) }, "Application acknowledgement type");
this.add(ID.class, false, 1, 2, new Object[]{ getMessage(), new Integer(0) }, "Country code");
} catch(HL7Exception e) {
log.error("Unexpected error creating MSH - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns
* MSH-1: "Field separator" - creates it if necessary
*/
public ST getFieldSeparator() {
ST retVal = this.getTypedField(1, 0);
return retVal;
}
/**
* Returns
* MSH-1: "Field separator" - creates it if necessary
*/
public ST getMsh1_FieldSeparator() {
ST retVal = this.getTypedField(1, 0);
return retVal;
}
/**
* Returns
* MSH-2: "Encoding characters" - creates it if necessary
*/
public ST getEncodingCharacters() {
ST retVal = this.getTypedField(2, 0);
return retVal;
}
/**
* Returns
* MSH-2: "Encoding characters" - creates it if necessary
*/
public ST getMsh2_EncodingCharacters() {
ST retVal = this.getTypedField(2, 0);
return retVal;
}
/**
* Returns
* MSH-3: "Sending application" - creates it if necessary
*/
public ST getSendingApplication() {
ST retVal = this.getTypedField(3, 0);
return retVal;
}
/**
* Returns
* MSH-3: "Sending application" - creates it if necessary
*/
public ST getMsh3_SendingApplication() {
ST retVal = this.getTypedField(3, 0);
return retVal;
}
/**
* Returns
* MSH-4: "Sending facility" - creates it if necessary
*/
public ST getSendingFacility() {
ST retVal = this.getTypedField(4, 0);
return retVal;
}
/**
* Returns
* MSH-4: "Sending facility" - creates it if necessary
*/
public ST getMsh4_SendingFacility() {
ST retVal = this.getTypedField(4, 0);
return retVal;
}
/**
* Returns
* MSH-5: "Receiving application" - creates it if necessary
*/
public ST getReceivingApplication() {
ST retVal = this.getTypedField(5, 0);
return retVal;
}
/**
* Returns
* MSH-5: "Receiving application" - creates it if necessary
*/
public ST getMsh5_ReceivingApplication() {
ST retVal = this.getTypedField(5, 0);
return retVal;
}
/**
* Returns
* MSH-6: "Receiving facility" - creates it if necessary
*/
public ST getReceivingFacility() {
ST retVal = this.getTypedField(6, 0);
return retVal;
}
/**
* Returns
* MSH-6: "Receiving facility" - creates it if necessary
*/
public ST getMsh6_ReceivingFacility() {
ST retVal = this.getTypedField(6, 0);
return retVal;
}
/**
* Returns
* MSH-7: "Date / Time of message" - creates it if necessary
*/
public TS getDateTimeOfMessage() {
TS retVal = this.getTypedField(7, 0);
return retVal;
}
/**
* Returns
* MSH-7: "Date / Time of message" - creates it if necessary
*/
public TS getMsh7_DateTimeOfMessage() {
TS retVal = this.getTypedField(7, 0);
return retVal;
}
/**
* Returns
* MSH-8: "Security" - creates it if necessary
*/
public ST getSecurity() {
ST retVal = this.getTypedField(8, 0);
return retVal;
}
/**
* Returns
* MSH-8: "Security" - creates it if necessary
*/
public ST getMsh8_Security() {
ST retVal = this.getTypedField(8, 0);
return retVal;
}
/**
* Returns
* MSH-9: "Message type" - creates it if necessary
*/
public CM_MSG getMessageType() {
CM_MSG retVal = this.getTypedField(9, 0);
return retVal;
}
/**
* Returns
* MSH-9: "Message type" - creates it if necessary
*/
public CM_MSG getMsh9_MessageType() {
CM_MSG retVal = this.getTypedField(9, 0);
return retVal;
}
/**
* Returns
* MSH-10: "Message Control ID" - creates it if necessary
*/
public ST getMessageControlID() {
ST retVal = this.getTypedField(10, 0);
return retVal;
}
/**
* Returns
* MSH-10: "Message Control ID" - creates it if necessary
*/
public ST getMsh10_MessageControlID() {
ST retVal = this.getTypedField(10, 0);
return retVal;
}
/**
* Returns
* MSH-11: "Processing ID" - creates it if necessary
*/
public ID getProcessingID() {
ID retVal = this.getTypedField(11, 0);
return retVal;
}
/**
* Returns
* MSH-11: "Processing ID" - creates it if necessary
*/
public ID getMsh11_ProcessingID() {
ID retVal = this.getTypedField(11, 0);
return retVal;
}
/**
* Returns
* MSH-12: "Version ID" - creates it if necessary
*/
public ID getVersionID() {
ID retVal = this.getTypedField(12, 0);
return retVal;
}
/**
* Returns
* MSH-12: "Version ID" - creates it if necessary
*/
public ID getMsh12_VersionID() {
ID retVal = this.getTypedField(12, 0);
return retVal;
}
/**
* Returns
* MSH-13: "Sequence number" - creates it if necessary
*/
public NM getSequenceNumber() {
NM retVal = this.getTypedField(13, 0);
return retVal;
}
/**
* Returns
* MSH-13: "Sequence number" - creates it if necessary
*/
public NM getMsh13_SequenceNumber() {
NM retVal = this.getTypedField(13, 0);
return retVal;
}
/**
* Returns
* MSH-14: "Continuation pointer" - creates it if necessary
*/
public ST getContinuationPointer() {
ST retVal = this.getTypedField(14, 0);
return retVal;
}
/**
* Returns
* MSH-14: "Continuation pointer" - creates it if necessary
*/
public ST getMsh14_ContinuationPointer() {
ST retVal = this.getTypedField(14, 0);
return retVal;
}
/**
* Returns
* MSH-15: "Accept acknowledgement type" - creates it if necessary
*/
public ID getAcceptAcknowledgementType() {
ID retVal = this.getTypedField(15, 0);
return retVal;
}
/**
* Returns
* MSH-15: "Accept acknowledgement type" - creates it if necessary
*/
public ID getMsh15_AcceptAcknowledgementType() {
ID retVal = this.getTypedField(15, 0);
return retVal;
}
/**
* Returns
* MSH-16: "Application acknowledgement type" - creates it if necessary
*/
public ID getApplicationAcknowledgementType() {
ID retVal = this.getTypedField(16, 0);
return retVal;
}
/**
* Returns
* MSH-16: "Application acknowledgement type" - creates it if necessary
*/
public ID getMsh16_ApplicationAcknowledgementType() {
ID retVal = this.getTypedField(16, 0);
return retVal;
}
/**
* Returns
* MSH-17: "Country code" - creates it if necessary
*/
public ID getCountryCode() {
ID retVal = this.getTypedField(17, 0);
return retVal;
}
/**
* Returns
* MSH-17: "Country code" - creates it if necessary
*/
public ID getMsh17_CountryCode() {
ID retVal = this.getTypedField(17, 0);
return retVal;
}
/** {@inheritDoc} */
protected Type createNewTypeWithoutReflection(int field) {
switch (field) {
case 0: return new ST(getMessage());
case 1: return new ST(getMessage());
case 2: return new ST(getMessage());
case 3: return new ST(getMessage());
case 4: return new ST(getMessage());
case 5: return new ST(getMessage());
case 6: return new TS(getMessage());
case 7: return new ST(getMessage());
case 8: return new CM_MSG(getMessage());
case 9: return new ST(getMessage());
case 10: return new ID(getMessage(), new Integer( 103 ));
case 11: return new ID(getMessage(), new Integer( 104 ));
case 12: return new NM(getMessage());
case 13: return new ST(getMessage());
case 14: return new ID(getMessage(), new Integer( 155 ));
case 15: return new ID(getMessage(), new Integer( 155 ));
case 16: return new ID(getMessage(), new Integer( 0 ));
default: return null;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy