---
updatedAt: 2025-06-11T00:22:18.000Z
agentTools:
  projectIndex: https://developer.lifen.fr/llms.txt
---

# Access Patient Coverage Information

## Introduction

The Patient/Encounter API Service provides you with access to information about patients' administrative profile, patients' coverage and patients' encounters.

This information is usually stored in hospitals' Patient Administrative Systems (PAS - in french GAM Gestion Administrative des Malades ou GAP Gestion Administrative des Patients).

> 📘 This API is not yet available for patients from Vivalto healthcare structures.

## Access Control

You need a Machine to [Machine To Machine Communications](https://developer.lifen.fr/docs/machine-to-machine-communications) to use this API.

You need to have the `PATIENT_GAM_SEARCH` scope to access the Patient/Encounter Platform service.

## Search Patient Coverage

You can search patient Coverage only with one body param : `beneficiary` (patient Lifen references)

You need to get the Patient FHIR reference from the [Access Patient Information](https://developer.lifen.fr/reference/patient)

To search a patient coverage by patient parameter, use the following route : POST `{{host}}/fhir/v3/Coverage/_search`

The **Patient/Encounter API Service** uses the [`_search` feature from FHIR](https://www.hl7.org/fhir/http.html#search) with :

* HTTP Verb = `POST`
* Content-type = `application/x-www-form-urlencoded`

The response will be a bundle resource that contains all the coverage that match the search.

### Search parameters :

<Table>
  <thead>
    <tr>
      <th>
        Parameter     
      </th>

      <th>
        Value type
      </th>

      <th>
        Description & Restrictions
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **`beneficiary`**
      </td>

      <td>
        string
      </td>

      <td>
        FHIR reference of the Patient in Lifen system (`Patient/xxxx`)\
        Multi-value search is available for this param (use `,`to make a OR) **except for Ramsay**. You are limited to 10 values max.
      </td>

      <td>
        `Patient/8617500`\
        `Patient/8617500,Patient/6989855`
      </td>
    </tr>
  </tbody>
</Table>

To better understand the FHIR standard definition of each field, you can refer to the FHIR documentation here : [FHIR Coverage](https://www.hl7.org/fhir/coverage.html#resource).

Example of CURL query :

```json
curl --request POST \
  --url https://api.post-prod.lifen.fr/fhir/v3/Coverage/_search \
  --header 'Authorization: Bearer xxxxxxxxxxxxxx'
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data beneficiary=Patient/23435345
```

### Example of a bundle resource

```json json
{
  "resourceType": "Bundle",
  "meta": {
    "lastUpdated": "2023-01-23T16:37:18.692+00:00"
  },
  "type": "searchset",
  "total": 1,
  "entry": [
    {
      "resource": {
        "resourceType": "Coverage",
        "identifier": [
          {
            "use": "official",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "NH"
                }
              ]
            },
            "system": "urn:oid:1.2.250.1.213.1.4.8",
            "value": "[NIR-OD]"
          }
        ],
        "status": "active",
        "beneficiary": {
          "reference": "Patient/[id]"
        },
        "payor": [
          {
            "reference": "Organization/21793798"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}
```

### Fields description :

| Fields        | Type           | Definition                                           | Possible values      |
| ------------- | -------------- | :--------------------------------------------------- | -------------------- |
| `identifier`  | string         | NIR/NIA-OD of the patient                            | `2950244162294`      |
| `status`      | string         | status of the Coverage resource                      | `active`by default   |
| `beneficiary` | valueReference | FHIR reference of the patient you search for         | `Patient/3435434`    |
| `payor`       | valueReference | FHIR reference of the AMO or AMC issuer organization | `Organization/34345` |