Scheduling
1.0.0 - Trial-Implementation
Scheduling
1.0.0 - Trial-Implementation
This page is part of the IHE ITI Scheduling (v1.0.0: Publication) 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
| Active as of 2024-12-12 |
{
"resourceType" : "CapabilityStatement",
"id" : "IHE.Scheduling.client",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement IHE.Scheduling.client</b></p><a name=\"IHE.Scheduling.client\"> </a><a name=\"hcIHE.Scheduling.client\"> </a><a name=\"IHE.Scheduling.client-en-US\"> </a><h2 id=\"title\">IHE Scheduling Client</h2><ul><li>Implementation Guide Version: 1.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <strong>SHALL</strong> support <code>application/fhir+xml</code>, <strong>SHOULD</strong> support <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-12-12 </li><li>Published by: IHE IT Infrastructure Technical Committee </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h3 id=\"shouldIGs\">SHOULD Support the Following Implementation Guides</h3><ul><li><a href=\"https://profiles.ihe.net/ITI/BALP/1.1.3/ImplementationGuide-ihe.iti.balp.html\">https://profiles.ihe.net/ITI/BALP/ImplementationGuide/ihe.iti.balp</a></li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div><p>IHE Scheduling client will</p>\n<ol>\n<li>query for Patient resources matching the Patient resource query parameters,</li>\n<li>query for Appointment resources matching the IHE Scheduling Appointment resource query parameters,</li>\n<li>use the operations defined for the Appointment resource</li>\n</ol>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>None mandated by IHE, encouraged IHE-IUA or SMART-on-FHIR</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>search-system</code>interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Appointment1-1\">Appointment</a></td><td><a href=\"StructureDefinition-ihe-sched-appt.html\">https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, identifier, patient, date, specialty, appointment-type, practitioner, patient+date</td><td/><td/><td><code>$find</code>, <code>$book</code>, <code>$hold</code></td></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Appointment1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Appointment</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ihe-sched-appt.html\">IHE ITI Appointment Profile</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>The client <strong>SHALL</strong> provide both the system and code values.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient, or one of the patients, for whom this apointement exists</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">date</a></td><td><code>date</code></td><td><div><p>The date, or date range, for the appointments being searched.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">specialty</a></td><td><code>token</code></td><td><div><p>The specialty for which the appointments being searched is.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">appointment-type</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">practitioner</a></td><td><code>reference</code></td><td><div><p>The provider, or one of the providers, with whom this apointement is scheduled</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/appointment.html#search\">date</a></td><td><code>reference</code>+<code>date</code></td></tr></tbody></table></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-appointment-find.html\">$find</a></td><td><div><p>Document the find operation</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-appointment-book.html\">$book</a></td><td><div><p>Document the book operation</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"OperationDefinition-appointment-hold.html\">$hold</a></td><td><div><p>Document the hold operation</p>\n</div></td></tr></tbody></table></div></div></div></div></div></div>"
},
"url" : "https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.client",
"version" : "1.0.0",
"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 \r\n1. query for Patient resources matching the Patient resource query parameters, \r\n1. query for Appointment resources matching the IHE Scheduling Appointment resource query parameters,\r\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"
}
]
}
]
}
IG © 2024+ IHE IT Infrastructure Technical Committee. Package ihe.iti.scheduling#1.0.0 based on FHIR 4.0.1. Generated 2024-12-12
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change