View on GitHub

easitrace

Transaction Field Keys

This document lists all generic field key definitions available in the MPaaS.MovementServices library. These keys serve as the foundation for transaction field mapping across all service implementations (RMIS, ScotMoves, DAERA, etc.).

Overview

Generic field keys are defined globally and follow a hierarchical naming convention using dot notation (e.g., Departure.Identifier). Each generic key may be mapped to service-specific keys by individual service implementations.

Movement Transaction Fields

Departure Location Fields

Generic Key Path Description Data Type
Departure.Date Date the animals depart from the location Date
Departure.LoadingDate Date when animals are loaded for transport Date
Departure.Country Country code of the departure location String
Departure.Locality Locality/district of the departure location String
Departure.Identifier Unique identifier for the departure location (typically GLN or CPH) String
Departure.InternalIdentifier Internal system identifier for the departure location String
Departure.Town Town/city name of the departure location String
Departure.Street Street address of the departure location String
Departure.PostCode Postal code of the departure location String
Departure.FirstName First name of contact person at departure location String
Departure.LastName Last name of contact person at departure location String
Departure.EmailAddress Email address of contact at departure location Email
Departure.PropertyType Type of property at departure location String
Departure.HerdNumber Herd number at the departure location String
Departure.AssuranceNumber Assurance/compliance number at departure location String
Departure.SlapMark SLAP mark/identification at departure location String
Departure.PhoneNumber Phone number of contact at departure location String
Departure.Homebred Indicator whether animals are home-bred at departure Boolean
Departure.SellersConfirmation Seller’s confirmation of movement Boolean
Departure.Longitude Longitude coordinates of departure location Double
Departure.Latitude Latitude coordinates of departure location Double
Departure.CountSent Number of animals sent from departure location Integer

Destination Location Fields

Generic Key Path Description Data Type
Destination.ArrivalDate Date animals arrive at the destination Date
Destination.UnLoadingDate Date when animals are unloaded at destination Date
Destination.Country Country code of the destination location String
Destination.Locality Locality/district of the destination location String
Destination.Identifier Unique identifier for the destination location (typically GLN or CPH) String
Destination.InternalIdentifier Internal system identifier for the destination location String
Destination.Town Town/city name of the destination location String
Destination.Street Street address of the destination location String
Destination.PostCode Postal code of the destination location String
Destination.FirstName First name of contact person at destination String
Destination.LastName Last name of contact person at destination String
Destination.EmailAddress Email address of contact at destination Email
Destination.PropertyType Type of property at destination String
Destination.HerdNumber Herd number at the destination location String
Destination.AssuranceNumber Assurance/compliance number at destination String
Destination.SlapMark SLAP mark/identification at destination String
Destination.PhoneNumber Phone number of contact at destination String
Destination.TimeSincePurchase Time elapsed since animals were purchased String
Destination.CountDeadOnArrival Number of animals found dead on arrival Integer
Destination.KeeperNotChanged Indicator if keeper/ownership has not changed Boolean
Destination.IsSeparationUnit Indicator if destination is a separation/quarantine unit Boolean
Destination.IsCommonLand Indicator if destination is common land Boolean
Destination.Type Type of destination facility (e.g., Farm, Market, Abattoir) String
Destination.AnimalsDifferent Indicator if animals at destination differ from departure Boolean
Destination.ConfirmationStickers Confirmation stickers received at destination String
Destination.Longitude Longitude coordinates of destination location Double
Destination.Latitude Latitude coordinates of destination location Double

Haulier/Transport Fields

Generic Key Path Description Data Type
Haulier.CompanyName Name of the haulage/transport company String
Haulier.RegistrationNumber Vehicle registration number used for transport String
Haulier.PermitNumber Transport permit number String
Haulier.VehicleRegistration Vehicle registration plate String
Haulier.MeansOfTransport Method of transport (e.g., Lorry, Trailer) String
Haulier.TransportName Name of transport/vehicle String
Haulier.AuthorisationNumber Transport authorisation number String
Haulier.Type Type of haulier/transporter String
Haulier.DriverName Name of the driver/transporter String
Haulier.PhoneNumber Phone number of haulier/driver String
Haulier.DepartureDate Date haulier departs with animals Date
Haulier.Signature Digital signature of haulier/driver String
Haulier.SignatureDate Date when signature was provided Date
Haulier.JourneyDistanceOver65K Indicator if journey distance exceeds 65km Boolean

FCI (Food Chain Information) Fields

Generic Key Path Description Data Type
Fci.Satisfied Indicator if FCI requirements are satisfied Boolean
Fci.WithdrawalPeriodsMet Indicator if medicine withdrawal periods are met Boolean
Fci.ZNCPScore ZNCP (animal welfare) assessment score String
Fci.ToSlaughter Indicator if animals are destined for slaughter Boolean
Fci.DescribeDiseases Description of any diseases present String
Fci.DescribeSamples Description of samples taken (if applicable) String
Fci.Signature Digital signature confirming FCI String
Fci.SignatureDate Date when FCI was signed off Date

Movement-Level Fields

Generic Key Path Description Data Type
Movement.PreviousDate Date of the previous related movement Date
Movement.UpdatedDate Date when movement record was last updated Date
Movement.ExpectedDuration Expected duration of movement/journey String
Movement.Id Unique identifier for the movement transaction String
Movement.InternalId Internal system identifier for the movement String
Movement.ToCPRC Indicator if movement is to CPRC (Central Performance Recording Centre) Boolean
Movement.WithinYourBusiness Indicator if movement is within the same business Boolean
Movement.AnimalType Type of animals in the movement String
Movement.OffExemptionCode Exemption code when animals leave the location String
Movement.OnExemptionCode Exemption code when animals arrive at location String
Movement.ConfirmationNo Movement confirmation number String
Movement.MoveDate Date of the movement Date
Movement.ExpectedCount Expected number of animals in movement Integer

Buyer/Seller Fields

Generic Key Path Description Data Type
Buyer.InvoiceNumber Invoice number from buyer String
Seller.PaymentNumber Payment reference number from seller String

Health Transaction Fields

Generic Key Path Description Data Type
Health.Medicines.Consignment Indicator if medicines are in consignment Boolean
Health.Medicines.Hernia Indicator if hernia treatment applied Boolean
Health.Medicines.Individual Indicator if medicine applied to individual animal Boolean
Health.InjuredPigs Number of injured pigs Integer
Health.PoorDoerPigs Number of poor doer (weak) pigs Integer
Health.TailBitePigs Number of pigs with tail bite injuries Integer

Register Transaction Fields

Generic Key Path Description Data Type
Register.BirthPropertyIdentifier Identifier of the birth/natal property String
Register.BirthPropertyPostalIdentifier Postal identifier of birth property String
Register.Colour Colour/coat colour of animal String
Register.ProductionType Production type/breed classification String
Register.MissingDate Date animal went missing Date
Register.FoundDate Date animal was found Date
Register.NMRCode National Movement Register (NMR) code String
BusinessId Business/holding identifier String
HerdNumber Herd/flock number String

Death Transaction Fields

Generic Key Path Description Data Type
Death.DisposalManner Method of carcass disposal (e.g., Burial, Incineration) String
Death.DisposalPlace Location where carcass is disposed String
Death.Location Location where animal died String
Death.IsSlaughter Indicator if death was due to slaughter Boolean
Death.Date Date of animal’s death Date
BusinessId Business/holding identifier String
HerdNumber Herd/flock number String

Still Birth Transaction Fields

Generic Key Path Description Data Type
StillBirth.BusinessId Business/holding identifier String
StillBirth.DisposalManner Method of carcass disposal String
StillBirth.DisposalLocation Location where carcass is disposed String
StillBirth.Type Type/classification of still birth String
HerdNumber Herd/flock number String

Import/Export Fields

Import

Generic Key Path Description Data Type
Import.Country Country of origin for imported animals String
Import.Date Date of import Date

Export

Generic Key Path Description Data Type
Export.Country Destination country for exported animals String
Export.Date Date of export Date

Property Fields

Generic Key Path Description Data Type
Property.Identifier Primary identifier for property (e.g., CPH, GLN) String
Property.SecondaryIdentifier Secondary identifier for property (e.g., Postal ID) String
Property.IncorporatedDate Date property was incorporated into system Date
Property.CeasedDate Date property ceased operations Date

Query Operation Fields

GetAnimals

Generic Key Path Description Data Type
GetAnimals.OrderBy Field to order animal query results by String
GetAnimals.IncludeSubHoldings Indicator to include sub-holdings in query results Boolean

Historical

Generic Key Path Description Data Type
Departure.DateFrom Start date for historical movement query (departure) Date
Departure.DateTo End date for historical movement query (departure) Date
Movement.Date Date filter for historical movements Date

ReTag

Generic Key Path Description Data Type
Retag.Date Date of re-tagging event Date
Retag.Reason Reason for re-tagging animal String

Global Fields

Generic Key Path Description Data Type
EmailAddress Email address (global context) Email
HerdNumber Herd/flock number (global context) String
SerialNumber Serial number identifier String
UserReference User-supplied reference number String

Service-Specific Field Mapping Examples

Movement MoveOff - Departure Location

Generic Key RMIS Specific Key ScotMoves Specific Key DAERA Specific Key
Departure.Identifier RMIS.Departure.Gln N/A* N/A*
Departure.Date RMIS.Departure.Date ScotMoves.Movement.DepartureLocation N/A*
Departure.Latitude RMIS.Departure.Latitude N/A* N/A*
Departure.Longitude RMIS.Departure.Longitude N/A* N/A*
Departure.CountSent RMIS.Departure.CountSent N/A* N/A*

*Not required or implemented for this service’s MoveOff capability

Movement MoveOff - Destination Location

Generic Key RMIS Specific Key ScotMoves Specific Key DAERA Specific Key
Destination.Identifier RMIS.Destination.Gln ScotMoves.Movement.DestinationLocation N/A*
Destination.ArrivalDate RMIS.Destination.ArrivalDate N/A* N/A*
Destination.ExpectedCount RMIS.Destination.ExpectedCount N/A* N/A*
Destination.CountDeadOnArrival RMIS.Destination.DeceasedCount N/A* N/A*

*Not required or implemented for this service’s MoveOff capability

Movement MoveOff - Haulier/Transport

Generic Key RMIS Specific Key ScotMoves Specific Key DAERA Specific Key
Haulier.PermitNumber N/A N/A DAERA.Move.PermitNumber
Haulier.MeansOfTransport N/A N/A DAERA.Move.MeanOfTransport
Haulier.RegistrationNumber N/A N/A DAERA.Move.Registration
Haulier.DriverName N/A N/A DAERA.Move.Transporter

Register Fields

Generic Key RMIS Specific Key ScotMoves Specific Key DAERA Specific Key
Register.BirthPropertyIdentifier N/A ScotMoves.Register.BirthLocation N/A
Register.BirthPropertyPostalIdentifier N/A ScotMoves.Register.BirthPostalLocation N/A
Register.NMRCode N/A N/A DAERA.Register.NMRCode
Register.HerdNumber N/A N/A DAERA.Register.GenericInput.HerdNo

Death Fields

Generic Key RMIS Specific Key ScotMoves Specific Key DAERA Specific Key
Death.Location N/A ScotMoves.Death.MainLocation N/A
Death.Date N/A ScotMoves.Death.Date DAERA.Death.DeathDate
Death.DisposalManner N/A N/A DAERA.Death.DisposalManner
Death.DisposalPlace N/A N/A DAERA.Death.DisposalPlace
Death.HerdNumber N/A N/A DAERA.Death.GenericInput.HerdNo

Query Operation Fields

Generic Key RMIS Specific Key ScotMoves Specific Key DAERA Specific Key
GetAnimals.IncludeSubHoldings N/A ScotMoves.GetAnimals.IncludeSubHoldings N/A
GetAnimals.OrderBy N/A N/A DAERA.AnimalQuery.OrderBy

Notes

Data Types: