DigitalLivestockPassport

version: 0.4.0

DigitalLivestockPassport Domain

Data Model

Data Model of aatp/DigitalLivestockPassport

Data Definitions

DigitalLivestockPassport

A digital livestock passport (Cattle) as a verifiable credential.

Property Definition Type
@context A list of JSON-LD context URIs that define the semantic meaning of properties within the credential. Text
id A unique identifier (URI) assigned to the product passport. May be a UUID URI
issuer The organisation that is the issuer of this VC. Note that the "id" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the "otherIdentifiers" property. CredentialIssuer
validFrom The date and time from which the credential is valid. DateTime
validUntil The expiry date (if applicable) of this verifiable credential. DateTime
credentialSubject The animal record that is the subject of this digital livestock passport. BovineAnimal

BovineAnimal

A bovine animal record - including

Property Definition Type
countryOfProduction The country in which this item was produced / manufactured. Code
id The NLIS ID of the animal as a full resolvable URI URI
name The registered name of the product within the identifier scheme. Text
registeredId The NLIS ID of the Animal Text
idScheme The identifier scheme for this product. Eg a GS1 GTIN or an AU Livestock NLIS, or similar. If self issued then use the party ID of the issuer. IdentifierScheme
serialNumber Unset
batchNumber Identifier of the specific production batch of the product. Unique within the product class. Text
productImage Reference information (location, type, name) of an image of the product. Link
description A textual description providing details about the product. Text
productCategory A code representing the product's class, typically using the UN CPC (United Nations Central Product Classification) https://unstats.un.org/unsd/classifications/Econ/cpc Classification
furtherInformation A URL pointing to further human readable information about the product. Link
producedByParty The business name and ABN that owns the farm that is the producer (birth) of the animal. Identifier
producedAtFacility The farm name and identifier (usually a PIC - Property Identification Code) of the farm that produced the animal. Identifier
dimensions Unset
productionDate The birth date of the animal. Date
granularityLevel Code to indicate the granularity of this digital product passport - item level, batch level or product class level. Code
dueDiligenceDeclaration Unset
materialsProvenance Unset
conformityClaim An array of claim objects representing various product conformity claims about the product / batch. These can be sustainability claims, circularity claims, or any other claim type within the conformity topic list. Claim
circularityScorecard Unset
emissionsScorecard The emissions scorecard for this animal in accordance witht he GHG protocol EmissionsPerformance
traceabilityInformation An array of traceability events grouped by value chain process. Where actual traceability events are unavailable or carry sensitive information, passport publishers may specify the extent to which the traceability information has been independently verified. TraceabilityPerformance
characteristics Bovine characteristcs at the date of livestock passport issue - terminology from MLA National Livestiock Guidelines 2022 - https://www.ausmeat.com.au/media/1521/mla-national-livestock-guidelines-2022-web_final_291122.pdf. BovineCharcteristics
healthTreatment A list of animal health treatment records. HealthTreatment

CredentialIssuer

From unece.untp-core

The issuer party (person or organisation) of a verifiable credential.

Property Definition Type
id The W3C DID of the issuer - should be a did:web or did:tdw URI
name The name of the issuer person or organisation Text
otherIdentifier An optional list of other registered identifiers for this credential issuer Identifier

Identifier

From unece.untp-core

The ID and Name of an identified entity such as a product, facility, party, standard, etc. If the identifier is a W3C DID then the corresponding DID document SHOULD include a serviceEndpoint of type "IdentityResolver". If the identifier is not a W3C DID then the id property SHOULD be an identity resolver URL.

Property Definition Type
id The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. URI
name The registered name of the entity within the identifier scheme. Examples: product - EV battery 300Ah, Party - Sample Company Pty Ltd, Facility - Green Acres battery factory Text
registeredId The registration number (alphanumeric) of the entity within the register. Unique within the register. Text
idScheme The identifier scheme. Examples : Product - id.gs1.org/01, Party - business.gov.au/abn, Facility - did:web:facilities.acme.com. IdentifierScheme

IdentifierScheme

From unece.untp-core

An identifier registration scheme for products, facilities, or organisations. Typically operated by a state, national or global authority.

Property Definition Type
id The globally unique identifier of the registration scheme. The scheme should be registered and discoverable from vocabulary.uncefact.org/identifierSchemes URI
name The name of the identifier scheme. Text

Link

From unece.untp-core

A structure to provide a URL link plus metadata associated with the link.

Property Definition Type
linkURL The URL of the target resource. URI
linkName A display name for the target resource Text
linkType The type of the target resource - drawn from a controlled vocabulary Text

Classification

From unece.untp-core

A classification scheme and code / name representing a category value for a product, entity, or facility.

Property Definition Type
id The globally unique URI representing the specific classifier value URI
code classification code within the scheme Text
name Name of the classification represented by the code Text
schemeID Classification scheme ID URI
schemeName The name of the classification scheme Text

Measure

From unece.untp-core

The measure class defines a numeric measured value (eg 10) and a coded unit of measure (eg KG).

Property Definition Type
value The numeric value of the measure Numeric
unit Unit of measure drawn from the UNECE Rec20 measure code list. Code (unitOfMeasure)

Claim

From unece.DigitalProductPassport

A declaration of conformance with one or more criteria from a specific standard or regulation.

Property Definition Type
assessmentDate The date on which this assessment was made. Date
declaredValue The list of specific values measured as part of this assessment (eg tensile strength) Metric
id A unique identifier for the declaration. Often this will be an extension of the product.id or attestation.id. But could be a UUID. URI
referenceStandard The reference to the standard that defines the specification / criteria Standard
referenceRegulation The reference to the regulation that defines the assessment criteria Regulation
assessmentCriteria The specification against which the assessment is made. Criterion
declaredValues The list of specific values measured as part of this assessment (eg tensile strength) Metric
conformance An indicator of whether or not the claim or assesment conforms to the regulatory or standard criteria. Indicator
conformityTopic The conformity topic category for this assessment (eg vocabulary.uncefact.org/sustainability/emissions) Code
conformityEvidence A URI pointing to the evidence supporting the claim. SHOULD be a URL to a UNTP Digital Conformity Credential (DCC) SecureLink

Standard

From unece.untp-core

A standard (eg ISO 14000) that specifies the criteria for conformance.

Property Definition Type
id A unique identifier for the standard (eg https://www.iso.org/standard/60857.html). URI
name The name of the standard Text
issuingParty The party that issued the standard Identifier
issueDate The date when the standard was issued. Date

Regulation

From unece.untp-core

A regulation (eg EU deforestation regulation) that defines the criteria for assessment.

Property Definition Type
id The globally unique identifier of this regulation. URI
name The name of the regulation or act. Text
jurisdictionCountry The legal jurisdiction (country) under which the regulation is issued. Code (countryCode)
administeredBy the issuing body of the regulation. For example Australian Government Department of Climate Change, Energy, the Environment and Water Identifier
effectiveDate the date at which the regulation came into effect. Date

Criterion

From unece.untp-core

A specific rule or criterion within a standard or regulation. eg a carbon intensity calculation rule within an emissions standard.

Property Definition Type
id A unique identifier for the criterion within the standard or regulation. For example CO2 emissions calculations for liquid fuel combustion. URI
name A name that describes this criteria. Text
thresholdValues A conformity threshold defined by the specification (eg minimum compressive strength) Metric

Metric

From unece.untp-core

A specific measure of performance against the criteria that governs the claim. Expressed as an array of metric (ie unit of measure) / value (ie the actual numeric value) pairs.

Property Definition Type
metricName A human readable name for this metric (for example "Tensile strength") Text
metricValue A numeric value and unit of measure for this metric. Could be a measured value or a specified threshold. Eg {"value":400, "unit":"MPA"} as tensile strength of structural steel Measure
score A score or rank associated with this measured metric. Text
accuracy A percentage represented as a numeric between 0 and 1 indicating the rage of accuracy of the claimed value (eg 0.05 means that the actual value is within 5% of the claimed value.) Numeric

SecureLink

From unece.untp-core

A binary file that is hashed ()for tamper evidence) and optionally encrypted (for confidentiality).

Property Definition Type
linkURL The URL of the target resource. URI
linkName A display name for the target resource Text
linkType The type of the target resource - drawn from a controlled vocabulary Text
hashDigest The hash of the file. Text
hashMethod The hashing algorithm used to create the target hash. SHA-265 is the recommended standard Code (hashMethodCode)
encryptionMethod The symmetric encryption algorithm used to encrypt the link target. AES is the recommended standard. Decryption keys are expected to be passed out of bounds. Code (encryptionMethodCode)

EmissionsPerformance

From unece.untp-core

Product specific characteristics. This class is an extension point for industry specific product characteristics or performance information such as clothing size or battery capacity.

Property Definition Type
carbonFootprint The carbon footprint of the product in KgCO2e per declared unit. Decimal
declaredUnit The unit of product (EA, KGM, LTR, etc) that is the basis for carbon footprint. Code (unitOfMeasure)
operationalScope The operational scope of the emissions performance. Only scope 1 & 2, or including upstream scope 3 (cradle to gate) or upstream and downstream scope 3 (cradle to grave). Code (operationalScopeCode)
primarySourcedRatio The ratio of emissions data from primary sources (ie from supplier / product specific information rather than secondary / industry averages). Decimal
reportingStandard The reporting standard (eg GHG Protocol, IFRS S2, ESRS, etc) against which this product emissions performance is assessed. Standard

TraceabilityPerformance

From unece.DigitalProductPassport

An array of secure links to TraceabilityEvent objects detailing EPCIS events related to the traceability of the product batch. Events are grouped by value chain process (eg "Weaving" in textiles supply chain).

Property Definition Type
valueChainProcess Human readable name for the industry specific value chain process representing this traceability data set. Text
verifiedRatio The proportion (0 to 1) of materials in this value chain process that have been traced using verifiable traceability event. Numeric
traceabilityEvent A list of secure links to digital traceability events that support this traceability performance statement. May be encrypted for confidentiality purposes. SecureLink

BovineCharcteristics

From aatp.aatp-core

Bovine characteristcs at the date of livestock passport issue - terminology from MLA National Livestiock Guidelines 2022 - https://www.ausmeat.com.au/media/1521/mla-national-livestock-guidelines-2022-web_final_291122.pdf.

Property Definition Type
sex The sex of the animal. Code (SexCode)
sexCharacteristic Characteristic based on sex and age. Eg HY for yearling heiffer Code (SexCharacteristicCode)
breed Breed code array. Single code for pure bred cattle. List each breed for mixed breeds. eg ["AA"] represewnts pure bred Angus. Code (BreedCode)
liveWeight Live weight of the animal in Kg Decimal
carcassWeight Carcass weight in Kg - only applicable if passport is issued post slaughter. Decimal
fatScore Fat score based on depth of fat at 12th to 13th rib. 1 is lightest and 6 is heaviest. Code (FatScoreCode)
muscleScore Muscle score based on thickness through stifle. A is heaviest, E is lightest. Code (MuscleScoreCode)
frameSize Frame size (lookup based on hook height for given age and sex). 1 is the smallest and 11 is the largest. Code (FrameSizeCode)
maturity Maturity type or growth potential is a way of describingthe skeletal size of cattle. Frame score, which is the height of a beef animal at a given age can be used as a measure of its maturity type. Given adequate nutrition and health, most animals should maintain the same frame score and hence maturity type throughout their life, while actual height increases with age. Code (MaturityTypeCode)

HealthTreatment

From aatp.aatp-core

An animal health treatment record.

Property Definition Type
icarDiseaseCategory The disease category that this treatment targets. Code (IcarCategoryCode)
treatmentDate The data the treatment was applied. Date
productId The APVMA product code for the treatment ideally as a resolvable URL Code (TreatmentProductCode)
productBatchId The batch number of the specific treatment product. Text
productExpiry The expiry date of the specific treatemtn product batch. Date
productName The name of the treatment product Text
doseRate The dose rate for the administered treatment. Measure
witholdingPeriod The pre-slauhghter / pre export witholding period in days for this treatment. Integer

Code Tables

Imported Domains

aatp / DigitalLivestockPassportv 0.4.0