Iso20022

CaseStatusReportV04

camt.039.001.04

Scope The Case Status Report 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 Case Status Report message is sent in reply to a Case Status Report Request message. This message

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
%% CaseStatusReportV04 recursion level 0 with max 0
CaseStatusReportV04 *-- "1..1" ReportHeader4 : Header
CaseStatusReportV04 *-- "1..1" Case3 : Case
CaseStatusReportV04 *-- "1..1" CaseStatus2 : Status
CaseStatusReportV04 *-- "0..1" CaseAssignment3 : NewAssignment
CaseStatusReportV04 *-- "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
%% ReportHeader4 recursion level 0 with max 1
class ReportHeader4{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
ReportHeader4 *-- "1..1" IParty12Choice : From
ReportHeader4 *-- "1..1" IParty12Choice : To
%% IParty12Choice recursion level 1 with max 1
%% IParty12Choice recursion level 1 with max 1

ReportHeader4 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. IParty12Choice - Required 1..1
To Party to which the status of the case is reported. IParty12Choice - 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
%% Case3 recursion level 0 with max 1
class Case3{
    Identification IsoMax35Text
    ReopenCaseIndication IsoYesNoIndicator
}
Case3 *-- "1..1" IParty12Choice : Creator
%% IParty12Choice recursion level 1 with max 1

Case3 members

Member name Description Data Type / Multiplicity
Identification Uniquely identifies the case. IsoMax35Text - Required 1..1
Creator Party that created the investigation case. IParty12Choice - 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
%% CaseAssignment3 recursion level 0 with max 1
class CaseAssignment3{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
CaseAssignment3 *-- "1..1" IParty12Choice : Assigner
CaseAssignment3 *-- "1..1" IParty12Choice : Assignee
%% IParty12Choice recursion level 1 with max 1
%% IParty12Choice recursion level 1 with max 1

CaseAssignment3 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 CaseStatusReportV04 implementation follows a specific implementaiton pattern. First of all, CaseStatusReportV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CaseStatusReportV04Document implements IOuterDocument. Because CaseStatusReportV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CaseStatusReportV04.

classDiagram
    class IOuterRecord
    CaseStatusReportV04 --|> IOuterRecord : Implements
    CaseStatusReportV04Document --|> IOuterDocument~CaseStatusReportV04~ : Implements
    class IOuterDocument~CaseStatusReportV04~ {
        CaseStatusReportV04 Message
     }

Document wrapper for serialization

The only real purpose CaseStatusReportV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.039.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CaseStatusReportV04.ToDocument() method. The returned CaseStatusReportV04Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    CaseStatusReportV04Document *-- CaseStatusReportV04 : 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.04">
    <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="_sVp9glkyEeGeoaLUQk__nA_-1954850313"
  nextVersions="_eYI_PW2PEei3KuUgpx7Xcw"
  previousVersion="_PzltuNE-Ed-BzquC8wXy7w_86849110"
  name="CaseStatusReportV04"
  definition="Scope&#xD;&#xA;The Case Status Report message is sent by a case assignee to a case creator or case assigner.&#xD;&#xA;This message is used to report on the status of a case.&#xD;&#xA;Usage&#xD;&#xA;A Case Status Report message is sent in reply to a Case Status Report Request message. This message&#xD;&#xA;- covers one and only one case at a time. (If a case assignee needs to report on several cases, then multiple Case Status Report messages must be sent.)&#xD;&#xA;- may be forwarded to subsequent case assigner(s) until it reaches the end point&#xD;&#xA;- is able to indicate the fact that a case has been assigned to a party downstream in the payment processing chain&#xD;&#xA;- may not be used in place of a Resolution Of Investigation (except for the condition given in the next bullet point) or Notification Of Case Assignment message&#xD;&#xA;- may be skipped and replaced by a Resolution Of Investigation message when the request for a investigation status is received at the time the assigner has resolved the case. (In this case a Resolution Of Investigation message can be sent instead of a Case Status Report and the case may be closed.)."
  registrationStatus="Registered"
  messageSet="_wRx2xk2rEeG_I4xRYCA_7g _urpIICeJEeOCeO5e7islRQ"
  xmlTag="CaseStsRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_sVzHcFkyEeGeoaLUQk__nA_-366423921"
    nextVersions="_eYI_P22PEei3KuUgpx7Xcw"
    name="Header"
    definition="Specifies generic information about an investigation report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_toznclkyEeGeoaLUQk__nA_-1793756198" />
  <messageBuildingBlock
    xmi:id="_sVzHcVkyEeGeoaLUQk__nA_-1249657208"
    nextVersions="_eYI_QW2PEei3KuUgpx7Xcw"
    name="Case"
    definition="Identifies the investigation case."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Case"
    complexType="_tijOcFkyEeGeoaLUQk__nA_-1838378407" />
  <messageBuildingBlock
    xmi:id="_sVzHclkyEeGeoaLUQk__nA_360770913"
    nextVersions="_eYI_Q22PEei3KuUgpx7Xcw"
    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="_sV84cFkyEeGeoaLUQk__nA_246931847"
    nextVersions="_eYI_RW2PEei3KuUgpx7Xcw"
    name="NewAssignment"
    definition="Identifies the change of an assignment for an investigation case from an assigner to a new assignee.&#xA;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="_sbKvolkyEeGeoaLUQk__nA_1583838951" />
  <messageBuildingBlock
    xmi:id="_sV84cVkyEeGeoaLUQk__nA_-686689479"
    nextVersions="_eYI_R22PEei3KuUgpx7Xcw"
    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="04" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.