Scheduling
1.0.0-comment - ballot International flag

This page is part of the IHE ITI Scheduling (v1.0.0-comment: Publication Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

CapabilityStatement: IHE Scheduling Server

Official URL: https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.server Version: 1.0.0-comment
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.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement IHE.Scheduling.server

IHE Scheduling Server

  • Implementation Guide Version: 1.0.0-comment
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support application/fhir+xml, SHALL support 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.

SHOULD Support the Following Implementation Guides

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-systeminteraction.

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: SHALL Appointment

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: SHALL Bundle

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

Interaction summary

    Resource Conformance: SHALL Patient

    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