# datamodels.jp

> Data models that work in Japan: JSON Schemas (2020-12), JSON-LD @context files and RDFS vocabularies at URLs that never change. Usable as plain JSON, as linked data, and with NGSI-LD brokers. Existing standards (Smart Data Models, the Digital Agency's GIF, RFC 8984) are extended and mapped, not copied.

Every model page is published in Japanese (https://datamodels.jp/models/...) and English (https://datamodels.jp/en/models/...). Exact versions (v1.0.0) never change; major aliases (v1) follow the latest compatible version. Machine-readable list of every model with all its URLs: https://datamodels.jp/catalog.json.

## Guides

- [Tutorial: from a CSV file to a map](https://datamodels.jp/en/guide/tutorial): one real open-data CSV converted into a catalog model, loaded into GeonicDB, queried and shown on a map, step by step
- [Using the models](https://datamodels.jp/en/guide/use): validate JSON, send it to an NGSI-LD broker, use it as linked data
- [Use with GeonicDB](https://datamodels.jp/en/guide/geonicdb): register a catalog model in GeonicDB, then create and query entities
- [Converting data](https://datamodels.jp/en/guide/mapping): convert data that follows a standard into a model with its mapping file (datamodels convert)
- [Adding attributes](https://datamodels.jp/en/guide/extend): add attributes of your own to a catalog model without copying it, and where to host the result
- [Extension builder](https://datamodels.jp/en/guide/builder): build the @context and JSON Schema for your own attributes on a catalog model, in the browser
- [Your own names](https://datamodels.jp/en/guide/names): use your own attribute and type names with JSON-LD aliases, without changing the model
- [URLs and versions](https://datamodels.jp/en/guide/urls): which URL to use, what never changes, versions and deprecation
- [Contributing](https://datamodels.jp/en/guide/contribute): propose or change models, stages and who decides
- [Rules for models](https://datamodels.jp/en/guide/rules): when to define a new type, the rules, mapping to standards, writing examples
- [Listing your extension](https://datamodels.jp/en/guide/list-extension): list the attributes you added to a model under "Extended by" on its page: the issue form, field by field
- [Telling us about another catalog](https://datamodels.jp/en/guide/report-catalog): report a missing catalog of data models or vocabularies: the issue form, field by field
- [Your own data models](https://datamodels.jp/en/guide/own-models): where to publish a model that does not belong in this catalog: your own site (a node) or Smart Data Models
- [Publishing on your own site](https://datamodels.jp/en/guide/own-site): publish your own models with fixed URLs on GitHub Pages with datamodels-toolkit: init, add, check, build, your domain
- [Other data model catalogs](https://datamodels.jp/en/guide/catalogs): catalogs and standards used globally and in Japan, and how this catalog relates to them

## Subject: common (Common / 共通), version 1.0.0

Building blocks that other subjects use as attribute values, such as addresses and geometries. They are value types: used inside an attribute, not as entities of their own.

- [@context](https://datamodels.jp/context/common/v1.jsonld): use this alias in data and Link headers; exact version https://datamodels.jp/context/common/v1.0.0.jsonld for audits and reproducing results
- [Vocabulary](https://datamodels.jp/vocab/common/v1.0.0.jsonld): RDFS classes, subclass relations, ja/en labels
- [Geometry](https://datamodels.jp/en/models/common/Geometry/) (ジオメトリ; value type, draft): A GeoJSON geometry (RFC 7946) as the value of a GeoProperty such as location: Point, LineString, Polygon, their multi forms (MultiPoint, MultiLineString, MultiPolygon), or a GeometryCollection of these. Positions are longitude, latitude and optional altitude, in WGS 84. A model may narrow the allowed types, for example to Point only. JSON Schema: https://datamodels.jp/schema/common/Geometry/v1.0.0.json
- [JapaneseAddress](https://datamodels.jp/en/models/common/JapaneseAddress/) (日本の住所; value type, draft): A Japanese postal address as the value of an address Property. schema.org PostalAddress terms where the meaning matches, plus the Japanese structure (machiaza, chome, banchi, go), JIS and local-government codes, the Address Base Registry town id and the residential-indication flag. Every field is optional; addressText alone is acceptable when the address cannot be structured. JSON Schema: https://datamodels.jp/schema/common/JapaneseAddress/v1.0.0.json

## Subject: decision (Decision / 判定), version 1.0.0

Records of automated decisions (made with an AI or other model): what was decided about, with which rules and version, by which model, the answers and the resulting action, and how a person checked it. Provenance is based on W3C PROV-O.

- [@context](https://datamodels.jp/context/decision/v1.jsonld): use this alias in data and Link headers; exact version https://datamodels.jp/context/decision/v1.0.0.jsonld for audits and reproducing results
- [Vocabulary](https://datamodels.jp/vocab/decision/v1.0.0.jsonld): RDFS classes, subclass relations, ja/en labels
- [Decision](https://datamodels.jp/en/models/decision/Decision/) (判定; entity type, draft): One automated decision about one entity: a model's answers to the questions of a rule set, with probabilities, and the resulting action. JSON Schema: https://datamodels.jp/schema/decision/Decision/v1.0.0.json

## Subject: disaster (Disaster response / 災害対応), version 1.0.0

Data for municipal disaster response: places to evacuate to, facilities where evacuees stay, and how shelters are run during a disaster. It matches the data municipalities and national agencies already publish. Road closures are in the Transportation subject.

- [@context](https://datamodels.jp/context/disaster/v1.jsonld): use this alias in data and Link headers; exact version https://datamodels.jp/context/disaster/v1.0.0.jsonld for audits and reproducing results
- [Vocabulary](https://datamodels.jp/vocab/disaster/v1.0.0.jsonld): RDFS classes, subclass relations, ja/en labels
- [DesignatedShelter](https://datamodels.jp/en/models/disaster/DesignatedShelter/) (指定避難所; entity type, draft): One designated shelter (指定避難所, Basic Act on Disaster Management Art. 49-7), the master record of a facility where evacuees stay for a while, as municipalities register it and GSI publishes it. Opening status and evacuee counts are not here (that is EvacuationShelter, which links here with shelter). JSON Schema: https://datamodels.jp/schema/disaster/DesignatedShelter/v1.0.0.json
- [EvacuationShelter](https://datamodels.jp/en/models/disaster/EvacuationShelter/) (避難所の運用状況; entity type, draft): Operational overlay for one evacuation shelter. The shelter master data (name, location) is not included: the designated shelter is referenced by shelter (DesignatedShelter) or by externalShelterId / nationalShelterId, and one of the three is required. Only opening status and evacuee counts live here. When the shelter is also a designated emergency evacuation site, site links to its EvacuationSite. Models the operation of a 指定避難所 (designated shelter, Basic Act on Disaster Management Art. 49-7), a distinct legal concept from the 指定緊急避難場所 (designated emergency evacuation site, Art. 49-4). JSON Schema: https://datamodels.jp/schema/disaster/EvacuationShelter/v1.0.0.json
- [EvacuationSite](https://datamodels.jp/en/models/disaster/EvacuationSite/) (指定緊急避難場所; entity type, draft): One designated emergency evacuation site (指定緊急避難場所, Basic Act on Disaster Management Art. 49-4), one row of the list a municipality publishes as 自治体標準オープンデータセット dataset 03. Sites are designated per hazard. Opening status and evacuee counts are not here (that is EvacuationShelter). JSON Schema: https://datamodels.jp/schema/disaster/EvacuationSite/v1.0.0.json

## Subject: task (Task management / タスク管理), version 1.0.0

Data for tracking work: what needs to be done, by whom, by when and for which milestone. It covers what issue trackers, calendar to-dos and municipal work orders have in common; status and priority follow RFC 8984 (JSCalendar). System-specific names can be used with aliases.

- [@context](https://datamodels.jp/context/task/v1.jsonld): use this alias in data and Link headers; exact version https://datamodels.jp/context/task/v1.0.0.jsonld for audits and reproducing results
- [Vocabulary](https://datamodels.jp/vocab/task/v1.0.0.jsonld): RDFS classes, subclass relations, ja/en labels
- [Milestone](https://datamodels.jp/en/models/task/Milestone/) (マイルストーン; entity type, draft): A planned target that groups tasks within a project: a version in Redmine, a milestone in GitHub or GitLab, a fix version in Jira. It has a name, a due date and a state. JSON Schema: https://datamodels.jp/schema/task/Milestone/v1.0.0.json
- [Project](https://datamodels.jp/en/models/task/Project/) (プロジェクト; entity type, draft): A grouping of tasks: a project in a tracker, one disaster-response operation, a campaign. Called differently in different settings, with the same common attributes. JSON Schema: https://datamodels.jp/schema/task/Project/v1.0.0.json
- [Task](https://datamodels.jp/en/models/task/Task/) (タスク; entity type, draft): A tracked unit of work: a ticket or issue in a tracker, a calendar to-do, a municipal work order. State and priority follow RFC 8984 (JSCalendar); the source system's own status name and kind are kept in statusLabel and subtype. Location may be any geometry. JSON Schema: https://datamodels.jp/schema/task/Task/v1.0.0.json

## Subject: transportation (Transportation / 交通), version 1.0.0

Data about roads and traffic, based on national standards (the National Police Agency's traffic regulation data format and MLIT's Road Information Provision System).

- [@context](https://datamodels.jp/context/transportation/v1.jsonld): use this alias in data and Link headers; exact version https://datamodels.jp/context/transportation/v1.0.0.jsonld for audits and reproducing results
- [Vocabulary](https://datamodels.jp/vocab/transportation/v1.0.0.jsonld): RDFS classes, subclass relations, ja/en labels
- [RoadRestriction](https://datamodels.jp/en/models/transportation/RoadRestriction/) (通行規制; entity type, draft): One road restriction, including closures: road name, regulated section (point, line or area), status, category and period. JSON Schema: https://datamodels.jp/schema/transportation/RoadRestriction/v1.0.0.json

## Optional

- [catalog.json](https://datamodels.jp/catalog.json): every model with its type IRI, context, schema, vocabulary, example, page (Japanese and English), mapping and adapter URLs, its attributes (type, required, IRI) and the licence (CC0-1.0)
- [Standards covered](https://datamodels.jp/en/guide/standards): every external standard a model is mapped to (EEI, the municipal standard open datasets, GSI, GIF and more), with a link to each field-by-field table
- [AI and agents](https://datamodels.jp/en/ai): how AI is used to make this site, and what agents can use
- [Source repository](https://github.com/geolonia/datamodels): schemas, mappings to other standards, notes
- [Licences](https://datamodels.jp/LICENSE-CONTENT): machine-readable files CC0 1.0, prose CC BY 4.0, code Apache-2.0