Send Response Batch Wrapper - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
MCCI_IN200002UK03
BatchResponse

The Send Response Batch wrapper forms the outer wrapper for a batch of response or application acknowledgement message interactions.
Used by:
[1..1] id (II)

A unique identifier for this acknowledgement or response batch.

The Identifier Global datatype flavour is used to carry this information as follows:

  • A DCE UUID is held in the root attribute
[1..1] creationTime (TS)

The date and time that the sending system created the batch message.
[1..1] transmissionQuantity (INT)

A count of individual message interactions contained within this batch message.
[1..1] versionCode (CS {CNE:HL7StandardVersionCode } )

A code which identifies the version of the NPfIT Message Implementation Manual that describes the HL7 version 3 standard used to format the batch message.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in theHL7StandardVersionCode vocabulary.
[1..1] interactionId (II)

The fixed value interaction identifier that identifies a Send Response Batch interchange.

The Identifier External datatype flavour is used to carry this information as follows:

  • The root attribute shall contain an OID with the value 2.16.840.1.113883.2.1.3.2.4.12
  • The extension attribute shall contain the value "MCCI_IN200002UKnn" where nn is the latest version number.
[1..1] communicationFunctionRcv (CommunicationFunctionRcv)

Identifying information about the system receiving the batch message.
[1..1] communicationFunctionSnd (CommunicationFunctionSnd)

Identifying information about the system sending the batch message.
[0..*] manifestItem (ManifestItem)
A class which will occur once for each message interaction that is present in the batch response.
[0..1] batchSequenceNo (BatchSequenceNo)

A class carrying the sequence number of the batch message within the sequence of batch messages relating to a single business process.
[1..*] acknowledgement (Acknowledgement)

Details about the type of acknowledgement and the batch message being acknowledged.

[0..1] batchControlActEvent (BatchControlActEvent)
A batch Control Act.
CommunicationFunctionRcv

Details about the receiving system.
Used by: BatchResponse,
[1..1] typeCode (CS {CNE:RCV } ) { Fixed="RCV " }

Indicates that the communication function being served is the receiver.

  • Fixed value "RCV".
[1..1] device (Device)

Identifying information about the receiving device.
CommunicationFunctionSnd

Details about the sending system.
Used by: BatchResponse,
[1..1] typeCode (CS {CNE:SND } ) { Fixed="SND " }

Indicates that the communication function being served is the sender.

  • Fixed value "SND".
[1..1] device (Device)

Identifying information about the sending device.
Device

The Device class represents the sender and receiver.
Used by: CommunicationFunctionRcv,CommunicationFunctionSnd,
[1..1] classCode (CS {CNE:DEV } ) { Fixed="DEV " }

Indicates that the entity is a device.

  • Fixed value "DEV".
[1..1] determinerCode (CS {CNE:INSTANCE } ) { Fixed="INSTANCE " }

Indicates that the entity is a single instance.

  • Fixed value "INSTANCE".
[1..*] id (SET<II>)

A single unique identifier of the accredited system that represents the party who is either sending or receiving the batch message.

The accredited system is represented by the SDS Accredited Application Instance Id held in the SDS directory as the Accredited System Identifier. This is carried in the following way:

  • The root attribute shall contain an OID with the value 1.2.826.0.1285.0.2.0.107
  • the extension attribute shall contain the appropriate identifier.

A set of ids allows more than one address identifying the party to be present. This requirement does not exist at present but may be identified in the future.
[0..1] agencyFor (Agent)

An agent role linking device and organisation.
Acknowledgement

Details about the batch message being acknowledged.

NB. The batch acknowledgement reflects the action taken by the receiving system on the whole batch. In the case where there is not a one to one relationship between the Send and Response batches, eg, many response interactions to one request, the same acknowledgement detail will be repeated on every batch response.

Used by: BatchResponse,
[1..1] typeCode (CS {CNE:AcknowledgementType } )

A code identifying the action that has been taken by the receiving system on the batch message being acknowledged. The code is related only to the batch process and does not reflect processing of the individual interactions.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the Acknowledgement Type vocabulary.

If the receiving system processes the whole batch message successfully this code shall contain the value "AA" - Application Acknowledgement Accept. This accept code is related only to the batch message process, not to the processing of individual interactions.

If the receiving system identifies a batch level business issue or error this code shall contain "AE" - Application Acknowledgement Error. This error code relates only to the batch process and not to the processing of individual interactions.

If the receiving system fails to process the whole batch message for reasons relating to the delivery of the batch message or it's structure, this code shall contain "AR" - Application Acknowledgement Reject and the error shall be reported in AcknowledgementDetail.code.
[0..*] acknowledgementDetail (AcknowledgementDetail)

Error detail information pertaining to the batch message being acknowledged.
[1..1] targetBatch (TargetBatch)

Identifying information about the batch message being acknowledged.
TargetBatch

The reference to the specific batch that is being acknowledged.
Used by: Acknowledgement,
[1..1] id (II)

The unique identifier of the batch that is being acknowledged. This is the identifier from the Batch.id attribute of the batch message being acknowledged.

The Identifier Global datatype flavour is used to carry this information as follows:

  • A UUID is held in the root attribute
AcknowledgementDetail

Additional detail about a batch message that has been processed by the receiving system and the messaging error that has been identified. A messaging error is related to the communication and delivery of the batch message or it's structure.

This information shall only be present when Acknowledgement.typeCode = "AR".
Used by: Acknowledgement,
[1..1] typeCode (CS {CNE:AcknowledgementDetailType } )

A code identifying the severity of the messaging problem that has been identified.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the AcknowledgementDetailType vocabulary.
[1..1] code (CV {CNE:AcknowledgementExceptionCode } )

A code identifying the specific problem being reported.

Any of the CodedValue datatype flavours can be used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the AcknowledgementExceptionCode vocabulary.
  • The codeSystem attribute shall contain the appropriate OID.
  • The displayName attribute is optional and may contain the textual description of the code.
Agent

An agent linking device and organisation.
Used by: Device,
[1..1] classCode (CS {CNE:AGNT } ) { Fixed="AGNT " }

Indicates that the role is that of an agent.

  • Fixed value "AGNT".
[0..1] representedOrganization (Organization) Identifying information about the organisation.
Organization

The organisation of the sender or receiver of the batch message.

N.B. Domain specific guidance will be given describing the population of this construct in a future MIM.
Used by: Agent,
[1..1] classCode (CS {CNE:ENT } ) { Fixed="ENT " }

Indicates that this is an organisation.

  • Fixed value "ENT".
[1..1] determinerCode (CS {CNE:INSTANCE } ) { Fixed="INSTANCE " }

Indicates that the entity is a single instance.

  • Fixed value "INSTANCE".
[1..1] id (II)

An SDS identifier that uniquely identifies the organisation of the intended recipient. This is carried in the following way:

  • The root attribute shall contain an OID with the value 1.2.826.0.1285.0.1.10
  • the extension attribute shall contain the SDS Organisation ID
[1..1] scopedRole1      [CMET: UKCT_MT120301UK02]

NPfIT CMET identifying an Organization fulfilling a specific role. Full details of the organization are available from SDS. Details of the scoping organization are either not required or available from SDS.

In this context the optional CMET identifies an SDS workgroup id as the recipient of the message. The only attribute that may be populated in this context is UKCT_MT120501UK03.OrganizationSDS.id as follows:

  • The root attribute shall contain an OID with the value 1.2.826.0.1285.0.2.0.109
  • The extension attribute shall contain the SDS workgroup id.
[1..1] scopedRole2      [CMET: UKCT_MT120501UK03]

NPfIT CMET identifying a person fulfilling a specific role. Full details of the person and role profile are available from SDS.

In this context the person is the named intended recipient of the message who shall be identified by an SDS Role Profile Id and an SDS User Id.

ManifestItem
A class carrying a set of values relating to a specific message interaction present in the batch response message. Typically this class will be repeated for each message interaction.
Used by: BatchResponse,
[1..1] payloadId (II)
The unique identifier for a specific message interaction contained within the batch response.

The Identifier Global datatype flavour is used to carry this information as follows:
  • A DCE UUID is held in the root attribute
[2..2] manifestValue (ManifestValue)
The set of values relating to this message interaction.
BatchSequenceNo

A parameter carrying a batch sequence number attribute.

The batch sequence number (BSN) is managed by the sender of a batch message.

The BSN is a mechanism for describing the order in which batch messages (either request or response) are sent. This mechanism is used where a business process at the sender generates multiple batch requests or responses.

BSNs must be unique within a concatenation of the ebXML ConversationId and the Accredited System Identifier carried in BatchRequest.communicationFunctionSnd.device.id. This allows both the sender of the request and the sender of the response to manage sequencing independently.

The BSN will allow the receiver to physically order the in-going interactions for further processing; thus preserving message order. Message ordering is not mandatory behaviour it is the responsibility of the receiver to determine whether it is required.

The BSN can assist the receiver in determining missing batch messages within a sequence. A missing batch message is determined at the receiver by analysing BSNs, and looking for gaps. However, the BSN does not aid the receiver in identifying a lost last Send Batch message. Hence, it is the responsibility of the sender to determine that batch requests have gone missing and have not been processed by the receiver. Application specific behaviour is required to recover from a missing interaction.

Due to the behavioural characteristics of batching, the responses to the individual messages in a request batch interaction can be sent in more than one response interaction. For correlation purposes, the BSN of the batch request interaction is provided in the batch response in an AttentionLine item for an individual message response.
Used by: BatchResponse,
[1..1] value (II)

The batch sequence number will be carried in an identifier using the IdentifierExternal datatype flavour as follows:

  • The root attribute shall contain an OID with the value 2.16.840.1.113883.2.1.3.2.4.18.10
  • The extension attribute shall carry the sequence number

The sequence number shall start at 0 for the first send batch message in a related sequence of batch messages and increment by 1 for each subsequent batch message. The maximum number is 99999999. If the maximum is reached, the sender must re-start at 0.

BatchControlActEvent
A batch Control Act which is mandatory and occurs once within each batch. It allows those participations that are common to all interactions in a batch, author and author1, to be carried once only.
Used by: BatchResponse,
[1..1] classCode (CS {CNE:CACT } ) { Fixed="CACT " }
  • Fixed value "CACT".
[1..1] moodCode (CS {CNE:EVN } ) { Fixed="EVN " }
  • Fixed value "EVN".
[1..2] author1

A participation referring to one or more systems that are involved in the initiation of the batch message.

One instance of the participation is mandatory and shall carry the accredited service id of the system in use at the time the batch message is initiated.

One instance of the participation is optional and may carry the workstation id of the system being used by the logged in user at the time the batch message is initiated.
[1..1] typeCode (CS {CNE:AUT } ) { Fixed="AUT " }

Indicates that the role has author responsibility.

  • Fixed value "AUT".
[1..1] agent      [CMET: UKCT_MT121001UK01]

NPfIT CMET to identify a mandatory system which could be software or hardware. Full details of the system are available from SDS.

In this context the system is a system in use at the time the message is initiated. This shall be represented by either the SDS Accredited Application Instance Id held in the SDS directory as the Accredited System Identifier or a locally identified workstation id.
[0..1] author

A participation referring to a person who is logged in at the time the message is initiated.

The participation is optional. It shall be present when the message is initiated by a person. It shall not be present when the message is automaticallyinitiated by a system.
[1..1] typeCode (CS {CNE:AUT } ) { Fixed="AUT " }

Indicates that the role has author responsibility.

  • Fixed value "AUT".
[1..1] agent      [CMET: UKCT_MT120901UK01]

NPfIT CMET to identify a person fulfilling a specific role where the Person, Role Profile and JobRole are all mandatory. Full details of the person, role profile and job role are available from SDS.

In this context the person is the signed in user for the user session responsible for initiating the message. The person shall be identified by SDS Role Profile ID, SDS User Id and SDS Role Id.
[1..*] message (Message)
A link to one or more message interactions contained within the batch.
ManifestValue
A set of unique identifiers relating to a single message interaction contained in the batch.

In this instance the batch response mandates the inclusion of two unique identifiers per message interaction:

  •  interaction identifier
  • batch sequence number
Used by: ManifestItem,
[1..1] manifestItemKey (CV {CNE:ManifestItemType})

A keyword identifying the type of identifier.

Any of the CodedValue datatype flavours can be used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the ManifestItemType vocabulary.

There shall be two fixed keyword values available in this instance:

  1. "interaction"
  2. "batchSeqNo"
[1..1] manifestItemValue (II)
The value pertaining to the keyword carried in manifestItemKey.

Where the keyword is "interaction", the value shall be the interaction identifier of the interaction identified by payloadId.

The Identifier External datatype flavour is used to carry this information as follows:

  • The root attribute shall contain an OID with the value 2.16.840.1.113883.2.1.3.2.4.12
  • The extension attribute shall carry the interaction identifier

Where the keyword is "batchSeqNo", the value shall be the batch sequence number of the interaction identified by payloadId.

The batch sequence number identifier is obtained from the batch wrapper BatchSequenceNo.value of the batch message carrying the interaction to which this response message interaction is responding. It will be carried in an identifier using the Identifier External datatype flavour as follows:

  • The root attribute shall contain an OID with the value 2.16.840.1.113883.2.1.3.2.4.18.10
  • The extension attribute shall carry the sequence number.
Message
The entry point into each interaction within the batch.

See BatchControlActItemRespond
Used by: BatchControlActEvent,