version: 0.0.3
untp-core Domain
Data Model
Data Definitions
VerifiableCredential
A verifiable credential is a digital and verifiable version of everyday credentials such as certificates and licenses. It conforms to the W3C Verifiable Credentials Data Model v2.0 (VCDM)
Property | Definition | Type |
---|---|---|
@context | A list of JSON-LD contect URIs that define the seamntic meaning of prperties within the credential. | Text |
id | A unique identifier (URI) assigned to the product passport. | URI |
issuer | The W3C DID of the Party that issued the verifiable credential. | URI |
type | The credential type. Must include the string "VerifiableCredential" and additionally the specific credential type (eg "UNTPDigitalProductPassport") | Text |
validFrom | The date and time from which the credential is valid. | DateTime |
validUntil | The expiry date (if applicable) of this verifiable credential. | DateTime |
credentialStatus | The status of the verifiable credential - must be an object that conforms to the W3C VCDM 2.0 Status object - https://www.w3.org/TR/vc-data-model-2.0/#status | Text |
Party
The Party class represents an entity such as an organization, or a company that manufactured the product.
Property | Definition | Type |
---|---|---|
partyID | The decentralised identifier of the party - must be a W3C DID. | Identifier |
name | The name of the organization or company, represented as a text string. | Text |
Facility
The physical site (eg farm or factory) where the product or materials was produced.
Property | Definition | Type |
---|---|---|
facilityID | A unique identifier (URI) assigned to the facility. (Link Resolver - GS1 GLN?) | Identifier |
name | The name of the facility, represented as a text string. | Text |
geoLocation | The gelocation of the facility as a URI - typically a plus code (see https://maps.google.com/pluscodes/) | URI |
operatedBy | The Party entity responsible for operating the facility. | Party |
Metric
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 |
---|---|---|
name | A human readable name for this metric | Text |
value | A numeric value representing the measurement or evaluation outcome for the claim. | 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 |
Dimension
Overall (length, width, height) dimensions and weight/volume of an item.
Property | Definition | Type |
---|---|---|
weight | the weight of the product | Measure |
length | The length of the product or packaging | Measure |
width | The width of the product or packaging | Measure |
height | The height of the product or packaging | Measure |
volume | The displacement volume of the product. | Measure |
Classification
A classification scheme and code / name representing a category value for a product, entity, or facility.
Property | Definition | Type |
---|---|---|
schemeID | Classification scheme - eg https://unstats.un.org/unsd/classifications/Econ/cpc | URI |
classifierValue | classifier value within the scheme - eg "01211" in UN CPC | Text |
classifierName | Name of the classifier - eg "Asparagus" for code "01211" in UNCPC | Text |
classifierID | Linked data URL to a web vocabulary entery for this classificaiton code. When this property is provided, the scheme, value, and name properties of the classifer are not required. eg https://vocabulary.uncefact.org/unlocode#AUBNE represensign the port of Brisbane in the UN/LOCODE classification scheme. | URI |
Identifier
An identifier of a party, product, or facility that is defined by an identifier scheme and idenfier value and, optinally, verification evidence
Property | Definition | Type |
---|---|---|
identifierScheme | the identifier scheme as defined by the registrar that manages the identifier registry. If the identifier scheme is registered with UNTP then this URI can use used to dicsover the resolution method (to get more data) and the verification method (to prove ownership). | URI |
identifierValue | The value of the identifier within the scheme | Text |
Measure
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) |
BinaryFile
A file representing a data snapshot that is used to infomr the conformity assessment.
Property | Definition | Type |
---|---|---|
fileHash | The MD5 hash of the file. | Text |
fileLocation | The location of the evidence file. | URI |
fileType | The type of file, represented as a MIME type. | Code (mimeType) |
Code Tables
unitOfMeasure
UNECE Recommendation 20 Unit of Measure codelist
Code values for this table can be found here:
https://vocabulary.uncefact.org/UnitMeasureCode
mimeType
Code values for this table can be found here:
https://mimetype.io/all-types