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/HL7/APIX---API-Exchange-for-Medicinal-Products/ and changes regularly. See the Directory of published versions
<Task xmlns="http://hl7.org/fhir">
<id value="scenario1-04-finance-payment"/>
<meta>
<versionId value="2"/>
<lastUpdated value="2025-03-06T14:00:00+01:00"/>
<profile
value="http://hl7.org/fhir/uv/apix/StructureDefinition/apix-task"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Task scenario1-04-finance-payment</b></p><a name="scenario1-04-finance-payment"> </a><a name="hcscenario1-04-finance-payment"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">version: 2; Last updated: 2025-03-06 14:00:00+0100</p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-apix-task.html">APIX Regulatory Task</a></p></div><p><b>identifier</b>: <a href="http://terminology.hl7.org/7.0.1/NamingSystem-uri.html" title="As defined by RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt)(with many schemes defined in many RFCs). For OIDs and UUIDs, use the URN form (urn:oid:(note: lowercase) and urn:uuid:). See http://www.ietf.org/rfc/rfc3001.txt and http://www.ietf.org/rfc/rfc4122.txt
This oid is used as an identifier II.root to indicate the the extension is an absolute URI (technically, an IRI). Typically, this is used for OIDs and GUIDs. Note that when this OID is used with OIDs and GUIDs, the II.extension should start with urn:oid or urn:uuid:
Note that this OID is created to aid with interconversion between CDA and FHIR - FHIR uses urn:ietf:rfc:3986 as equivalent to this OID. URIs as identifiers appear more commonly in FHIR.
This OID may also be used in CD.codeSystem.">Uniform Resource Identifier (URI)</a>/urn:uuid:invoice-task-uuid</p><p><b>partOf</b>: <a href="Task-scenario1-01-initial-submission.html">Task Type IB Variation</a></p><p><b>status</b>: Completed</p><p><b>businessStatus</b>: <span title="Codes:{http://hl7.org/fhir/uv/apix/CodeSystem/apix-business-status payment-received}">Payment Received</span></p><p><b>intent</b>: proposal</p><p><b>priority</b>: Routine</p><p><b>code</b>: <span title="Codes:{http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-code request-payment}">Request Payment</span></p><p><b>for</b>: <a href="MedicinalProductDefinition/example-ma">WonderDrug 50mg Tablets</a></p><p><b>authoredOn</b>: 2025-03-05 09:00:00+0100</p><p><b>lastModified</b>: 2025-03-06 14:00:00+0100</p><p><b>requester</b>: <a href="#hcscenario1-04-finance-payment/org-ema-srm-hmed">European Medicines Agency</a></p><h3>RequestedPerformers</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Reference</b></td></tr><tr><td style="display: none">*</td><td><a href="#hcscenario1-04-finance-payment/org-synthpharma-ag">SynthPharma AG</a></td></tr></table><h3>Inputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td><td><b>Value[x]</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-input-type regulatory-document}">Regulatory Document</span></td><td><a href="#hcscenario1-04-finance-payment/docref-invoice">DocumentReference: version = 1.0; status = current; docStatus = final; type = Invoice</a></td></tr></table><h3>Outputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td><td><b>Value[x]</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-output-type regulatory-document}">Regulatory Document</span></td><td><a href="#hcscenario1-04-finance-payment/docref-payment-proof">DocumentReference: version = 1.0; status = current; docStatus = final; type = Proof of Payment</a></td></tr></table><hr/><blockquote><p class="res-header-id"><b>Generated Narrative: Organization #org-synthpharma-ag</b></p><a name="scenario1-04-finance-payment/org-synthpharma-ag"> </a><a name="hcscenario1-04-finance-payment/org-synthpharma-ag"> </a><p><b>name</b>: SynthPharma AG</p></blockquote><hr/><blockquote><p class="res-header-id"><b>Generated Narrative: Organization #org-ema-srm-hmed</b></p><a name="scenario1-04-finance-payment/org-ema-srm-hmed"> </a><a name="hcscenario1-04-finance-payment/org-ema-srm-hmed"> </a><p><b>name</b>: European Medicines Agency – Human Medicines Evaluation Division</p></blockquote><hr/><blockquote><p class="res-header-id"><b>Generated Narrative: DocumentReference #docref-invoice</b></p><a name="scenario1-04-finance-payment/docref-invoice"> </a><a name="hcscenario1-04-finance-payment/docref-invoice"> </a><p><b>version</b>: 1.0</p><p><b>status</b>: Current</p><p><b>docStatus</b>: Final</p><p><b>type</b>: <span title="Codes:{http://hl7.org/fhir/uv/apix/CodeSystem/ctd-section m1.0}">Invoice</span></p><blockquote><p><b>content</b></p><h3>Attachments</h3><table class="grid"><tr><td style="display: none">-</td><td><b>ContentType</b></td><td><b>Url</b></td><td><b>Size</b></td><td><b>Title</b></td><td><b>Creation</b></td></tr><tr><td style="display: none">*</td><td>application/pdf</td><td><a href="https://api.ema.example/binaries/invoices/INV-2025-001.pdf">https://api.ema.example/binaries/invoices/INV-2025-001.pdf</a></td><td>450000</td><td>INV-2025-001.pdf</td><td>2025-03-05 08:00:00+0100</td></tr></table></blockquote></blockquote><hr/><blockquote><p class="res-header-id"><b>Generated Narrative: DocumentReference #docref-payment-proof</b></p><a name="scenario1-04-finance-payment/docref-payment-proof"> </a><a name="hcscenario1-04-finance-payment/docref-payment-proof"> </a><p><b>version</b>: 1.0</p><p><b>status</b>: Current</p><p><b>docStatus</b>: Final</p><p><b>type</b>: <span title="Codes:{http://hl7.org/fhir/uv/apix/CodeSystem/ctd-section m1.0}">Proof of Payment</span></p><h3>RelatesTos</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Target</b></td></tr><tr><td style="display: none">*</td><td><a href="DocumentReference/docref-invoice">Invoice #INV-2025-001</a></td></tr></table><blockquote><p><b>content</b></p><h3>Attachments</h3><table class="grid"><tr><td style="display: none">-</td><td><b>ContentType</b></td><td><b>Url</b></td><td><b>Size</b></td><td><b>Title</b></td><td><b>Creation</b></td></tr><tr><td style="display: none">*</td><td>application/pdf</td><td><a href="https://api.synthpharma.example/binaries/payments/confirm-inv-2025-001.pdf">https://api.synthpharma.example/binaries/payments/confirm-inv-2025-001.pdf</a></td><td>280000</td><td>Payment-Confirmation.pdf</td><td>2025-03-06 13:30:00+0100</td></tr></table></blockquote></blockquote></div>
</text>
<contained>
<Organization>
<id value="org-synthpharma-ag"/>
<name value="SynthPharma AG"/>
</Organization>
</contained>
<contained>
<Organization>
<id value="org-ema-srm-hmed"/>
<name
value="European Medicines Agency – Human Medicines Evaluation Division"/>
</Organization>
</contained>
<contained>
<DocumentReference>
<id value="docref-invoice"/>
<version value="1.0"/>
<status value="current"/>
<docStatus value="final"/>
<type>
<coding>
<system value="http://hl7.org/fhir/uv/apix/CodeSystem/ctd-section"/>
<code value="m1.0"/>
<display value="Invoice"/>
</coding>
</type>
<content>
<attachment>
<contentType value="application/pdf"/>
<url
value="https://api.ema.example/binaries/invoices/INV-2025-001.pdf"/>
<size value="450000"/>
<title value="INV-2025-001.pdf"/>
<creation value="2025-03-05T08:00:00+01:00"/>
</attachment>
</content>
</DocumentReference>
</contained>
<contained>
<DocumentReference>
<id value="docref-payment-proof"/>
<version value="1.0"/>
<status value="current"/>
<docStatus value="final"/>
<type>
<coding>
<system value="http://hl7.org/fhir/uv/apix/CodeSystem/ctd-section"/>
<code value="m1.0"/>
<display value="Proof of Payment"/>
</coding>
</type>
<relatesTo>
<target>
<reference value="DocumentReference/docref-invoice"/>
<display value="Invoice #INV-2025-001"/>
</target>
</relatesTo>
<content>
<attachment>
<contentType value="application/pdf"/>
<url
value="https://api.synthpharma.example/binaries/payments/confirm-inv-2025-001.pdf"/>
<size value="280000"/>
<title value="Payment-Confirmation.pdf"/>
<creation value="2025-03-06T13:30:00+01:00"/>
</attachment>
</content>
</DocumentReference>
</contained>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="urn:uuid:invoice-task-uuid"/>
</identifier>
<partOf>🔗
<reference value="Task/scenario1-01-initial-submission"/>
</partOf>
<status value="completed"/>
<businessStatus>
<coding>
<system
value="http://hl7.org/fhir/uv/apix/CodeSystem/apix-business-status"/>
<code value="payment-received"/>
<display value="Payment Received"/>
</coding>
</businessStatus>
<intent value="proposal"/>
<priority value="routine"/>
<code>
<coding>
<system value="http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-code"/>
<code value="request-payment"/>
<display value="Request Payment"/>
</coding>
</code>
<for>
<reference value="MedicinalProductDefinition/example-ma"/>
<display value="WonderDrug 50mg Tablets"/>
</for>
<authoredOn value="2025-03-05T09:00:00+01:00"/>
<lastModified value="2025-03-06T14:00:00+01:00"/>
<requester>
<reference value="#org-ema-srm-hmed"/>
<display value="European Medicines Agency"/>
</requester>
<requestedPerformer>
<reference>
<reference value="#org-synthpharma-ag"/>
<display value="SynthPharma AG"/>
</reference>
</requestedPerformer>
<input>
<type>
<coding>
<system
value="http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-input-type"/>
<code value="regulatory-document"/>
<display value="Regulatory Document"/>
</coding>
</type>
<valueReference>
<reference value="#docref-invoice"/>
</valueReference>
</input>
<output>
<type>
<coding>
<system
value="http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-output-type"/>
<code value="regulatory-document"/>
<display value="Regulatory Document"/>
</coding>
</type>
<valueReference>
<reference value="#docref-payment-proof"/>
</valueReference>
</output>
</Task>