The CSR segment will contain fundamental administrative and regulatory information required to document a patient's enrollment on a clinical trial. This segment is all that is required if one needs to message another system that an enrollment has taken place, i.e., from clinical trials to pharmacy, accounting, or order entry systems. The CSR segment may also be used to identify that OBR, OBX, RXA, and RXR segments that follow represent data applicable to the identified study.
HL7 Attribute Table - CSR - Clinical Study Registration
Base Framework | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
CSR | ||||||||||
1 | 01011 | Sponsor Study ID | SHOULD | [1..1] | EI Entity Identifier | |||||
2 | 01036 | Alternate Study ID | MAY | [0..1] | EI Entity Identifier | |||||
3 | 01037 | Institution Registering the Patient | MAY | [0..1] | InstitutionRegisteringthePatient (CD) | CWE Coded with Exceptions | ||||
4 | 01038 | Sponsor Patient ID | SHOULD | [1..1] | CX Extended Composite ID with Check Digit | |||||
5 | 01039 | Alternate Patient ID - CSR | MAY | [0..1] | CX Extended Composite ID with Check Digit | |||||
6 | 01040 | Date/Time of Patient Study Registration | SHOULD | [1..1] | DTM Date/Time | |||||
7 | 01041 | Person Performing Study Registration | MAY | [0..*] | XCN Extended Composite ID Number and Name for Persons | |||||
8 | 01042 | Study Authorizing Provider | SHOULD | [1..*] | XCN Extended Composite ID Number and Name for Persons | |||||
9 | 01043 | Date/Time Patient Study Consent Signed | C Condition defined for this element | MAY | [0..1] | DTM Date/Time | ||||
10 | 01044 | Patient Study Eligibility Status | C Condition defined for this element | MAY | [0..1] | PatientStudyEligibilityStatus (CD) | CWE Coded with Exceptions | |||
11 | 01045 | Study Randomization Date/time | MAY | [0..3] | DTM Date/Time | |||||
12 | 01046 | Randomized Study Arm | MAY | [0..3] | RandomizedStudyArm (CD) | CWE Coded with Exceptions | ||||
13 | 01047 | Stratum for Study Randomization | MAY | [0..3] | StratumforStudyRandomization (CD) | CWE Coded with Exceptions | ||||
14 | 01048 | Patient Evaluability Status | C Condition defined for this element | MAY | [0..1] | PatientEvaluabilityStatus (CD) | CWE Coded with Exceptions | |||
15 | 01049 | Date/Time Ended Study | C Condition defined for this element | MAY | [0..1] | DTM Date/Time | ||||
16 | 01050 | Reason Ended Study | C Condition defined for this element | MAY | [0..1] | ReasonEndedStudy (CD) | CWE Coded with Exceptions | |||
17 | 00816 | Action Code | MAY | [0..1] | [2..2] | univ: SegmentActionCode (CD) hl7VS-segmentActionCode (VS) segmentAction (CS) | ID Coded Value for HL7 Defined Tables |
The root for the expression is on the segment.
Seq. | Referenced Elements | Introduction | Invariant | Comment |
---|---|---|---|---|
1 | ? |
Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
---|---|---|---|---|---|---|---|---|---|---|
CSR | ||||||||||
1 | 01011 | Sponsor Study ID | SHALL | [1..1] | EI Entity Identifier | |||||
2 | 01036 | Alternate Study ID | MAY | [0..1] | EI Entity Identifier | |||||
3 | 01037 | Institution Registering the Patient | MAY | [0..1] | InstitutionRegisteringthePatient (CD) | CWE Coded with Exceptions | ||||
4 | 01038 | Sponsor Patient ID | SHALL | [1..1] | CX Extended Composite ID with Check Digit | |||||
5 | 01039 | Alternate Patient ID - CSR | MAY | [0..1] | CX Extended Composite ID with Check Digit | |||||
6 | 01040 | Date/Time of Patient Study Registration | SHALL | [1..1] | DTM Date/Time | |||||
7 | 01041 | Person Performing Study Registration | MAY | [0..*] | XCN Extended Composite ID Number and Name for Persons | |||||
8 | 01042 | Study Authorizing Provider | SHALL | [1..*] | XCN Extended Composite ID Number and Name for Persons | |||||
9 | 01043 | Date/Time Patient Study Consent Signed | C Condition defined for this element | MAY | [0..1] | DTM Date/Time | ||||
10 | 01044 | Patient Study Eligibility Status | C Condition defined for this element | MAY | [0..1] | PatientStudyEligibilityStatus (CD) | CWE Coded with Exceptions | |||
11 | 01045 | Study Randomization Date/time | MAY | [0..3] | DTM Date/Time | |||||
12 | 01046 | Randomized Study Arm | MAY | [0..3] | RandomizedStudyArm (CD) | CWE Coded with Exceptions | ||||
13 | 01047 | Stratum for Study Randomization | MAY | [0..3] | StratumforStudyRandomization (CD) | CWE Coded with Exceptions | ||||
14 | 01048 | Patient Evaluability Status | C Condition defined for this element | MAY | [0..1] | PatientEvaluabilityStatus (CD) | CWE Coded with Exceptions | |||
15 | 01049 | Date/Time Ended Study | C Condition defined for this element | MAY | [0..1] | DTM Date/Time | ||||
16 | 01050 | Reason Ended Study | C Condition defined for this element | MAY | [0..1] | ReasonEndedStudy (CD) | CWE Coded with Exceptions | |||
17 | 00816 | Action Code | MAY | [0..1] | [2..2] | univ: SegmentActionCode (CD) hl7VS-segmentActionCode (VS) segmentAction (CS) | ID Coded Value for HL7 Defined Tables |
Base Framework | Base Standard Profile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | Implement | Vocabulary | |
CSR | ||||||||||||
1 | 01011 | Sponsor Study ID | SHOULD | [1..1] | EI Entity Identifier | SHALL | ||||||
2 | 01036 | Alternate Study ID | MAY | [0..1] | EI Entity Identifier | MAY | ||||||
3 | 01037 | Institution Registering the Patient | MAY | [0..1] | InstitutionRegisteringthePatient (CD) | CWE Coded with Exceptions | MAY | |||||
4 | 01038 | Sponsor Patient ID | SHOULD | [1..1] | CX Extended Composite ID with Check Digit | SHALL | ||||||
5 | 01039 | Alternate Patient ID - CSR | MAY | [0..1] | CX Extended Composite ID with Check Digit | MAY | ||||||
6 | 01040 | Date/Time of Patient Study Registration | SHOULD | [1..1] | DTM Date/Time | SHALL | ||||||
7 | 01041 | Person Performing Study Registration | MAY | [0..*] | XCN Extended Composite ID Number and Name for Persons | MAY | ||||||
8 | 01042 | Study Authorizing Provider | SHOULD | [1..*] | XCN Extended Composite ID Number and Name for Persons | SHALL | ||||||
9 | 01043 | Date/Time Patient Study Consent Signed | C Condition defined for this element | MAY | [0..1] | DTM Date/Time | MAY | |||||
10 | 01044 | Patient Study Eligibility Status | C Condition defined for this element | MAY | [0..1] | PatientStudyEligibilityStatus (CD) | CWE Coded with Exceptions | MAY | ||||
11 | 01045 | Study Randomization Date/time | MAY | [0..3] | DTM Date/Time | MAY | ||||||
12 | 01046 | Randomized Study Arm | MAY | [0..3] | RandomizedStudyArm (CD) | CWE Coded with Exceptions | MAY | |||||
13 | 01047 | Stratum for Study Randomization | MAY | [0..3] | StratumforStudyRandomization (CD) | CWE Coded with Exceptions | MAY | |||||
14 | 01048 | Patient Evaluability Status | C Condition defined for this element | MAY | [0..1] | PatientEvaluabilityStatus (CD) | CWE Coded with Exceptions | MAY | ||||
15 | 01049 | Date/Time Ended Study | C Condition defined for this element | MAY | [0..1] | DTM Date/Time | MAY | |||||
16 | 01050 | Reason Ended Study | C Condition defined for this element | MAY | [0..1] | ReasonEndedStudy (CD) | CWE Coded with Exceptions | MAY | ||||
17 | 00816 | Action Code | MAY | [0..1] | [2..2] | univ: SegmentActionCode (CD) hl7VS-segmentActionCode (VS) segmentAction (CS) | ID Coded Value for HL7 Defined Tables | MAY |
Base Framework | Base Standard Profile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Seq# | Data Element | Description | Flags | Optionality | Repetition | Length | C.LEN | Table | Data Type | Optionality | Table | |
CSR | ||||||||||||
1 | 01011 | Sponsor Study ID | O | EI Entity Identifier |
R | |||||||
2 | 01036 | Alternate Study ID | O | EI Entity Identifier |
||||||||
3 | 01037 | Institution Registering the Patient | O | CWE Coded with Exceptions |
(0589) | |||||||
4 | 01038 | Sponsor Patient ID | O | CX Extended Composite ID with Check Digit |
R | |||||||
5 | 01039 | Alternate Patient ID - CSR | O | CX Extended Composite ID with Check Digit |
||||||||
6 | 01040 | Date/Time of Patient Study Registration | O | DTM Date/Time |
R | |||||||
7 | 01041 | Person Performing Study Registration | O | Y | XCN Extended Composite ID Number and Name for Persons |
|||||||
8 | 01042 | Study Authorizing Provider | O | Y | XCN Extended Composite ID Number and Name for Persons |
R | ||||||
9 | 01043 | Date/Time Patient Study Consent Signed | C Condition defined for this element |
O | DTM Date/Time |
|||||||
10 | 01044 | Patient Study Eligibility Status | C Condition defined for this element |
O | CWE Coded with Exceptions |
(0590) | ||||||
11 | 01045 | Study Randomization Date/time | O | Y/3 | DTM Date/Time |
|||||||
12 | 01046 | Randomized Study Arm | O | Y/3 | CWE Coded with Exceptions |
(0591) | ||||||
13 | 01047 | Stratum for Study Randomization | O | Y/3 | CWE Coded with Exceptions |
(0592) | ||||||
14 | 01048 | Patient Evaluability Status | C Condition defined for this element |
O | CWE Coded with Exceptions |
(0593) | ||||||
15 | 01049 | Date/Time Ended Study | C Condition defined for this element |
O | DTM Date/Time |
|||||||
16 | 01050 | Reason Ended Study | C Condition defined for this element |
O | CWE Coded with Exceptions |
(0594) | ||||||
17 | 00816 | Action Code | O | [2..2] | ID Coded Value for HL7 Defined Tables |
(0206) |
Seq# | Data Element | Description | Optionality | Repetition | Length | C.LEN | Table | Data Type | |
---|---|---|---|---|---|---|---|---|---|
CSR | |||||||||
1 | 01011 | Sponsor Study ID | R | EI Entity Identifier |
|||||
2 | 01036 | Alternate Study ID | O | EI Entity Identifier |
|||||
3 | 01037 | Institution Registering the Patient | O | (0589) | CWE Coded with Exceptions |
||||
4 | 01038 | Sponsor Patient ID | R | CX Extended Composite ID with Check Digit |
|||||
5 | 01039 | Alternate Patient ID - CSR | O | CX Extended Composite ID with Check Digit |
|||||
6 | 01040 | Date/Time of Patient Study Registration | R | DTM Date/Time |
|||||
7 | 01041 | Person Performing Study Registration | O | Y | XCN Extended Composite ID Number and Name for Persons |
||||
8 | 01042 | Study Authorizing Provider | R | Y | XCN Extended Composite ID Number and Name for Persons |
||||
9 | 01043 | Date/Time Patient Study Consent Signed | C | DTM Date/Time |
|||||
10 | 01044 | Patient Study Eligibility Status | C | (0590) | CWE Coded with Exceptions |
||||
11 | 01045 | Study Randomization Date/time | O | Y/3 | DTM Date/Time |
||||
12 | 01046 | Randomized Study Arm | O | Y/3 | (0591) | CWE Coded with Exceptions |
|||
13 | 01047 | Stratum for Study Randomization | O | Y/3 | (0592) | CWE Coded with Exceptions |
|||
14 | 01048 | Patient Evaluability Status | C | (0593) | CWE Coded with Exceptions |
||||
15 | 01049 | Date/Time Ended Study | C | DTM Date/Time |
|||||
16 | 01050 | Reason Ended Study | C | (0594) | CWE Coded with Exceptions |
||||
17 | 00816 | Action Code | O | [2..2] | (0206) | ID Coded Value for HL7 Defined Tables |
Definition: The field contains the universal identifier for the clinical trial. Since many clinical trials are collaborative and multi-centered, and since one goal of these standards is to promote automated data exchange among sites, the primary identifier should come from the sponsor. The coding system component may reference the sponsor. Example:
T93-0807^NCI (where NCI refers to the National Cancer Institute).
Definition: This field contains an alternate identifier that may be used as agreed upon by messaging parties. For example, the sending application may code its internal study number here.
Definition: This field distinguishes the institution where registration occurred. The legal approval to give patients access to a trial lies with the Internal Review Board for the institution. Universal healthcare provider facility codes should be used when they exist. Currently coding systems must be devised by users. Refer to Table 0589 - Institution Registering the Patient in Chapter 2C for valid values.
Definition: This field contains the main patient identification for the study. The sponsor patient ID allows automation of records on patients treated at various institutions. The sponsor patient ID should be unique for each patient participating on the study identified in CSR-1 Sponsor Study ID.
Definition: This field may be the sending application's patient identification. Coding conventions may be used as agreed upon by users.
Definition: This field containing the date of the patient registration is mandatory. The time component is optional. The time stamp for a registration may be useful. For example, patients may be randomized at the pharmacy according to the order in which they were registered.
Definition: This field contains the healthcare facility employee who actually phoned, submitted a form, or interactively registered the patient on the clinical trial. This is generally done under authorization from the attending physician or a principal or collaborating investigator.
Definition: This field contains the healthcare provider, generally the attending physician, who is accountable that the patient is eligible for the trial and has signed an informed consent. National standard healthcare provider codes should be used when they exist. This field is required for the patient registration trigger event (C01).
Definition: This field contains the consent form signing date is collected to provide a checkpoint that the consent form was obtained. Since many trials involve unapproved drugs and other treatment modalities, the consent form is highly important to document and store. This field is required for the patient registration trigger event (C01). The time component is optional.
Definition: This field indicates whether the patient was an appropriate candidate for the trial. It is important for quality control and data analysis. The code set will vary among clinical trials. An example answer set is: Yes, No, By Approval, Not Assessed, Unknown. This field is required for the patient registration trigger event (C01). Refer to Table 0590 - Patient Study Eligibility Status in Chapter 2C for valid values.
Definition: This field contains the date the patient was randomized. The time component is optional. Up to three randomizations are supported. Sequential randomizations are listed in chronological order.
Definition: This field contains codes that must be developed by users. The blind treatment assignment may be communicated as a dummy text: ^blind or if a coded treatment assignment must also be communicated: 1^blind^local_code. If more than one randomization occurs, the second and third repetitions will correspond to the second and third repetitions of CSR-11 Study Randomization Date/Time, if they exist. Refer to Table 0591 - Randomized Study Arm in Chapter 2C for valid values.
Definition: Many studies have stratified randomization schemas. The strata codes must be developed for each clinical trial. This field is important for statistical analysis of the study results. The second and third repetitions will correspond to the second and third repetitions of CSR-11 Study Randomization Date/Time and CSR-12 Randomized Study Arm, if they exist. Refer to Table 0592 - Stratum for Study Randomization in Chapter 2C for valid values.
Definition: This field categorizes the inclusion of this patient's data for various analyses. The patient's data may be evaluable for analysis of adverse events but not for outcomes. Or it may be evaluable for some outcomes and not others. The coding systems will vary among trials. This field is required for the off-study trigger event (C04). Refer to Table 0593 - Patient Evaluability Status in Chapter 2C for valid values.
Definition: This field contains the date the patient completes or is otherwise removed from the study. This field is required for the off-study event (C04). The time component is optional.
Definition: This information is important for quality control and data analysis. The coding systems will vary among trials. An example answer set is: Adverse Events, Completed Trial, Death, Drug Resistance, Intercurrent Illness, Lost to Follow up, No Response to Therapy, Noncompliance, Progression of Disease, Protocol Violation, Refused Further Therapy. This field is required for the off-study trigger event (C04). Refer to Table 0594 - Reason Ended Study in Chapter 2C for valid values.
Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.
The action code can only be used when CSR-1 and CSR-4, or CSR-2 and CSR-5 are valued as agreed to by the trading partners in accordance with the guidance in Chapter 2, Section 2.10.4.2.