API for the Exchange of Medicinal Product Information (APIX), published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/APIX---API-Exchange-for-Medicinal-Products/ and changes regularly. See the Directory of published versions

Endpoint/Organization

Page standards status: Informative

Organization and Endpoint

In APIX, Organization and Endpoint work together to represent the parties involved in regulatory exchange and the technical channels used for communication. An Organization represents either an Applicant or a Regulator on the FHIR server and includes the contact and identification details needed throughout a regulatory procedure. Organizations may reference one or more Endpoints, which define the technical connection details for receiving notifications or other machine‑to‑machine interactions.

The Endpoint.managingOrganization element is especially important: it identifies which Organization owns or controls the Endpoint, ensuring that only the appropriate party can modify or maintain the connection details. Together, Organization and Endpoint form the identity and communication layer of the APIX ecosystem.

Example Organization

Example Endpoint

Example Endpoint with header element

---

Organization

Element	Cardinality (APIX)	Value / Example	Purpose / Notes
Organization.identifier	1..*	Globally unique identifier	Primary identity for Applicants and Regulators within APIX
Organization.endpoint	0..*	Reference to Endpoint	Links the Organization to the technical endpoint used for receiving notifications or other automated interactions

---

Endpoint

Element	Cardinality (APIX)	Value / Example	Purpose / Notes
Endpoint.identifier	0..*	Globally unique identifier	Enables reuse across multiple FHIR servers and ensures stable cross‑system identity
Endpoint.connectionType	1..1	hl7-fhir-subscription-notify (or temporary IG code)	Indicates that the Endpoint is used for receiving FHIR Subscription notifications
Endpoint.name	0..1	Human‑readable label	Useful for UI display and administrative clarity
Endpoint.address	1..1	URL e.g. https://example.org/fhir-notify	Where notifications or other machine‑to‑machine messages are delivered
Endpoint.payload and Endpoint.header	0..*	Machine‑readable connection details	May include authentication headers or content‑type declarations; carries security implications
Endpoint.managingOrganization	0..1	Reference to Organization	Indicates which Organization owns and controls the Endpoint configuration