Package | ihe.iti.scheduling |
Type | CapabilityStatement |
Id | IHE.Scheduling.server |
FHIR Version | R4 |
Source | https://profiles.ihe.net/ITI/Scheduling/https://build.fhir.org/ig/IHE/ITI.Scheduling/CapabilityStatement-IHE.Scheduling.server.html |
URL | https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.server |
Version | 1.0.1-current |
Status | active |
Date | 2024-12-12 |
Name | IHE_Scheduling_Server |
Title | IHE Scheduling Server |
Realm | uv |
Authority | ihe |
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. |
Copyright | IHE http://www.ihe.net/Governance/#Intellectual_Property |
Kind | requirements |
No resources found
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 |
ihe-sched-avail-bundle | IHE ITI Scheduling Bundle Profile |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement IHE.Scheduling.server
application/fhir+xml
, SHALL support application/fhir+json
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.
server
Scheduling server provides capability to query for Patient resources matching a sub-set of the FHIR core Patient resource query parameters
None mandated by IHE, encouraged IHE-IUA or SMART-on-FHIR
search-system
interaction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
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 | ||||
Bundle | https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle |
read
, search-type
.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 |
{ "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" } ] } ] }