API Reference

Update Appointment with identifier {identifier}

Appointment on the FHIR specification website.

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

The body should be a valid FHIR object for Appointment.

Here is an example:

{
  "resourceType": "Appointment",
  "id": "2docs",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Brian MRI results discussion</div>"
  },
  "status": "booked",
  "serviceCategory": [
    {
      "coding": [
        {
          "system": "http://example.org/service-category",
          "code": "gp",
          "display": "General Practice"
        }
      ]
    }
  ],
  "serviceType": [
    {
      "coding": [
        {
          "code": "52",
          "display": "General Discussion"
        }
      ]
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "394814009",
          "display": "General practice"
        }
      ]
    }
  ],
  "appointmentType": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v2-0276",
        "code": "WALKIN",
        "display": "A previously unscheduled walk-in visit"
      }
    ]
  },
  "priority": 5,
  "description": "Discussion about Peter Chalmers MRI results",
  "supportingInformation": [
    {
      "reference": "DiagnosticReport/ultrasound"
    }
  ],
  "start": "2013-12-09T09:00:00Z",
  "end": "2013-12-09T11:00:00Z",
  "comment": "Clarify the results of the MRI to ensure context of test was correct",
  "participant": [
    {
      "actor": {
        "reference": "Patient/example",
        "display": "Peter James Chalmers"
      },
      "required": "information-only",
      "status": "accepted"
    },
    {
      "actor": {
        "reference": "Practitioner/example",
        "display": "Dr Adam Careful"
      },
      "required": "required",
      "status": "accepted"
    },
    {
      "actor": {
        "reference": "Practitioner/f202",
        "display": "Luigi Maas"
      },
      "required": "required",
      "status": "accepted"
    },
    {
      "actor": {
        "display": "Phone Call"
      },
      "required": "information-only",
      "status": "accepted"
    }
  ]
}

You can reference the FHIR documentation to determine the format for Appointment.

Language
Credentials
Click Try It! to start a request and see the response here!