Package ca.uhn.hl7v2.model.v251.segment

Class CSR

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

Represents an HL7 CSR message segment (Clinical Study Registration). This segment has the following fields:

  • CSR-1: Sponsor Study ID (EI)
  • CSR-2: Alternate Study ID (EI) optional
  • CSR-3: Institution Registering the Patient (CE) optional
  • CSR-4: Sponsor Patient ID (CX)
  • CSR-5: Alternate Patient ID - CSR (CX) optional
  • CSR-6: Date/Time Of Patient Study Registration (TS)
  • CSR-7: Person Performing Study Registration (XCN) optional repeating
  • CSR-8: Study Authorizing Provider (XCN) repeating
  • CSR-9: Date/time Patient Study Consent Signed (TS) optional
  • CSR-10: Patient Study Eligibility Status (CE) optional
  • CSR-11: Study Randomization Date/time (TS) optional repeating
  • CSR-12: Randomized Study Arm (CE) optional repeating
  • CSR-13: Stratum for Study Randomization (CE) optional repeating
  • CSR-14: Patient Evaluability Status (CE) optional
  • CSR-15: Date/time Ended Study (TS) optional
  • CSR-16: Reason Ended Study (CE) optional
See Also:

  • Constructor Details

  • Method Details

    • getSponsorStudyID

      public EI getSponsorStudyID()
      Returns CSR-1: "Sponsor Study ID" - creates it if necessary

    • getCsr1_SponsorStudyID

      public EI getCsr1_SponsorStudyID()
      Returns CSR-1: "Sponsor Study ID" - creates it if necessary

    • getAlternateStudyID

      public EI getAlternateStudyID()
      Returns CSR-2: "Alternate Study ID" - creates it if necessary

    • getCsr2_AlternateStudyID

      public EI getCsr2_AlternateStudyID()
      Returns CSR-2: "Alternate Study ID" - creates it if necessary

    • getInstitutionRegisteringThePatient

      public CE getInstitutionRegisteringThePatient()
      Returns CSR-3: "Institution Registering the Patient" - creates it if necessary

    • getCsr3_InstitutionRegisteringThePatient

      public CE getCsr3_InstitutionRegisteringThePatient()
      Returns CSR-3: "Institution Registering the Patient" - creates it if necessary

    • getSponsorPatientID

      public CX getSponsorPatientID()
      Returns CSR-4: "Sponsor Patient ID" - creates it if necessary

    • getCsr4_SponsorPatientID

      public CX getCsr4_SponsorPatientID()
      Returns CSR-4: "Sponsor Patient ID" - creates it if necessary

    • getAlternatePatientIDCSR

      public CX getAlternatePatientIDCSR()
      Returns CSR-5: "Alternate Patient ID - CSR" - creates it if necessary

    • getCsr5_AlternatePatientIDCSR

      public CX getCsr5_AlternatePatientIDCSR()
      Returns CSR-5: "Alternate Patient ID - CSR" - creates it if necessary

    • getDateTimeOfPatientStudyRegistration

      public TS getDateTimeOfPatientStudyRegistration()
      Returns CSR-6: "Date/Time Of Patient Study Registration" - creates it if necessary

    • getCsr6_DateTimeOfPatientStudyRegistration

      public TS getCsr6_DateTimeOfPatientStudyRegistration()
      Returns CSR-6: "Date/Time Of Patient Study Registration" - creates it if necessary

    • getPersonPerformingStudyRegistration

      public XCN[] getPersonPerformingStudyRegistration()
      Returns all repetitions of Person Performing Study Registration (CSR-7).

    • getCsr7_PersonPerformingStudyRegistration

      public XCN[] getCsr7_PersonPerformingStudyRegistration()
      Returns all repetitions of Person Performing Study Registration (CSR-7).

    • getPersonPerformingStudyRegistrationReps

      public int getPersonPerformingStudyRegistrationReps()
      Returns a count of the current number of repetitions of Person Performing Study Registration (CSR-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getPersonPerformingStudyRegistration

      public XCN getPersonPerformingStudyRegistration(int rep)
      Returns a specific repetition of CSR-7: "Person Performing Study Registration" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCsr7_PersonPerformingStudyRegistration

      public XCN getCsr7_PersonPerformingStudyRegistration(int rep)
      Returns a specific repetition of CSR-7: "Person Performing Study Registration" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCsr7_PersonPerformingStudyRegistrationReps

      public int getCsr7_PersonPerformingStudyRegistrationReps()
      Returns a count of the current number of repetitions of Person Performing Study Registration (CSR-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertPersonPerformingStudyRegistration

      public XCN insertPersonPerformingStudyRegistration(int rep) throws HL7Exception
      Inserts a repetition of CSR-7: "Person Performing Study Registration" 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)

    • insertCsr7_PersonPerformingStudyRegistration

      public XCN insertCsr7_PersonPerformingStudyRegistration(int rep) throws HL7Exception
      Inserts a repetition of CSR-7: "Person Performing Study Registration" 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)

    • removePersonPerformingStudyRegistration

      public XCN removePersonPerformingStudyRegistration(int rep) throws HL7Exception
      Removes a repetition of CSR-7: "Person Performing Study Registration" 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)

    • removeCsr7_PersonPerformingStudyRegistration

      public XCN removeCsr7_PersonPerformingStudyRegistration(int rep) throws HL7Exception
      Removes a repetition of CSR-7: "Person Performing Study Registration" 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)

    • getStudyAuthorizingProvider

      public XCN[] getStudyAuthorizingProvider()
      Returns all repetitions of Study Authorizing Provider (CSR-8).

    • getCsr8_StudyAuthorizingProvider

      public XCN[] getCsr8_StudyAuthorizingProvider()
      Returns all repetitions of Study Authorizing Provider (CSR-8).

    • getStudyAuthorizingProviderReps

      public int getStudyAuthorizingProviderReps()
      Returns a count of the current number of repetitions of Study Authorizing Provider (CSR-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getStudyAuthorizingProvider

      public XCN getStudyAuthorizingProvider(int rep)
      Returns a specific repetition of CSR-8: "Study Authorizing Provider" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCsr8_StudyAuthorizingProvider

      public XCN getCsr8_StudyAuthorizingProvider(int rep)
      Returns a specific repetition of CSR-8: "Study Authorizing Provider" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCsr8_StudyAuthorizingProviderReps

      public int getCsr8_StudyAuthorizingProviderReps()
      Returns a count of the current number of repetitions of Study Authorizing Provider (CSR-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertStudyAuthorizingProvider

      public XCN insertStudyAuthorizingProvider(int rep) throws HL7Exception
      Inserts a repetition of CSR-8: "Study Authorizing Provider" 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)

    • insertCsr8_StudyAuthorizingProvider

      public XCN insertCsr8_StudyAuthorizingProvider(int rep) throws HL7Exception
      Inserts a repetition of CSR-8: "Study Authorizing Provider" 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)

    • removeStudyAuthorizingProvider

      public XCN removeStudyAuthorizingProvider(int rep) throws HL7Exception
      Removes a repetition of CSR-8: "Study Authorizing Provider" 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)

    • removeCsr8_StudyAuthorizingProvider

      public XCN removeCsr8_StudyAuthorizingProvider(int rep) throws HL7Exception
      Removes a repetition of CSR-8: "Study Authorizing Provider" 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)

    • getDateTimePatientStudyConsentSigned

      public TS getDateTimePatientStudyConsentSigned()
      Returns CSR-9: "Date/time Patient Study Consent Signed" - creates it if necessary

    • getCsr9_DateTimePatientStudyConsentSigned

      public TS getCsr9_DateTimePatientStudyConsentSigned()
      Returns CSR-9: "Date/time Patient Study Consent Signed" - creates it if necessary

    • getPatientStudyEligibilityStatus

      public CE getPatientStudyEligibilityStatus()
      Returns CSR-10: "Patient Study Eligibility Status" - creates it if necessary

    • getCsr10_PatientStudyEligibilityStatus

      public CE getCsr10_PatientStudyEligibilityStatus()
      Returns CSR-10: "Patient Study Eligibility Status" - creates it if necessary

    • getStudyRandomizationDateTime

      public TS[] getStudyRandomizationDateTime()
      Returns all repetitions of Study Randomization Date/time (CSR-11).

    • getCsr11_StudyRandomizationDateTime

      public TS[] getCsr11_StudyRandomizationDateTime()
      Returns all repetitions of Study Randomization Date/time (CSR-11).

    • getStudyRandomizationDateTimeReps

      public int getStudyRandomizationDateTimeReps()
      Returns a count of the current number of repetitions of Study Randomization Date/time (CSR-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getStudyRandomizationDateTime

      public TS getStudyRandomizationDateTime(int rep)
      Returns a specific repetition of CSR-11: "Study Randomization Date/time" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCsr11_StudyRandomizationDateTime

      public TS getCsr11_StudyRandomizationDateTime(int rep)
      Returns a specific repetition of CSR-11: "Study Randomization Date/time" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCsr11_StudyRandomizationDateTimeReps

      public int getCsr11_StudyRandomizationDateTimeReps()
      Returns a count of the current number of repetitions of Study Randomization Date/time (CSR-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertStudyRandomizationDateTime

      public TS insertStudyRandomizationDateTime(int rep) throws HL7Exception
      Inserts a repetition of CSR-11: "Study Randomization Date/time" 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)

    • insertCsr11_StudyRandomizationDateTime

      public TS insertCsr11_StudyRandomizationDateTime(int rep) throws HL7Exception
      Inserts a repetition of CSR-11: "Study Randomization Date/time" 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)

    • removeStudyRandomizationDateTime

      public TS removeStudyRandomizationDateTime(int rep) throws HL7Exception
      Removes a repetition of CSR-11: "Study Randomization Date/time" 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)

    • removeCsr11_StudyRandomizationDateTime

      public TS removeCsr11_StudyRandomizationDateTime(int rep) throws HL7Exception
      Removes a repetition of CSR-11: "Study Randomization Date/time" 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)

    • getRandomizedStudyArm

      public CE[] getRandomizedStudyArm()
      Returns all repetitions of Randomized Study Arm (CSR-12).

    • getCsr12_RandomizedStudyArm

      public CE[] getCsr12_RandomizedStudyArm()
      Returns all repetitions of Randomized Study Arm (CSR-12).

    • getRandomizedStudyArmReps

      public int getRandomizedStudyArmReps()
      Returns a count of the current number of repetitions of Randomized Study Arm (CSR-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRandomizedStudyArm

      public CE getRandomizedStudyArm(int rep)
      Returns a specific repetition of CSR-12: "Randomized Study Arm" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCsr12_RandomizedStudyArm

      public CE getCsr12_RandomizedStudyArm(int rep)
      Returns a specific repetition of CSR-12: "Randomized Study Arm" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCsr12_RandomizedStudyArmReps

      public int getCsr12_RandomizedStudyArmReps()
      Returns a count of the current number of repetitions of Randomized Study Arm (CSR-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRandomizedStudyArm

      public CE insertRandomizedStudyArm(int rep) throws HL7Exception
      Inserts a repetition of CSR-12: "Randomized Study Arm" 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)

    • insertCsr12_RandomizedStudyArm

      public CE insertCsr12_RandomizedStudyArm(int rep) throws HL7Exception
      Inserts a repetition of CSR-12: "Randomized Study Arm" 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)

    • removeRandomizedStudyArm

      public CE removeRandomizedStudyArm(int rep) throws HL7Exception
      Removes a repetition of CSR-12: "Randomized Study Arm" 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)

    • removeCsr12_RandomizedStudyArm

      public CE removeCsr12_RandomizedStudyArm(int rep) throws HL7Exception
      Removes a repetition of CSR-12: "Randomized Study Arm" 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)

    • getStratumForStudyRandomization

      public CE[] getStratumForStudyRandomization()
      Returns all repetitions of Stratum for Study Randomization (CSR-13).

    • getCsr13_StratumForStudyRandomization

      public CE[] getCsr13_StratumForStudyRandomization()
      Returns all repetitions of Stratum for Study Randomization (CSR-13).

    • getStratumForStudyRandomizationReps

      public int getStratumForStudyRandomizationReps()
      Returns a count of the current number of repetitions of Stratum for Study Randomization (CSR-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getStratumForStudyRandomization

      public CE getStratumForStudyRandomization(int rep)
      Returns a specific repetition of CSR-13: "Stratum for Study Randomization" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCsr13_StratumForStudyRandomization

      public CE getCsr13_StratumForStudyRandomization(int rep)
      Returns a specific repetition of CSR-13: "Stratum for Study Randomization" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCsr13_StratumForStudyRandomizationReps

      public int getCsr13_StratumForStudyRandomizationReps()
      Returns a count of the current number of repetitions of Stratum for Study Randomization (CSR-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertStratumForStudyRandomization

      public CE insertStratumForStudyRandomization(int rep) throws HL7Exception
      Inserts a repetition of CSR-13: "Stratum for Study Randomization" 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)

    • insertCsr13_StratumForStudyRandomization

      public CE insertCsr13_StratumForStudyRandomization(int rep) throws HL7Exception
      Inserts a repetition of CSR-13: "Stratum for Study Randomization" 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)

    • removeStratumForStudyRandomization

      public CE removeStratumForStudyRandomization(int rep) throws HL7Exception
      Removes a repetition of CSR-13: "Stratum for Study Randomization" 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)

    • removeCsr13_StratumForStudyRandomization

      public CE removeCsr13_StratumForStudyRandomization(int rep) throws HL7Exception
      Removes a repetition of CSR-13: "Stratum for Study Randomization" 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)

    • getPatientEvaluabilityStatus

      public CE getPatientEvaluabilityStatus()
      Returns CSR-14: "Patient Evaluability Status" - creates it if necessary

    • getCsr14_PatientEvaluabilityStatus

      public CE getCsr14_PatientEvaluabilityStatus()
      Returns CSR-14: "Patient Evaluability Status" - creates it if necessary

    • getDateTimeEndedStudy

      public TS getDateTimeEndedStudy()
      Returns CSR-15: "Date/time Ended Study" - creates it if necessary

    • getCsr15_DateTimeEndedStudy

      public TS getCsr15_DateTimeEndedStudy()
      Returns CSR-15: "Date/time Ended Study" - creates it if necessary

    • getReasonEndedStudy

      public CE getReasonEndedStudy()
      Returns CSR-16: "Reason Ended Study" - creates it if necessary

    • getCsr16_ReasonEndedStudy

      public CE getCsr16_ReasonEndedStudy()
      Returns CSR-16: "Reason Ended Study" - creates it if necessary

    • createNewTypeWithoutReflection

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