Vocab — core domain

The cross-cutting foundation reused by every domain: shared abstractions and value objects, plus parties, places and identifiers.

core overview

References (other domains): conformity → Attestation; finance → Account; production → Claim, Material, MaterialUsage, ProductBatch, ProductionProcess; regulatory → GovernmentRegistration; trade → SupplyChainInventory

Classes

19 classes.

Class	Definition
`Address`	A postal/physical address of a party or location.
`Communication`	The exchange of thoughts, messages, or information, as universally exchanged by speech, signals, writing, or behaviour between persons and/or organizations.
`Coordinate`	A geographic point defined by latitude and longitude (WGS 84).
`Dimension`	Overall length, width, height, weight and volume of an item.
`Facility`	The physical site (e.g. farm or factory) where a product or materials are produced, handled or stored.
`Identifier`	A single identifier issued for an entity within a scheme: the registered value plus the issuing scheme, with an optional label.
`IdentifierScheme`	An identifier registration scheme for products, facilities, or organisations.
`Image`	A binary image encoded as base64 text with its media type.
`Link`	A URL link plus associated metadata (name, type, hash).
`Location`	A place — address and/or geo-location of a point, area or boundary.
`Measure`	A numeric value together with its unit of measure.
`MonetaryAmount`	A monetary value together with its currency.
`Organisation`	An organisational party.
`Party`	An actor in the supply chain. Roles (buyer, seller, carrier, importer, …) are properties whose range is Party, not subclasses.
`PartyRole`	A party in the role it plays relative to a referencing entity (party + role, optionally on-behalf-of). An identity-less value object, not a party-register entry.
`Period`	A period of time (e.g. a month, quarter or year).
`Person`	An individual party.
`RegisteredIdentity`	The registration of a party’s identity in an official register (the subject of a Digital Identity Anchor).
`TradeDocument`	A thin anchor for an exchanged business document: a grouping of domain concepts identified by a documentType code. Its structure is defined in downstream schemas, not in this vocabulary.

Class detail

Address

Address detail

Property	Type
`additionalStreetName`	string
`addressCountry`	country-id
`addressLocality`	string
`addressRegion`	string
`addressTypeCode`	address-type-code-list
`attentionOf`	string
`buildingName`	string
`buildingNumber`	string
`careOf`	string
`citySubDivisionName`	string
`departmentName`	string
`freeForm`	string
`geoCoordinate`	Coordinate
`lineFive`	string
`lineFour`	string
`lineOne`	string
`lineThree`	string
`lineTwo`	string
`postalCode`	string
`postOfficeBoxNumber`	string
`streetAddress`	string

Communication

Communication detail

Property	Type
`access`	string
`areaNumberCode`	any-code
`communicationChannelCode`	communication-channel-code-list
`completeNumber`	string
`countryNumberCode`	itu-calling-code
`emailURIId`	anyURI
`extensionNumber`	string
`hTMLPreferredIndicator`	string
`invalidIndicator`	string
`localNumber`	string
`uRIId`	anyURI
`useCode`	any-code
`websiteURIId`	anyURI

Coordinate

Property	Type
`latitude`	decimal
`longitude`	decimal

Dimension

Property	Type
`dimensionTypeCode`	dimension-type-code-list
`height`	Measure
`length`	Measure
`volume`	Measure
`weight`	Measure
`width`	Measure

Facility

Facility detail

Property	Type
`identifier`	Identifier
`alsoKnownAs`	Party
`alsoKnownAs`	Facility
`completionDate`	date
`constructionDate`	date
`countryOfOperation`	country-id
`description`	string
`facilityMaterialUsage`	MaterialUsage
`licence`	string
`locatedAt`	Location
`name`	string
`operatedBy`	Organisation
`performanceClaim`	Claim
`postalAddress`	Address
`processCategory`	any-code
`registrationId`	Identifier
`relatedDocument`	Link
`relatedParty`	PartyRole
`renovationDate`	date
`subordinateFacility`	Facility

Identifier

Property	Type
`idScheme`	IdentifierScheme
`name`	string
`registeredId`	string

IdentifierScheme

Property	Type
`identifier`	Identifier
`description`	string
`name`	string

Image

Property	Type
`applicableMaterial`	Material
`imageData`	string
`mediaType`	string

Link

Property	Type
`digestMultibase`	string
`linkName`	string
`linkType`	string
`linkURL`	anyURI
`mediaType`	string

Location

Location detail

Property	Type
`identifier`	Identifier
`countryName`	string
`description`	string
`geoBoundary`	Coordinate
`latitude`	decimal
`locationName`	string
`locationTypeCode`	location-function-code-list
`longitude`	decimal
`name`	string
`physicalGeographicalCoordinate`	Coordinate
`physicalGeographicalPoint`	Coordinate
`plusCode`	string
`postalAddress`	Address
`specifiedFacility`	Facility
`specifiedInventory`	SupplyChainInventory
`stayPeriod`	Period
`unLocationCode`	un-locode

Measure

Property	Type
`lowerTolerance`	decimal
`unitCode`	unit-of-measure
`upperTolerance`	decimal
`value`	decimal

MonetaryAmount

Property	Type
`currency`	currency-code-list
`value`	decimal

Organisation

Organisation detail

Property	Type
`identifier`	Identifier
`brandName`	string
`description`	string
`industryCategory`	isic
`legalName`	string
`leiCode`	string
`name`	string
`registrationCountry`	country-id
`registrationId`	Identifier
`tradingBusinessName`	string

Party

Party detail

Property	Type
`identifier`	Identifier
`allianceName`	string
`alsoKnownAs`	Party
`alsoKnownAs`	Facility
`chainName`	string
`contact`	Person
`contactTypeCode`	contact-type-code-list
`definedContact`	Party
`description`	string
`email`	string
`endPointURICommunication`	Communication
`faxNumber`	string
`financialAccount`	Account
`hasAttestation`	Attestation
`name`	string
`partyTypeCode`	party-type-code-list
`postalAddress`	Address
`providedProcess`	ProductionProcess
`relatedBatch`	ProductBatch
`relatedMaterial`	Material
`salesManagerName`	string
`specifiedGovernmentRegistration`	GovernmentRegistration
`specifiedLegalOrganization`	Organisation
`taxId`	Identifier
`telephone`	string
`tradePartyLanguageCode`	language-code-list
`website`	anyURI

PartyRole

Property	Type
`actingParty`	Party
`onBehalfOf`	Party
`role`	party-role

Period

Property	Type
`endDate`	date
`periodInformation`	string
`startDate`	date

Person

Property	Type
`identifier`	Identifier
`description`	string
`familyName`	string
`givenName`	string
`jobTitle`	string
`name`	string

RegisteredIdentity

RegisteredIdentity detail

Property	Type
`identifier`	Identifier
`description`	string
`name`	string
`publicInformation`	anyURI
`registeredDate`	date
`registeredName`	string
`registerType`	registry-type
`registrar`	Party
`registrationId`	Identifier
`registrationScope`	anyURI

TradeDocument

Property	Type
`identifier`	Identifier
`description`	string
`documentType`	document-type
`name`	string
`placeOfIssue`	Location
`referencedDocument`	TradeDocument

Code lists

32 schemes · 4368 concepts.

Code list	Concepts	Structure
Unit of measure	1383	flat · 30 collections
Document type	822	hierarchy
Language	370	flat
Status	352	flat
Location Function	315	flat
Measured Attribute	292	flat
Country	249	flat
Currency	179	flat
Contact Type	104	flat
Time Reference	65	flat
Document Status	51	flat
Communication Channel	47	flat
Party role	46	hierarchy · 5 collections
Dimension Type	24	flat
Workflow Status	24	flat
Address Type	8	flat
Organization Function Type	6	flat
Priority Description	6	flat
Registry Type	6	flat
Party Type	5	flat
Vocab term status	4	flat
Address Format Type	3	flat
Vocab code list scope	3	flat
Vocab object nature	2	flat
Validation Document Status	2	flat
Vocab any code	0	flat
Harmonized System (HS)	0	flat
ISIC (International Standard Industrial Classification)	0	flat
ISO 3166-2 (country subdivisions)	0	flat
ITU-T E.164 country calling codes	0	flat
UN number (Dangerous Goods)	0	flat
UN/LOCODE	0	flat