ITB Implementation Guide
0.1.0 - Release Label

ITB Implementation Guide, published by . This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/wof-portal-fhir-ig/ and changes regularly. See the Directory of published versions

Home

Official URL: http://portal.wof.purified.link/fhir/ImplementationGuide/portal.wof.purified.link Version: 0.1.0
Draft as of 2024-02-13 Computable Name: ITBImplementationGuide

ITB Implementation Guide

Introduction

Welcome to the Implementation Guide for WOF-PORTAL and ITB

This guide describes all the included elements and how they can be used to build an Internet Time Booking application.

Getting started

Steps to show available time slots

  1. Get the HealthCareServices

  2. Get the ActivityDefinitions

  3. Get the PractitionerRoles for specified HealthCareService

  4. Get the Schedules for specified actor and service-type

  5. Get the Slots by service-type, start-time and duration

Steps to edit and reschedule a booking

Pre-requisites: User has logged in

  1. Get the HealthCareServices

*This is a search operation that returns a Bundle of HealthCareServices. Both active and inactive are returned.

  1. Get the ActivityDefinitions

  2. Display the clinics

  3. Select clinic

  4. Get the Appointments for the specified HealthCareService

  5. Get the PractitionerRoles for the specified HealthCareService

  6. What are the PractitionerRoles used for here?

  7. Get Patient What is the patient(s) used for here?

  8. After the previous step information about the appointments in the selected clinic can be displayed

  9. Select appointment to be rescheduled

  10. Get the Schedules for specified actor and PractitionerRole

  11. Get the HealthCareServices

  12. Get the Appointments

  13. Get Slot for specified Schedule and Appointment

  14. Select a new date and time

  15. Put Appointment.

  16. Get the HealthCareServices

  17. Get the Appointments for the specified HealthCareService

  18. Get the PractitionerRoles for the specified HealthCareService
  19. Get Patient What is the patient(s) used for here?
  1. Get Schedule by Id

FHIR Endpoints

HealthCareService

  • GET {url}/HealthcareService

    Example:

     GET http://localhost:5017/portal/fhir/PractitionerRole?service=HealthcareService/b81f2315-7476-45e8-9ae6-51f547e2d82e

ActivityDefinition

  • GET {url}/ActivityDefinition

    Example:

     GET http://localhost:5017/cof-portal/fhir/ActivityDefinition

3. PractitionerRole

  • GET {url}/PractitionerRole

    Search params:

    • service - a reference to a HealthCareService (HealthCareService/identifier)

    Example:

      GET http://localhost:5017/portal/fhir/PractitionerRole?service=HealthcareService/b81f2315-7476-45e8-9ae6-51f547e2d82e

Schedule

  • GET {url}/Schedule

    Search params:

    • actor - a reference to a HealthCareService
    • service-type - a code from csServiceTypes

    Example:

      GET http://localhost:5017/fc580e7c-7fd8-4acd-92e9-42cb052763d4/fhir/Schedule?actor=HealthcareService/b81f2315-7476-45e8-9ae6-51f547e2d82e&service-type=examination

Slot

  • GET {}/Slot

    Search params:

    • schedule - an identifier
    • service-type - a code from csServiceTypes
    • duration - in minutes
    • start - a date

    Example:

      GET http://localhost:5017/fc580e7c-7fd8-4acd-92e9-42cb052763d4/fhir/Slot?schedule=a17f8424-9c11-4421-9523-b67631a67e7c&service-type=examination&duration=30,0&start=gt2021-09-13T00:00&start=lt2021-10-01T00:0

API URL Convention

https://url/{resourceType}/{id} ?{params}

Usage scenarios

Servers

Patient test data

References