Resource entities - adewg/ICAR GitHub Wiki

The following resource entities are defined in the ADE standard. These are designed to be manipulated, retrieved and sent as individual resources and as collections of a set of resources of the same type. In the tables below, Version indicates the ADE release version the resource was first supported ("since-version").

Operating Resources

Resource Name Version Description
icarAnimalCoreResource 1.0 Describes an animal with its identity, characteristics, and pedigree.
icarAnimalSetResource 1.1 Defines a set of animals (a group, mob, or other categorisation).
icarDeviceResource 1.0 Describes a device used to observe or interact with animals
icarFeedResource 1.2 Defines a livestock feed.
icarFeedStorageResource 1.2 Defines a feed storage location.
icarLocationResource 1.0 Allows listing of locations on the server to which the user/client has access.
icarMedicineResource 1.1 Provides information about a medicine.
icarRationResource 1.2 Defines a ration made of multiple feeds.
icarReproEmbryoResource 1.0 Describes an embryo - used in reproduction events.
icarReproSemenStrawResource 1.0 Describes a semen straw - used in reproduction events.
icarStatisticsResource 1.3 Used to deliver calculated statistics for groups of animals.

Event Resources

The following resources are "events" which represent observations or actions recorded for animals.

Category Event Resource Name Version Description
Registration and Movements icarMovementArrivalEventResource 1.0 Documents the arrival of an animal into a herd or location.
icarMovementBirthEventResource 1.0 Documents the initial recording of an animal by its birth.
icarMovementDeathEventResource 1.0 Documents the death or slaughter of an animal.
icarMovementDepartureEventResource 1.0 Documents the departure of an animal from a location.
Milking icarMilkingDryOffEventResource 1.0 Documents an animal being dried off at the end of a lactation.
icarMilkingVisitEventResource 1.0 Documents an animal's visit to a robot or manual milking.
icarTestDayResultEventResource 1.1 Records the test day result for a milking animal.
icarLactationStatusObservedEventResource 1.1 Change the lactation status based on observation.
Reproduction icarReproAbortionEventResource 1.0 Records an abortion.
icarReproDoNotBreedEventResource 1.1 Toggle the "Do not breed" status of an animal.
icarReproHeatEventResource 1.0 Records a heat observed or measured for an animal.
icarReproInseminationEventResource 1.0 Records the insemination of an animal, using natural or artificial insemination, or embryo transfer.
icarReproMatingRecommendationResource 1.0 Provides a mating recommendation generated by a system.
icarReproParturitionEventResource 1.0 Records the parturition (calving, lambing, fawning, etc) of a dam.
icarReproPregnancyCheckEventResource 1.0 Records a pregnancy test result.
icarReproStatusObservedEventResource 1.1 Modifies reproductive status of an animal based on observation (rather than an event such as mating, parturition, pregnancy check or abortion).
Performance icarConformationScoreEventResource 1.1 Records numeric conformation scores in one of the recognised categories.
icarWeightEventResource 1.0 Records the live weight of an animal.
icarGroupWeightEventResource 1.3 Records sampled weights for a group of animals.
Group Management icarAnimalSetJoinEventResource 1.1 Records an animal joining or being allocated to an animal set.
icarAnimalSetLeaveEventResource 1.1 Records an animal leaving or being removed from an animal set.
Health icarDiagnosisEventResource 1.1 Records an animal being diagnosed with a disease or issue.
icarTreatmentEventResource 1.1 Records an individual health treatment (medicine and/or procedure) for an animal.
icarTreatmentProgramEventResource 1.1 Records a programme of treatments (medicine or procedure) for an animal. This may be specified as a course summary or an array of individual treatment events.
icarGroupTreatmentEventResource 1.3 Records a treatment applied to a group of animals.
Feeding icarFeedIntakeEventResource 1.2 Records feeding or feed intake of individual animals.

Summary or Calculated Resources

The following resources represent calculated or aggregated data for animals. These are not physical objects or events, per se.

Category Event Resource Name Version Description
Reproduction icarGestationResource 1.1 Provides derived or calculated data about a gestation (pregnancy) of an animal (based on reproductive events).
Milking icarLactationResource 1.0 Provides aggregated data about a lactation of a milking animal (based on milking visits and other observations).
icarTestDayResource 1.1 Provides animal data about a herd testing day.
icarDailyMilkingAveragesResource 1.2 Provides average milking performance data.
Performance icarBreedingValueResource 1.1 Provides information about breeding values (statistical predictions of progeny performance) calculated for an animal.
Feeding icarFeedRecommendationResource 1.2 Provides per-animal feed recommendations.
icarFeedReportResource 1.2 Provides per-animal feed intake summaries. See also how this might interact with animal sets