API for the Exchange of Medicinal Product Information (APIX)
0.1.0 - ci-build
API for the Exchange of Medicinal Product Information (APIX), published by Gravitate Health Project. 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/cander2/apix-ig/ and changes regularly. See the Directory of published versions
This page outlines a scenario demonstrating the use of the API Exchange IG and Structured Regulatory Correspondence IG for a Type II variation submission to extend the shelf life of a biologic product.
This scenario is for a Type II variation to extend the shelf life of a biologic product from 24 to 36 months. The variation requires updates to labeling (ePI) and pharmaceutical quality (PQI) content. The submission, or Transaction Bundle
, includes a Task
, a DocumentReference
with base64-encoded attachments (application form as a Collection Bundle, ePI Document Bundle, PQI Collection Bundle), and a Provenance
. The EMA processes the Transaction Bundle
, sends a Transaction Bundle
back which includes a LoQ with 10 questions (2 administrative, 3 labeling, 5 CMC) as a Questionnaire
. PharmaInc responds with a Transaction Bundle
that includes a QuestionnaireResponse
(including an SVG image and multi-paragraph text for specific answers). Finally, the EMA issues a Decision Letter Document Bundle
within a final 'Transaction Bundle'. All exchanges use RESTful FHIR APIs per the API Exchange IG.
Figure 1: Flow diagram showing the 5 Step exchange between PharmaInc and the EMA, conducted via FHIR Transaction Bundles over RESTful APIs.
PharmaInc submits a Type II variation to extend the shelf life from 24 to 36 months via a Transaction Bundle to the EMA’s FHIR server (https://ema.example.org/fhir
). The Bundle includes:
Refer to Type II Variation for an example of the Transaction Bundle from the Company to the Regulator which contains the original submission.
The EMA’s FHIR server receives the Transaction Bundle at https://ema.example.org/fhir
, validates it per the API Exchange IG, and processes the resources:
MedicinalProductDefinition/mpd-001
.The EMA prepares to send a List of Questions (LoQ). No new FHIR resources are created in this step.
The EMA compiles a LoQ with 10 questions (2 administrative, 3 labeling, 5 CMC) in a Questionnaire
resource within a Collection Bundle. The Transaction Bundle includes a Task
(requesting responses), the Questionnaire
, and a Provenance
, sent to PharmaInc’s FHIR server (https://pharma-inc.example.org/fhir
).
Questions:
Refer to List of Questions for an example of the Transaction Bundle from the Regulator to the Company which contains the List of Questions.
PharmaInc’s FHIR server processes the LoQ, prepares a QuestionnaireResponse
with answers to all 10 questions, and sends a Transaction Bundle to the EMA’s FHIR server (https://ema.example.org/fhir
). For cmc-4
(container closure system), the response includes a base64-encoded SVG image. For cmc-5
(degradation products), the response includes two paragraphs. The Bundle includes a Task
(indicating completion), the QuestionnaireResponse
, and a Provenance
.
Responses:
Refer to List of Questions Response for an example of the Transaction Bundle from the Company to the Regulator which contains a response to the List of Questions.
The EMA reviews PharmaInc’s LoQ responses and approves the variation. The Decision Letter is a Document Bundle with a Composition
, encoded as base64 data in a DocumentReference
. The Transaction Bundle includes a Task
, the DocumentReference
, and a Provenance
, sent to PharmaInc’s FHIR server (https://pharma-inc.example.org/fhir
).
Refer to Decision Letter for an example of the Transaction Bundle from the Regulator to the Company which contains the Decision Letter.