Model Documentation

This is the documentation for the data model.

Classes

Classes are identified by a URI, and are grouped here by the domain of that URI. Namespace prefixes are used where possible.

data.food.gov.uk

alert:Alert[definition]
alert:Allergen[definition]
alert:BatchDescription[definition]
alert:Country[definition]
alert:HazardCategory[definition]
alert:Pathogen[definition]
alert:PathogenRisk[definition]
alert:Problem[definition]
alert:ProductCategory[definition]
alert:ProductDetail[definition]
alert:Reason[definition]
alert:Status[definition]

www.w3.org

org:Organization[definition]
skos:Concept[definition]

data.food.gov.uk

alert:Alert[definition]
alert:Problem[definition]
alert:ProductDetail[definition]
alert:BatchDescription[definition]
alert:Allergen[definition]
alert:Reason[definition]
alert:HazardCategory[definition]
alert:PathogenRisk[definition]
alert:Pathogen[definition]
alert:Country[definition]
alert:ProductCategory[definition]
alert:Status[definition]

Alert

alert:Alert[definition]

Property Description Range
type[type]
rdf:type
Required
Multi-valued

Type of the alert, will be a generic Alert and one of AA (Allergy Alert), PRIN (Product Recall Information Notice) or FAFA (Food Alert For Action).

rdf:Resource[definition]
previousAlert[previousAlert]
alert:previousAlert
Optional
Single-valued

Optional, used for alerts which substantially update a previous alert

relatedAlerts[relatedAlerts]
alert:relatedAlerts
Optional
Multi-valued

zero or more alerts that are related to this alert. The nature of the relationship is unspecified.

reportingBusiness[reportingBusiness]
alert:reportingBusiness
Optional
Single-valued

The food business reporting the alert, may not be present in the case of FAFAs

otherBusiness[otherBusiness]
alert:otherBusiness
Optional
Single-valued

Optional additional businesses involved, e.g. distributing supermarkets

notation[notation]
skos:notation
Required
Single-valued

Unique identifier for the alert

xsd:string[definition]
title[title]
dct:title
Required
Single-valued

Short title for the alert, guidelines suggest a length between 50 and 90 characters.

rdf:langString[definition]
description[description]
dct:description
Required
Single-valued

The main textual description of the alert not including the sections covered elsewhere (risk, product details, action taken, consumer advice). For most alerts (AA, PRIN) this will be the summary paragraph. FAFAs allow for more extensive text in the Alert description.

rdf:langString[definition]
SMStext[SMStext]
alert:SMStext
Optional
Single-valued

Short description to be used in SMS notifications

rdf:langString[definition]
twitterText[twitterText]
alert:twitterText
Optional
Single-valued

Short description to be used in twitter notifications

rdf:langString[definition]
shortTitle[shortTitle]
alert:shortTitle
Optional
Single-valued

Shortened version of the title of the alert for use in social media

rdf:langString[definition]
alertURL[alertURL]
alert:alertURL
Optional
Single-valued

URL for the alert on the FSA web site, this is where the human readable presentation will appear and is the URL that should be referenced in social media announcements, a shortened version of this URL is provided in the shortURL field.

rdf:Resource[definition]
shortURL[shortURL]
alert:shortURL
Optional
Single-valued

Shortened URL for this alert suitable for use in tweets and SMS.

rdf:Resource[definition]
actionTaken[actionTaken]
alert:actionTaken
Optional
Single-valued

Description of the action taken, or in the case of FAFAs then actions to be taken by enforcement authority.

rdf:langString[definition]
consumerAdvice[consumerAdvice]
alert:consumerAdvice
Optional
Single-valued

Text giving the advice to consumers

rdf:langString[definition]
relatedMedia[relatedMedia]
alert:relatedMedia
Optional
Multi-valued

Optional URL link to a supporting document or other media, typically a PDF of a product recall notice from the reporting business, but may also be an image of the product other supporting documentation. In some cases there may be multiple supporting documents (in which case the JSON value will be an array).

rdf:Resource[definition]
problem[problem]
alert:problem
Optional
Multi-valued

One or more structured descriptions of problems, or suspected problems, with the products that may pose a risk for consumers and that have led to the advice being issued.

productDetails[productDetails]
alert:productDetails
Optional
Multi-valued

One or more structured descriptions of products which are the subject of the alert.

created[created]
dct:created
Required
Single-valued
xsd:date[definition]
modified[modified]
dct:modified
Required
Single-valued
xsd:dateTime[definition]
status[status]
alert:status
Optional
Single-valued

The status of the Alert, normally this will be alert:Published but rare cases may be changed to alert:Withdrawn.

country[country]
alert:country
Optional
Multi-valued

Country to which the alert applies. May have more than one value (e.g. England and Wales). Absence of a country value indicates that alert may apply to any country with the UK.

Problem

alert:Problem[definition]

Property Description Range
riskStatement[riskStatement]
alert:riskStatement
Optional
Single-valued

Text describing the problem in terms of the risk to consumers. Typically this will be based on standard text patterns for the particular risk but may be overridden in the editor to express the particular situation at hand.

rdf:langString[definition]
allergen[allergen]
alert:allergen
Optional
Multi-valued

Zero, one or more allergens drawn from the controlled list of allergens. For an Allergen Alert there will also be at least one allergen present on the problem statement.

pathogenRisk[pathogenRisk]
alert:pathogenRisk
Optional
Single-valued

Classifies the problem as being due to actual or possible contamination with a pathogen.

hazardCategory[hazardCategory]
alert:hazardCategory
Optional
Single-valued

Classifies the problem as into one of the hazard categories. This information is useful for analysis and retrieval but does not directly affect the default textual presentation of the alert. Support for this field is under discussion.

reason[reason]
alert:reason
Optional
Single-valued

Classifies the reason for the problem as being one of a standard set of reasons. This information is useful for analysis and retrieval but does not directly affect the default textual presentation of the alert. Support for this field is under discussion.

comment[comment]
rdfs:comment
Optional
Single-valued

Optional place-holder to record additional explanation of the hazard or reason, especially in the case there 'other' is selected. This is not for presentation in the alert text and may not be use in first iterations of the system. Collection of information on exceptional cases via this field might support future enhancements to the controlled lists.

rdf:langString[definition]

ProductDetail

alert:ProductDetail[definition]

Property Description Range
productName[productName]
alert:productName
Required
Single-valued

Name of the affected product

rdf:langString[definition]
productCode[productCode]
alert:productCode
Optional
Single-valued

Identifying code for the affected product

xsd:string[definition]
packSizeDescription[packSizeDescription]
alert:packSizeDescription
Optional
Single-valued

Description of the package size affected - may be weight, volume or other description.

rdf:langString[definition]
batchDescription[batchDescription]
alert:batchDescription
Optional
Multi-valued

One or more descriptions of the product batches affected by the alert. In most cases there will only be a single batch description for each product detail but in rare cases there can be a table of such descriptions.

allergen[allergen]
alert:allergen
Optional
Multi-valued

Zero, one or more allergens drawn from the controlled list of allergens. The overall problem statement will include all allergens, however in some cases a single Alert might involve multiple products with different allergens present in each. This field supports that situation.

productCategory[productCategory]
alert:productCategory
Optional
Single-valued

Identifies the category of the affected product. This information is used to support search and analysis and does not need to be separately included in the alert presentation.

BatchDescription

alert:BatchDescription[definition]

Property Description Range
useByDescription[useByDescription]
alert:useByDescription
Optional
Single-valued

Use by date range for the batch expressed in text form for presentation.

rdf:langString[definition]
bestBeforeDescription[bestBeforeDescription]
alert:bestBeforeDescription
Optional
Single-valued

Best before date range for the batch expressed in text form for presentation.

rdf:langString[definition]
batchCode[batchCode]
alert:batchCode
Optional
Single-valued

Batch number or code for the batch expressed in text form for presentation.

rdf:langString[definition]
lotNumber[lotNumber]
alert:lotNumber
Optional
Single-valued

Lot number for batch expressed in text form for presentation.

rdf:langString[definition]
batchTextDescription[batchTextDescription]
alert:batchTextDescription
Optional
Single-valued

Other textual description for the batch.

rdf:langString[definition]
useByDate[useByDate]
alert:useByDate
Optional
Single-valued

'Use by' date (or dates) for the batch. In some cases there may be multiple dates or the dates by might be given as month-year only. This field is used for API filtering and not for presentation, the presentation form is given by the useByDescription field.

xsd:date[definition]
bestBeforeDate[bestBeforeDate]
alert:bestBeforeDate
Optional
Single-valued

'Best before' date (or dates) for the batch. In some cases there may be multiple dates or the dates by might be given as month-year only. This field is used for API filtering and not for presentation, the presentation form is given by the bestBeforeDescription field.

xsd:date[definition]

Allergen

alert:Allergen[definition]

Property Description Range
type[type]
rdf:type
Required
Multi-valued
rdf:Resource[definition]
label[label]
rdfs:label
Required
Single-valued
notation[notation]
skos:notation
Required
Single-valued
prefLabel[prefLabel]
skos:prefLabel
Optional
Single-valued
altLabel[altLabel]
skos:altLabel
Optional
Single-valued
broader[broader]
skos:broader
Optional
Single-valued
narrower[narrower]
skos:narrower
Optional
Single-valued
topConceptOf[topConceptOf]
skos:topConceptOf
Optional
Single-valued
inScheme[inScheme]
skos:inScheme
Optional
Single-valued
description[description]
dct:description
Optional
Single-valued
riskStatement[riskStatement]
alert:riskStatement
Required
Single-valued

Default text describing the risk from this allergen

rdf:langString[definition]
relatedFoodTypes[relatedFoodTypes]
alert:relatedFoodTypes
Optional
Single-valued
rdf:Resource[definition]

Reason

alert:Reason[definition]

Property Description Range
label[label]
rdfs:label
Required
Single-valued
notation[notation]
skos:notation
Required
Single-valued

HazardCategory

alert:HazardCategory[definition]

Property Description Range
label[label]
rdfs:label
Required
Single-valued
notation[notation]
skos:notation
Required
Single-valued

PathogenRisk

alert:PathogenRisk[definition]

Property Description Range
type[type]
rdf:type
Required
Multi-valued
rdf:Resource[definition]
label[label]
rdfs:label
Required
Single-valued
notation[notation]
skos:notation
Required
Single-valued
prefLabel[prefLabel]
skos:prefLabel
Optional
Single-valued
inScheme[inScheme]
skos:inScheme
Optional
Single-valued
riskStatement[riskStatement]
alert:riskStatement
Required
Single-valued

Default text describing the risk from this pathogen, or possible pathogen

rdf:langString[definition]
pathogen[pathogen]
alert:pathogen
Required
Single-valued

Indicates the actual pathogen involved. The PathogenRisk may represent actual or possible contamination with this pathogen.

Pathogen

alert:Pathogen[definition]

Property Description Range
type[type]
rdf:type
Required
Multi-valued
rdf:Resource[definition]
label[label]
rdfs:label
Required
Single-valued
notation[notation]
skos:notation
Required
Single-valued
prefLabel[prefLabel]
skos:prefLabel
Optional
Single-valued
inScheme[inScheme]
skos:inScheme
Optional
Single-valued

Country

alert:Country[definition]

Property Description Range
type[type]
rdf:type
Required
Multi-valued
rdf:Resource[definition]
label[label]
rdfs:label
Required
Single-valued
seeAlso[seeAlso]
rdfs:seeAlso
Optional
Single-valued
description[description]
dct:description
Optional
Single-valued
notation[notation]
skos:notation
Optional
Single-valued
prefLabel[prefLabel]
skos:prefLabel
Optional
Single-valued
broader[broader]
skos:broader
Optional
Single-valued
narrower[narrower]
skos:narrower
Optional
Single-valued
inScheme[inScheme]
skos:inScheme
Optional
Single-valued

ProductCategory

alert:ProductCategory[definition]

Property Description Range
label[label]
rdfs:label
Required
Single-valued
notation[notation]
skos:notation
Required
Single-valued

Status

alert:Status[definition]

Property Description Range
type[type]
rdf:type
Required
Multi-valued
rdf:Resource[definition]
label[label]
rdfs:label
Required
Single-valued
notation[notation]
skos:notation
Required
Single-valued
prefLabel[prefLabel]
skos:prefLabel
Optional
Single-valued
inScheme[inScheme]
skos:inScheme
Optional
Single-valued

www.w3.org

org:Organization[definition]
skos:Concept[definition]

Organization

org:Organization[definition]

Property Description Range
commonName[commonName]
alert:commonName
Required
Single-valued

Name by which the organization is commonly known

legalName[legalName]
schema-org:legalName
Optional
Single-valued

Legal (registered) name of the organization. This field will not be supported in the initial version of the system.

identifier[identifier]
org:identifier
Optional
Single-valued

Identifier for the organization, typically company registration number. This field will not be supported in the initial version of the system. In the future a register of food businesses may be used to obtain unique identifiers for relevant businesses.

Concept

skos:Concept[definition]

Property Description Range
label[label]
rdfs:label
Required
Single-valued
notation[notation]
skos:notation
Required
Single-valued

Namespace Prefixes

These are the namespace prefixes that are referenced in the data model.

alert http://data.food.gov.uk/food-alerts/def/
allergen http://data.food.gov.uk/codes/alerts/def/allergen/
api http://purl.org/linked-data/api/vocab#
dc http://purl.org/dc/elements/1.1/
dct http://purl.org/dc/terms/
def-foodtype http://data.food.gov.uk/codes/foodtype/def/terms/
dgu http://reference.data.gov.uk/def/reference/
foaf http://xmlns.com/foaf/0.1/
hazard http://data.food.gov.uk/codes/alerts/def/hazard/
id-alert http://data.food.gov.uk/food-alerts/id/
id-foodtype http://data.food.gov.uk/codes/foodtype/id/
model http://localhost/localmapping/
org http://www.w3.org/ns/org#
owl http://www.w3.org/2002/07/owl#
pathogen http://data.food.gov.uk/codes/alerts/def/pathogen/
pathogen-risk http://data.food.gov.uk/codes/alerts/def/pathogen-risk/
product http://data.food.gov.uk/codes/alerts/def/product/
qb http://purl.org/linked-data/cube#
rdf http://www.w3.org/1999/02/22-rdf-syntax-ns#
rdfs http://www.w3.org/2000/01/rdf-schema#
reason http://data.food.gov.uk/codes/alerts/def/reason/
schema-org http://schema.org/
skos http://www.w3.org/2004/02/skos/core#
text http://jena.apache.org/text#
void http://rdfs.org/ns/void#
xsd http://www.w3.org/2001/XMLSchema#