Domain objects

Overview

This topic discusses the JSON representation of domain objects. Domains specify the set of valid values for a field.

The following domain objects are discussed:

  • Range Domain
  • Coded value domain
  • Inherited domain

Range domain

Range domain specifies a range of valid values for a field. The type property for range domains is range.

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "type": "range",
  "name": "<domainName>",
  "range": [ <minValue>, <maxValue> ]
}

Coded value domain

Coded value domain specifies an explicit set of valid values for a field. Each valid value is assigned a unique name. The type property for coded value domains is codedValue.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "type": "codedValue",
  "name": "<domainName>",
  "codedValues": [
  {"name": "<codeName1>", "code": <code1>},
  {"name": "<codeName2>", "code": <code2> }
  ]
}

Inherited domain

Inherited domains apply to domains on subtypes. It implies that the domain for a field at the subtype level is the same as the domain for the field at the layer level.

Use dark colors for code blocksCopy
1
2
3
{
  "type": "inherited"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.