vocab - CDSM-WG/CDS-M GitHub Wiki
JsonLD vocabulary of CDS-M
The list of the most important concepts:
- specification
- meta data
- use case
- standard
- contract part
- metrics
- term or condition
- transport condition
- processing condition
- archive condition
specification
Definition: The specification specifies all known dimensions of data exchange. The contract parts, the technical parts, the conditions for transport, processing and archiving, but specifies also the scores on personal aspects and interoperability.
{
"@context": {
"@vocab": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#specification",
"metaData": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#meta-data",
"useCases": { "@id" : "https://github.com/CDSM-WG/CDS-M/blob/main/jsonld/use-case.jsonld", "@container": "@set" },
"standards": { "@id" : "https://github.com/CDSM-WG/CDS-M/blob/main/jsonld/standard.jsonld", "@container": "@set" },
"termsAndConditions": { "@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#term-or-condition", "@container": "@set" },
"contractParts": { "@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#agreements", "@container": "@set" },
"transport": { "@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#transport-condition", "@container": "@set" },
"processing": { "@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#processing-condition", "@container": "@set" },
"archive": { "@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#archive-condition", "@container": "@set" }
}
}
meta data
Definition: contains the data related to the contract itself, like who's involved, what are their roles and when is the contract valid.
Attributes:
name | type | cardinality | explanation |
---|---|---|---|
specificationVersion | text | 1 | the version number of this instance of a specificationfirst number = use case selectionsecond = ict configurationthird = contract configuration |
contractors | contractor | 1..n | contract parties |
roles | enum [SUPPLIER, CONSUMER, BOTH] | 1..n | roles of the parties, corresponding to the contractor on the same index |
startValidity | date | 0..1 | start date of the contract, only applicable at contract level |
endValidity | date | 0..1 | end date of the contract, only applicable at contract level |
{
"@id": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#meta-data",
"@type": "metaData",
"@context": {
"@vocab": "https://github.com/CDSM-WG/CDS-M/wiki/vocab/",
"specificationVersion": { "@id": "http://purl.org/dc/terms/hasVersion" },
"contractors": { "@id": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#contractor", "@container": "@list" },
"roles": { "@id": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#role", "@container": "@list" },
"startValidity": { "@id": "http://www.w3.org/2001/XMLSchema#date" },
"endValidity": { "@id": "http://www.w3.org/2001/XMLSchema#date" },
}
}
use case
Definition:
Attributes:
{
"@context": {
"@vocab": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#use-case",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"id": {
"@id": "https://schema.org/identifier",
"@type": "xsd:text"
},
"externalReference": {
"@id": "https://schema.org/URL",
"@type": "xsd:text"
},
"story": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#story",
"benefits": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#solution",
"problemsSolved": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#solution",
"standards": "https://raw.githubusercontent.com/CDSM-WG/CDS-M/building-blocks-proposal/standard.jsonld",
"metrics": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#metrics",
"termsAndConditions": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#term-or-condition",
"agreements": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#agreements",
"transport": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#transport-condition",
"processing": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#processing-condition",
"archive": "https://github.com/CDSM-WG/CDS-M/wiki/vocab#archive-condition",
}
}
standard
Definition:
Attributes:
{
"@context": {
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#standard",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"type": {
"@type": "xsd:text"
},
"name": {
"@id": "https://schema.org/identifier",
"@type": "xsd:text"
},
"bbversion": {
"@type": "xsd:number",
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#building-block-version"
},
"description": {
"@type": "xsd:text"
},
"conflicts": { "@id" : "https://schema.org/URL", "@container": "@set", "@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#conflict" },
"conflictsWhenNotMet": { "@id" : "https://schema.org/URL", "@container": "@set", "@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#unmet-conflict" },
"part": {
"@id": "https://schema.org/identifier",
"@type": "xsd:text",
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#standard-part"
},
"version": {
"@id": "https://schema.org/identifier",
"@type": "xsd:text"
},
"externalReference": { "@id" : "https://schema.org/URL" },
"exchangeType": {
"@type": "xsd:text",
"enum": ["API", "SOAP", "file-based"],
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#exchange-type"
},
"url": { "@id" : "https://schema.org/URL" },
"authentications": { "@id" : "https://schema.org/URL", "@container": "@set", "@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#authentication-methods" },
"explanation": { "@type": "xsd:text" },
"privacy": {
"@type": "xsd:text",
"enum": ["A", "B", "C", "D", "E"],
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#privacy-scale"
},
"implementationEffort": {
"@type": "xsd:text",
"enum": ["A", "B", "C", "D", "E"],
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#implementation-effort-scale"
},
"reusability": {
"@type": "xsd:text",
"enum": ["A", "B", "C", "D", "E"],
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#reusability-scale"
},
"interoperability": {
"@type": "xsd:text",
"enum": ["A", "B", "C", "D", "E"],
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#interoperability-scale"
},
"domain": {
"@type": "xsd:text",
"enum": ["A", "B", "C", "D", "E"],
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#domain-fit-scale"
},
"fieldModifications": { "@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#field-modification",
"@container": "@set" },
"mediumType": {
"@type": "xsd:text",
"enum": ["json-file", "xml-file", "comma-delimited-csv-file", "semicolon-delimited-csv-file", "pipe-delimited-csv-file", "shapefile"],
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#medium-type"
},
"schema": {
"@type": "xsd:text",
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#standard-schema"
},
"refreshRate": {
"@type": "xsd:number",
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#refresh-rate"
},
"aggregationLevel": {
"@id" : "https://schema.org/URL",
"@vocab" : "https://github.com/CDSM-WG/CDS-M/wiki/vocab#aggregation-level"
}
}
}
metric
Definition:
Attributes:
contract part
Definition:
Attributes:
term or condition
Definition:
Attributes:
transport condition
Definition:
Attributes:
processing condition
Definition:
Attributes:
archive condition
Definition:
Attributes:
supporting objects
aggregation level
Definition:
Attributes:
authentication method
Definition:
Attributes:
building block version
Definition:
Attributes:
conflict
Definition:
Attributes:
conflict not met
Definition:
Attributes:
contractor
Definition: The formal name of the contractor
Type: text
data protection scale
Definition:
Attributes:
domain fit scale
Definition:
Attributes:
exchange type
Definition:
Attributes:
field modification
Definition:
Attributes:
implementation effort scale
Definition:
Attributes:
interoperability scale
Definition:
Attributes:
medium type
Definition:
Attributes:
"json-file", "xml-file", "comma-delimited-csv-file", "semicolon-delimited-csv-file", "pipe-delimited-csv-file", "shapefile"
privacy scale
Definition:
Attributes:
refresh rate
Definition:
Attributes:
reusability scale
Definition:
Attributes:
role
Definition: Role of the contractor
Type: text, allowed values: SUPPLIER, CONSUMER, BOTH
solution
Definition: a description of the solution and to whom it applies Attributes:
name | type | cardinality | explanation |
---|---|---|---|
to | text | 1 | The role to whom it applies |
items | text | 1..n | The description of the solution |
standard part
Definition:
Attributes:
standard schema
Definition:
Attributes:
story
Definition: The user story of this use case Attributes:
name | type | cardinality | explanation |
---|---|---|---|
asA | text | 1 | Stakeholder name, f.x. 'city' |
iWouldLikeTo | text | 1 | measurable information |
inOrderTo | text | 1..n | describe the reason(s) to request this data, array |