camt.039.001.01
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
- 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.)
- 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 Resolution Of Investigation (except for the condition given in the next bullet point) or Notification Of Case Assignment message
- may be skipped and replaced by a Resolution Of Investigation message if at the moment when the request for a investigation status arrives, the assignee has obtained a solution. (In this case a Resolution Of Investigation message can be sent in lieu of a Case Status Report 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 %% CaseStatusReport recursion level 0 with max 0 CaseStatusReport *-- "1..1" ReportHeader : Header CaseStatusReport *-- "1..1" Case : Case CaseStatusReport *-- "1..1" CaseStatus : Status CaseStatusReport *-- "0..1" CaseAssignment : NewAssignment
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 %% ReportHeader recursion level 0 with max 1 class ReportHeader{ Identification IsoMax35Text From IsoAnyBICIdentifier To IsoAnyBICIdentifier CreationDateTime IsoISODateTime }
ReportHeader members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Identification of the report. | IsoMax35Text - Required 1..1 |
From | Party reporting the status of the case. | IsoAnyBICIdentifier - Required 1..1 |
To | Party to which the status of the case is reported. | IsoAnyBICIdentifier - Required 1..1 |
CreationDateTime | Creation date and time of the report generation. | IsoISODateTime - Required 1..1 |
Case building block
Identifies the case. Information identifying a case. For comparison, see the ISO20022 official specification
classDiagram direction tb %% Case recursion level 0 with max 1 class Case{ Identification IsoMax35Text Creator IsoAnyBICIdentifier ReopenCaseIndication IsoYesNoIndicator }
Case members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Unique id assigned by the case creator. | IsoMax35Text - Required 1..1 |
Creator | Party that created the case. | IsoAnyBICIdentifier - Required 1..1 |
ReopenCaseIndication | Set to yes if the case was closed and needs to be 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 %% CaseStatus recursion level 0 with max 1 class CaseStatus{ DateTime IsoISODateTime CaseStatus CaseStatus1Code InvestigationStatus InvestigationExecutionConfirmation1Code Reason IsoMax140Text }
CaseStatus members
Member name | Description | Data Type / Multiplicity |
---|---|---|
DateTime | Date and time of the status. | IsoISODateTime - Required 1..1 |
CaseStatus | Status of the case. | CaseStatus1Code - Required 1..1 |
InvestigationStatus | Status of the investigation. | InvestigationExecutionConfirmation1Code - Optional 0..1 |
Reason | Free text justification of the status. | IsoMax140Text - Optional 0..1 |
NewAssignment building block
Identifies the last assignment performed. Represents the assignment of a case to a party. Assignment is a step in the overall process of managing a case. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CaseAssignment recursion level 0 with max 1 class CaseAssignment{ Identification IsoMax35Text Assigner IsoAnyBICIdentifier Assignee IsoAnyBICIdentifier CreationDateTime IsoISODateTime }
CaseAssignment members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Identification of an assignment within a case. | IsoMax35Text - Required 1..1 |
Assigner | Party that assigns the case to another party. This is also the sender of the message. | IsoAnyBICIdentifier - Required 1..1 |
Assignee | Party that the case is assigned to. This is also the receiver of the message. | IsoAnyBICIdentifier - Required 1..1 |
CreationDateTime | Date and time at which the assignment was created. | IsoISODateTime - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the CaseStatusReport implementation follows a specific implementaiton pattern. First of all, CaseStatusReport impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CaseStatusReportDocument implements IOuterDocument. Because CaseStatusReport implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CaseStatusReport.
classDiagram class IOuterRecord CaseStatusReport --|> IOuterRecord : Implements CaseStatusReportDocument --|> IOuterDocument~CaseStatusReport~ : Implements class IOuterDocument~CaseStatusReport~ { CaseStatusReport Message }
Document wrapper for serialization
The only real purpose CaseStatusReportDocument serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.039.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CaseStatusReport.ToDocument() method. The returned CaseStatusReportDocument value will serialize correctly according to ISO 20022 standards.
classDiagram CaseStatusReportDocument *-- CaseStatusReport : 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.01">
<camt.039.001.01>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Case>
<!-- Case inner content -->
</Case>
<Sts>
<!-- Status inner content -->
</Sts>
<NewAssgnmt>
<!-- NewAssignment inner content -->
</NewAssgnmt>
</camt.039.001.01>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_N4ghGNE-Ed-BzquC8wXy7w_-876168840"
name="CaseStatusReport"
definition="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
- 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.)
- 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 Resolution Of Investigation (except for the condition given in the next bullet point) or Notification Of Case Assignment message
- may be skipped and replaced by a Resolution Of Investigation message if at the moment when the request for a investigation status arrives, the assignee has obtained a solution. (In this case a Resolution Of Investigation message can be sent in lieu of a Case Status Report and the case may be closed.)."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlName="camt.039.001.01"
xmlTag="camt.039.001.01"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_N4ghGdE-Ed-BzquC8wXy7w_1412424914"
name="Header"
definition="Specifies generic information about an investigation report."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_RI5fwNp-Ed-ak6NoX_4Aeg_24374172" />
<messageBuildingBlock
xmi:id="_N4ghGtE-Ed-BzquC8wXy7w_77721534"
name="Case"
definition="Identifies the case."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Case"
complexType="_SpAnotp-Ed-ak6NoX_4Aeg_136183535" />
<messageBuildingBlock
xmi:id="_N4ghG9E-Ed-BzquC8wXy7w_146061162"
name="Status"
definition="Defines the status of the case."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Sts"
complexType="_VJDih9p-Ed-ak6NoX_4Aeg_964129193" />
<messageBuildingBlock
xmi:id="_N4prANE-Ed-BzquC8wXy7w_158065612"
name="NewAssignment"
definition="Identifies the last assignment performed."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="NewAssgnmt"
complexType="_T9Dpetp-Ed-ak6NoX_4Aeg_588710247" />
<messageDefinitionIdentifier
businessArea="camt"
messageFunctionality="039"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.