Package ca.uhn.hl7v2.model.v24.segment

Class OM7

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v24.segment.OM7
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class OM7 extends AbstractSegment

Represents an HL7 OM7 message segment (Additional Basic Attributes). This segment has the following fields:

  • OM7-1: Sequence Number - Test/ Observation Master File (NM)
  • OM7-2: Universal Service Identifier (CE)
  • OM7-3: Category Identifier (CE) optional repeating
  • OM7-4: Category Description (TX) optional
  • OM7-5: Category Synonym (ST) optional repeating
  • OM7-6: Effective Test/Service Start Date/Time (TS) optional
  • OM7-7: Effective Test/Service End Date/Time (TS) optional
  • OM7-8: Test/Service Default Duration Quantity (NM) optional
  • OM7-9: Test/Service Default Duration Units (CE) optional
  • OM7-10: Test/Service Default Frequency (IS) optional
  • OM7-11: Consent Indicator (ID) optional
  • OM7-12: Consent Identifier (CE) optional
  • OM7-13: Consent Effective Start Date/Time (TS) optional
  • OM7-14: Consent Effective End Date/Time (TS) optional
  • OM7-15: Consent Interval Quantity (NM) optional
  • OM7-16: Consent Interval Units (CE) optional
  • OM7-17: Consent Waiting Period Quantity (NM) optional
  • OM7-18: Consent Waiting Period Units (CE) optional
  • OM7-19: Effective Date/Time of Change (TS) optional
  • OM7-20: Entered By (XCN) optional
  • OM7-21: Orderable-at Location (PL) optional repeating
  • OM7-22: Formulary Status (IS) optional
  • OM7-23: Special Order Indicator (ID) optional
  • OM7-24: Primary Key Value - CDM (CE) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getSequenceNumberTestObservationMasterFile

      public NM getSequenceNumberTestObservationMasterFile()
      Returns OM7-1: "Sequence Number - Test/ Observation Master File" - creates it if necessary

    • getOm71_SequenceNumberTestObservationMasterFile

      public NM getOm71_SequenceNumberTestObservationMasterFile()
      Returns OM7-1: "Sequence Number - Test/ Observation Master File" - creates it if necessary

    • getUniversalServiceIdentifier

      public CE getUniversalServiceIdentifier()
      Returns OM7-2: "Universal Service Identifier" - creates it if necessary

    • getOm72_UniversalServiceIdentifier

      public CE getOm72_UniversalServiceIdentifier()
      Returns OM7-2: "Universal Service Identifier" - creates it if necessary

    • getCategoryIdentifier

      public CE[] getCategoryIdentifier()
      Returns all repetitions of Category Identifier (OM7-3).

    • getOm73_CategoryIdentifier

      public CE[] getOm73_CategoryIdentifier()
      Returns all repetitions of Category Identifier (OM7-3).

    • getCategoryIdentifierReps

      public int getCategoryIdentifierReps()
      Returns a count of the current number of repetitions of Category Identifier (OM7-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getCategoryIdentifier

      public CE getCategoryIdentifier(int rep)
      Returns a specific repetition of OM7-3: "Category Identifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm73_CategoryIdentifier

      public CE getOm73_CategoryIdentifier(int rep)
      Returns a specific repetition of OM7-3: "Category Identifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm73_CategoryIdentifierReps

      public int getOm73_CategoryIdentifierReps()
      Returns a count of the current number of repetitions of Category Identifier (OM7-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertCategoryIdentifier

      public CE insertCategoryIdentifier(int rep) throws HL7Exception
      Inserts a repetition of OM7-3: "Category Identifier" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertOm73_CategoryIdentifier

      public CE insertOm73_CategoryIdentifier(int rep) throws HL7Exception
      Inserts a repetition of OM7-3: "Category Identifier" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeCategoryIdentifier

      public CE removeCategoryIdentifier(int rep) throws HL7Exception
      Removes a repetition of OM7-3: "Category Identifier" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeOm73_CategoryIdentifier

      public CE removeOm73_CategoryIdentifier(int rep) throws HL7Exception
      Removes a repetition of OM7-3: "Category Identifier" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getCategoryDescription

      public TX getCategoryDescription()
      Returns OM7-4: "Category Description" - creates it if necessary

    • getOm74_CategoryDescription

      public TX getOm74_CategoryDescription()
      Returns OM7-4: "Category Description" - creates it if necessary

    • getCategorySynonym

      public ST[] getCategorySynonym()
      Returns all repetitions of Category Synonym (OM7-5).

    • getOm75_CategorySynonym

      public ST[] getOm75_CategorySynonym()
      Returns all repetitions of Category Synonym (OM7-5).

    • getCategorySynonymReps

      public int getCategorySynonymReps()
      Returns a count of the current number of repetitions of Category Synonym (OM7-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getCategorySynonym

      public ST getCategorySynonym(int rep)
      Returns a specific repetition of OM7-5: "Category Synonym" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm75_CategorySynonym

      public ST getOm75_CategorySynonym(int rep)
      Returns a specific repetition of OM7-5: "Category Synonym" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm75_CategorySynonymReps

      public int getOm75_CategorySynonymReps()
      Returns a count of the current number of repetitions of Category Synonym (OM7-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertCategorySynonym

      public ST insertCategorySynonym(int rep) throws HL7Exception
      Inserts a repetition of OM7-5: "Category Synonym" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertOm75_CategorySynonym

      public ST insertOm75_CategorySynonym(int rep) throws HL7Exception
      Inserts a repetition of OM7-5: "Category Synonym" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeCategorySynonym

      public ST removeCategorySynonym(int rep) throws HL7Exception
      Removes a repetition of OM7-5: "Category Synonym" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeOm75_CategorySynonym

      public ST removeOm75_CategorySynonym(int rep) throws HL7Exception
      Removes a repetition of OM7-5: "Category Synonym" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getEffectiveTestServiceStartDateTime

      public TS getEffectiveTestServiceStartDateTime()
      Returns OM7-6: "Effective Test/Service Start Date/Time" - creates it if necessary

    • getOm76_EffectiveTestServiceStartDateTime

      public TS getOm76_EffectiveTestServiceStartDateTime()
      Returns OM7-6: "Effective Test/Service Start Date/Time" - creates it if necessary

    • getEffectiveTestServiceEndDateTime

      public TS getEffectiveTestServiceEndDateTime()
      Returns OM7-7: "Effective Test/Service End Date/Time" - creates it if necessary

    • getOm77_EffectiveTestServiceEndDateTime

      public TS getOm77_EffectiveTestServiceEndDateTime()
      Returns OM7-7: "Effective Test/Service End Date/Time" - creates it if necessary

    • getTestServiceDefaultDurationQuantity

      public NM getTestServiceDefaultDurationQuantity()
      Returns OM7-8: "Test/Service Default Duration Quantity" - creates it if necessary

    • getOm78_TestServiceDefaultDurationQuantity

      public NM getOm78_TestServiceDefaultDurationQuantity()
      Returns OM7-8: "Test/Service Default Duration Quantity" - creates it if necessary

    • getTestServiceDefaultDurationUnits

      public CE getTestServiceDefaultDurationUnits()
      Returns OM7-9: "Test/Service Default Duration Units" - creates it if necessary

    • getOm79_TestServiceDefaultDurationUnits

      public CE getOm79_TestServiceDefaultDurationUnits()
      Returns OM7-9: "Test/Service Default Duration Units" - creates it if necessary

    • getTestServiceDefaultFrequency

      public IS getTestServiceDefaultFrequency()
      Returns OM7-10: "Test/Service Default Frequency" - creates it if necessary

    • getOm710_TestServiceDefaultFrequency

      public IS getOm710_TestServiceDefaultFrequency()
      Returns OM7-10: "Test/Service Default Frequency" - creates it if necessary

    • getConsentIndicator

      public ID getConsentIndicator()
      Returns OM7-11: "Consent Indicator" - creates it if necessary

    • getOm711_ConsentIndicator

      public ID getOm711_ConsentIndicator()
      Returns OM7-11: "Consent Indicator" - creates it if necessary

    • getConsentIdentifier

      public CE getConsentIdentifier()
      Returns OM7-12: "Consent Identifier" - creates it if necessary

    • getOm712_ConsentIdentifier

      public CE getOm712_ConsentIdentifier()
      Returns OM7-12: "Consent Identifier" - creates it if necessary

    • getConsentEffectiveStartDateTime

      public TS getConsentEffectiveStartDateTime()
      Returns OM7-13: "Consent Effective Start Date/Time" - creates it if necessary

    • getOm713_ConsentEffectiveStartDateTime

      public TS getOm713_ConsentEffectiveStartDateTime()
      Returns OM7-13: "Consent Effective Start Date/Time" - creates it if necessary

    • getConsentEffectiveEndDateTime

      public TS getConsentEffectiveEndDateTime()
      Returns OM7-14: "Consent Effective End Date/Time" - creates it if necessary

    • getOm714_ConsentEffectiveEndDateTime

      public TS getOm714_ConsentEffectiveEndDateTime()
      Returns OM7-14: "Consent Effective End Date/Time" - creates it if necessary

    • getConsentIntervalQuantity

      public NM getConsentIntervalQuantity()
      Returns OM7-15: "Consent Interval Quantity" - creates it if necessary

    • getOm715_ConsentIntervalQuantity

      public NM getOm715_ConsentIntervalQuantity()
      Returns OM7-15: "Consent Interval Quantity" - creates it if necessary

    • getConsentIntervalUnits

      public CE getConsentIntervalUnits()
      Returns OM7-16: "Consent Interval Units" - creates it if necessary

    • getOm716_ConsentIntervalUnits

      public CE getOm716_ConsentIntervalUnits()
      Returns OM7-16: "Consent Interval Units" - creates it if necessary

    • getConsentWaitingPeriodQuantity

      public NM getConsentWaitingPeriodQuantity()
      Returns OM7-17: "Consent Waiting Period Quantity" - creates it if necessary

    • getOm717_ConsentWaitingPeriodQuantity

      public NM getOm717_ConsentWaitingPeriodQuantity()
      Returns OM7-17: "Consent Waiting Period Quantity" - creates it if necessary

    • getConsentWaitingPeriodUnits

      public CE getConsentWaitingPeriodUnits()
      Returns OM7-18: "Consent Waiting Period Units" - creates it if necessary

    • getOm718_ConsentWaitingPeriodUnits

      public CE getOm718_ConsentWaitingPeriodUnits()
      Returns OM7-18: "Consent Waiting Period Units" - creates it if necessary

    • getEffectiveDateTimeOfChange

      public TS getEffectiveDateTimeOfChange()
      Returns OM7-19: "Effective Date/Time of Change" - creates it if necessary

    • getOm719_EffectiveDateTimeOfChange

      public TS getOm719_EffectiveDateTimeOfChange()
      Returns OM7-19: "Effective Date/Time of Change" - creates it if necessary

    • getEnteredBy

      public XCN getEnteredBy()
      Returns OM7-20: "Entered By" - creates it if necessary

    • getOm720_EnteredBy

      public XCN getOm720_EnteredBy()
      Returns OM7-20: "Entered By" - creates it if necessary

    • getOrderableAtLocation

      public PL[] getOrderableAtLocation()
      Returns all repetitions of Orderable-at Location (OM7-21).

    • getOm721_OrderableAtLocation

      public PL[] getOm721_OrderableAtLocation()
      Returns all repetitions of Orderable-at Location (OM7-21).

    • getOrderableAtLocationReps

      public int getOrderableAtLocationReps()
      Returns a count of the current number of repetitions of Orderable-at Location (OM7-21). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getOrderableAtLocation

      public PL getOrderableAtLocation(int rep)
      Returns a specific repetition of OM7-21: "Orderable-at Location" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm721_OrderableAtLocation

      public PL getOm721_OrderableAtLocation(int rep)
      Returns a specific repetition of OM7-21: "Orderable-at Location" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm721_OrderableAtLocationReps

      public int getOm721_OrderableAtLocationReps()
      Returns a count of the current number of repetitions of Orderable-at Location (OM7-21). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertOrderableAtLocation

      public PL insertOrderableAtLocation(int rep) throws HL7Exception
      Inserts a repetition of OM7-21: "Orderable-at Location" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertOm721_OrderableAtLocation

      public PL insertOm721_OrderableAtLocation(int rep) throws HL7Exception
      Inserts a repetition of OM7-21: "Orderable-at Location" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeOrderableAtLocation

      public PL removeOrderableAtLocation(int rep) throws HL7Exception
      Removes a repetition of OM7-21: "Orderable-at Location" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeOm721_OrderableAtLocation

      public PL removeOm721_OrderableAtLocation(int rep) throws HL7Exception
      Removes a repetition of OM7-21: "Orderable-at Location" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getFormularyStatus

      public IS getFormularyStatus()
      Returns OM7-22: "Formulary Status" - creates it if necessary

    • getOm722_FormularyStatus

      public IS getOm722_FormularyStatus()
      Returns OM7-22: "Formulary Status" - creates it if necessary

    • getSpecialOrderIndicator

      public ID getSpecialOrderIndicator()
      Returns OM7-23: "Special Order Indicator" - creates it if necessary

    • getOm723_SpecialOrderIndicator

      public ID getOm723_SpecialOrderIndicator()
      Returns OM7-23: "Special Order Indicator" - creates it if necessary

    • getPrimaryKeyValueCDM

      public CE[] getPrimaryKeyValueCDM()
      Returns all repetitions of Primary Key Value - CDM (OM7-24).

    • getOm724_PrimaryKeyValueCDM

      public CE[] getOm724_PrimaryKeyValueCDM()
      Returns all repetitions of Primary Key Value - CDM (OM7-24).

    • getPrimaryKeyValueCDMReps

      public int getPrimaryKeyValueCDMReps()
      Returns a count of the current number of repetitions of Primary Key Value - CDM (OM7-24). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getPrimaryKeyValueCDM

      public CE getPrimaryKeyValueCDM(int rep)
      Returns a specific repetition of OM7-24: "Primary Key Value - CDM" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm724_PrimaryKeyValueCDM

      public CE getOm724_PrimaryKeyValueCDM(int rep)
      Returns a specific repetition of OM7-24: "Primary Key Value - CDM" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm724_PrimaryKeyValueCDMReps

      public int getOm724_PrimaryKeyValueCDMReps()
      Returns a count of the current number of repetitions of Primary Key Value - CDM (OM7-24). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertPrimaryKeyValueCDM

      public CE insertPrimaryKeyValueCDM(int rep) throws HL7Exception
      Inserts a repetition of OM7-24: "Primary Key Value - CDM" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertOm724_PrimaryKeyValueCDM

      public CE insertOm724_PrimaryKeyValueCDM(int rep) throws HL7Exception
      Inserts a repetition of OM7-24: "Primary Key Value - CDM" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removePrimaryKeyValueCDM

      public CE removePrimaryKeyValueCDM(int rep) throws HL7Exception
      Removes a repetition of OM7-24: "Primary Key Value - CDM" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeOm724_PrimaryKeyValueCDM

      public CE removeOm724_PrimaryKeyValueCDM(int rep) throws HL7Exception
      Removes a repetition of OM7-24: "Primary Key Value - CDM" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • createNewTypeWithoutReflection

      protected Type createNewTypeWithoutReflection(int field)
      Overrides:
      createNewTypeWithoutReflection in class AbstractSegment