Iso20022

OrderInstructionStatusReportV04

setr.016.001.04

Scope The OrderInstructionStatusReport message is sent by an executing party, for example, a transfer agent, to the instructing party, for example, an investment manager or its authorised representative, to report the status of an order from the time the executing party receives the order until the time the order is executed. Usage The OrderInstructionStatusReport message is used to report on the status of a subscription, redemption or a switch order. The OrderInstructionStatusReport message may be used to give the status of:

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
%% OrderInstructionStatusReportV04 recursion level 0 with max 0
OrderInstructionStatusReportV04 *-- "1..1" MessageIdentification1 : MessageIdentification
OrderInstructionStatusReportV04 *-- "0..1" IReferences61Choice : Reference
OrderInstructionStatusReportV04 *-- "1..1" IStatus24Choice : StatusReport
OrderInstructionStatusReportV04 *-- "0..1" Extension1 : Extension

Now, we will zero-in one-by-one on each of these building blocks.

MessageIdentification building block

Reference that uniquely identifies the message from a business application standpoint. Identifies a message by a unique identifier and the date and time when the message was created by the sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageIdentification1 recursion level 0 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}

MessageIdentification1 members

Member name Description Data Type / Multiplicity
Identification Identification of the message. IsoMax35Text - Required 1..1
CreationDateTime Date of creation of the message. IsoISODateTime - Required 1..1

Reference building block

Reference to the message or communication that was previously received. Choice of references used to reference a previous transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IReferences61Choice recursion level 0 with max 1

References61Choice members

Member name Description Data Type / Multiplicity

StatusReport building block

Status of the order. Choice of status. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IStatus24Choice recursion level 0 with max 1

Status24Choice members

Member name Description Data Type / Multiplicity

Extension 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
%% Extension1 recursion level 0 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}

Extension1 members

Member name Description Data Type / Multiplicity
PlaceAndName Name qualifying the information provided in the Text field, and place where this information should be inserted. IsoMax350Text - Required 1..1
Text Text of the extension. IsoMax350Text - Required 1..1

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the OrderInstructionStatusReportV04 implementation follows a specific implementaiton pattern. First of all, OrderInstructionStatusReportV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, OrderInstructionStatusReportV04Document implements IOuterDocument. Because OrderInstructionStatusReportV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type OrderInstructionStatusReportV04.

classDiagram
    class IOuterRecord
    OrderInstructionStatusReportV04 --|> IOuterRecord : Implements
    OrderInstructionStatusReportV04Document --|> IOuterDocument~OrderInstructionStatusReportV04~ : Implements
    class IOuterDocument~OrderInstructionStatusReportV04~ {
        OrderInstructionStatusReportV04 Message
     }

Document wrapper for serialization

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

classDiagram
    OrderInstructionStatusReportV04Document *-- OrderInstructionStatusReportV04 : 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:setr.016.001.04">
    <OrdrInstrStsRpt>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <Ref>
            <!-- Reference inner content -->
        </Ref>
        <StsRpt>
            <!-- StatusReport inner content -->
        </StsRpt>
        <Xtnsn>
            <!-- Extension inner content -->
        </Xtnsn>
    </OrdrInstrStsRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_Aab7JTbLEead9bDRE_1DAQ"
  previousVersion="_jk5cZdE7Ed-BzquC8wXy7w_-141988055"
  name="OrderInstructionStatusReportV04"
  definition="Scope&#xD;&#xA;The OrderInstructionStatusReport message is sent by an executing party, for example, a transfer agent, to the instructing party, for example, an investment manager or its authorised representative, to report the status of an order from the time the executing party receives the order until the time the order is executed.&#xD;&#xA;Usage&#xD;&#xA;The OrderInstructionStatusReport message is used to report on the status of a subscription, redemption or a switch order.&#xD;&#xA;The OrderInstructionStatusReport message may be used to give the status of:&#xD;&#xA;- one order message by using OrderDetailsReport or,&#xD;&#xA;- one or more individual order instructions by using IndividualOrderDetailsReport, or&#xD;&#xA;- one or more switch orders by using SwitchOrderDetailsReport.&#xD;&#xA;If the OrderInstructionStatusReport message is used to report the status of an individual order, then IndividualOrderDetailsReport is used and the order reference of the individual order is quoted in OrderReference. The message identification of the message in which the individual order was conveyed may also be quoted in RelatedReference but this is not recommended.&#xD;&#xA;If the OrderInstructionStatusReport message is used to report the status of a switch order, then SwitchOrderDetailsReport is used and the order reference of the switch order is quoted in OrderReference. The message identification of the message in which the switch order was conveyed may also be quoted in RelatedReference but this is not recommended.&#xD;&#xA;If the OrderInstructionStatusReport message is used to report the status of an entire order message, for example, the SubscriptionBulkOrder, or a SubscriptionOrder containing several orders, then OrderDetailsReport is used and the message identification of the order message is quoted in RelatedReference. All the orders within the message must have the same status.&#xD;&#xA;One of the following statuses can be reported:&#xD;&#xA;- an accepted status, or,&#xD;&#xA;- an already executed status, or,&#xD;&#xA;- a sent to next party status, or,&#xD;&#xA;- a received status, or,&#xD;&#xA;- a settled status, or,&#xD;&#xA;- a communication problem with next party status, or,&#xD;&#xA;- a confirmation amendment status, or,&#xD;&#xA;- a done for the day status, or,&#xD;&#xA;- a partially done status, or,&#xD;&#xA;- an open status, or,&#xD;&#xA;- a cancelled status, or&#xD;&#xA;- a conditionally accepted status, or,&#xD;&#xA;- a rejected status, or,&#xD;&#xA;- a suspended status, or,&#xD;&#xA;- a partially settled status, or,&#xD;&#xA;- an in-repair status (only for an individual or switch order).&#xD;&#xA;For a switch order, the OrderInstructionStatusReport message provides the status of the whole switch order, that is, it is not possible to accept one leg and to reject the other leg: the entire switch order has to be rejected. In order to identify the legs within the switch that are causing the problem, the leg is identified in either the RedemptionLegIdentification or SubscriptionLegIdentification elements.&#xD;&#xA;When the OrderInstructionStatusReport is used to give the status of an individual or a switch order, the following can be specified:&#xD;&#xA;- repaired conditions (for a switch, this is at the level of a leg),&#xD;&#xA;- information related to the order, for example, settlement amount, number of units, expected trade date."
  registrationStatus="Registered"
  messageSet="_hijK0WiLEeOuqdLlpUIWBw _qCumkAFwEeu2__1EbNXzuA"
  xmlTag="OrdrInstrStsRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_Aab7JzbLEead9bDRE_1DAQ"
    previousVersion="_jlDNadE7Ed-BzquC8wXy7w_514323009"
    name="MessageNameAndReferenceGuideline"
    definition="If Reference/RelatedReference/MessageName or Reference/OtherReference/MessageName is present, it must contain 502 or must start with setr.001, setr.004, setr.007, setr.010, setr.013, setr.019 or setr.018 and Reference/RelatedReference/Reference must contain the message reference of a message in this list."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_Aab7KTbLEead9bDRE_1DAQ"
    previousVersion="_jlDNbNE7Ed-BzquC8wXy7w_1903300086"
    name="OtherReferenceGuideline"
    definition="Reference/OtherReference should be used to reference an order instruction sent in a proprietary way or used for a system reference. If Reference/OtherReference is present, Reference/OtherReference/MessageName must contain 'fax' or 'phone' or 'email', etc."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_Aab7LzbLEead9bDRE_1DAQ"
    previousVersion="_jk5cZtE7Ed-BzquC8wXy7w_387710946"
    name="MessageIdentification"
    definition="Reference that uniquely identifies the message from a business application standpoint."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_aAGPoUHOEeazV4RAqPV71g"
    name="Reference"
    definition="Reference to the message or communication that was previously received."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="Ref"
    complexType="_kTej8UHOEeazV4RAqPV71g" />
  <messageBuildingBlock
    xmi:id="_iBEnAEHPEeazV4RAqPV71g"
    name="StatusReport"
    definition="Status of the order."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="StsRpt"
    complexType="_N37HcEHPEeazV4RAqPV71g" />
  <messageBuildingBlock
    xmi:id="_Aab7OzbLEead9bDRE_1DAQ"
    previousVersion="_jlDNYtE7Ed-BzquC8wXy7w_1340149318"
    name="Extension"
    definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="Xtnsn"
    complexType="_Q6vvCNp-Ed-ak6NoX_4Aeg_1503007069" />
  <messageDefinitionIdentifier
    businessArea="setr"
    messageFunctionality="016"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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