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/espen-servicewell/wof-portal-fhir-ig/ and changes regularly. See the Directory of published versions

CapabilityStatement: ITB capability statement (Experimental)

Official URL: http://portal.wof.purified.link/fhir/CapabilityStatement Version: 0.1.0
Draft as of 2021-06-22 Computable Name: ITB

Usage:Clinical Focus: positive

Copyright/Legal: Copyright © Service Well AB

This is the FHIR capability statement for the ITB interface

ITB capability statement, published for contracting and operational support

Raw OpenAPI-Swagger Definition file | Download

ITB capability statement

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats: application/json-patch+json
  • Published on: 2021-06-22
  • Published by: null

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

This CapabilityStatement instantiates the CapabilityStatement http://ihe.org/fhir/CapabilityStatement/pixm-client

SHALL Support the Following Implementation Guides

  • https://build.fhir.org/ig/barbrov/wof-portal-fhir-ig/

FHIR RESTful Capabilities

Mode: server

Main FHIR endpoint for ITB

Security
Enable CORS: yes
Security services supported: SMART-on-FHIR

See Smart on FHIR documentation

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRV-RSUCDH-IH-TSearches_include_revincludeOperations
ITBActivityDefinitionSupported Profiles
  ITB ActivityDefinition		yyyyyy
ITBAppointmenthttp://portal.wof.purified.link/fhir/StructureDefinition/ITBAppointmentyyyyyyactor, patient
ITBAppointmentResponsehttp://portal.wof.purified.link/fhir/StructureDefinition/ITBAppointmentResponsey
ITBEndPointhttp://portal.wof.purified.link/fhir/StructureDefinition/ITBEndpointyy
ITBHealthcareServicehttp://portal.wof.purified.link/fhir/StructureDefinition/ITBHealthcareServiceyyyyyyyendpoint
ITBOrganizationhttp://portal.wof.purified.link/fhir/StructureDefinition/ITBOrganizationyy
ITBPatienthttp://portal.wof.purified.link/fhir/StructureDefinition/ITBPatientyy
ITBPractitionerhttp://portal.wof.purified.link/fhir/StructureDefinition/ITBPractitioneryy
ITBSchedulehttp://portal.wof.purified.link/fhir/StructureDefinition/ITBScheduleyyservice, actor, service-type, _sort
ITBSlothttp://portal.wof.purified.link/fhir/StructureDefinition/ITBSlotyyschedule, service-type, start

Resource Conformance: supported ITBActivityDefinition

​Core FHIR Resource
ITBActivityDefinition
Reference Policy
Interaction summary
  • Supports read, vread, update, history-instance, history-type, create.

Supported Profiles

ITB ActivityDefinition

Documentation

https://build.fhir.org/ig/servicewell/wof-portal-fhir-ig/StructureDefinition-ITBActivityDefinition.html

Resource Conformance: supported ITBAppointment

Base System Profile
ITB Appointment
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, vread, update, history-instance, history-type, create.

Documentation

URL for Documentation to be added

Search Parameters
ConformanceParameterTypeDocumentation
SHALLactorreference

Search for example for a HealtCareService referenced as actor.

SHALLpatientreference

Search for patient referenced by the Appointment.

 

Resource Conformance: supported ITBAppointmentResponse

Base System Profile
ITB AppointmentResponse
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create.

Documentation

URL for Documentation to be added

Resource Conformance: supported ITBEndPoint

Base System Profile
ITB Endpoint
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, vread.

Documentation

URL for Documentation to be added

Resource Conformance: supported ITBHealthcareService

Base System Profile
ITB HealthcareService
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, vread, update, delete, history-instance, history-type, create.

Documentation

URL for Documentation to be added

Search Parameters
ConformanceParameterTypeDocumentation
SHALLendpointreference

Endpoint id must be of type guid

 

Resource Conformance: supported ITBOrganization

Base System Profile
ITB Organization
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, vread.

Documentation

URL for Documentation to be added

Resource Conformance: supported ITBPatient

Base System Profile
ITB Patient
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, vread.

Documentation

URL for Documentation to be added

Resource Conformance: supported ITBPractitioner

Base System Profile
ITB Practitioner
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, vread.

Documentation

URL for Documentation to be added

Resource Conformance: supported ITBSchedule

Base System Profile
ITB Schedule
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, vread, read, vread.

Documentation

https://build.fhir.org/ig/servicewell/wof-portal-fhir-ig/StructureDefinition-ITBSchedule.html

Search Parameters
ConformanceParameterTypeDocumentation
SHALLservicereference

Search for a referenced HealthCareService

SHALLactorreference

Search for example for a HealtCareService or PractitionerRole referenced in actor.

SHALLservice-typetoken

Search for Schedules with specified service-type

SHALL_sortstring

Specify search order for results

 

Resource Conformance: supported ITBSlot

Base System Profile
ITB Slot
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, vread.

Documentation

https://build.fhir.org/ig/servicewell/wof-portal-fhir-ig/StructureDefinition-ITBSlot.html

Search Parameters
ConformanceParameterTypeDocumentation
SHALLschedulereference

Search for Slots with reference to specified Schedule.

SHALLservice-typetoken

Search for Slots with specified service-type

SHALLstartdate

Specify search order for results