DigitalLivestockPassport
version: 0.3.2
DigitalLivestockPassport Domain
Data Model
Data Definitions
DigitalLivestockPassport
A digital livestock passport.
| Property | Definition | Type |
|---|---|---|
| @context | A list of JSON-LD context URIs that define the seamntic meaning of prperties 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 isuer 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.
| Property | Definition | Type |
|---|---|---|
| name | Text | |
| registeredId | Text | |
| idScheme | IdentifierScheme | |
| nlisId | The NLIS identifier of the animal | Text |
| mobNumber | The identifier of the herd or mob of which this animal is a member. | 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 Party entity that manufactured the product. | Entity |
| producedAtFacility | The Facility where the product batch was produced / manufactured. | Entity |
| countryOfProduction | The country in which this item was produced / manufactured. | Code |
| dimensions | The physical dimensions of the product. Not every dimension is relevant to every products. For example bulk materials may have wieght and volume but not length, with, or height."weight":{"value":10, "unit":"KGM"} | Dimension |
| birthDate | The birth date of the animal. May be set to the onset of calving period (as an idicator or maximum age). | Date |
| serialNumber | Unset | |
| batchNumber | Unset | |
| productionDate | Unset | |
| id | The National Livestock Idenficiation System (NLIS) ID expressed as a URI as follows https://{resolver}.{issuerDomain}/nlis/{Identifier}. The idenfiier may be either the structured NLIS ID or the RFID tag ID. | URI |
| characteristics | The bovine characteristics for this animal in acordance with MLA guidelines https://www.ausmeat.com.au/media/1521/mla-national-livestock-guidelines-2022-web_final_291122.pdf. | BovineCharcteristics |
| healthTreatments | The health treatment history for this animal in accordance with APMVA guidelines https://www.apvma.gov.au/ | HealthTreatment |
| emissionsScorecard | The emissions scorecard for this animal in accordance witht he GHG protocol | EmissionsPerformance |
| conformityDeclarations | A list of conformity declarations for this animal against specific criteria from a standard or regulation. | BovineDeclaration |
BovineDeclaration
A specific assessment about the product or facility against a specific specification. Eg the carbon intensity of a given product or batch.
| Property | Definition | Type |
|---|---|---|
| id | A unique identifier for the delcaration. 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 |
| compliance | An indicator of whether or not the assessment meets the specification. | Indicator |
| conformityTopic | The conformity topic category for this assessment (eg vocabulary.uncefact.org/sustainability/emissions) | Code |
CredentialIssuer
From unece.untp-core
The issuer party ()person or orgnaition) 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 |
| otherIdentifiers | An optional list of other registered identifiers for this credential issuer | Entity |
Entity
From unece.untp-core
The ID and Name of an identified entity such qs 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 peroperty 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. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory | Text |
| registeredId | The registration number (alphanumeric) of the entity within the register. Unique within the register. | Text |
| idScheme | The identifier scheme. Exampleproduct - 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 gloabl 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 |
Dimension
From unece.untp-core
Overall (length, width, height) dimensions and weight/volume of an item.
| Property | Definition | Type |
|---|---|---|
| weight | the weight of the product. EG {"value":10, "unit":"KGM"} | Measure |
| length | The length of the product or packaging eg {"value":840, "unit":"MMT"} | Measure |
| width | The width of the product or packaging. eg {"value":150, "unit":"MMT"} | Measure |
| height | The height of the product or packaging. eg {"value":220, "unit":"MMT"} | Measure |
| volume | The displacement volume of the product. eg {"value":7.5, "unit":"LTR"} | Measure |
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) |
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. | 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 |
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 inlcuing 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 |
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 | Entity |
| 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 Australin Goernment Department of Climate Change, Energy, the Environment and Water | Entity |
| 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 criteria within the standard or regulation. For example CO2 emissions calaculations for liquid fule combusion. | 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 emasure) / 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 strenght of structural steel | Measure |
| 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 |
Code Tables
countryCode
Country code list.
Code values for this table can be found here:
https://vocabulary.uncefact.org/CountryId
unitOfMeasure
UNECE Recommendation 20 Unit of Measure codelist
Code values for this table can be found here:
https://vocabulary.uncefact.org/UnitMeasureCode
SexCode
Sex code
| Name | Value | Description |
|---|---|---|
| M | Male | |
| F | Female |
SexCharacteristicCode
| Name | Description |
|---|---|
| HY | YEARLING HEIFER |
| C | COW |
| CSP | SPAYED COW |
| HC | HEIFER CALF |
| H | HEIFER |
| HSP | SPAYED HEIFER |
| BY | YEARLING BULL |
| SC | STEER CALF |
| S | STEER |
| V | VEAL |
| MFV | MILK FED VEALER (MSA SPECIFIC) |
| BC | BULL CALF |
| B | BULL |
| SY | YEARLING STEER |
| RV | ROSÉ VEAL |
BreedCode
Breed Code is used to describe a group of animals that have a specific characteristic or trait.
| Value | Name |
|---|---|
| AA | ANGUS |
| AB | AUBRAC |
| AF | AFRICANDER |
| AK | AKAUSHI |
| AL | AUSTRALIAN LOWLINE |
| AN | ANGLER |
| AU | AUSTRALIS (SOUTH DEVON/ANGUS) |
| AY | AYRSHIRE |
| BA | BLONDE D'AQUITAINE |
| BB | BRAHMAN |
| BC | BALI CATTLE (BUNTANG) |
| BE | BRALER |
| BF | BRAFORD |
| BG | BRANGUS |
| BH | BRAHMOUSIN |
| BJ | BONSMARA |
| BK | BEEFMAKER |
| BL | BELGIAN BLUE |
| BM | BEEFMASTER |
| BN | BORAN |
| BO | BEEFALO |
| BQ | BOVELDER |
| BR | BELMONT RED |
| BU | BUFFALO |
| BV | BRAUNVIEH |
| BW | BRITISH WHITE |
| BY | BLUE GREY |
| BZ | BARZONA (COMPOSITE) |
| CA | CHIANGUS |
| CB | CHARBRAY |
| CC | CHAROLAIS (& POLL) |
| CD | A.C.D.C |
| CF | CHIFORD |
| CI | CHIANINA |
| CN | CANADIENNE |
| DD | DEVON |
| DK | DRAKENSBERGER |
| DM | DROUGHTMASTER |
| DR | DANISH RED |
| DS | DAIRY SHORTHORN |
| DX | DEXTER |
| FF | HOLSTEIN-FRIESIAN |
| FS | AUSTRALIAN FRIESIAN SAHIWAL |
| GA | GALLOWAY (& BELTED) |
| GC | GASCONNE |
| GG | GUERNSEY |
| GM | GREYMAN |
| GV | GELBVIEH |
| HH | HEREFORD |
| HI | HIGHLAND |
| HU | HUGUENOT |
| HV | HAYES CONVERTER |
| IB | ITALIAN/MEDITERRANEAN BUFFALO |
| IS | AUSTRALIAN ILLAWARRA SHORTHORN |
| JJ | JERSEY |
| KA | AULIEKOL |
| KW | KAZAKH WHITE HEAD |
| LB | LEAN BOS (CHIANINA/SAHIWAL) |
| LH | LONGHORN (TEXAS) |
| LL | LIMOUSIN |
| LR | LINCOLN RED |
| LU | LUING |
| MA | MARCHIGIANA |
| MD | MANDALONG SPECIAL |
| MG | MURRAY GREY |
| MH | MASHONA |
| MI | MUESE-RHINE-ISSEL |
| MO | MONTBELIARDE |
| MS | MILKING SHORTHORN |
| MU | MAINE-ANJOU |
| MZ | AUSTRALIAN MILKING ZEBU |
| NG | NGUNI |
| NL | NELORE |
| NO | NORMANDE |
| OO | UNKNOWN |
| OZ | AUSLINE |
| PH | POLL HEREFORD |
| PM | PIEDMONTESE |
| PR | PIE ROUGE |
| PT | PARTHENAIS |
| PU | PUSTERTALER |
| PZ | PINZGAUER |
| QL | QUEENSLANDER |
| RA | RED ANGUS |
| RB | ROTBUT |
| RC | CRC Tropical Red Composite |
| RF | RED AND WHITE HOLSTEIN FRIESIAN |
| RO | ROMAGNOLA |
| RP | RED POLL |
| RS | RED SINDHI |
| RV | RIVER BUFFALO (MURRAH) |
| SA | SHETLAND |
| SB | BROWN SWISS |
| SC | SIMINDICUS |
| SD | SOUTH DEVON |
| SE | SENEPOL |
| SG | SANTA GERTRUDIS |
| SH | SIMFORD |
| SI | SIMMENTAL (& FLECKVIEH & BLACK & POLL) |
| SK | SPECKLE PARK (Canada) |
| SL | SALERS |
| SM | SIMBRAH |
| SN | SAHIWAL-SHORTHORN |
| SP | SWAMP BUFFALO |
| SQ | SQUARE MEATER |
| SR | SWEDISH RED |
| SS | SHORTHORN (& POLL & BEEF & DURHAM) |
| ST | SUPERTALER |
| SU | SUSSEX |
| SV | SHAVER BEEFBLEND COMPOSITE |
| SW | SAHIWAL |
| TA | TARENTAISE |
| TC | THAI NATIVE - CENTRAL (KO LARN) |
| TH | THAI NATIVE - NORTH EAST (E-SARN RED) |
| TI | TULI |
| TN | THAI NATIVE - NORTH (KAO LAMPOON) |
| TP | TROPICANA (Mandalong x Red Brahman) |
| TS | THAI NATIVE - SOUTHERN FIGHTING |
| TX | TEXON |
| UR | AUSTRALIAN RED |
| UU | SOUTH AFRICAN RED |
| WA | WATUZI |
| WB | WELSH BLACK |
| WY | WAGYU |
| XA | ALEXANDRIA (NAPCO) COMPOSITE |
| XD | MANDALAY COMPOSITE |
| XH | HOTLANDER (SI/BB/SE/RA COMPOSITE) |
| XK | KYNUNA (NAPCO) COMPOSITE |
| XM | MOORELLA COMPOSITE |
| XR | TOORAK COMPOSITE |
| XS | STABILISER (British x Continental) |
| XT | TAURICUS (SD/RA/BJ red composite) |
| XX | SUPERBEEFEX (AACO) COMPOSITE |
| XY | BARKLY (AACO) COMPOSITE |
| ZE | ZEBU |
FatScoreCode
Fat score code provides an assessment of subcutaneous fat without any assessment for muscle.
| Value | Name |
|---|---|
| 1 | 1 to 2mm at 12th rib |
| 2 | 2 to 3mm at 12th rib |
| 3 | 4 to 7mm at 12th rib |
| 4 | 8 to 12mm at 12th rib |
| 5 | 13 to 18mm at 12th rib |
| 6 | Over 18mm at 12th rib |
MuscleScoreCode
Muscle score code
| Name | Value |
|---|---|
| A | Very heavy |
| B | Heavy |
| C | Average |
| D | Light |
| E | Very light |
FrameSizeCode
Frame size following guidelines in MLA national bovine livestock guidelines. Frame size is assessed using a measured height for a specific sex and age. Frame size should remain relative constant throughout an animal's life.
| Value | Name |
|---|---|
| 1 | small 1 |
| 2 | small 2 |
| 3 | moderate 3 |
| 4 | moderate 4 |
| 5 | moderate 5 |
| 6 | large 6 |
| 7 | large 7 |
| 8 | large 8 |
| 9 | huge 9 |
| 10 | huge 10 |
| 11 | huge 11 |
MaturityTypeCode
Maturity type or growth potential is a way of describing the 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.
| Value | Name | Description |
|---|---|---|
| early | Early maturity frame size 1 to 2 | Generally short in every skeletal dimension. Generally, reach market potential at low carcase weights, i.e. 150–180kg carcase weight at 9–12mm of fat at the P8 site. Tendency to have excess fat coverage and therefore low yielding at heavier carcase weights. Lack rapid growth potential. Will generally reach mature cow weights less than 450kg at fat score 3 (7-12mm) |
| moderate | Moderate maturity frame size 3, 4 and 5 | Average growth potential rising to good growth for frame 5s. Generally, reach market potential at carcase weights of 200-350kg with 9–12mm of fat at the P8 site. Suitable for a range of different market. Will generally reach mature cow weights 450-600kg at fat score 3 (7-12mm) |
| late | Late maturity frame size 6, 7 and 8 | Much larger cattle with high growth potential. Reach market potential at heavier carcase weights of 350– 450kg with 9–12mm of fat at the P8 site. Will generally reach mature cow weight greater than 600kg in fat score 3 (7-12mm) |
| veryLate | Very late maturity frame size 9, 10 and 11 | Huge cattle with extreme growth potential, and usually extremely lean |
IcarCategoryCode
ICAR disease category code
| Value | Name |
|---|---|
| 1 | Organ conditions |
| 2 | Reproduction disorders in females |
| 3 | Reproduction disorders in males |
| 4 | Infectious disease and other microbe-related diseases (except local infections of udder and claws) |
| 5 | Parasitoses (parasite infestations) |
| 6 | Metabolic diseases and deficiencies |
| 7 | Poisoning |
| 8 | Behavioural disorders and general findings |
| 9 | Health-related information not representing diagnoses |
TreatmentProductCode
APMVA animal health treatement product code.
Code values for this table can be found here:
https://portal.apvma.gov.au/pubcris
operationalScopeCode
Code list to indicate scope 3 emissions operational boundaries
| Value | Name | Description |
|---|---|---|
| None | Excludes scope 3 | Scope 1 & 2 only |
| CradleToGate | Cradle to gate | Includes upstream scope 3 only |
| CradleToGrave | Cradle to grave | includes full lifecycle (upstream and downstream) scope 3 |
conformityTopicCode
A high level category scheme for product and facility conformity declarations (claims or attestations)
| Value | Name | Description |
|---|---|---|
| environment.energy | Clean energy | claims supporting clean energy transition |
| environment.emissions | GHG emissions | claims supporting GHG emissions reduction |
| environment.water | Water usage | claims supporting minimising water usage impact |
| environment.waste | Waste reduction | claims supporting waste processing and reduction |
| environment.deforestation | Deforestation | claims supporting native forest restoration |
| environment.biodiversity | Biodiversity | claims supporting improved biodiversity outcomes |
| circularity.content | Circular content | claims supporting the use of recycled content in products |
| circularity.design | Circular design | claims supporting product design for circularity outcomes |
| social.labour | Fair work | claims supporting labour rights including fair wages |
| social.rights | Human rights | claims supporting human rights and anti-discrimination |
| social.community | Community development | claims supporting local community development |
| social.safety | Safety | claims supporting process and product safety |
| governance.ethics | Ethics | claims supporting ethical conduct and corporate governance |
| governance.compliance | Regulatory compliance | claims supporting regulatory compliance including taxation and community protection |
| governance.transparency | Transparency | claims supporting transparency and traceability |