TEMPLATE |
The following table identifies the most common types of data elements in the IMO Data Set and provides a template for new data elements, including name, definition and recommended format. |
Template for common types of data elements |
Indicator |
end the name with "indicator" |
start definition with ‘A "yes/no" indicator whether’ |
n1 |
Name |
end the name with "name" |
start definition with "The name of" |
an..70
an..256
an..512
|
Description |
end the name with "description" |
start definition with "A description of " |
an..256
an..512
|
Sequence Number |
end the name with "sequence number" |
start definition with "A sequence number indicating" |
n..5 |
Quantity |
end the name with "quantity" or "number" |
start definition with "The quantity of" "The count of" or "The number of" |
n..8 |
Measure |
end the name with "[measure type] e.g. volume, weight, etc." |
start definition with "The [measure type e.g. volume, weight] of " |
n..16,6 |
Code |
End the name with ",coded " |
start definition with "A code representing …" |
an..3
an..17
|
Identifier |
End the name with "identifier " |
start definition with "The identifier [of, for, etc.] … " |
an..17
an..35
|
Date Time |
End the name with "[start/end] date time" |
The date and time [of, for, etc.] … |
an..35 |
Date |
End the name with "[start/end] date" |
The [start/end] date [of, for, etc.] … |
an..10
an..35
|
Binary Object |
end the name with"[ object type] e.g. picture, graphic, etc." |
Start definition with "The [object type e.g. picture, graphic, sound, video] of " |
Binary object |
Use of codes and identifiers |
Coded data elements are used to simplify data entry and reporting by using a standard set of codes that represent data elements values in a consistent and structured manner. By using the same codes, data can be easily exchanged between different systems or organizations. Some examples of IMO code lists are IMO0043 "Crewmember rank or rating, coded" or IMO0183 "Waste type, coded".
On the other hand, identifiers are used as a unique value to identify a specific object or entity in a data model. Identifiers may be used as a primary key, allowing the data to be organized and queried efficiently. Some examples of IMO identifiers are IMO0007 "Agent identification number" and IMO0082 "Message sender identifier". Note that the uniqueness of identifier values normally is limited to the scope of the identifier.
|
Formats of date and date & time data elements |
IMO data elements related to ‘dates’ and ‘dates and time’ are common in the IMO Data Set. Date formats (e.g. DD/MM/YYYY or MM/DD/YY) are left to implementation since standard organizations have different approaches. To avoid any ambiguity, UN/EDIFACT 2379 (Code specifying the representation of a date, time or period codes) is recommended and defines formats that are aligned with ISO 8601 Standard.
Note: For date and time, all times should include the local time offset from UTC (the local time zone) or be specified as UTC "Z for Zulu time". This will avoid confusion over what zone the time is specified in (e.g. sender, receiver, departure, destination or UTC time).
Example: CCYYMMDDHHMMSSZHHMM
The “BR01: Date time values are always provided with the indication of time zone” is used in data elements.
|
Generic versus specific data elements |
Data elements in the IMO Compendium should be specific and not generic but the data elements that are reused in various positions should use consistent data formats as described above and the same structure wherever possible.
Examples: |
IMO0002 |
Agent family contact name |
The agent's employee contact family name. |
an..70 |
IMO0032 |
Ship company name |
The name of the Company. |
an..70 |
IMO0036 |
Company security officer family name |
The family name of the company security officer shown in the ship security plan. |
an..70 |
|
|