Scheduling
1.0.1-current - ci-build International flag

Scheduling, published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.Scheduling/ and changes regularly. See the Directory of published versions

: Book_Appointment_Operation - JSON Representation

Active as of 2024-12-12

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "appointment-book",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition appointment-book</b></p><a name=\"appointment-book\"> </a><a name=\"hcappointment-book\"> </a><a name=\"appointment-book-en-US\"> </a><p>URL: [base]/Appointment/$book</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>appointment-reference</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-ihe-sched-appt.html\" title=\"https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt\">IHE ITI Appointment Profile</a>)</td><td/><td><div><p>A resource id for one of proposed Appointments returned by a prior $find operation (e.g., Resource/1234).  References can be to an absolute URL, but servers only perform this operation on their own appointments.</p>\n</div></td></tr><tr><td>IN</td><td>appointment-resource</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/appointment.html\">Appointment</a> (<a href=\"StructureDefinition-ihe-sched-appt.html\" title=\"https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt\">IHE ITI Appointment Profile</a>)</td><td/><td><div><p>The full appointment resource is needed for appointment change requests</p>\n</div></td></tr><tr><td>IN</td><td>patient-resource</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a> (<a href=\"http://hl7.org/fhir/R4/patient.html\" title=\"http://hl7.org/fhir/StructureDefinition/Patient\">Patient</a>)</td><td/><td><div><p>The Patient resource type is used to provide the patient information as known to the Scheduling client at the time of booking of the appointment.</p>\n</div></td></tr><tr><td>IN</td><td>comment</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The optional comment can be added for additional notes that could be useful for booking, canceling, or modifying an appointment</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a> (<a href=\"StructureDefinition-ihe-sched-avail-bundle.html\" title=\"https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle\">IHE ITI Scheduling Bundle Profile</a>)</td><td/><td><div><p>An <a href=\"StructureDefinition-ihe-sched-avail-bundle.html\">IHE ITI Scheduling Appointment Bundle Profile</a>  of type <code>searchset</code> consisting of the requested booked Appointment resource and MAY also contain an OperationOutcome with errors, warnings or information as a result of processing the operation. The Appointment resource will have an updated <code>status</code> of &quot;booked&quot; if a new appointment is booked or an existing appointment is modified, or status of &quot;cancelled&quot; if an appointment is cancelled or not created.</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book",
  "version" : "1.0.1-current",
  "name" : "Book_Appointment_Operation",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-12-12",
  "publisher" : "IHE IT Infrastructure Technical Committee",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
        }
      ]
    },
    {
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    },
    {
      "name" : "IHE IT Infrastructure Technical Committee",
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    }
  ],
  "description" : "Request to book a selected Appointment. This operation follows the appointment availability and optional hold interactions.  This operation 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 book request and updates the resource status accordingly. \n\n In addition to the booking an appointment, this operation can also request to modify or cancel an existing appointment. \n\n### Book a New Appointment\n When booking a new appoint, the operation SHALL have either an `appointment-reference` or an `appointment-resource` parameter. If the `appointment-resource` parameter is used, the value of `Appointment.status` SHALL have the value of `pending`.\n\nA successful new appointment `$book` operation returns an [IHE ITI Appointment](./StructureDefinition-ihe-sched-appt.html) resource with the the value of `Appointment.status` set to `booked`.\n\n### Modify an Existing Appointment\n When requesting a modification of an existing appointment, the operation SHALL have an `appointment-resource` parameter and the value of `Appointment.status` SHALL have the value of `booked`.\n\nA successful request to modify an existing modification returns an [IHE ITI Appointment](./StructureDefinition-ihe-sched-appt.html) resource with the the value of `Appointment.status` set to `booked` and the changes that were requested correspondingly reflected in the resource.\n\n### Cancel an Existing Appointment  \n When requesting a cancellation of an existing appointment, the operation SHALL have an `appointment-resource` parameter and the value of `Appointment.status` SHALL have the value of `cancelled`.\n\nA successful request to cancel an existing modification returns an [IHE ITI Appointment](./StructureDefinition-ihe-sched-appt.html) resource with the the value of `Appointment.status` set to `cancelled`\n\n ",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "code" : "book",
  "resource" : [
    "Appointment"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "appointment-reference",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "A resource id for one of proposed Appointments returned by a prior $find operation (e.g., Resource/1234).  References can be to an absolute URL, but servers only perform this operation on their own appointments.",
      "type" : "Reference",
      "targetProfile" : [
        🔗 "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt"
      ]
    },
    {
      "name" : "appointment-resource",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The full appointment resource is needed for appointment change requests",
      "type" : "Appointment",
      "targetProfile" : [
        🔗 "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt"
      ]
    },
    {
      "name" : "patient-resource",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "The Patient resource type is used to provide the patient information as known to the Scheduling client at the time of booking of the appointment.",
      "type" : "Patient",
      "targetProfile" : [
        🔗 "http://hl7.org/fhir/StructureDefinition/Patient"
      ]
    },
    {
      "name" : "comment",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The optional comment can be added for additional notes that could be useful for booking, canceling, or modifying an appointment",
      "type" : "string"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "An [IHE ITI Scheduling Appointment Bundle Profile](StructureDefinition-ihe-sched-avail-bundle.html)  of type `searchset` consisting of the requested booked Appointment resource and MAY also contain an OperationOutcome with errors, warnings or information as a result of processing the operation. The Appointment resource will have an updated `status` of \"booked\" if a new appointment is booked or an existing appointment is modified, or status of \"cancelled\" if an appointment is cancelled or not created.",
      "type" : "Bundle",
      "targetProfile" : [
        🔗 "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle"
      ]
    }
  ]
}