Scheduling
1.0.1-current - ci-build
Scheduling
1.0.1-current - ci-build
Scheduling, published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.Scheduling/ and changes regularly. See the Directory of published versions
| Active as of 2024-12-12 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:CapabilityStatement ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "IHE.Scheduling.server"] ; #
fhir:text [
fhir:status [ fhir:v "extensions" ] ;
fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement IHE.Scheduling.server</b></p><a name=\"IHE.Scheduling.server\"> </a><a name=\"hcIHE.Scheduling.server\"> </a><a name=\"IHE.Scheduling.server-en-US\"> </a><h2 id=\"title\">IHE Scheduling Server</h2><ul><li>Implementation Guide Version: 1.0.1-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <strong>SHALL</strong> support <code>application/fhir+xml</code>, <strong>SHALL</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>server</code></h3></div><div class=\"panel-body\"><div><p>Scheduling server provides capability to query for Patient resources matching a sub-set of the FHIR core Patient resource query parameters</p>\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><tr><td><a href=\"#Bundle1-2\">Bundle</a></td><td><a href=\"StructureDefinition-ihe-sched-avail-bundle.html\">https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle</a></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><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 class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Bundle1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Bundle</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-avail-bundle.html\">IHE ITI Scheduling Bundle 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/></div></div><p/></div></div></div></div>"
] ; #
fhir:url [ fhir:v "https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.server"^^xsd:anyURI] ; #
fhir:version [ fhir:v "1.0.1-current"] ; #
fhir:name [ fhir:v "IHE_Scheduling_Server"] ; #
fhir:title [ fhir:v "IHE Scheduling Server"] ; #
fhir:status [ fhir:v "active"] ; #
fhir:experimental [ fhir:v "false"^^xsd:boolean] ; #
fhir:date [ fhir:v "2024-12-12"^^xsd:date] ; #
fhir:publisher [ fhir:v "IHE IT Infrastructure Technical Committee"] ; #
fhir:contact ( [
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "https://www.ihe.net/ihe_domains/it_infrastructure/" ] ] )
] [
( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "iti@ihe.net" ] ] )
] [
fhir:name [ fhir:v "IHE IT Infrastructure Technical Committee" ] ;
( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "iti@ihe.net" ] ] )
] ) ; #
fhir:description [ fhir:v "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."] ; #
fhir:jurisdiction ( [
( fhir:coding [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ] ;
fhir:code [ fhir:v "001" ] ] )
] ) ; #
fhir:copyright [ fhir:v "IHE http://www.ihe.net/Governance/#Intellectual_Property"] ; #
fhir:kind [ fhir:v "requirements"] ; #
fhir:fhirVersion [ fhir:v "4.0.1"] ; #
fhir:format ( [
fhir:v "application/fhir+xml" ;
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] )
] [
fhir:v "application/fhir+json" ;
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] )
] ) ; #
fhir:implementationGuide ( [
fhir:v "https://profiles.ihe.net/ITI/BALP/ImplementationGuide/ihe.iti.balp"^^xsd:anyURI ;
fhir:link <https://profiles.ihe.net/ITI/BALP/ImplementationGuide/ihe.iti.balp> ;
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHOULD" ] ] )
] ) ; #
fhir:rest ( [
fhir:mode [ fhir:v "server" ] ;
fhir:documentation [ fhir:v "Scheduling server provides capability to query for Patient resources matching a sub-set of the FHIR core Patient resource query parameters" ] ;
fhir:security [
fhir:cors [ fhir:v "false"^^xsd:boolean ] ;
fhir:description [ fhir:v "None mandated by IHE, encouraged IHE-IUA or SMART-on-FHIR" ] ] ;
( fhir:resource [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] [
fhir:url [ fhir:v "required"^^xsd:anyURI ] ;
fhir:value [ fhir:v "patient" ] ] [
fhir:url [ fhir:v "required"^^xsd:anyURI ] ;
fhir:value [ fhir:v "date" ] ] ) ;
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"^^xsd:anyURI ] ] ) ;
fhir:type [ fhir:v "Appointment" ] ;
fhir:profile [
fhir:v "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt"^^xsd:anyURI ;
fhir:link <https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt> ;
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ] ;
( fhir:interaction [
fhir:code [ fhir:v "read" ] ] [
fhir:code [ fhir:v "search-type" ] ] ) ;
( fhir:searchParam [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ;
fhir:name [ fhir:v "_id" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/SearchParameter/Resource-id"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/SearchParameter/Resource-id> ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Logical id of this artifact" ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ;
fhir:name [ fhir:v "identifier" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/SearchParameter/clinical-identifier"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/SearchParameter/clinical-identifier> ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "The client **SHALL** provide both the system and code values." ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ;
fhir:name [ fhir:v "patient" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/SearchParameter/Appointment-patient"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/SearchParameter/Appointment-patient> ] ;
fhir:type [ fhir:v "reference" ] ;
fhir:documentation [ fhir:v "The patient, or one of the patients, for whom this apointement exists" ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHOULD" ] ] ) ;
fhir:name [ fhir:v "date" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/SearchParameter/clinical-date"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/SearchParameter/clinical-date> ] ;
fhir:type [ fhir:v "date" ] ;
fhir:documentation [ fhir:v "The date, or date range, for the appointments being searched." ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHOULD" ] ] ) ;
fhir:name [ fhir:v "specialty" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/SearchParameter/Appointment-specialty"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/SearchParameter/Appointment-specialty> ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "The specialty for which the appointments being searched is." ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHOULD" ] ] ) ;
fhir:name [ fhir:v "appointment-type" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/SearchParameter/Appointment-appointment-type"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/SearchParameter/Appointment-appointment-type> ] ;
fhir:type [ fhir:v "token" ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHOULD" ] ] ) ;
fhir:name [ fhir:v "practitioner" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/SearchParameter/Appointment-practitioner"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/SearchParameter/Appointment-practitioner> ] ;
fhir:type [ fhir:v "reference" ] ;
fhir:documentation [ fhir:v "The provider, or one of the providers, with whom this apointement is scheduled" ] ] ) ;
( fhir:operation [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ;
fhir:name [ fhir:v "find" ] ;
fhir:definition [
fhir:v "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-find"^^xsd:anyURI ;
fhir:link <https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-find> ] ;
fhir:documentation [ fhir:v "Document the find operation" ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ;
fhir:name [ fhir:v "book" ] ;
fhir:definition [
fhir:v "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book"^^xsd:anyURI ;
fhir:link <https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book> ] ;
fhir:documentation [ fhir:v "Document the book operation" ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHOULD" ] ] ) ;
fhir:name [ fhir:v "hold" ] ;
fhir:definition [
fhir:v "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-hold"^^xsd:anyURI ;
fhir:link <https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-hold> ] ;
fhir:documentation [ fhir:v "Document the hold operation" ] ] ) ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ;
fhir:type [ fhir:v "Bundle" ] ;
fhir:profile [
fhir:v "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle"^^xsd:anyURI ;
fhir:link <https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle> ;
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ] ] ) ;
( fhir:interaction [
fhir:code [ fhir:v "search-system" ] ] )
] ) . #
IG © 2024+ IHE IT Infrastructure Technical Committee. Package ihe.iti.scheduling#1.0.1-current based on FHIR 4.0.1. Generated 2024-12-16
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change