camt.039.001.05
Scope The CaseStatusReport message is sent by a case assignee to a case creator or case assigner. This message is used to report on the status of a case. Usage A CaseStatusReport message is sent in reply to a CaseStatusReportRequest message. This message
- covers one and only one case at a time. (If a case assignee needs to report on several cases, then multiple CaseStatusReport messages must be sent);
- may be forwarded to subsequent case assigner(s) until it reaches the end point;
- is able to indicate the fact that a case has been assigned to a party downstream in the payment processing chain;
- may not be used in place of a ResolutionOfInvestigation (except for the condition given in the next bullet point) or NotificationOfCaseAssignment message;
- may be skipped and replaced by a ResolutionOfInvestigation message when the request for a investigation status is received at the time the assigner has resolved the case. (In this case a ResolutionOfInvestigation message can be sent instead of a CaseStatusReport and the case may be closed).
Message Construction
Every ISO20022 message has at the highest level what we call ‘building blocks’. Because the message is constructed as immutable records, the association is by composition. Below you can see the relationship between the message and its constituent building blocks: For comparison, see the ISO20022 official specification
classDiagram direction LR %% CaseStatusReportV05 recursion level 0 with max 0 CaseStatusReportV05 *-- "1..1" ReportHeader5 : Header CaseStatusReportV05 *-- "1..1" Case5 : Case CaseStatusReportV05 *-- "1..1" CaseStatus2 : Status CaseStatusReportV05 *-- "0..1" CaseAssignment5 : NewAssignment CaseStatusReportV05 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Specifies generic information about an investigation report. Specifies generic information about an investigation report. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ReportHeader5 recursion level 0 with max 1 class ReportHeader5{ Identification IsoMax35Text CreationDateTime IsoISODateTime } ReportHeader5 *-- "1..1" IParty40Choice : From ReportHeader5 *-- "1..1" IParty40Choice : To %% IParty40Choice recursion level 1 with max 1 %% IParty40Choice recursion level 1 with max 1
ReportHeader5 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Point to point reference as assigned by the case assigner to unambiguously identify the case status report. | IsoMax35Text - Required 1..1 |
From | Party reporting the status of the investigation case. | IParty40Choice - Required 1..1 |
To | Party to which the status of the case is reported. | IParty40Choice - Required 1..1 |
CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
Case building block
Identifies the investigation case. Provides further details to identify an investigation case. For comparison, see the ISO20022 official specification
classDiagram direction tb %% Case5 recursion level 0 with max 1 class Case5{ Identification IsoMax35Text ReopenCaseIndication IsoYesNoIndicator } Case5 *-- "1..1" IParty40Choice : Creator %% IParty40Choice recursion level 1 with max 1
Case5 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Uniquely identifies the case. | IsoMax35Text - Required 1..1 |
Creator | Party that created the investigation case. | IParty40Choice - Required 1..1 |
ReopenCaseIndication | Indicates whether or not the case was previously closed and is now re-opened. | IsoYesNoIndicator - Optional 0..1 |
Status building block
Defines the status of the case. Defines the status of an investigation case. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CaseStatus2 recursion level 0 with max 1 class CaseStatus2{ DateTime IsoISODateTime CaseStatus CaseStatus2Code Reason IsoMax140Text }
CaseStatus2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
DateTime | Date and time of the status. | IsoISODateTime - Required 1..1 |
CaseStatus | Status of the case. | CaseStatus2Code - Required 1..1 |
Reason | Free text justification of the status. | IsoMax140Text - Optional 0..1 |
NewAssignment building block
Identifies the change of an assignment for an investigation case from an assigner to a new assignee. Usage: The assigner must be the sender of this confirmation and the assignee must be the receiver. Represents the assignment of a case to a party. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CaseAssignment5 recursion level 0 with max 1 class CaseAssignment5{ Identification IsoMax35Text CreationDateTime IsoISODateTime } CaseAssignment5 *-- "1..1" IParty40Choice : Assigner CaseAssignment5 *-- "1..1" IParty40Choice : Assignee %% IParty40Choice recursion level 1 with max 1 %% IParty40Choice recursion level 1 with max 1
CaseAssignment5 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Uniquely identifies the case assignment. | IsoMax35Text - Required 1..1 |
Assigner | Party who assigns the case. | Usage: This is also the sender of the message. |
Assignee | Party to which the case is assigned. | Usage: This is also the receiver of the message. |
CreationDateTime | Date and time at which the assignment was created. | IsoISODateTime - Required 1..1 |
SupplementaryData building block
Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification
classDiagram direction tb %% SupplementaryData1 recursion level 0 with max 1 class SupplementaryData1{ PlaceAndName IsoMax350Text } SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope %% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
SupplementaryData1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PlaceAndName | Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. | IsoMax350Text - Optional 0..1 |
Envelope | Technical element wrapping the supplementary data. | IsoSupplementaryDataEnvelope1 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the CaseStatusReportV05 implementation follows a specific implementaiton pattern. First of all, CaseStatusReportV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CaseStatusReportV05Document implements IOuterDocument. Because CaseStatusReportV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CaseStatusReportV05.
classDiagram class IOuterRecord CaseStatusReportV05 --|> IOuterRecord : Implements CaseStatusReportV05Document --|> IOuterDocument~CaseStatusReportV05~ : Implements class IOuterDocument~CaseStatusReportV05~ { CaseStatusReportV05 Message }
Document wrapper for serialization
The only real purpose CaseStatusReportV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.039.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CaseStatusReportV05.ToDocument() method. The returned CaseStatusReportV05Document value will serialize correctly according to ISO 20022 standards.
classDiagram CaseStatusReportV05Document *-- CaseStatusReportV05 : Document
Sample of message format
This is an abbreviated version of what the message should look like.
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.039.001.05">
<CaseStsRpt>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Case>
<!-- Case inner content -->
</Case>
<Sts>
<!-- Status inner content -->
</Sts>
<NewAssgnmt>
<!-- NewAssignment inner content -->
</NewAssgnmt>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CaseStsRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_eYI_PW2PEei3KuUgpx7Xcw"
previousVersion="_sVp9glkyEeGeoaLUQk__nA_-1954850313"
name="CaseStatusReportV05"
definition="Scope
The CaseStatusReport message is sent by a case assignee to a case creator or case assigner.
This message is used to report on the status of a case.
Usage
A CaseStatusReport message is sent in reply to a CaseStatusReportRequest message. This message
- covers one and only one case at a time. (If a case assignee needs to report on several cases, then multiple CaseStatusReport messages must be sent);
- may be forwarded to subsequent case assigner(s) until it reaches the end point;
- is able to indicate the fact that a case has been assigned to a party downstream in the payment processing chain;
- may not be used in place of a ResolutionOfInvestigation (except for the condition given in the next bullet point) or NotificationOfCaseAssignment message;
- may be skipped and replaced by a ResolutionOfInvestigation message when the request for a investigation status is received at the time the assigner has resolved the case. (In this case a ResolutionOfInvestigation message can be sent instead of a CaseStatusReport and the case may be closed)."
registrationStatus="Registered"
messageSet="_moz48_2VEeGjgKzdN0DbWA"
xmlTag="CaseStsRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_eYI_P22PEei3KuUgpx7Xcw"
previousVersion="_sVzHcFkyEeGeoaLUQk__nA_-366423921"
name="Header"
definition="Specifies generic information about an investigation report."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_Dr8EK249EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_eYI_QW2PEei3KuUgpx7Xcw"
previousVersion="_sVzHcVkyEeGeoaLUQk__nA_-1249657208"
name="Case"
definition="Identifies the investigation case."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Case"
complexType="_8BF4W248EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_eYI_Q22PEei3KuUgpx7Xcw"
previousVersion="_sVzHclkyEeGeoaLUQk__nA_360770913"
name="Status"
definition="Defines the status of the case."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Sts"
complexType="_T-GLS9p-Ed-ak6NoX_4Aeg_-1949574113" />
<messageBuildingBlock
xmi:id="_eYI_RW2PEei3KuUgpx7Xcw"
previousVersion="_sV84cFkyEeGeoaLUQk__nA_246931847"
name="NewAssignment"
definition="Identifies the change of an assignment for an investigation case from an assigner to a new assignee.
Usage: The assigner must be the sender of this confirmation and the assignee must be the receiver."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="NewAssgnmt"
complexType="_BzPdIW49EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_eYI_R22PEei3KuUgpx7Xcw"
previousVersion="_sV84cVkyEeGeoaLUQk__nA_-686689479"
name="SupplementaryData"
definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="SplmtryData"
complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
<messageDefinitionIdentifier
businessArea="camt"
messageFunctionality="039"
flavour="001"
version="05" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.