Skip to content

Hierarchy Association

A Hierarchy Association (SDMX 3.0) links a Hierarchy to the structure it applies to, for example a dimension of a data structure, optionally within a context such as a dataflow. A hierarchy association document starts ref: "HierarchyAssociation=AGENCY:ID(1.0)".

Simple form

The document is the common header followed by the hierarchy reference and the reference to the linked structure.

format: "fusion-yaml(1.0.0)"
ref: "HierarchyAssociation=ACY:H1(1.0.2)"
name: "TEST"
hierarchy: "ECB:H_REF_AREA(1.0)"
dimension: "ECB:EXR(1.0).REF_AREA"

Source: hierarchyassociation/testAssoicationToDimension.yaml

  • hierarchy is the reference to the associated hierarchy, as a short URN.
  • The linked structure is written as a reference keyed by the lower-case class of the linked structure, here dimension for a dimension of the data structure ECB:EXR(1.0). A link to a dataflow would be written dataflow: "...", a link to a codelist codelist: "...", and so on.

Complex form

When the association applies only within a context, the context field is added. Because the field name is fixed, the class of the context structure is written in the value, using the canonical form Class=AGENCY:ID(version) (see references).

format: "fusion-yaml(1.0.0)"
ref: "HierarchyAssociation=ACY:H1(1.0.2)"
name: "TEST"
hierarchy: "ECB:H_REF_AREA(1.0)"
dimension: "ECB:EXR(1.0).REF_AREA"
context: "Dataflow=ECB:DF_EXR(2.0)"

Source: hierarchyassociation/testAssoicationContext.yaml

Field reference

Body fields, written after the common header:

Field Value Written when
hierarchy Short URN of the hierarchy Always.
<class> Short URN of the linked structure, keyed by its lower-case class (e.g. dimension, dataflow) Always.
context Canonical reference, e.g. "Dataflow=ECB:DF_EXR(2.0)" The association has a context.

Reading notes

  • The reader relies on field order: the first hierarchy field is read as the associated hierarchy, and any other reference field is read as the linked structure.