Harmonization: Add ManifestItem class to Transmission

Editing of harmonisation proposals prior to a harmonization meeting is restricted to the proposal submitter and the co-chairs of the steward comittee. Other changes will be undone. Please add comments to the "discussion" page associated with this proposal.

Recommendation for HL7 RIM Change	RECOMMENDATION ID:
Submitted by: INM	Revision (# and date): 20060303
Date submitted:	Committee status: neither Discussed nor Approved
Submitted by: Rene Spronk
NAME: Add ManifestItem class to Batch

Stewards Position

REQUIRED - This table should contain one row for each Steward Committee affected by the recommendation.

TC	RECOMMENDATION APPROVAL STATUS	AFFECTED ENTITIES OF INTEREST TO TC (responsibility level: S=Steward; I=Interested)
INM	Under review	S

(Penny Aitchison, 20060303) [This proposal] covers the NHS requirements.

Issue

The English NHS has defined a requirement to add a ManifestItem class for each Message contained in a Batch: a structure for carrying a set of values relating to a specific payload item (mostly: a message). Typically this class will be repeated for each payload instance in the batch.

Example values conveyed in the ManifestItem class: Artefact Id (Message.interactionId), Patient Id.

The ManifestItem class allows the receiver of a batch to quickly determine how to process the contents of that batch (e.g. how to split the batch and route the messages contained in it to various internal processes).

Recommendation(s)

• Add a new (blue) RIM class ManifestItem, with the following description: "Contains information about one single payload item contained within the Batch Transmission. The contents of the class shall be solely used for logistical processing related purposes (e.g. internal routing, processing order) and not have any impact on the semantic interpretation of the contents of the Batch Transmission. A Batch Transmission may contain a ManifestItem class for a subset of payload items, or none at all. The usage of the ManifestItem class is subject to site specific agreement."

• Add the following attributes to the ManifestItem class:
  • payloadId II [1..1] (mandatory attribute) - Description: "The identification of the Batch payload item being described by this ManifestItem, e.g. Message.id or Batch.id"
  • payloadSequenceNumber INT [0..1] - Description: "The position/index of payload item (e.g. Message) being described by this ManifestItem within the Batch. Within a Batch Transmission the first payload item shall have an index equal to 1."
  • manifestItemKey CV CWE [0..1] <=ManifestItemType - Description: "manifestItemKey and manifestItemValue are used to convey charateristics of the payload item identified by payloadId (and payloadSequenceNumber)."
  • manifestItemValue attribute ANY [0..*] - Description: "manifestItemKey and manifestItemValue are used to convey characteristics of the payload item identified by payloadId (and payloadSequenceNumber). If the manifestItemValue attribute has a value the manifestItemKey attribute must also have a value."

• Create a new ManifestItemType vocabulary with the following predefined concepts:
  • InteractionID of the payload item (or re-use existing OID for this concept: ...1.6)

Rationale

1. The current RIM classes don't support sending this information.
2. The AttentionLine class (see related Harmonization proposal entitled Harmonization: Description of AttentionLine contains information that applies to a Batch as a whole, whereas a ManifestItem contains information about one of the payload items contained in the Batch.

Recommended Action Items

• Implement the proposed solution