AARCHMRS Schema Specification

The AARCHMRS uses the Draft-04 version of json-schema as its schema standard.

Non standard Draft-04 properties used in the schema

As draft-04 json-schema permits additional properties, we have defined some properties to capture more details about some aspects of the schema:

• info (string, strings[]): provides detailed information about any property used inside a schema, it can be used at the the top level to define information about a given sub model. An array of strings are used to make it easier to write multilines in JSON.
• deprecated (boolean): is used for properties that have been deprecated in this version of the schema. For deprecated properties see the info/see section for details.
• see (string): property allows you to reference another property, formats include:
  • Schema.json this will reference the current property in Schema.json
  • Schema.json#another-property this will reference another-property in Schema.json
• examples (array): an array of examples. This comes from Draft-07, and is used to be forward compatible
• license (object): an object containing license information and copyright under which this package is provided.

AARCHMRS defined properties in the schema

Any schema defined property starting with an _ is reserved by the AARCHMRS schema definition, unless it is used inside the _meta property.

• _meta: See Meta for more details.
• _type: This string property is used to map the AARCHMRS json files to the corresponding models. Every schema model must have a _type property. These properties can be namespaced by a ..