5.1.1 CDMH — Header Record for Claim Detail Messages and Claim Detail Discrepancy Notifications

This is the Header Record for the Claim Detail Messages and Claim Detail Discrepancy Notifications created in accordance with this standard. Each file containing a Claim Detail Message or Claim Detail Discrepancy Notification shall have exactly one such Header Record. It shall be the first Record in each file.

Cell Name  

Field Definition

Data Type

M/O/C?[1]

Example

1

RecordType

 

The Type of the Record; always to contain “CDMH”.

Fixed string

M

CDMH

2

MessageVersion

The Version of the Message. This shall be in the form CDM/xxx/yyy/zzz with: 

  • xxx being the version number of the referenced Part 1 (Architecture) of the Claim Detail Message Suite Standard;

  • yyy being the version number of the referenced Part 2 (Allowed Value Sets) of the Digital Sales Report Message Suite Standard; and

  • zzz being the version number of the referenced Part 2 (Record Type Definitions) of the Claim Detail Message Suite Standard.

CDM/1.1.2/5.0/1.0 would therefore signal that the Claim Detail Message or Claim Detail Discrepancy Notification was created in accordance with the Architecture in version 1.1.2 of the Claim Detail Message Suite Standard, with the allowed values from version 5.0 of Part 2 of the Digital Sales Report Message Suite Standard and with the Record Type Definitions provided in version 1.0 of the Claim Detail Message Suite Standard.

Fixed string

M

CDM/1.2/5.0/4.2

3

MessageId

A string used to uniquely identify the Message. The MessageId shall be, in combination with the Message Sender's Id, globally unique. Thus, a Message Sender shall never re-use a MessageId.

String

M

1234567890

4

MessageCreatedDateTime

The date and time on which the Message was created. The only allowed format is ISO 8601:2004: YYYY-MM-DDThh:mm:ssTZD.

ISO datetime

M

2014-12-14T10:05:00Z

5

Profile

The Identifier of the Profile used for the Message in accordance with the relevant Profile of the Claim Detail Message Suite Standard.

For Claim Detail Messages and Corrections to Claim Detail Message the value for this Cell is defined in the relevant Profile.

For retractions, this Cell shall contain the string CDMRetraction.

String

M

BasicCDMPostUsage

6

ProfileVersion

The Identifier of the Version of the Profile used for the Message in accordance with the relevant Profile of the Claim Detail Message Suite Standard.

String

M

1.0

7

RelatedCDM

 

The MessageId of the Claim Detail Message that is retracted by this message or for which discrepancies are reported.

This Cell must be provided if a message is either a retraction to a previous Claim Detail Message or if the message at hand is a Discrepancy Notification.

String

 

C

1234567890

8

SalesReportId  

The MessageId of the DSR (or equivalent) Message that the Claim Detail Message or Claim Detail Discrepancy Notification is in respect of.

The SalesReportId shall be provided when the sales/usage report the Claim Detail Message or Claim Detail Discrepancy Notification is in respect of response to carries a message identifier (e.g. DDEX DSR). In that case, this Cell shall contain the MessageId of that DSR (or equivalent) Message.

In the case of a pre-usage choreography, this Cell may contain the Message ID of a message formatted in accordance with the Part 10 of the Digital Sales Reporting Message Suite Standard, i.e the Masterlist Profile, to which the Claim Detail Message or claim Detail Discrepancy Notification is in respect of.

String

C

0987654321

9

StartDate

The StartDate of the reporting Period covered by the Message (in ISO 8601:2004 format).

In most cases, this Cell shall contain the UsageStartDate from the DSR (or equivalent) Message that the Claim Detail Message is in response to.

This is a string with the syntax YYYY[-MM[-DD]].

ISO date

C

2014-12-01

10

EndDate

The EndDate of the reporting Period covered by the Message (in ISO 8601:2004 format).

In most cases, this Cell shall contain the UsageEndDatefrom the DSR (or equivalent) Message that the Claim Detail Message is in response to.

This is a string with the syntax YYYY[-MM[-DD]].

ISO date

C

2014-12-01

11

SenderPartyId

The DDEX PartyId (DPID) of the Message Sender.

DDEX Party ID

M

PADPIDA2008120501W

12

SenderName

The Full Name of the Message Sender.

String

M

GEMA

13

ServiceDescription

The service name (e.g. a service tier) that the Claim Detail Message or Claim Detail Discrepancy Notificationrelates to. The ServiceDescription may not contain space characters or underscores.

The ServiceDescription is intended to be a human-readable expression of the totality of the services the Claim Detail Message or Claim Detail Discrepancy Notification is in respect of. Where the Claim Detail Message or Claim Detail Discrepancy Notification is in respect of a DSR (or equivalent) Message that contained sales/usage data covering one sales context this should be the same as the string used in the file name and in the single Summary Record contained in the DSR (or equivalent) Message.

For Claim Detail Message or Claim Detail Discrepancy Notification covering multiple sale contexts, the ServiceDescription in the Header should be the same as on the file name and represent a human-readable summary of the sales contexts provided in the Summary Records.

In most cases, this Cell shall contain the ServiceDescription from the DSR (or equivalent) Message that the Claim Detail Message is in response to.

String

C

PremiumService

14

RecipientPartyId

The DDEX PartyId (DPID) of the Message Recipient. This element is mandatory when the Claim Detail Message or Claim Detail Discrepancy Notification is sent to one Message Recipient.

In most cases, this Cell shall contain the SenderPartyId from the DSR (or equivalent) Message that the Claim Detail Message is in response to.

DDEX Party ID

O

PADPIDA2007081601G

15

RecipientName

The Full Name of the Message Recipient. This element is mandatory when the Claim Detail Message or Claim Detail Discrepancy Notification is sent to one MessageRecipient.

In most cases, this Cell shall contain the SenderNamefrom the DSR (or equivalent) Message that the Claim Detail Message is in response to.

String

O

YouTube

16

ClaimingRound

The cardinal number of the claiming round.

ClaimingRound needs to be provided when Licensee and Licensor have agreed that claims are provided in multiple "rounds".

Integer

C

1


[1] Mandatory – Optional – Conditional