FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/IHE.Scheduling.server

Packageihe.iti.scheduling
Resource TypeCapabilityStatement
IdIHE.Scheduling.server
FHIR VersionR4
Sourcehttps://profiles.ihe.net/ITI/Scheduling/https://build.fhir.org/ig/IHE/ITI.Scheduling/CapabilityStatement-IHE.Scheduling.server.html
URLhttps://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.server
Version1.0.1-current
Statusactive
Date2024-12-12
NameIHE_Scheduling_Server
TitleIHE Scheduling Server
Realmuv
Authorityihe
DescriptionCapabilityStatement 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.
CopyrightIHE http://www.ihe.net/Governance/#Intellectual_Property
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
ihe.iti.balpBasic Audit Log Patterns (BALP)
OperationDefinition
appointment-bookBook_Appointment_Operation
appointment-findFind_Appointments_Operation
appointment-holdHold_Appointment_Operation
StructureDefinition
ihe-sched-apptIHE ITI Appointment Profile
ihe-sched-avail-bundleIHE ITI Scheduling Bundle Profile

Narrative

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

Generated Narrative: CapabilityStatement IHE.Scheduling.server

IHE Scheduling Server

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

FHIR RESTful Capabilities

Mode: server

Scheduling 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

Resource Conformance: SHALL Appointment

Base System Profile
IHE ITI Appointment Profile
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
IHE ITI Scheduling Bundle Profile
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Source

    {
  "resourceType": "CapabilityStatement",
  "id": "IHE.Scheduling.server",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.server",
  "version": "1.0.1-current",
  "name": "IHE_Scheduling_Server",
  "title": "IHE Scheduling Server",
  "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 Server 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": "SHALL"
        }
      ]
    }
  ],
  "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": "server",
      "documentation": "Scheduling server provides capability to query for Patient resources matching a sub-set of the FHIR core Patient resource query parameters",
      "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"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Bundle",
          "profile": "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle",
          "_profile": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode": "SHALL"
              }
            ]
          }
        }
      ],
      "interaction": [
        {
          "code": "search-system"
        }
      ]
    }
  ]
}