Package ca.uhn.hl7v2.model.v23.segment

Class APR

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

Represents an HL7 APR message segment (Appointment Preferences). This segment has the following fields:

  • APR-1: Time Selection Criteria (SCV) optional repeating
  • APR-2: Resource Selection Criteria (SCV) optional repeating
  • APR-3: Location Selection Criteria (SCV) optional repeating
  • APR-4: Slot Spacing Criteria (NM) optional
  • APR-5: Filler Override Criteria (SCV) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getTimeSelectionCriteria

      public SCV[] getTimeSelectionCriteria()
      Returns all repetitions of Time Selection Criteria (APR-1).

    • getApr1_TimeSelectionCriteria

      public SCV[] getApr1_TimeSelectionCriteria()
      Returns all repetitions of Time Selection Criteria (APR-1).

    • getTimeSelectionCriteriaReps

      public int getTimeSelectionCriteriaReps()
      Returns a count of the current number of repetitions of Time Selection Criteria (APR-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getTimeSelectionCriteria

      public SCV getTimeSelectionCriteria(int rep)
      Returns a specific repetition of APR-1: "Time Selection Criteria" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getApr1_TimeSelectionCriteria

      public SCV getApr1_TimeSelectionCriteria(int rep)
      Returns a specific repetition of APR-1: "Time Selection Criteria" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getApr1_TimeSelectionCriteriaReps

      public int getApr1_TimeSelectionCriteriaReps()
      Returns a count of the current number of repetitions of Time Selection Criteria (APR-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertTimeSelectionCriteria

      public SCV insertTimeSelectionCriteria(int rep) throws HL7Exception
      Inserts a repetition of APR-1: "Time Selection Criteria" 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)

    • insertApr1_TimeSelectionCriteria

      public SCV insertApr1_TimeSelectionCriteria(int rep) throws HL7Exception
      Inserts a repetition of APR-1: "Time Selection Criteria" 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)

    • removeTimeSelectionCriteria

      public SCV removeTimeSelectionCriteria(int rep) throws HL7Exception
      Removes a repetition of APR-1: "Time Selection Criteria" 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)

    • removeApr1_TimeSelectionCriteria

      public SCV removeApr1_TimeSelectionCriteria(int rep) throws HL7Exception
      Removes a repetition of APR-1: "Time Selection Criteria" 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)

    • getResourceSelectionCriteria

      public SCV[] getResourceSelectionCriteria()
      Returns all repetitions of Resource Selection Criteria (APR-2).

    • getApr2_ResourceSelectionCriteria

      public SCV[] getApr2_ResourceSelectionCriteria()
      Returns all repetitions of Resource Selection Criteria (APR-2).

    • getResourceSelectionCriteriaReps

      public int getResourceSelectionCriteriaReps()
      Returns a count of the current number of repetitions of Resource Selection Criteria (APR-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getResourceSelectionCriteria

      public SCV getResourceSelectionCriteria(int rep)
      Returns a specific repetition of APR-2: "Resource Selection Criteria" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getApr2_ResourceSelectionCriteria

      public SCV getApr2_ResourceSelectionCriteria(int rep)
      Returns a specific repetition of APR-2: "Resource Selection Criteria" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getApr2_ResourceSelectionCriteriaReps

      public int getApr2_ResourceSelectionCriteriaReps()
      Returns a count of the current number of repetitions of Resource Selection Criteria (APR-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertResourceSelectionCriteria

      public SCV insertResourceSelectionCriteria(int rep) throws HL7Exception
      Inserts a repetition of APR-2: "Resource Selection Criteria" 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)

    • insertApr2_ResourceSelectionCriteria

      public SCV insertApr2_ResourceSelectionCriteria(int rep) throws HL7Exception
      Inserts a repetition of APR-2: "Resource Selection Criteria" 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)

    • removeResourceSelectionCriteria

      public SCV removeResourceSelectionCriteria(int rep) throws HL7Exception
      Removes a repetition of APR-2: "Resource Selection Criteria" 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)

    • removeApr2_ResourceSelectionCriteria

      public SCV removeApr2_ResourceSelectionCriteria(int rep) throws HL7Exception
      Removes a repetition of APR-2: "Resource Selection Criteria" 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)

    • getLocationSelectionCriteria

      public SCV[] getLocationSelectionCriteria()
      Returns all repetitions of Location Selection Criteria (APR-3).

    • getApr3_LocationSelectionCriteria

      public SCV[] getApr3_LocationSelectionCriteria()
      Returns all repetitions of Location Selection Criteria (APR-3).

    • getLocationSelectionCriteriaReps

      public int getLocationSelectionCriteriaReps()
      Returns a count of the current number of repetitions of Location Selection Criteria (APR-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getLocationSelectionCriteria

      public SCV getLocationSelectionCriteria(int rep)
      Returns a specific repetition of APR-3: "Location Selection Criteria" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getApr3_LocationSelectionCriteria

      public SCV getApr3_LocationSelectionCriteria(int rep)
      Returns a specific repetition of APR-3: "Location Selection Criteria" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getApr3_LocationSelectionCriteriaReps

      public int getApr3_LocationSelectionCriteriaReps()
      Returns a count of the current number of repetitions of Location Selection Criteria (APR-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertLocationSelectionCriteria

      public SCV insertLocationSelectionCriteria(int rep) throws HL7Exception
      Inserts a repetition of APR-3: "Location Selection Criteria" 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)

    • insertApr3_LocationSelectionCriteria

      public SCV insertApr3_LocationSelectionCriteria(int rep) throws HL7Exception
      Inserts a repetition of APR-3: "Location Selection Criteria" 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)

    • removeLocationSelectionCriteria

      public SCV removeLocationSelectionCriteria(int rep) throws HL7Exception
      Removes a repetition of APR-3: "Location Selection Criteria" 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)

    • removeApr3_LocationSelectionCriteria

      public SCV removeApr3_LocationSelectionCriteria(int rep) throws HL7Exception
      Removes a repetition of APR-3: "Location Selection Criteria" 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)

    • getSlotSpacingCriteria

      public NM getSlotSpacingCriteria()
      Returns APR-4: "Slot Spacing Criteria" - creates it if necessary

    • getApr4_SlotSpacingCriteria

      public NM getApr4_SlotSpacingCriteria()
      Returns APR-4: "Slot Spacing Criteria" - creates it if necessary

    • getFillerOverrideCriteria

      public SCV[] getFillerOverrideCriteria()
      Returns all repetitions of Filler Override Criteria (APR-5).

    • getApr5_FillerOverrideCriteria

      public SCV[] getApr5_FillerOverrideCriteria()
      Returns all repetitions of Filler Override Criteria (APR-5).

    • getFillerOverrideCriteriaReps

      public int getFillerOverrideCriteriaReps()
      Returns a count of the current number of repetitions of Filler Override Criteria (APR-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getFillerOverrideCriteria

      public SCV getFillerOverrideCriteria(int rep)
      Returns a specific repetition of APR-5: "Filler Override Criteria" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getApr5_FillerOverrideCriteria

      public SCV getApr5_FillerOverrideCriteria(int rep)
      Returns a specific repetition of APR-5: "Filler Override Criteria" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getApr5_FillerOverrideCriteriaReps

      public int getApr5_FillerOverrideCriteriaReps()
      Returns a count of the current number of repetitions of Filler Override Criteria (APR-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertFillerOverrideCriteria

      public SCV insertFillerOverrideCriteria(int rep) throws HL7Exception
      Inserts a repetition of APR-5: "Filler Override Criteria" 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)

    • insertApr5_FillerOverrideCriteria

      public SCV insertApr5_FillerOverrideCriteria(int rep) throws HL7Exception
      Inserts a repetition of APR-5: "Filler Override Criteria" 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)

    • removeFillerOverrideCriteria

      public SCV removeFillerOverrideCriteria(int rep) throws HL7Exception
      Removes a repetition of APR-5: "Filler Override Criteria" 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)

    • removeApr5_FillerOverrideCriteria

      public SCV removeApr5_FillerOverrideCriteria(int rep) throws HL7Exception
      Removes a repetition of APR-5: "Filler Override Criteria" 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