Interactive explainer · generic healthcare examples

How a Metadata Registry, Data Dictionary, Data Catalogue, Terminology Service and Data Contract fit together

These concepts are often described with abstract language. This demonstrator starts with the practical questions that each service answers, then follows example data fields through a working registry, the dictionary published from it, a data catalogue and the data contracts that apply them.

Organisation-neutral Healthcare examples For policy, clinical, data and digital professionals

Start with six different questions

The easiest way to understand the architecture is to stop thinking about products and start with the question a user is trying to answer. The services overlap, but they are not interchangeable. Each has a different job.

Data Dictionary
“What does this data item mean?”

A human-readable publication of agreed data definitions. It helps clinicians, analysts, programme teams and suppliers understand a field consistently.

  • Plain-language definition
  • Business context
  • Data type and examples
  • Owner or steward
  • Links to controlled values
Think of it as: the published glossary people consult.
Metadata Registry
“What is the governed record behind that definition?”

The controlled system of record for metadata. It gives the definition an identifier, version, status, provenance and formal relationships to other metadata.

  • Persistent identifiers
  • Versions and lifecycle status
  • Approval history
  • Concept and representation
  • Machine-readable relationships
Think of it as: the governed catalogue database behind the published glossary.
Terminology Service / CTS
“Which clinical concepts, codes and value sets are available?”

A terminology service manages controlled clinical vocabularies, value sets and maps. It is where the meaning of clinical codes is maintained and versioned. The binding recorded in the registry or a contract decides which of them are permitted in a particular field.

  • Code systems
  • Value sets
  • Synonyms and hierarchy
  • Terminology versions
  • Mappings and validation
Think of it as: the authoritative vocabulary service, not a copy of the vocabulary inside the dictionary.
Reference Data Service
“Which shared operational values are valid?”

A reference-data service supplies reusable lists such as organisations, facilities, countries, care settings or service types. These values may be used by many systems.

  • Organisations and sites
  • Geographies
  • Service classifications
  • Identifier namespaces
  • Operational code lists
Think of it as: the authoritative list provider for reusable operational values.
Data Contract
“What must a producer supply, and what may a consumer rely on?”

A context-specific agreement for a data product, feed or API. It reuses governed definitions and then adds obligations such as required fields, quality rules and timeliness.

  • Required and optional fields
  • Quality and completeness rules
  • Timeliness and frequency
  • Version compatibility
  • Change and support arrangements
Think of it as: the rules of use for a particular exchange or dataset.
Data Catalogue
“What data assets exist, and where?”

A catalogue helps people discover feeds, datasets, tables and reports, with their owners, locations, access routes and sensitivity. It points to registry definitions for the meaning of each field rather than defining fields itself.

  • Asset descriptions and owners
  • Location and access route
  • Refresh and sensitivity
  • Link to any data contract
  • Field-to-registry mappings
Think of it as: the library index that tells you which books exist and where they are shelved.
The critical design principle: define once, reference many times. A data contract should reference the registered data element. The registered data element should reference a terminology value set or reference-data list. The dictionary should publish those relationships for people to understand. None of these layers should create its own conflicting copy.

The whole pattern in one picture

Relationship between dictionary, registry, terminology, reference data and contracts A metadata registry is the governed metadata system of record. A data dictionary is published from it. Terminology and reference data services remain authoritative for controlled values. Data contracts reference the registered definitions and bindings for a particular data exchange. Metadata Registry governed metadata system of record IDs · versions · status · provenance · relationships · bindings Data Dictionary human-readable publication meaning · scope · examples · ownership Terminology Service / CTS clinical concepts · value sets · maps versioned terminology content Reference Data Service organisations · locations · shared lists authoritative operational values Data Contract applies the registered definitions to one API, feed, dataset or data product publishes a view stores binding to stores reference to contract references registered IDs Data Catalogue feeds · datasets · tables · reports what exists, who owns it, where it is fields map to registered IDs
The dictionary is not usually a second master store. A mature design treats it as one or more user-friendly views published from the registry. That prevents the human definition and the machine-governed definition drifting apart.
The registry should not copy every code list. It should record which controlled vocabulary or reference list applies, including the version or binding strength where relevant. The owning service remains authoritative for the values.

What belongs where?

A common cause of confusion is that the same data item appears in several places. That is intentional. Each service holds a different kind of information about the same thing. The test is not “where does the field appear?” but “which service is authoritative for this aspect?”

Three boundaries that matter

Meaning versus permissible values

The dictionary explains what diagnosis means in this organisation. The terminology service supplies the permissible diagnosis concepts and codes. Copying the entire diagnosis terminology into the dictionary would create a second, quickly outdated source.

Definition versus representation

The concept “date of birth” is independent of whether one interface sends YYYY-MM-DD and another system stores a database date type. The registry can separate the concept from each technical representation while the dictionary presents the common meaning.

Reusable metadata versus context-specific rules

The dictionary may say what “discharge destination” means. A specific discharge feed may make it mandatory, require delivery within five minutes and limit it to a particular value set. Those are contract rules, because they apply to that specific exchange.

Try the “where should this live?” check

Choose an answer. Some organisations may implement the boundary differently, but the explanations show the preferred separation of concerns.

Follow one field from concept to use

The abstract terms become easier when we follow a single field. Select an example below. The same field is shown as a plain-language definition, a governed registry record, a controlled-value binding and a contract obligation.

Inside a metadata registry

A registry can model a data element as several related objects rather than as one long spreadsheet row. This may look unnecessarily formal until definitions have to be reused across hundreds of systems. The separation lets the same business concept use different representations without redefining the concept.

1Object classThe kind of thing being described, such as Person, Encounter, Observation or Organisation.
2PropertyThe characteristic of that thing, such as date of birth, start time, status or identifier.
3Data Element ConceptObject class + property. This captures meaning without yet fixing the technical representation.
4Data Element + Value DomainThe concept combined with an allowed representation, datatype, unit, terminology or reference-data binding.
Why this helps: “Person date of birth” can remain one stable concept while different systems map their local fields to it. A registry can record those mappings, versions and contexts rather than forcing every system to adopt the same physical database design.

Metadata registry: the governed record

This tab shows how a registry works in practice. Every record has a persistent identifier, version, registration status, steward, value-domain binding, relationships, implementation mappings and change history. The Dictionary and Data catalogue tabs read from these records; they do not hold their own copies.

Illustrative records. The stewards, dates, versions, approval decisions, value-set identifiers and local systems are made up for teaching. They do not describe any real registry. Registration statuses follow ISO/IEC 11179 terms: Candidate, Recorded, Qualified, Standard and Retired.
Registry IDData elementVersionStatusSteward

Common value-domain patterns

Primitive value

A date, integer, decimal, Boolean or text value. The registry defines datatype and format. No external code list may be needed.

date of birth discharge date and time

Terminology-coded value

The field carries a concept selected from a controlled clinical vocabulary or value set managed by a terminology service.

diagnosis laboratory test

Reference-data value

The field selects from an authoritative operational list such as an organisation, facility, country or care setting.

organisation identifier care setting

Composite value

The meaning depends on several linked elements, such as a measured value plus unit, method and effective time.

laboratory result blood pressure

Data dictionary: the published view

The dictionary is generated from the registry. It publishes only records at Standard or Qualified status, and it presents the same record at the level of detail each reader needs. Change the reader below: the definition stays the same and the detail around it changes.

Data catalogue: what exists, and where

A catalogue describes data assets: feeds, datasets, tables and reports. It tells users what exists, who owns it, where it is held and how to get it. It does not define what the fields mean. Instead, each asset maps its local fields to registry elements, so anyone who finds a dataset can see which governed definitions it uses and how well each field matches.

Illustrative assets. The assets, owners and local field names are made up. Four of the assets have data contracts. The other two do not, which is common in practice.

Data contracts make the metadata operational

A data contract is the point where shared definitions become obligations for a particular data product, feed or API. It is not the place to invent new meanings. It should reference the registered definitions, then add the rules that a producer and consumer need in that context.

A contract usually answers

  • Who produces the data and who consumes it?
  • What business purpose is the exchange serving?
  • Which registered data elements are in scope?
  • Which are required, optional or conditionally required?
  • Which terminology or reference-data bindings apply?
  • What quality, timeliness and completeness can consumers rely on?
  • What versioning and change-notice rules apply?
  • What happens when validation fails?

A contract should not become

  • a second data dictionary;
  • a copied terminology value set that silently becomes stale;
  • a substitute for the source system's clinical or business rules;
  • a vague statement that “data will be high quality” without measurable criteria;
  • an interface specification with no semantic identifiers;
  • a permanent promise that prevents controlled evolution.

Note: “contract” here means a governed data agreement. Procurement or legal documents may reference it, but the concept is broader than a legal contract.

Why referencing matters

Fragile pattern

Every interface document contains its own definition of “care setting”, copies a list of codes into an appendix and uses locally invented names. Six months later the values differ between interfaces and no one can tell which list is current.

Result: semantic drift, duplicated maintenance and expensive reconciliation.

Governed pattern

The contract references registered data element DE-CARE-SETTING and value-set binding VS-CARE-SETTING. The registry records provenance and status. The terminology or reference-data service supplies the current permitted values.

Result: one definition, one governed value source and many controlled uses.

Governance is what makes the architecture trustworthy

The technology is the easy part. The hard part is agreeing who can define, approve, change and retire metadata. A registry is valuable because it makes those decisions explicit and traceable.

1
Identify need

A programme, service or analyst needs a shared definition.

2
Define concept

Agree the business meaning before choosing a technical format.

3
Register

Assign persistent ID, steward, provenance and initial status.

4
Specify representation

Datatype, cardinality, units and value-domain pattern.

5
Bind values

Reference terminology or authoritative reference data where required.

6
Review & approve

Check semantics, safety, legal constraints and technical feasibility.

7
Publish

Expose human-readable dictionary views and machine-readable metadata.

8
Apply in contracts

Use registered IDs in APIs, feeds, datasets and procurements.

9
Monitor & evolve

Version changes, deprecate safely and preserve history.

What a useful registry records

Identity and meaning

Persistent identifier, preferred name, definition, synonyms, domain, object class, property and usage context.

Representation

Datatype, format, unit, cardinality, conceptual domain, value domain and any terminology or reference-data binding.

Governance

Steward, registration status, version, approval date, effective date, provenance, evidence, change history and retirement status.

Relationships

Broader and narrower concepts, component fields, aliases, maps, equivalence claims and relationships to datasets or contracts.

Implementation mappings

How local database columns, message fields, API properties or legacy codes correspond to the registered element.

Assurance information

Validation rules, known limitations, quality expectations, jurisdiction, sensitivity and constraints on reuse where appropriate.

Versioning rule of thumb: a wording clarification that does not change meaning may be a minor metadata revision. A change that alters the meaning, value domain or consumer expectation may require a new version, transition period or sometimes a new identifier. The governance process should make this predictable.

Common questions and misconceptions

Practical implementation principles

Start with high-value shared concepts

Do not attempt to register every database column in the enterprise on day one. Start with the data that is exchanged, reused, regulated, reported nationally or required by major transformation programmes.

Publish role-specific dictionary views

A clinician, analyst and integration engineer may need different detail, but they should be looking at views of the same registered metadata rather than separate definitions.

Bind, do not copy

If an authoritative terminology or reference-data source exists, the registry should point to it. Copying lists into spreadsheets creates unmanaged forks.

Make contracts machine-checkable where practical

Contract rules are more useful when validation can be automated. Required fields, datatype, code bindings and quality rules can often be tested at build and run time.

Preserve local mappings

Standardising metadata does not require every system to have the same physical schema. Register mappings from local fields to shared concepts and assess whether the mapping is exact, broader, narrower or lossy.

Treat metadata as a service

The registry, dictionary, terminology and reference-data capabilities need owners, APIs, support, release management and service levels. A static spreadsheet is a useful seed but not a sustainable enterprise service.

Illustrative educational demonstrator. It describes a generic service pattern and does not prescribe a particular product, standard or organisational implementation. All registry records, stewards, dates, value-set identifiers, catalogue assets and contracts are made up for teaching.