Users can choose which of the two APIs best supports the standards they have in place and the goals of their service, the ORD compatible API or the FHIR compatible API, or can use both. The ORD compatible API contains the full record from ODS, and the FHIR compatible API contains a reduced dataset, most useful for helping with transactions.
High level technical illustration
ORD compatible API
This API is designed to be compatible with the Organisation Reference Data (ORD) standard and contains the full record from ODS.
Users who have adopted the ORD standard and who want to hold data locally.
The ORD compatible API:
the user baselines data using the XML products and connects to the service to retrieve updates at a time that suits the user
the user synchronises changes into a local data store via the 'LastChangeDate' mechanism which allows users to retrieve records which have changed
All attributes from:
Organisation (such as OrgID, Name, Open Date, Close Date, LastChangeDate, Status)
Geographic Location (Address Details)
Contacts (mailto, http, tel, fax)
Roles (Primary and Non-Primary Roles)
Relationships (Legal and Operational Relationships including history where this has been captured by ODS)
Succession (History of legal Succession following reconfiguration/mergers, etc.)
Additional Attributes (Data Items included to support policy and pragmatic change)