6.8.2.5 OfficialSubmission
6.8.2.5.1 Purpose¶
Records data sent to an official body, such as milk recording or a registry: the exact file, its format, what it included and the recipient's answer.
6.8.2.5.2 Questions it answers¶
- What did we send to an official body, when, and in which format?
- Was it accepted?
- Has anything it included changed since it was sent?
- Which submission replaces it?
6.8.2.5.3 Fields¶
| Field | Type | Cardinality | Description |
|---|---|---|---|
id |
string (uuid) |
1..1 |
Key. |
farm |
Farm | 1..1 |
|
recipient |
string |
1..1 |
The receiving body, e.g. it.aia, nl.crv. |
format |
string |
1..1 |
Format and version, e.g. aia_pres_2024. National formats are export mappings, like parsers in reverse. |
coverage |
Period | 1..1 |
|
payload_path |
string |
1..1 |
The exact file sent, in the bucket, immutable. |
payload_hash |
string |
1..1 |
|
status |
enum | 1..1 |
Values: draft, sent, accepted, partially_accepted, rejected. |
response_path |
string |
0..1 |
The answer of the recipient, in the bucket. |
included_events |
ResolvedEvent | 0..* |
|
included_observations |
CanonicalObservation | 0..* |
|
outdated |
boolean |
1..1 |
Default: false.Set when something it included changes or is cancelled at the source after sending; a DataIssue (kind submission_outdated) asks for a correction. |
supersedes |
OfficialSubmission | 0..1 |
|
submitted_by |
User | 0..1 |
|
submitted_at |
datetime |
0..1 |
|
created_at |
datetime |
1..1 |
6.8.2.5.4 Relationships¶
References
OfficialSubmission.farm→ Farm (1..1)OfficialSubmission.included_events→ ResolvedEvent (0..*)OfficialSubmission.included_observations→ CanonicalObservation (0..*)OfficialSubmission.supersedes→ OfficialSubmission (0..1)OfficialSubmission.submitted_by→ User (0..1)
Referenced by
Uses types
6.8.2.5.5 Rules & constraints¶
- Data sent to an external official body: milk recording (in Italy the functional control: ANAG, PRES, CERF, CG-CELL; elsewhere e.g. CRV, DHIA), registries, health authorities. Not a canonical concept: the content is generated from.
- ResolvedEvents, CanonicalObservations and CanonicalPeriods; this entity records what was sent.
- Disputed facts are sent with their winning value; their DataIssue stays open.