FHIR IG Statistics: OperationDefinition/alpha-slot-find

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

Source

{
  "resourceType": "OperationDefinition",
  "id": "alpha-slot-find",
  "text": {
    "status": "additional",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.alp/OperationDefinition/alpha-slot-find",
  "version": "1.0.0",
  "name": "Find Slots",
  "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 queries for available free slots with optional parameters, such as date/time range, and specialty.  The server determines which open slots to expose to the application for use in creating new appointments. If neither a start or end date is given then the maximum period as defined by local business rules and starting from when the operation was transacted will be used. \n\n Note that all input parameters are simple types allowing either the 'GET'  or the 'POST' syntax to be used to initiate the interaction.  Examples of both are shown below.",
  "code": "find",
  "comment": "The _count parameter may be used to specify the upper limit of slots to be returned by the operation.  \n\n Note that is operation is intended to be used by patient-facing Apps.",
  "resource": [
    "Slot"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "start",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The start date/time of the period of time that should be checked for free slots. This parameter searched on the start time of the Slots (```Slot.start```). If no start date is provided, all available slots prior to the end date are in scope (subject to limits imposed by local business rules).",
      "type": "dateTime"
    },
    {
      "name": "end",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The end date/time of time that should be checked for appointment availability. This parameter searched on the start time of the Slots (```Slot.start```). If no end date is provided, all available slots after the start date are in scope (subject to limits imposed by local business rules).",
      "type": "dateTime"
    },
    {
      "name": "practitioner",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Reference to one or more practitioners. This may be implicit in some authorization contexts.",
      "type": "string",
      "searchType": "reference"
    },
    {
      "name": "patient",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Reference to one patient. This may be implicit in some authorization contexts.",
      "type": "string",
      "searchType": "reference"
    },
    {
      "name": "service-type",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Code for a certain type of appointment.",
      "type": "CodeableConcept"
    },
    {
      "name": "return",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "An Bundle of type `searchset` with entries of proposed Slot resources and may also contain an [OperationOutcome] (http://hl7.org/fhir/R4/operationoutcome.html) with errors, warnings or information as a result of processing the operation - e.g., an informational notice that the returned slots are not within the requested start and end times.  An empty bundle means no available slots based on inputs",
      "type": "Bundle"
    }
  ]
}