DigitalFacilityRecord
version: 0.6.0
DigitalFacilityRecord Domain
Data Model
Data Definitions
DigitalFacilityRecord
A digital verifiable credential holding facility performance information.
| 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 subject of a UNTP Digital Facility Record (DFR) is a Facility | FacilityRecord |
FacilityRecord
The physical site (eg farm or factory) where the product or materials was produced. Including the facility sustainability performance record.
| Property | Definition | Type |
|---|---|---|
| id | An id is not required in the data but jargon requires for blue class which won't redefine credentialSubject | URI |
| facility | The physical site (eg farm or factory) where the product or materials was produced. | Facility |
| conformityClaim | A list of conformity declarations against specific criteria from recognised standards or regulations. | Claim |
RenderTemplate2024
A single template format focused render method--where the content/media type decision becomes secondary (and is expressed separately).See https://github.com/w3c-ccg/vc-render-method/issues/9
| Property | Definition | Type |
|---|---|---|
| name | Human facing display name for selection | Text |
| mediaQuery | Media query as defined in https://www.w3.org/TR/mediaqueries-4/ | Text |
| template | An inline template field for use cases where remote retrieval of a render method is suboptimal | Text |
| url | URL for remotely hosted template | URI |
| mediaType | content/media type for (possible) conneg on the above URL and certainly for display use | Text |
| digestMultibase | Used for resource integrity and/or validation of the inline template |
Text |
WebRenderingTemplate2022
A simple (though non-standard) embedded template.
| Property | Definition | Type |
|---|---|---|
| name | Human facing display name for template | Text |
| template | An inline template field | Text |
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:webvh | URI |
| name | The name of the issuer person or organisation | Text |
| issuerAlsoKnownAs | An optional list of other registered identifiers for this credential issuer | Party |
Party
From unece.untp-core
An organisation. May be a supply chain actor, a certifier, a government agency.
| Property | Definition | Type |
|---|---|---|
| id | The globally unique ID of the party as a URI, ideally as a resolvable ID. | URI |
| name | The registered name of the party within the identifier scheme. | Text |
| registeredId | The registration number (alphanumeric) of the Party within the register. Unique within the register. | Text |
| idScheme | The identifier scheme of the party. Typically a national business register or a global scheme such as GLEIF. | IdentifierScheme |
| description | An optional short description of the party. | Text |
| registrationCountry | the country in which this organisation is registered | Code (countryCode) |
| organisationWebsite | Website for this organisation | URI |
| industryCategory | The industry categories for this organisations. Recommend use of UNCPC as the category scheme. for example - unstats.un.org/isic/1030 | Classification |
| partyAlsoKnownAs | An optional list of other registered identifiers for this organisation. For example DUNS, GLN, LEI, etc | Party |
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 |
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 |
Facility
From unece.untp-core
The physical site (eg farm or factory) where the product or materials was produced.
| Property | Definition | Type |
|---|---|---|
| id | The globally unique ID of the facility as URI, ideally as a resolvable URL. | URI |
| name | The registered name of the facility within the identifier scheme. | Text |
| registeredId | The registration number (alphanumeric) of the facility within the identifier scheme. Unique within the register. | Text |
| idScheme | The ID scheme of the facility. eg a GS1 GLN or a National land registry scheme. If self issued then use the party ID of the facility owner. | IdentifierScheme |
| description | An optional short description of the facility | Text |
| countryOfOperation | The country in which this facility is operating. | Code (countryCode) |
| processCategory | The industrial or production processes performed by this facility. Example unstats.un.org/isic/1030. | Classification |
| operatedByParty | The Party entity responsible for operating the facility.An object structure that uniquely identifies the party within a known party identification scheme. | Party |
| facilityAlsoKnownAs | An optional list of other registered identifiers for this facility - eg GLNs or other schemes. | Facility |
| locationInformation | Geo-location information for this facility as a resolvable geographic area (a Plus Code), and/or a geo-located point (latitude / longitude), and/or a defined boundary (GeoJSON Polygon). | Location |
| address | The Postal address of the location. | Address |
Location
From unece.untp-core
Location information including address and geo-location of points, areas, and boundaries
| Property | Definition | Type |
|---|---|---|
| plusCode | An open location code (https://maps.google.com/pluscodes/) representing this geographic location or region. Open location codes can represent any sized area from a point to a large region and are easily resolved to a visual map location. | URI |
| geoLocation | The latitude and longitude coordinates that best represent the specified location. Using GeoJSON Point notation. | Point |
| geoBoundary | The list of ordered coordinates that define a closed area polygon as a location boundary using GeoJSON polygon notation. | Polygon |
Point
From ietf.GeoJSON
Represents a Point geometry
| Property | Definition | Type |
|---|---|---|
| type | Text | |
| coordinates | Coordinates property of type Point3D | Point3D |
Point3D
From ietf.GeoJSON
Point in 3d space
| Property | Definition | Type |
|---|---|---|
| data | Array of decimal values | Decimal |
Polygon
From ietf.GeoJSON
Represents a Polygon geometry
| Property | Definition | Type |
|---|---|---|
| type | Text | |
| coordinates | Array of PolygonCoordinates | Point3DWrapper |
Point3DWrapper
From ietf.GeoJSON
| Property | Definition | Type |
|---|---|---|
| data | Point3D |
Address
From unece.untp-core
A postal address.
| Property | Definition | Type |
|---|---|---|
| streetAddress | the street address as an unstructured string. | Text |
| postalCode | The postal code or zip code for this address. | Text |
| addressLocality | The city, suburb or township name. | Text |
| addressRegion | The state or territory or province | Text |
| addressCountry | The address country as an ISO-3166 two letter country code. | Code (countryCode) |
Claim
From unece.untp-core
A declaration of conformance with one or more criteria from a specific standard or regulation.
| Property | Definition | Type |
|---|---|---|
| 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 |
| description | A textual description of the declaration being made. | Text |
| 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 |
| 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 |
| 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 (conformityTopicCode) |
| 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 | Party |
| 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 | Party |
| 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 scheme, standard or regulation. For example CO2 emissions calculations for liquid fuel combustion. | URI |
| name | A name that describes this criteria. | Text |
| description | A full text description of the criterion that clearly specifies how compliance is achieved and measured. | Text |
| conformityTopic | A gloabl UN/CEFACT standard sustainability toipic code. | Code (conformityTopicCode) |
| status | The lifecycle status of this criterion. | Code (statusCode) |
| subCriterion | List of criterion that are subordinate to this criterion in the hierarchy. | Criterion |
| thresholdValue | A threshold value that defines the minimum compliance level. | Metric |
| performanceLevel | A performance category code to group criterion in a given hierarchyLevel according to pareformance | Text |
| tags | a category code to represent target stakeholder types or commodity types to which this criteron applies. | Text |
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 |
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) |
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) |
Code Tables
countryCode
Country code list.
Code values for this table can be found here:
https://vocabulary.uncefact.org/CountryId#
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 |
statusCode
| Value | Name | Description |
|---|---|---|
| proposed | ||
| active | ||
| deprecated |
unitOfMeasure
UNECE Recommendation 20 Unit of Measure codelist
Code values for this table can be found here:
https://vocabulary.uncefact.org/UnitMeasureCode#
hashMethodCode
Hash method code list
| Value | Name | Description |
|---|---|---|
| SHA-256 | SHA 256 bit | Secure Hash Algorithm 256 bits |
| SHA-1 | SHA 160 bit | Secure Hash Algorithm 160 bits |
encryptionMethodCode
Encryption method code list
| Value | Name | Description |
|---|---|---|
| none | No encryption | no encryption |
| AES | AES encrypted | Advanced Encryption Standard (AES) |
Imported Domains
- [untp] - unece/untp-core:0.6.0