XIG: CapabilityStatement/IHE.Scheduling.client

FHIR IG Statistics: CapabilityStatement/IHE.Scheduling.client

Package	ihe.iti.scheduling
Type	CapabilityStatement
Id	IHE.Scheduling.client
FHIR Version	R4
Source	https://profiles.ihe.net/ITI/Scheduling/https://build.fhir.org/ig/IHE/ITI.Scheduling/CapabilityStatement-IHE.Scheduling.client.html
URL	https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.client
Version	1.0.1-current
Status	active
Date	2024-12-12
Name	IHE_Scheduling_Client
Title	IHE Scheduling Client
Realm	uv
Authority	ihe
Description	CapabilityStatement for Client Actor in the IHE IT Infrastructure Technical Framework Supplement IHE FHIR Scheduling. See https://profiles.ihe.net/ITI/TF/Volume1/ch-38.html.
Copyright	IHE http://www.ihe.net/Governance/#Intellectual_Property
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
ihe.iti.balp	Basic Audit Log Patterns (BALP)

OperationDefinition
appointment-book	Book_Appointment_Operation
appointment-find	Find_Appointments_Operation
appointment-hold	Hold_Appointment_Operation

StructureDefinition
ihe-sched-appt	IHE ITI Appointment Profile

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement IHE.Scheduling.client

IHE Scheduling Client

Implementation Guide Version: 1.0.1-current
FHIR Version: 4.0.1
Supported Formats: SHALL support application/fhir+xml, SHOULD support application/fhir+json
Supported Patch Formats:
Published on: 2024-12-12
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

https://profiles.ihe.net/ITI/BALP/ImplementationGuide/ihe.iti.balp

FHIR RESTful Capabilities

Mode: `client`

IHE Scheduling client will

query for Patient resources matching the Patient resource query parameters,
query for Appointment resources matching the IHE Scheduling Appointment resource query parameters,
use the operations defined for the Appointment resource

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 Type	Profile	R	S	U	C	Searches	`_include`	`_revinclude`	Operations
Appointment	https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt	y	y			_id, identifier, patient, date, specialty, appointment-type, practitioner, patient+date			`$find`, `$book`, `$hold`

Resource Conformance: SHALL Appointment

Base System Profile
IHE ITI Appointment Profile

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	Logical id of this artifact
SHALL	identifier	`token`	The client SHALL provide both the system and code values.
SHALL	patient	`reference`	The patient, or one of the patients, for whom this apointement exists
SHOULD	date	`date`	The date, or date range, for the appointments being searched.
SHOULD	specialty	`token`	The specialty for which the appointments being searched is.
SHOULD	appointment-type	`token`
SHOULD	practitioner	`reference`	The provider, or one of the providers, with whom this apointement is scheduled

Combined Search Parameters

Conformance	Parameters	Types
SHALL	patient+date	`reference`+`date`

Extended Operations

Conformance	Operation	Documentation
SHALL	$find	Document the find operation
SHALL	$book	Document the book operation
SHOULD	$hold	Document the hold operation

Source

{
  "resourceType": "CapabilityStatement",
  "id": "IHE.Scheduling.client",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.client",
  "version": "1.0.1-current",
  "name": "IHE_Scheduling_Client",
  "title": "IHE Scheduling Client",
  "status": "active",
  "experimental": false,
  "date": "2024-12-12",
  "publisher": "IHE IT Infrastructure Technical Committee",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://www.ihe.net/ihe_domains/it_infrastructure/"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "email",
          "value": "iti@ihe.net"
        }
      ]
    },
    {
      "name": "IHE IT Infrastructure Technical Committee",
      "telecom": [
        {
          "system": "email",
          "value": "iti@ihe.net"
        }
      ]
    }
  ],
  "description": "CapabilityStatement for Client Actor in the IHE IT Infrastructure Technical Framework Supplement IHE FHIR Scheduling. See https://profiles.ihe.net/ITI/TF/Volume1/ch-38.html.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "copyright": "IHE http://www.ihe.net/Governance/#Intellectual_Property",
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "_format": [
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        }
      ]
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }
      ]
    }
  ],
  "implementationGuide": [
    "https://profiles.ihe.net/ITI/BALP/ImplementationGuide/ihe.iti.balp"
  ],
  "_implementationGuide": [
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }
      ]
    }
  ],
  "rest": [
    {
      "mode": "client",
      "documentation": "IHE Scheduling client will \n1. query for Patient resources matching the Patient resource query parameters, \n1. query for Appointment resources matching the IHE Scheduling Appointment resource query parameters,\n1. use the operations defined for the Appointment resource",
      "security": {
        "cors": false,
        "description": "None mandated by IHE, encouraged IHE-IUA or SMART-on-FHIR"
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "date"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "Appointment",
          "profile": "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt",
          "_profile": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode": "SHALL"
              }
            ]
          },
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
              "type": "token",
              "documentation": "The client **SHALL** provide both the system and code values."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/Appointment-patient",
              "type": "reference",
              "documentation": "The patient, or one of the patients, for whom this apointement exists"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type": "date",
              "documentation": "The date, or date range, for the appointments being searched."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "specialty",
              "definition": "http://hl7.org/fhir/SearchParameter/Appointment-specialty",
              "type": "token",
              "documentation": "The specialty for which the appointments being searched is."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "appointment-type",
              "definition": "http://hl7.org/fhir/SearchParameter/Appointment-appointment-type",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "practitioner",
              "definition": "http://hl7.org/fhir/SearchParameter/Appointment-practitioner",
              "type": "reference",
              "documentation": "The provider, or one of the providers, with whom this apointement is scheduled"
            }
          ],
          "operation": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "find",
              "definition": "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-find",
              "documentation": "Document the find operation"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "book",
              "definition": "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book",
              "documentation": "Document the book operation"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "hold",
              "definition": "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-hold",
              "documentation": "Document the hold operation"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "search-system"
        }
      ]
    }
  ]
}