| MCCI_HD200101UV Response Batch Wrapper |
(Link to Excel View) Derived from RMIM: MCCI_RM200101UV |
||||||||
| Batch |
Design Comments: The key transactional information for a batch - a message that is a collection of HL7 V3 messages. |
||||||||
| id [1..1] (M) Batch (II) |
Design Comments: An identifier for the batch. |
||||||||
| creationTime [1..1] (M) Batch (TS) |
Design Comments: The point in time at which the bath was created by the sending party. |
||||||||
| securityText [0..1] Batch (ST.SIMPLE) |
Design Comments: A value that supports the implementation ofsecurity features for a transmission. |
||||||||
| responseModeCode [1..1] (M) Batch (CS) {CNE:V:ResponseMode} |
Design Comments: A coded indication of the responsibility of the receiver with regard to sending a response to the batch. E.g., the receiver is required to send an immediate response. |
||||||||
| versionCode [0..1] Batch (CS) {CNE:V:HL7StandardVersionCode} |
Design Comments: An identifier of the transmission version. It indicates the relevant version of the HL7 standard. |
||||||||
| interactionId [1..1] (M) Batch (II) |
Design Comments: The identifier of the V3 interaction that constrains the transmission. |
||||||||
| referenceControlId [0..1] Batch (II) |
Design Comments: An identifier assigned to the batch by the party creating the batch. |
||||||||
| name [0..1] Batch (SC.NT) {CWE:D:BatchName} |
Design Comments: A text identifier for the batch, to be used by the application processing the batch. |
||||||||
| batchComment [0..*] Batch (DSET<ST>) |
Design Comments: Text comments related to the batch. |
||||||||
| transmissionQuantity [0..1] Batch (INT.NONNEG) |
Design Comments: The count of individual transmissions contained within the batch, including nested batches. |
||||||||
| batchTotalNumber [0..*] Batch (DSET<INT.NONNEG>) |
Design Comments: The total number of messages in the batch. |
||||||||
| receiver [1..1] (Receiver) |
Design Comments: An indication that the related device is expected to undertake the function of receiving the batch. |
||||||||
| respondTo [0..*] (RespondTo) |
Design Comments: An indication that the related device is expected to undertake the function of responding to the batch. |
||||||||
| sender [1..1] (Sender) |
Design Comments: An indication that the related device has undertaken the function of sending the batch. |
||||||||
| attentionLine [0..*] (AttentionLine) |
Design Comments: A collection of parameters related to a transmission that may need to be accessible from the transmission wrapper. AttentionLine is a name-value pair, with keyWordText providing the topic from an enumerated set and value providing the parameter. |
||||||||
| acknowledgement [1..1] (Acknowledgement) |
Design Comments: Metadata necessary when acknowledging a message. |
||||||||
| message [0..*] (Message) |
Design Comments: A stub class that, in an instance, will be replaced by the interaction or interactions contained within the batch. UsageNotes: This is a so-called Stub which links the Batch class to the Message class. In instancesthis stub will be replaced by instances of the Message class. |
||||||||
| Receiver |
Design Comments: An indication that the related device is expected to undertake the function of receiving the batch. |
||||||||
| typeCode [1..1] (M) CommunicationFunction (CS) {CNE:C:CommunicationFunctionType:RCV, fixed value= "RCV"} |
Design Comments: The type code value, RCV, indicates the related device is the receiver of the batch. |
||||||||
| telecom [0..1] CommunicationFunction (TEL) |
Design Comments: A telecommunications address used by the receiving device. |
||||||||
| device [1..1] (Device) |
Design Comments: nformation for the device - item of equipment - that is employed in sending, receiving, or responding to the message. |
||||||||
| Device |
Design Comments: nformation for the device - item of equipment - that is employed in sending, receiving, or responding to the message. |
||||||||
| classCode [1..1] (M) Device (CS) {CNE:V:EntityClassDevice, root= "DEV"} |
Design Comments: The class code value, DEV, indicates that the entity in question is a device. |
||||||||
| determinerCode [1..1] (M) Device (CS) {CNE:V:EntityDeterminerSpecific, root= "INSTANCE"} |
Design Comments: The determiner code value, INSTANCE, indicates that a particular device instance is being referred to. |
||||||||
| id [1..*] (M) Device (DSET<II>) |
Design Comments: An identifier for the device. |
||||||||
| name [0..*] Device (COLL<EN>) |
Design Comments: A text name used to describe the device. |
||||||||
| desc [0..1] Device (ED) |
Design Comments: A text description of the device. |
||||||||
| existenceTime [0..1] Device (IVL<TS>) |
Design Comments: An indication of the point in time at which the device was manufactured. |
||||||||
| telecom [0..*] Device (COLL<TEL>) |
Design Comments: A telecommunications address used to contact the device. |
||||||||
| manufacturerModelName [0..1] Device (SC) {CWE:D:ManufacturerModelName} |
Design Comments: The name for the device type that has been assigned by the manufacturer. |
||||||||
| softwareName [0..1] Device (SC) {CWE:D:SoftwareName} |
Design Comments: The version and release of the software that operates the device as assigned by the manufacturer or software developer. |
||||||||
| asAgent [0..1] (Agent) |
Design Comments: A way of associating a device with the organization for which it acts as an agent. |
||||||||
| asLocatedEntity [0..1] (LocatedEntity) |
Design Comments: A way of associating a device with the place at which it is located. |
||||||||
| Agent |
Design Comments: A way of associating a device with the organization for which it acts as an agent. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassAgent, root= "AGNT"} |
Design Comments: The class code value, AGNT, indicates that the scoping entity is the organization that manages the device. |
||||||||
| representedOrganization [0..1] (Organization) |
Design Comments: An organization that is involved in the sending and/or receiving of the batch or of information related to it. |
||||||||
| Organization |
Design Comments: An organization that is involved in the sending and/or receiving of the batch or of information related to it. |
||||||||
| classCode [1..1] (M) Organization (CS) {CNE:V:EntityClassOrganization, root= "ORG"} |
Design Comments: The class code value, ORG, indicates that the entity is an organization. |
||||||||
| determinerCode [1..1] (M) Organization (CS) {CNE:V:EntityDeterminerSpecific, root= "INSTANCE"} |
Design Comments: The determiner code value, INSTANCE, indicates that a particular organization instance is being referred to. |
||||||||
| id [1..*] (M) Organization (DSET<II>) |
Design Comments: An identifier for the organization. |
||||||||
| name [0..*] Organization (COLL<EN>) |
Design Comments: A text name for the organization. |
||||||||
| telecom [0..*] Organization (COLL<TEL>) |
Design Comments: One or more telecommunication addresses for the organization. Note, this includes phone numbers, fax numbers, and email addresses. |
||||||||
| notificationParty [0..1] (R_NotificationPartyContact) | |||||||||
| LocatedEntity |
Design Comments: A way of associating a device with the place at which it is located. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassLocatedEntity, root= "LOCE"} |
Design Comments: The class code value, LOCE, indicates that the scoping entity is the place at which the device is located. |
||||||||
| location [0..1] (Place) |
Design Comments: Information about the location at which a device is located. |
||||||||
| Place |
Design Comments: Information about the location at which a device is located. |
||||||||
| classCode [1..1] (M) Place (CS) {CNE:V:EntityClassPlace, root= "PLC"} |
Design Comments: The class code value, PLC, indicates the entity is a place. |
||||||||
| determinerCode [1..1] (M) Place (CS) {CNE:V:EntityDeterminerSpecific, root= "INSTANCE"} |
Design Comments: The determiner code value, INSTANCE, indicates that a particular place instance is being referred to. |
||||||||
| id [1..*] (M) Place (DSET<II>) |
Design Comments: An identifier for the place. |
||||||||
| name [0..*] Place (COLL<EN>) |
Design Comments: A text name for the place. |
||||||||
| telecom [0..*] Place (COLL<TEL>) |
Design Comments: One or more telecommunication addresses for the place. Note, this includes phone numbers, fax numbers, and email addresses. |
||||||||
| RespondTo |
Design Comments: An indication that the related device is expected to undertake the function of responding to the batch. |
||||||||
| typeCode [1..1] (M) CommunicationFunction (CS) {CNE:C:CommunicationFunctionType:RSP, fixed value= "RSP"} |
Design Comments: The type code value, RSP, indicates the related device is the expected to receive responses related to the batch. |
||||||||
| telecom [0..1] CommunicationFunction (TEL) |
Design Comments: A telecommunications address used by the respond to device. |
||||||||
| device [1..1] (Device) | |||||||||
| Sender |
Design Comments: An indication that the related device has undertaken the function of sending the batch. |
||||||||
| typeCode [1..1] (M) CommunicationFunction (CS) {CNE:C:CommunicationFunctionType:SND, fixed value= "SND"} |
Design Comments: The type code value, SND, indicates the related device is the sender of the batch. |
||||||||
| telecom [0..1] CommunicationFunction (TEL) |
Design Comments: A telecommunications address used by the sending device. |
||||||||
| device [1..1] (Device) | |||||||||
| AttentionLine |
Design Comments: A collection of parameters related to a transmission that may need to be accessible from the transmission wrapper. AttentionLine is a name-value pair, with keyWordText providing the topic from an enumerated set and value providing the parameter. |
||||||||
| keyWordText [1..1] (M) AttentionLine (SC.NT) {CWE:D:AttentionKeyword} |
Design Comments: A category of attentionLine parameter. |
||||||||
| value [0..1] AttentionLine (ANY) {CWE:D:AttentionLineValue} |
Design Comments: A value associated with the key as provided in the AttentionLine.keyWordText attribute. |
||||||||
| Acknowledgement |
Design Comments: Metadata necessary when acknowledging a message. |
||||||||
| typeCode [1..1] (M) Acknowledgement (CS) {CNE:V:AcknowledgementType} |
Design Comments: The acknowledgement as defined in an enumerated set of acknowledgement types. E.g., the receiving application successfully processed message; the receiving application found error(s) in message |
||||||||
| expectedSequenceNumber [0..1] Acknowledgement (INT.POS) |
Design Comments: The sequence number of the message within a set of messages. |
||||||||
| messageWaitingNumber [0..1] Acknowledgement (INT.NONNEG) |
Design Comments: The number of messages the acknowledging application has waiting in queue for the receiving application. |
||||||||
| messageWaitingPriorityCode [0..1] Acknowledgement (CD) {CWE:D:MessageWaitingPriority} |
Design Comments: The highest level of importance in the set of messages the acknowledging application has waiting in queue for the receiving application. |
||||||||
| targetBatch [1..1] (TargetBatch) |
Design Comments: Information about the batch transmission that this batch is a response to (acknowledgement of). UsageNotes: This is the Ack’ed batch. This is a clone of the TargetTransmission class as shown in the D-MIM. |
||||||||
| acknowledgementDetail [0..*] (AcknowledgementDetail) |
Design Comments: Information about the communication, parsing or formal (non-business-rule) validation of the message being acknowledged. UsageNotes: Describes the error contained in the target batch. |
||||||||
| TargetBatch |
Design Comments: Information about the batch transmission that this batch is a response to (acknowledgement of). UsageNotes: This is the Ack’ed batch. This is a clone of the TargetTransmission class as shown in the D-MIM. |
||||||||
| id [1..1] (M) Transmission (II) |
Design Comments: An identifier for the batch. |
||||||||
| AcknowledgementDetail |
Design Comments: Information about the communication, parsing or formal (non-business-rule) validation of the message being acknowledged. UsageNotes: Describes the error contained in the target batch. |
||||||||
| typeCode [1..1] AcknowledgementDetail (CS) {CNE:V:AcknowledgementDetailType} |
Design Comments: The kind of information specified in the acknowledgement. |
||||||||
| code [0..1] AcknowledgementDetail (CD) {CWE:D:AcknowledgementDetailCode} |
Design Comments: The type of acknowledgement, from an enumerated set of acknowledgement types. |
||||||||
| text [0..1] AcknowledgementDetail (ED) |
Design Comments: Additional diagnostic information relevant to the message. |
||||||||
| location [0..*] AcknowledgementDetail (DSET<ST>) |
Design Comments: The position within the message being acknowledged that is related to the acknowledgement message. |
||||||||
| Message |
Design Comments: A stub class that, in an instance, will be replaced by the interaction or interactions contained within the batch. UsageNotes: This is a so-called Stub which links the Batch class to the Message class. In instancesthis stub will be replaced by instances of the Message class. |
||||||||