This page is part of the Argonaut Scheduling Implementation Guide (v1.0.0: Release) based on FHIR R3. This is the current published version. For a full list of available versions, see the Directory of published versions 
JSON Format: CapabilityStatement-client
Raw json
{
"resourceType" : "CapabilityStatement",
"id" : "client",
"text" : {
"status" : "additional",
"div" : "<div xmlns="http://www.w3.org/1999/xhtml">
<h2 id="argonaut-scheduling-conformance-requirements">Argonaut Scheduling Conformance Requirements</h2>
<p>This section outlines conformance requirements for the Argonaut Scheduling Client applications, identifying the specific profiles that need to be supported, the specific RESTful operations that need to be supported, and the search parameters that need to be supported. Note: The individual Argonaut Scheduling profiles identify the structural constraints, terminology bindings and invariants, however, implementers must refer to the conformance requirements for details on the RESTful operations, specific profiles and the search parameters applicable to each of the Argonaut Scheduling actors.</p>
<h3 id="conformance-requirements-for-the-argonaut-scheduling-implementation-guide-client">Conformance requirements for the Argonaut Scheduling Implementation Guide Client</h3>
<ul>
<li>FHIR Version: 3.0.1</li>
<li>Supported formats: xml, json</li>
<li>Published: March 20, 2018</li>
<li>Published by: The Argonaut Project</li>
</ul>
<p>The Section describes the expected capabilities of the Argonaut Scheduling Scheduling Client which is responsible for creating and initiating the queries for information about patient scheduling as well as creating and updating this information. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Argonaut Scheduling Servers are defined in the Argonaut Scheduling Server CapabilityStatement. Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.</p>
<h4 id="behavior">Behavior</h4>
<p>Description:</p>
<p>The Argonaut Scheduling Client <strong>SHOULD</strong>:</p>
<ol>
<li>Support fetching and querying scheduling information, using the supported RESTful interactions and search parameters declared in the Argonaut Scheduling Server CapabilityStatement.</li>
<li>Conform to the <a href="http://hl7.org/fhir/us/core/1.0.1">US Core Implementation Guide</a>.</li>
</ol>
<p>The Argonaut Scheduling Client <strong>MAY</strong>:</p>
<ol>
<li>Support creation and updates of scheduling and patient information, using the supported RESTful interactions and search parameters declared in the Argonaut Scheduling Server CapabilityStatement.</li>
</ol>
<h4 id="security-">Security:</h4>
<p>For general security consideration refer to the <a href="http://hl7.org/fhir/us/core/security.html">Security section</a> in the US Core Implementation Guide.</p>
<h4 id="profile-interaction-summary-">Profile Interaction Summary:</h4>
<p>Specific server search capabilities are described in detail in each of the resource sections below.</p>
<h4 id="appointment">Appointment</h4>
<p>Supported Profiles: <a href="StructureDefinition-argo-appt.html">Argonaut Appointment Profile</a>
</p>
<h5>Capabilities</h5>
<ol>
<li>
<p>A client <strong>SHOULD</strong> be capable of fetching Appointments using:</p>
<p>
<code>GET [base]/Appointment/[id]</code>.</p>
</li>
<li>
<p>A client <strong>SHOULD</strong> be capable of fetching Appointments using search:</p>
<p>
<code>GET [base]/Appointment?patient=[id]{&status=[status]}{&date=[date]{&date=[date]}}{&practitioner=[id]}</code>
</p>
<ol>
<li>A client <strong>SHOULD</strong> support the following search parameters:<ul>
<li>_id</li>
<li>patient</li>
<li>status</li>
<li>date - including the date modifiers ‘ge’,’le’,’gt’,’lt’</li>
<li>practitioner</li>
</ul>
</li>
</ol>
</li>
</ol>
<ol>
<li>
<p>A client <strong>SHOULD</strong> be capable of fetching Appointments by supporting the <a href="OperationDefinition-appointment-find.html">Appointment Availability Operation</a> using either the <code>GET</code> or <code>POST</code> syntax.</p>
<p>
<code>GET [base]/Appointment/$find?{parameters}&?{_count}</code>
</p>
<p>
<code>POST [base]/Appointment/$find?{_count}</code>
</p>
</li>
<li>
<p>A client <strong>MAY</strong> be capable of creating or updating Appointments by supporting the <a href="OperationDefinition-appointment-hold.html">Appointment Hold Operation</a>.</p>
<p>
<code>POST [base]/Appointment/[id]/$hold</code>
</p>
<p>
<code>POST [base]/Appointment/$hold</code>
</p>
</li>
<li>
<p>A client <strong>SHOULD</strong> be capable of creating or updating Appointments by supporting the <a href="OperationDefinition-appointment-book.html">Appointment Book Operation</a>.</p>
<p>
<code>POST [base]/Appointment/[id]/$hold</code>
</p>
<p>
<code>POST [base]/Appointment/$hold</code>
</p>
</li>
<li>
<p>A client <strong>SHOULD</strong> be capable of updating Appointments by supporting patch using either JSON, XML, or FHIRPath Patch.</p>
<p>
<code>PATCH [Base]/Appointment/[id]</code>
</p>
</li>
</ol>
<hr/>
<h4 id="bundle">Bundle</h4>
<p>Supported Profiles:</p>
<ul>
<li>
<a href="StructureDefinition-avail-bundle.html">Argonaut Appointment Bundle Profile</a>
</li>
<li>
<p>
<a href="StructureDefinition-slot-bundle.html">Argonaut Slot Bundle Profile</a>
</p>
</li>
<li>
<p>A client <strong>SHOULD</strong> be capable of consuming a Bundle as a response to a a query or operation.</p>
</li>
</ul>
<h4 id="coverage">Coverage</h4>
<p>Supported Profiles: <a href="StructureDefinition-argo-coverage.html">Argonaut Coverage Profile</a>
</p>
<h5>Capabilities</h5>
<ol>
<li>
<p>A client <strong>MAY</strong> be capable of updating or creating a patient's Coverage.</p>
<p>
<code>PUT [base]/Coverage/[id]</code>
</p>
<p>
<code>PUT or POST [base]/Coverage</code>
</p>
</li>
</ol>
<hr/>
<h4 id="patient">Patient</h4>
<p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/1.0.1//StructureDefinition-us-core-patient.html#search">US Core Patient Profile</a>
</p>
<h5>Capabilities</h5>
<ol>
<li>
<p>A client <strong>SHOULD</strong> be capable of searching for Patients as defined in the US Core Implementation Guide.</p>
</li>
<li>
<p>A client <strong>MAY</strong> be capable of creating Patients by supporting create.</p>
<p>
<code>POST [base]/Patient</code>
</p>
</li>
</ol>
<hr/>
<h4 id="schedule">Schedule</h4>
<p>Supported Profiles: <a href="StructureDefinition-argo-sched-notif.html">Argonaut Schedule Notification Profile</a>
</p>
<ol>
<li>A client <strong>MAY</strong> be capable of consuming a Schedule notification as a response to a <a href="StructureDefinition-argo-sub-notif.html">Argonaut Scheduling Subscription Profile</a>.</li>
</ol>
<hr/>
<h4>Slot</h4>
<p>Supported Profiles: <a href="StructureDefinition-prefetch-slot.html">Argonaut Prefetch Slot Profile</a>
</p>
<h5>Capabilities</h5>
<ol>
<li>
<p>A client <strong>MAY</strong> be capable of fetching Slots by supporting the <a href="OperationDefinition-appointment-find.html">Appointment Availability Operation</a>.</p>
<ul>
<li>
<p>Both the <code>GET</code> and <code>POST</code> Syntax SHALL be supported:</p>
<p>
<code>GET [base]/Slot/$prefetch?{parameters}</code>
</p>
<p>
<code>POST [base]/Slot/$prefetch</code>
</p>
</li>
</ul>
</li>
</ol>
<hr/>
<h4 id="subscription">Subscription</h4>
<p>Supported Profiles: <a href="StructureDefinition-argo-sub-notif.html">Argonaut Scheduling Subscription Profile</a>
</p>
<h5>Capabilities</h5>
<ol>
<li>
<p>A client <strong>MAY</strong> be capable of creating Subscriptions</p>
<p>
<code>POST [base]/Subscription</code>
</p>
</li>
<li>
<p>A client <strong>MAY</strong> be capable of deleting Subscriptions</p>
<p>
<code>DELETE [base]/Subscription</code>
</p>
</li>
</ol>
</div>"
},
"url" : "http://fhir.org/guides/argonaut-scheduling/CapabilityStatement/client",
"version" : "1.0.0",
"name" : "Argonaut_Scheduling_Client_CapabilityStatement",
"title" : "Argonaut Scheduling Client CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2018-03-18T18:00:00+11:00",
"publisher" : "Argonaut Project",
"description" : "The Argonaut Scheduling Client CapabilityStatement provides a for a complete list of supported RESTful interactions for the Argonaut Scheduling Implementation Guide",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "3.0.1",
"format" : [
"application/fhir+xml",
"application/fhir+json"
],
"patchFormat" : [
"application/json-patch+json",
"application/xml-patch+xml",
"application/fhirpath-patch+fhirpath"
],
"implementationGuide" : [
"http://fhir.org/guides/argonaut-scheduling/ImplementationGuide/ig",
"http://hl7.org/fhir/us/core/ImplementationGuide/ig"
],
"rest" : [
{
"mode" : "server",
"documentation" : "The [Argonaut](http://argonautwiki.hl7.org/) Scheduling Project is a vendor agnostic specification providing FHIR RESTful APIs and guidance for access to and booking of appointments for patients by both patient and practitioner end users. This specification is based on [FHIR Version 3.0.1](http://hl7.org/fhir/STU3) and specifically the [Scheduling and Appointment resources](http://hl7.org/fhir/STU3/administration-module.html#sched).",
"security" : {
"service" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/restful-security-service",
"code" : "SMART-on-FHIR"
}
]
}
],
"description" : "For general security consideration refer to the [Security section](http://hl7.org/fhir/us/core/security.html) in the US Core Implementation Guide."
},
"resource" : [
{
"type" : "Appointment",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "patch"
}
],
"referencePolicy" : [
"enforced"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/_id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/patient",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/status",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/date",
"type" : "date"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "practitioner",
"definition" : "http://hl7.org/fhir/SearchParameter/practitioner",
"type" : "reference",
"documentation" : "including the date modifiers ‘ge’,’le’,’gt’,’lt’"
}
]
},
{
"type" : "Coverage",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
}
],
"updateCreate" : true,
"referencePolicy" : [
"enforced"
]
},
{
"type" : "Patient",
"documentation" : "A serve **SHALL** be capable of searching for Patients as defined in the US Core Implementation Guide",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
],
"referencePolicy" : [
"enforced"
]
},
{
"type" : "Schedule",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "read"
}
]
},
{
"type" : "Subscription",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
}
]
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "find",
"definition" : {
"reference" : "http://fhir.org/guides/argonaut-scheduling/OperationDefinition/appointment-find"
}
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "hold",
"definition" : {
"reference" : "http://fhir.org/guides/argonaut-scheduling/OperationDefinition/appointment-hold"
}
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "book",
"definition" : {
"reference" : "http://fhir.org/guides/argonaut-scheduling/OperationDefinition/appointment-book"
}
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "prefetch",
"definition" : {
"reference" : "http://fhir.org/guides/argonaut-scheduling/OperationDefinition/slot-prefetch"
}
}
]
}
]
}
