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

Class CDM

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

Represents an HL7 CDM message segment (Charge Description Master). This segment has the following fields:

  • CDM-1: Primary Key Value - CDM (CE)
  • CDM-2: Charge Code Alias (CE) optional repeating
  • CDM-3: Charge Description Short (ST)
  • CDM-4: Charge Description Long (ST) optional
  • CDM-5: Description Override Indicator (IS) optional
  • CDM-6: Exploding Charges (CE) optional repeating
  • CDM-7: Procedure Code (CE) optional repeating
  • CDM-8: Active/Inactive Flag (ID) optional
  • CDM-9: Inventory Number (CE) optional repeating
  • CDM-10: Resource Load (NM) optional
  • CDM-11: Contract Number (CK) optional repeating
  • CDM-12: Contract Organization (XON) optional repeating
  • CDM-13: Room Fee Indicator (ID) optional
See Also:

  • Constructor Details

  • Method Details

    • getPrimaryKeyValueCDM

      public CE getPrimaryKeyValueCDM()
      Returns CDM-1: "Primary Key Value - CDM" - creates it if necessary

    • getCdm1_PrimaryKeyValueCDM

      public CE getCdm1_PrimaryKeyValueCDM()
      Returns CDM-1: "Primary Key Value - CDM" - creates it if necessary

    • getChargeCodeAlias

      public CE[] getChargeCodeAlias()
      Returns all repetitions of Charge Code Alias (CDM-2).

    • getCdm2_ChargeCodeAlias

      public CE[] getCdm2_ChargeCodeAlias()
      Returns all repetitions of Charge Code Alias (CDM-2).

    • getChargeCodeAliasReps

      public int getChargeCodeAliasReps()
      Returns a count of the current number of repetitions of Charge Code Alias (CDM-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getChargeCodeAlias

      public CE getChargeCodeAlias(int rep)
      Returns a specific repetition of CDM-2: "Charge Code Alias" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCdm2_ChargeCodeAlias

      public CE getCdm2_ChargeCodeAlias(int rep)
      Returns a specific repetition of CDM-2: "Charge Code Alias" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCdm2_ChargeCodeAliasReps

      public int getCdm2_ChargeCodeAliasReps()
      Returns a count of the current number of repetitions of Charge Code Alias (CDM-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertChargeCodeAlias

      public CE insertChargeCodeAlias(int rep) throws HL7Exception
      Inserts a repetition of CDM-2: "Charge Code Alias" 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)

    • insertCdm2_ChargeCodeAlias

      public CE insertCdm2_ChargeCodeAlias(int rep) throws HL7Exception
      Inserts a repetition of CDM-2: "Charge Code Alias" 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)

    • removeChargeCodeAlias

      public CE removeChargeCodeAlias(int rep) throws HL7Exception
      Removes a repetition of CDM-2: "Charge Code Alias" 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)

    • removeCdm2_ChargeCodeAlias

      public CE removeCdm2_ChargeCodeAlias(int rep) throws HL7Exception
      Removes a repetition of CDM-2: "Charge Code Alias" 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)

    • getChargeDescriptionShort

      public ST getChargeDescriptionShort()
      Returns CDM-3: "Charge Description Short" - creates it if necessary

    • getCdm3_ChargeDescriptionShort

      public ST getCdm3_ChargeDescriptionShort()
      Returns CDM-3: "Charge Description Short" - creates it if necessary

    • getChargeDescriptionLong

      public ST getChargeDescriptionLong()
      Returns CDM-4: "Charge Description Long" - creates it if necessary

    • getCdm4_ChargeDescriptionLong

      public ST getCdm4_ChargeDescriptionLong()
      Returns CDM-4: "Charge Description Long" - creates it if necessary

    • getDescriptionOverrideIndicator

      public IS getDescriptionOverrideIndicator()
      Returns CDM-5: "Description Override Indicator" - creates it if necessary

    • getCdm5_DescriptionOverrideIndicator

      public IS getCdm5_DescriptionOverrideIndicator()
      Returns CDM-5: "Description Override Indicator" - creates it if necessary

    • getExplodingCharges

      public CE[] getExplodingCharges()
      Returns all repetitions of Exploding Charges (CDM-6).

    • getCdm6_ExplodingCharges

      public CE[] getCdm6_ExplodingCharges()
      Returns all repetitions of Exploding Charges (CDM-6).

    • getExplodingChargesReps

      public int getExplodingChargesReps()
      Returns a count of the current number of repetitions of Exploding Charges (CDM-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getExplodingCharges

      public CE getExplodingCharges(int rep)
      Returns a specific repetition of CDM-6: "Exploding Charges" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCdm6_ExplodingCharges

      public CE getCdm6_ExplodingCharges(int rep)
      Returns a specific repetition of CDM-6: "Exploding Charges" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCdm6_ExplodingChargesReps

      public int getCdm6_ExplodingChargesReps()
      Returns a count of the current number of repetitions of Exploding Charges (CDM-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertExplodingCharges

      public CE insertExplodingCharges(int rep) throws HL7Exception
      Inserts a repetition of CDM-6: "Exploding Charges" 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)

    • insertCdm6_ExplodingCharges

      public CE insertCdm6_ExplodingCharges(int rep) throws HL7Exception
      Inserts a repetition of CDM-6: "Exploding Charges" 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)

    • removeExplodingCharges

      public CE removeExplodingCharges(int rep) throws HL7Exception
      Removes a repetition of CDM-6: "Exploding Charges" 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)

    • removeCdm6_ExplodingCharges

      public CE removeCdm6_ExplodingCharges(int rep) throws HL7Exception
      Removes a repetition of CDM-6: "Exploding Charges" 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)

    • getProcedureCode

      public CE[] getProcedureCode()
      Returns all repetitions of Procedure Code (CDM-7).

    • getCdm7_ProcedureCode

      public CE[] getCdm7_ProcedureCode()
      Returns all repetitions of Procedure Code (CDM-7).

    • getProcedureCodeReps

      public int getProcedureCodeReps()
      Returns a count of the current number of repetitions of Procedure Code (CDM-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getProcedureCode

      public CE getProcedureCode(int rep)
      Returns a specific repetition of CDM-7: "Procedure Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCdm7_ProcedureCode

      public CE getCdm7_ProcedureCode(int rep)
      Returns a specific repetition of CDM-7: "Procedure Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCdm7_ProcedureCodeReps

      public int getCdm7_ProcedureCodeReps()
      Returns a count of the current number of repetitions of Procedure Code (CDM-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertProcedureCode

      public CE insertProcedureCode(int rep) throws HL7Exception
      Inserts a repetition of CDM-7: "Procedure Code" 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)

    • insertCdm7_ProcedureCode

      public CE insertCdm7_ProcedureCode(int rep) throws HL7Exception
      Inserts a repetition of CDM-7: "Procedure Code" 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)

    • removeProcedureCode

      public CE removeProcedureCode(int rep) throws HL7Exception
      Removes a repetition of CDM-7: "Procedure Code" 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)

    • removeCdm7_ProcedureCode

      public CE removeCdm7_ProcedureCode(int rep) throws HL7Exception
      Removes a repetition of CDM-7: "Procedure Code" 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)

    • getActiveInactiveFlag

      public ID getActiveInactiveFlag()
      Returns CDM-8: "Active/Inactive Flag" - creates it if necessary

    • getCdm8_ActiveInactiveFlag

      public ID getCdm8_ActiveInactiveFlag()
      Returns CDM-8: "Active/Inactive Flag" - creates it if necessary

    • getInventoryNumber

      public CE[] getInventoryNumber()
      Returns all repetitions of Inventory Number (CDM-9).

    • getCdm9_InventoryNumber

      public CE[] getCdm9_InventoryNumber()
      Returns all repetitions of Inventory Number (CDM-9).

    • getInventoryNumberReps

      public int getInventoryNumberReps()
      Returns a count of the current number of repetitions of Inventory Number (CDM-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getInventoryNumber

      public CE getInventoryNumber(int rep)
      Returns a specific repetition of CDM-9: "Inventory Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCdm9_InventoryNumber

      public CE getCdm9_InventoryNumber(int rep)
      Returns a specific repetition of CDM-9: "Inventory Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCdm9_InventoryNumberReps

      public int getCdm9_InventoryNumberReps()
      Returns a count of the current number of repetitions of Inventory Number (CDM-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertInventoryNumber

      public CE insertInventoryNumber(int rep) throws HL7Exception
      Inserts a repetition of CDM-9: "Inventory Number" 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)

    • insertCdm9_InventoryNumber

      public CE insertCdm9_InventoryNumber(int rep) throws HL7Exception
      Inserts a repetition of CDM-9: "Inventory Number" 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)

    • removeInventoryNumber

      public CE removeInventoryNumber(int rep) throws HL7Exception
      Removes a repetition of CDM-9: "Inventory Number" 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)

    • removeCdm9_InventoryNumber

      public CE removeCdm9_InventoryNumber(int rep) throws HL7Exception
      Removes a repetition of CDM-9: "Inventory Number" 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)

    • getResourceLoad

      public NM getResourceLoad()
      Returns CDM-10: "Resource Load" - creates it if necessary

    • getCdm10_ResourceLoad

      public NM getCdm10_ResourceLoad()
      Returns CDM-10: "Resource Load" - creates it if necessary

    • getContractNumber

      public CK[] getContractNumber()
      Returns all repetitions of Contract Number (CDM-11).

    • getCdm11_ContractNumber

      public CK[] getCdm11_ContractNumber()
      Returns all repetitions of Contract Number (CDM-11).

    • getContractNumberReps

      public int getContractNumberReps()
      Returns a count of the current number of repetitions of Contract Number (CDM-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getContractNumber

      public CK getContractNumber(int rep)
      Returns a specific repetition of CDM-11: "Contract Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCdm11_ContractNumber

      public CK getCdm11_ContractNumber(int rep)
      Returns a specific repetition of CDM-11: "Contract Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCdm11_ContractNumberReps

      public int getCdm11_ContractNumberReps()
      Returns a count of the current number of repetitions of Contract Number (CDM-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertContractNumber

      public CK insertContractNumber(int rep) throws HL7Exception
      Inserts a repetition of CDM-11: "Contract Number" 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)

    • insertCdm11_ContractNumber

      public CK insertCdm11_ContractNumber(int rep) throws HL7Exception
      Inserts a repetition of CDM-11: "Contract Number" 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)

    • removeContractNumber

      public CK removeContractNumber(int rep) throws HL7Exception
      Removes a repetition of CDM-11: "Contract Number" 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)

    • removeCdm11_ContractNumber

      public CK removeCdm11_ContractNumber(int rep) throws HL7Exception
      Removes a repetition of CDM-11: "Contract Number" 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)

    • getContractOrganization

      public XON[] getContractOrganization()
      Returns all repetitions of Contract Organization (CDM-12).

    • getCdm12_ContractOrganization

      public XON[] getCdm12_ContractOrganization()
      Returns all repetitions of Contract Organization (CDM-12).

    • getContractOrganizationReps

      public int getContractOrganizationReps()
      Returns a count of the current number of repetitions of Contract Organization (CDM-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getContractOrganization

      public XON getContractOrganization(int rep)
      Returns a specific repetition of CDM-12: "Contract Organization" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCdm12_ContractOrganization

      public XON getCdm12_ContractOrganization(int rep)
      Returns a specific repetition of CDM-12: "Contract Organization" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCdm12_ContractOrganizationReps

      public int getCdm12_ContractOrganizationReps()
      Returns a count of the current number of repetitions of Contract Organization (CDM-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertContractOrganization

      public XON insertContractOrganization(int rep) throws HL7Exception
      Inserts a repetition of CDM-12: "Contract Organization" 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)

    • insertCdm12_ContractOrganization

      public XON insertCdm12_ContractOrganization(int rep) throws HL7Exception
      Inserts a repetition of CDM-12: "Contract Organization" 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)

    • removeContractOrganization

      public XON removeContractOrganization(int rep) throws HL7Exception
      Removes a repetition of CDM-12: "Contract Organization" 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)

    • removeCdm12_ContractOrganization

      public XON removeCdm12_ContractOrganization(int rep) throws HL7Exception
      Removes a repetition of CDM-12: "Contract Organization" 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)

    • getRoomFeeIndicator

      public ID getRoomFeeIndicator()
      Returns CDM-13: "Room Fee Indicator" - creates it if necessary

    • getCdm13_RoomFeeIndicator

      public ID getCdm13_RoomFeeIndicator()
      Returns CDM-13: "Room Fee Indicator" - creates it if necessary

    • createNewTypeWithoutReflection

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