These docs are for v2. Click to read the latest docs for v3.

Access Encounter Information v2

The Search Encounter gives you access to the care pathways of a patient.

Access Control

You have to use the Access Token of an authenticated user with the ENCOUNTER_SEARCH permission in the scope to access the FHIR Encounter API.

Patient's hospitalization

A patient can be hospitalized and stay in a hospital in different departments. Stays are represented by the FHIR resource Encounter.

An Encounter has several fields too :

  • period: The start and end time of the encounter (search on a range but not on specific field start or end (more details here)
  • subject/patient: The patient present at the encounter
  • service-provider._extension: Search on UF (Functional Unit) extension to filter on healthcare service

Some example to search on Encounter :

  • /Encounter?date=ge2021-01-01
  • /Encounter?patient=Patient/12345
  • /Encounter?service-provider._extension=http://lifen.fr/fhir/StructureDefinition/Encounter/ServiceProvider/Extension/FonctionalUnit-1.0|500

To learn more about the definitions of the other fields, you can look at the definition of the fields here : FHIR Encounter DSTU3

Example of an encounter return by the API :

{
  "resourceType": "Encounter",
  "identifier": [
    {
      "use": "official",
      "type": {
        "coding": [
          {
            "system": "http://www.interopsante.org/fhir/valueset/fr-encounter-identifier-type",
            "version": "3.0.1",
            "code": "VN",
            "display": "Visit Number"
          }
        ]
      },
      "system": "urn:oid:1.2.250.1.71.4.2.2.111111111111111",
      "value": "111111111",
      "assigner": {
        "reference": "Organization/xxxxxx"
      }
    }
  ],
  "status": "finished",
  "subject": {
    "reference": "Patient/xxxxx"
  },
  "period": {
    "start": "2020-12-22T09:00:00+01:00",
    "end": "2021-01-06T12:00:00+01:00"
  },
  "serviceProvider": {
    "extension": [
      {
        "url": "http://lifen.fr/fhir/StructureDefinition/Encounter/ServiceProvider/Extension/FonctionalUnit-1.0",
        "valueString": "400"
      }
    ],
    "reference": "Organization/xxxxxx"
  }
}