Skip to content

Mapping

Referenced schema · Source · Dereferenced version

A join record linking a concept's primary coding to an alternate coding in another system, with a SKOS relation.

Fields

Field Type Required Description
id string matching ^map:.+::.+$ yes
primary_coding_id string matching ^coding:[a-z]+:.+$ yes Foreign key to codings.id.
coding_id string matching ^coding:[a-z]+:.+$ yes Foreign key to codings.id.
relation one of broadMatch, closeMatch, exactMatch, narrowMatch, relatedMatch yes

JSON Schema

Full JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://moalmanac.org/schemas/referenced/mappings.schema.json",
  "title": "Mapping",
  "description": "A join record linking a concept's primary coding to an alternate coding in another system, with a SKOS relation.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^map:.+::.+$"
    },
    "primary_coding_id": {
      "type": "string",
      "pattern": "^coding:[a-z]+:.+$",
      "description": "Foreign key to `codings.id`."
    },
    "coding_id": {
      "type": "string",
      "pattern": "^coding:[a-z]+:.+$",
      "description": "Foreign key to `codings.id`."
    },
    "relation": {
      "enum": [
        "broadMatch",
        "closeMatch",
        "exactMatch",
        "narrowMatch",
        "relatedMatch"
      ]
    }
  },
  "required": [
    "id",
    "primary_coding_id",
    "coding_id",
    "relation"
  ],
  "additionalProperties": false
}