IHE ITI Scheduling
0.8.0-current - ci-build International flag

IHE ITI Scheduling, published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.8.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.Scheduling/ and changes regularly. See the Directory of published versions

CapabilityStatement: IHE Scheduling Server

Official URL: https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.server Version: 0.8.0-current
Active as of 2024-02-05 Computable Name: IHE_Scheduling_Server

Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property

CapabilityStatement for Server Actor in the IHE IT Infrastructure Technical Framework Supplement IHE FHIR Scheduling. See https://profiles.ihe.net/ITI/TF/Volume1/ch-38.html. The IHE Profile text is Normative, this conformance resource is Informative.

Raw OpenAPI-Swagger Definition file | Download

IHE Scheduling Server

  • Implementation Guide Version: 0.8.0-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2024-02-05
  • Published by: IHE IT Infrastructure Technical Committee

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.

FHIR RESTful Capabilities

Mode: server

FooBar server provides capability to query for Patient resources matching a sub-set of the FHIR core Patient resource query parameters

Security

None mandated by IHE, encouraged IHE-IUA or SMART-on-FHIR

Summary of System-wide Interactions
  • Supports the search-system interaction.

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 TypeProfileRSUCSearches_include_revincludeOperations
Appointmenthttps://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-apptyy_id, identifier, patient, date, specialty, appointment-type, practitioner, patient+date$find, $book, $hold
Bundlehttps://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle
Patienthttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patientyy_id, idenitfier, birthdate, family, gender, given, name, family+gender, birthdate+family, birthdate+name, gender+name

Resource Conformance: SHALLAppointment

Base System Profile
https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALLidentifiertoken

The client SHALL provide both the system and code values.

SHALLpatientreference

The patient, or one of the patients, for whom this apointement exists

SHOULDdatedate

The date, or date range, for the appointments being searched.

SHOULDspecialtytoken

The specialty for which the appointments being searched is.

SHOULDappointment-typetoken
SHOULDpractitionerreference

The provider, or one of the providers, with whom this apointement is scheduled

Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+datereference+date
Extended Operations
ConformanceOperationDocumentation
SHALL$find

Document the find operation

SHALL$book

Document the book operation

SHOULD$hold

Document the hold operation

Resource Conformance: SHALLBundle

Base System Profile
https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Resource Conformance: SHALLPatient

    Base System Profile
    http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient
    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary
    • Supports read, search-type.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALL_idtoken

    Logical id of this artifact

    SHALLidenitfiertoken

    The server SHALL NOT support only code values.

    SHOULDbirthdatedate

    A server SHALL support a value precise to the day.

    SHOULDfamilystring

    A portion of the family name of the patient

    SHOULDgendertoken

    Gender of the patient

    SHOULDgivenstring

    A portion of the given name of the patient

    SHOULDnamestring

    The full name of the patient or part of it

    Combined Search Parameters
    ConformanceParametersTypes
    SHOULDfamily+genderstring+token
    SHOULDbirthdate+familydate+string
    SHOULDbirthdate+namedate+string
    SHOULDgender+nametoken+string