FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/eAfspraak-appointment-book

Packagenictiz.fhir.nl.stu3.eafspraak
Resource TypeOperationDefinition
IdeAfspraak-appointment-book
FHIR VersionR3
Sourcehttps://simplifier.net/resolve?scope=nictiz.fhir.nl.stu3.eafspraak@1.0.6&canonical=http://nictiz.nl/fhir/OperationDefinition/eAfspraak-appointment-book
URLhttp://nictiz.nl/fhir/OperationDefinition/eAfspraak-appointment-book
Version2.0.1
Statusactive
NameAppointment Book
Realmnl
DescriptionRequest to book a selected Appointment. This operation follows the slot-find operation. This operaton completes the booking of an appointment. The server determines if the nominated appointment is still available (i.e., all the required actors and physical assets needed for the appointment are still available) and either accepts or rejects the hold request and updates the specific slot and appointment resource status accordingly. **This operation is heavily influenced by the operation defined in the [US Argonaut project](https://argonautproject.github.io/scheduling/OperationDefinition-appointment-book.html)**
Typetrue
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

No narrative content found in resource


Source

{
  "resourceType": "OperationDefinition",
  "id": "eAfspraak-appointment-book",
  "url": "http://nictiz.nl/fhir/OperationDefinition/eAfspraak-appointment-book",
  "version": "2.0.1",
  "name": "Appointment Book",
  "status": "active",
  "kind": "operation",
  "publisher": "Nictiz",
  "contact": [
    {
      "name": "Nictiz",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.nictiz.nl",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Request to book a selected Appointment. This operation follows the slot-find operation.  This operaton completes the booking of an appointment.  The server determines if the nominated appointment is still available (i.e., all the required actors and physical assets needed for the appointment are still available) and either accepts or rejects the hold request and updates the specific slot and appointment resource status accordingly. \n\n **This operation is heavily influenced by the operation defined in the [US Argonaut project](https://argonautproject.github.io/scheduling/OperationDefinition-appointment-book.html)**",
  "idempotent": false,
  "code": "book",
  "comment": "It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with the patient(s), or determine whether the context has the rights to the nominated patient(s), if there is one.  Specifying the relationship between the context, a user and patient records is outside the scope of this specification",
  "resource": [
    "Appointment"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "appointment",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "After fetching open Slots, an Appointment resource is created by the Client Application and is exchanged with the EHR. This parameter represents this appointment",
      "type": "Appointment",
      "profile": {
        "reference": "http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment",
        "display": "eAfspraak-Appointment"
      }
    },
    {
      "name": "return",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "A Bundle of type `searchset` containing the requested Appointment resource and may also contain an [OperationOutcome](http://hl7.org/fhir/stu3/operationoutcome.html) with errors, warnings or information as a result of processing the operation.   If the booking is accepted, the Appointment resource will have an updated `status` of \"booked\" and  the `participants`element updated to include the patients.  If the booking is rejected, the Appointment resource will have an updated `status` of  \"cancelled\".",
      "type": "Bundle"
    }
  ]
}