XIG: OperationDefinition/alpha-appointment-request

FHIR IG Statistics: OperationDefinition/alpha-appointment-request

Package	alpha.core.r4
Resource Type	OperationDefinition
Id	alpha-appointment-request
FHIR Version	R4
Source	https://simplifier.net/resolve?scope=alpha.core.r4@1.0.0&canonical=http://hl7.alp/OperationDefinition/alpha-appointment-request
URL	http://hl7.alp/OperationDefinition/alpha-appointment-request
Version	1.0.0
Status	active
Name	Appointment Request
Authority	hl7
Description	This operation allows a client to create an Appointment [request] on a server, using a free Slot.
Type	true
Kind	operation

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

Request an Appointment

This operation allows a client to create an Appointment [request] on a server, using a free Slot.

Operation functionality in terms of FHIR

If the (input parameter) Slot is 'free', an Appointment resource (with status='proposed') will be created, Slot.status will be set to 'busy-tentative', and the Appointment.participant.status of all Patient or RelatedPerson participants will be set to 'accepted'. The status of any other participants will be set to 'needs-action'.

Source

{
  "resourceType": "OperationDefinition",
  "id": "alpha-appointment-request",
  "text": {
    "status": "additional",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.alp/OperationDefinition/alpha-appointment-request",
  "version": "1.0.0",
  "name": "Appointment Request",
  "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 create an Appointment [request] on a server, using a free Slot.",
  "code": "request",
  "comment": "This operation is intended to be used by a Patient facing app.",
  "resource": [
    "Appointment"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "patient",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Reference to one patient. The patient may be implicitly known from the authentication context.",
      "type": "Reference"
    },
    {
      "name": "slot",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Reference to one slot.",
      "type": "Reference"
    },
    {
      "name": "related-person",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "References to accompanying related persons. It is assumed that they accept the appointment request and its timing if and when the Patient (or a relatedPerson thereof) created the scheduling request.",
      "type": "Reference"
    },
    {
      "name": "return",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "An [Appointment] resource.",
      "type": "Appointment"
    }
  ]
}