Skip to content

Access Appointment Information

The FHIR Appointment API gives you access to appointment's information for a patient.

Access Control

You have to use the Access Token of an authenticated user with the APPOINTMENT_READ and APPOINTMENT_CREATE permission in the scope to access the FHIR Appointment API. For user authentication, take a look at the Connect Users Guide.

Patient's appointment

Appointment resources are used to provide information about a planned meeting that may be in the future or past. A patient sometimes needs an appointment for pre-admission or consultation.

An Appointment has several fields :

  • start: When the appointment is to take place
  • end: When the appointment is to conclude
  • participant: Participants involved in the appointment (patient, practitioner, healthcare service)

To learn more about the definitions of the other fields, you can look at the definition of the fields here : https://www.hl7.org/fhir/stu3/appointment.html#resource

Example :

{
  "resourceType": "Appointment",
  "status": "pending",
  "start": "2025-12-31T16:32:00+00:09",
  "end": "2025-12-31T16:32:00+00:09",
  "participant": [
    {
      "actor": {
        "reference": "Patient/xxxxxx"
      },
      "status": "accepted"
    },
    {
      "extension": [
        {
          "url": "http://lifen.fr/fhir/StructureDefinition/Apointment/Extension/Participant/PractitionerName-V1",
          "valueString": "FIRSTNAME LASTNAME"
        }
      ],
      "type": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "code": "PPRF"
            }
          ]
        }
      ],
      "status": "accepted"
    },
    {
      "extension": [
        {
          "url": "http://lifen.fr/fhir/StructureDefinition/Apointment/Extension/Participant/ServiceName-V1",
          "valueString": "ORGA NAME"
        }
      ],
      "type": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "code": "LOC"
            }
          ]
        }
      ],
      "status": "accepted"
    }
  ]
}