{
  "id": "dataDictionary.json#",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "A catalogue containing definitions and descriptions of the resource types, resource attributes, and resource associations.",
  "example": "../../examples/full_example.json#/dataDictionary/0",
  "required": ["dictionaryInfo"],
  "additionalProperties": false,
  "properties": {
    "dictionaryInfo": {
      "type": "object",
      "description": "Information describing the dictionary and its source.",
      "example": "../../examples/full_example.json#/dataDictionary/0/dictionaryInfo",
      "required": ["resourceType", "citation", "description"],
      "additionalProperties": false,
      "properties": {
        "citation": {
          "description": "Citation for the dictionary.",
          "example": "../../examples/full_example.json#/dataDictionary/0/dictionaryInfo",
          "$ref": "citation.json#/definitions/dictionary"
        },
        "resourceType": {
          "type": "string",
          "description": "The type of resource described by the dictionary."
        },
        "description": {
          "type": "string",
          "description": "Description of the dictionary."
        },
        "language": {
          "type": "string",
          "description": "Language used within the dictionary. Should be a valid ISO 639-3 code."
        }
      }
    },
    "domain": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Information describing an enumerated list of values.",
        "example": "../../examples/full_example.json#/dataDictionary/0/domain/0",
        "required": ["domainId", "codeName", "description", "member"],
        "additionalProperties": false,
        "properties": {
          "domainId": {
            "type": "string"
          },
          "commonName": {
            "type": "string"
          },
          "codeName": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "member": {
            "type": "array",
            "items": {
              "type": "object",
              "example": "../../examples/full_example.json#/dataDictionary/0/domain/0/member",
              "required": ["name", "value", "definition"],
              "additionalProperties": false,
              "properties": {
                "name": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                },
                "definition": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "entity": {
      "type": "array",
      "items": {
        "type": "object",
        "example": "../../examples/full_example.json#/dataDictionary/0/entity/1",
        "required": ["entityId", "codeName", "definition"],
        "additionalProperties": false,
        "properties": {
          "entityId": {
            "type": "string"
          },
          "commonName": {
            "type": "string"
          },
          "codeName": {
            "type": "string"
          },
          "alias": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "definition": {
            "type": "string"
          },
          "primaryKeyAttributeCodeName": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "index": {
            "type": "array",
            "items": {
              "type": "object",
              "example": "../../examples/full_example.json#/dataDictionary/0/entity/1/index",
              "required": ["codeName", "allowDuplicates", "attributeCodeName"],
              "additionalProperties": false,
              "properties": {
                "codeName": {
                  "type": "string"
                },
                "allowDuplicates": {
                  "type": "boolean"
                },
                "attributeCodeName": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "attribute": {
            "type": "array",
            "items": {
              "type": "object",
              "example": "../../examples/full_example.json#/dataDictionary/0/entity/1/attribute",
              "required": ["codeName", "dataType", "definition", "allowNull"],
              "additionalProperties": false,
              "properties": {
                "commonName": {
                  "type": "string"
                },
                "codeName": {
                  "type": "string"
                },
                "alias": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "definition": {
                  "type": "string"
                },
                "dataType": {
                  "type": "string"
                },
                "allowNull": {
                  "type": "boolean"
                },
                "units": {
                  "type": "string"
                },
                "domainId": {
                  "type": "string"
                },
                "minValue": {
                  "type": "string"
                },
                "maxValue": {
                  "type": "string"
                }
              }
            }
          },
          "foreignKey": {
            "type": "array",
            "items": {
              "type": "object",
              "example": "../../examples/full_example.json#/dataDictionary/0/entity/1/foreignKey",
              "required": ["localAttributeCodeName", "referencedEntityCodeName", "referencedAttributeCodeName"],
              "additionalProperties": false,
              "properties": {
                "localAttributeCodeName": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "referencedEntityCodeName": {
                  "type": "string"
                },
                "referencedAttributeCodeName": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}