CARECONNECT.API.R4\Appointment API - XML Representation

Care Connect API - Local Development build (v4.0.0). See the Directory of published versions
: Appointment API - XML Representation


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="appointment"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>Care Connect Appointment Capability Statement</h2><div><p>Minimal conformance requirements for a Appointment API. This would typically be found on Patient Administration Systems and Electronic Patient Record Systems</p>
</div><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td/></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title="GET a resource (read interaction)">Read</b></th><th><b title="GET all set of resources of the type (search interaction)">Search</b></th><th><b title="PUT a new resource version (update interaction)">Update</b></th><th><b title="POST a new resource (create interaction)">Create</b></th></tr><tr><td>Appointment</td><td><a href="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment">https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Schedule</td><td><a href="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule">https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Slot</td><td><a href="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Slot">https://fhir.hl7.org.uk/StructureDefinition/UKCore-Slot</a></td><td>y</td><td>y</td><td></td><td></td></tr></table></div>
  </text>
  <url
       value="https://project-wildfyre.github.io/careconnect-api-r4/CapabilityStatement/appointment"/>
  <version value="4.0.0"/>
  <name value="Care Connect Appointment Capability Statement"/>
  <status value="active"/>
  <date value="2021-04-02T09:18:26+01:00"/>
  <publisher value="mayfield-is.co.uk"/>
  <contact>
    <telecom>
      <system value="email"/>
      <value value="kevin.mayfield@mayfield-is.co.uk"/>
    </telecom>
  </contact>
  <description
               value="Minimal conformance requirements for a Appointment API. This would typically be found on Patient Administration Systems and Electronic Patient Record Systems"/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="826"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="application/fhir+json"/>
  <rest>
    <mode value="server"/>
    <resource>
      <type value="Appointment"/>
      <profile
               value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <conditionalUpdate value="true"/>
      <searchParam>
        <name value="_id"/>
        <type value="string"/>
        <documentation value="The ID of the resource"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation value="An Identifier of the Appointment"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Schedule"/>
      <profile
               value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="_id"/>
        <type value="string"/>
        <documentation value="The ID of the resource"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation value="A Schedule Identifier"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Slot"/>
      <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Slot"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <conditionalUpdate value="true"/>
      <searchParam>
        <name value="_id"/>
        <type value="string"/>
        <documentation value="The ID of the resource"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation value="A Slot Identifier"/>
      </searchParam>
      <searchParam>
        <name value="schedule"/>
        <type value="reference"/>
        <documentation
                       value="The Schedule Resource that we are seeking a slot within"/>
      </searchParam>
      <searchParam>
        <name value="service"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <name value="start"/>
        <type value="date"/>
        <documentation value="Appointment date/time."/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <type value="string"/>
        <documentation value="The free/busy status of the appointment"/>
      </searchParam>
    </resource>
  </rest>
</CapabilityStatement>