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

FHIR IG Statistics: OperationDefinition/alpha-appointment-cancel

Packagealpha.core.r4
Resource TypeOperationDefinition
Idalpha-appointment-cancel
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=alpha.core.r4@1.0.0&canonical=http://hl7.alp/OperationDefinition/alpha-appointment-cancel
URLhttp://hl7.alp/OperationDefinition/alpha-appointment-cancel
Version1.0.0
Statusactive
NameAppointment Cancel
Authorityhl7
DescriptionThis operation allows a client to to cancel an Appointment or Appointment [request].
Typefalse
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

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

Cancel an Appointment

This operation allows a client to cancel an Appointment or Appointment [request].

Operation functionality in terms of FHIR

Sets the status of the appointment to 'cancelled' and the status of its associated Slot(s) to 'free'.


Source

{
  "resourceType": "OperationDefinition",
  "id": "alpha-appointment-cancel",
  "text": {
    "status": "additional",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.alp/OperationDefinition/alpha-appointment-cancel",
  "version": "1.0.0",
  "name": "Appointment Cancel",
  "status": "active",
  "kind": "operation",
  "publisher": "Alpha NHIT Centre",
  "contact": [
    {
      "name": "Alpha NHIT Centre",
      "telecom": [
        {
          "system": "email",
          "value": "info@nhitcentre.alp",
          "use": "work"
        }
      ]
    }
  ],
  "description": "This operation allows a client to to cancel an Appointment or Appointment [request].",
  "code": "cancel",
  "comment": "The operation updates the instance of the Appointment resource.",
  "resource": [
    "Appointment"
  ],
  "system": false,
  "type": false,
  "instance": true,
  "parameter": [
    {
      "name": "appointment",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The appointment which should be cancelled.",
      "type": "Appointment"
    },
    {
      "name": "return",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "A cancelled [Appointment] resource (in case of success).",
      "type": "Appointment"
    }
  ]
}