Specification
APX Specification: technical documentation
Version 0.16.0 (draft)
Updated 2026-11-02
Six documents in the form of the APDS 4.1 technical documentation
The documents
APX is documented the way APDS 4.1 is: an Overview, an Information Model, a Data Dictionary, a Use Case Document, and, because APX is an API as well as a data model, an Interface Specification and the requests APX makes of APDS. The Information Model, Data Dictionary and Interface Specification are generated from the OpenAPI document, so they can never disagree with it.
| Document | What it holds | |
|---|---|---|
| Overview | What APX is, why it exists, how it relates to APDS, each module and its benefits, security, conformance. | |
| Information Model | The modules, their classes and relationships, enumerations and code lists, with a class diagram for each. | |
| Data Dictionary | Every class, attribute, association, enumeration and code list, in the APDS table format. | |
| Use Case Document | Worked use cases showing how the data and the API are applied, and the module scenario suites. | |
| Interface Specification | Every operation and webhook, with parameters, bodies, responses and scopes. | |
| Requests to APDS | Corrections, Data Dictionary differences, new enumeration values and data elements offered to APDS. |
The sources are in docs/apx-specification/ of the APX repository. The narrower APX Data Specification holds only the data elements proposed to APDS.