Overview

The Akinox GAP API provides a simplified FHIR R4 interface for submitting GAP requests to the Akinox platform.
The API accepts FHIR Bundle resources containing one Task, one Patient resource, and up to two RelatedPerson resources. All other resources in the Bundle is ignored.

Authentication

The Akinox GAP API supports the OAuth 2.0 Client Credentials Flow authentication mechanism — clients obtain a bearer token from the Akinox authorization server, then include the token in the Authorization: Bearer {token} header.

Requests without valid authentication will receive a 401 Unauthorized response.

Endpoint

All GAP requests must be submitted to:

POST /gap/demandes/Bundle
Content-Type: application/fhir+json

The payload must conform to the profiles listed in the FHIR Artifacts directory of this Implementation Guide.

Authorized Representatives

For patients who have an authorized representative serving as their primary contact person, include a RelatedPerson resource with the relationship code GUARD (guardian) to represent this authorized representative.

Response Codes

201 - Created 401 - Unauthorized 422 - Unprocessable Entity 500 - Internal Server Error

OperationOutcome Responses

In case of an error, the API may return a FHIR OperationOutcome resource containing diagnostic details.

{
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "invalid",
      "diagnostics": "The Task.identifier is missing."
    }
  ]
}

Clients should inspect the HTTP status code first, then parse the OperationOutcome (if present) for more details. The requestId should be included when contacting support for issue tracking.