Skip to content

Organisation Unit Scheme

An Organisation Unit Scheme is an organisation scheme whose items are the units (departments, divisions, etc.) of an organisation. Units can form a hierarchy, but unlike a Category Scheme the hierarchy is not nested: every unit is written in the flat items array and a child names its parent unit with parent. Documents start ref: "OrganisationUnitScheme=AGENCY:ID(1.0)".

The layout is the same as the Agency Scheme, including contacts, with the extra parent field.

Simple form

A unit with an English name only, no parent and no contacts, is written as ID: "name".

format: "fusion-yaml(1.0.0)"
ref: "OrganisationUnitScheme=ACY:OUS(1.0)"
name: "TEST"
items:
- UNIT1: "Unit One"
- UNIT2: "Unit Two"
- UNIT3: "Unit Three"
Source: organisationunitscheme/testScheme.yaml

The document starts with the common header. The body is:

  • items: the units, in scheme order, written as described in Items.

Complex form

A unit becomes an object when it has a parent unit or contacts, as well as for the usual reasons (a description, a non-English name, a uri, annotations or links).

format: "fusion-yaml(1.0.0)"
ref: "OrganisationUnitScheme=ACY:OUS(1.0)"
name: "TEST"
items:
- UNIT1: "Unit One"
- SUB1:
    name: "Sub Unit One"
    parent: "UNIT1"
- SUB11:
    name: "Sub Unit One.One"
    parent: "SUB1"
- UNIT2: "Unit Two"
- SUB2:
    name: "Sub Unit Two"
    parent: "UNIT2"
- UNIT3: "Unit Three"
Source: organisationunitscheme/testHierarchy.yaml

  • parent is the id of the parent unit in the same scheme (not a URN).
  • parent is written after the names and uri, and before contacts.

Field reference

Field Value Written when
partial true The scheme is partial.
items Array of units The scheme has at least one unit.
items[].ID String (the English name), or an object Always, one entry per unit.
items[].ID.name, name-xx Localised text The unit has the name.
items[].ID.description, description-xx Localised text The unit has the description.
items[].ID.uri String The unit has a URI.
items[].ID.parent String, the id of the parent unit The unit has a parent.
items[].ID.contacts Array of contacts The unit has contacts.
items[].ID.annotations Annotations The unit has annotations.
items[].ID.links Links The unit has links.

A unit is written in the simple form when it has exactly one name, in English, no description, no uri, no annotations, no links, no contacts and no parent.