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

FHIR IG Statistics: OperationDefinition/appointment-hold

Packageihe.iti.scheduling
TypeOperationDefinition
Idappointment-hold
FHIR VersionR4
Sourcehttps://profiles.ihe.net/ITI/Scheduling/https://build.fhir.org/ig/IHE/ITI.Scheduling/OperationDefinition-appointment-hold.html
URLhttps://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-hold
Version1.0.1-current
Statusactive
Date2024-12-12
NameHold_Appointment_Operation
Realmuv
Authorityihe
DescriptionRequest for a hold on a selected Appointment in order for the user to complete entering data for booking an appointment. This operation precedes the booking and follows the appointment availability interaction. 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 resource status accordingly.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
IHE.Scheduling.clientIHE Scheduling Client
IHE.Scheduling.serverIHE Scheduling Server

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition appointment-hold

URL: [base]/Appointment/$hold

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INappointment-reference1..1Reference (IHE ITI Appointment Profile)

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.

OUTreturn0..1Bundle (IHE ITI Scheduling Bundle Profile)

An IHE ITI Scheduling Appointment Bundle Profile of type searchset consisting of the requested held 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 "pending" if the hold is approved or "cancelled" if the hold is rejected.


Source

{
  "resourceType": "OperationDefinition",
  "id": "appointment-hold",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-hold",
  "version": "1.0.1-current",
  "name": "Hold_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 for a hold on a selected Appointment in order for the user to complete entering data for booking an appointment.  This operation precedes the booking and follows the appointment availability interaction.  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 resource status accordingly. ",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "code": "hold",
  "resource": [
    "Appointment"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "appointment-reference",
      "use": "in",
      "min": 1,
      "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": "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 held 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 \"pending\" if the hold is approved or  \"cancelled\" if the hold is rejected.",
      "type": "Bundle",
      "targetProfile": [
        "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle"
      ]
    }
  ]
}