Care Connect API - Local Development build (vnull). See the Directory of published versions

Foundation API - XML Representation

(back to description)

Raw xml

Source view

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="foundation"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>Care Connect Foundation API Capability Statement</h2><div><p>Minimal conformance requirements for a Foundation API. This would typically be found on health 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>Flag</td><td><a href="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Flag-1">https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Flag-1</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>HealthcareService</td><td><a href="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-HealthcareService-1">https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-HealthcareService-1</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Location</td><td><a href="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1">https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Organization</td><td><a href="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1">https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Patient</td><td><a href="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1">https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Practitioner</td><td><a href="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1">https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>PractitionerRole</td><td><a href="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-PractitionerRole-1">https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-PractitionerRole-1</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Procedure</td><td><a href="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Procedure-1">https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Procedure-1</a></td><td>y</td><td>y</td><td></td><td></td></tr></table></div>
  </text>
  <url
       value="https://kevinmayfield.github.io/careconnect-api-stu3/CapabilityStatement/foundation"/>
  <version value="3.0.0"/>
  <name value="Care Connect Foundation API Capability Statement"/>
  <status value="active"/>
  <date value="2020-01-04T08:01:49+00: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 Foundation API. This would typically be found on health Systems"/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="826"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="3.0.2"/>
  <acceptUnknown value="extensions"/>
  <format value="application/fhir+json"/>
  <rest>
    <mode value="server"/>
    <resource>
      <type value="Flag"/>
      <profile>
        <reference
                   value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Flag-1"/>
      </profile>
      <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="Business identifier"/>
      </searchParam>
      <searchParam>
        <name value="patient"/>
        <type value="reference"/>
        <documentation value="The identity of a subject to list flags for"/>
      </searchParam>
    </resource>
    <resource>
      <type value="HealthcareService"/>
      <profile>
        <reference
                   value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-HealthcareService-1"/>
      </profile>
      <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="Business identifier"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Location"/>
      <profile>
        <reference
                   value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1"/>
      </profile>
      <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="address-postalcode"/>
        <type value="string"/>
        <documentation value="A postal code specified in an address"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation value="An identifier for the location"/>
      </searchParam>
      <searchParam>
        <name value="name"/>
        <type value="string"/>
        <documentation value="A portion of the location&#39;s name or alias"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Organization"/>
      <profile>
        <reference
                   value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1"/>
      </profile>
      <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="address-postalcode"/>
        <type value="string"/>
        <documentation value="A postal code specified in an address"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation
                       value="Any identifier for the organization (not the accreditation issuer&#39;s identifier)"/>
      </searchParam>
      <searchParam>
        <name value="name"/>
        <type value="string"/>
        <documentation value="A portion of the organization&#39;s name or alias"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Patient"/>
      <profile>
        <reference
                   value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1"/>
      </profile>
      <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="address-postalcode"/>
        <type value="string"/>
        <documentation value="A postalCode specified in an address"/>
      </searchParam>
      <searchParam>
        <name value="birthdate"/>
        <type value="date"/>
        <documentation value="The patient&#39;s date of birth"/>
      </searchParam>
      <searchParam>
        <name value="email"/>
        <type value="string"/>
        <documentation value="A value in an email contact"/>
      </searchParam>
      <searchParam>
        <name value="family"/>
        <type value="string"/>
        <documentation value="A portion of the family name of the patient"/>
      </searchParam>
      <searchParam>
        <name value="gender"/>
        <definition
                    value="https://fhir.hl7.orguk/STU3/SearchParameter/careconnect-patient-gender"/>
        <type value="string"/>
        <documentation value="Gender of the patient"/>
      </searchParam>
      <searchParam>
        <name value="given"/>
        <type value="string"/>
        <documentation value="A portion of the given name of the patient"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation value="A patient identifier"/>
      </searchParam>
      <searchParam>
        <name value="name"/>
        <type value="string"/>
        <documentation
                       value="A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"/>
      </searchParam>
      <searchParam>
        <name value="phone"/>
        <type value="string"/>
        <documentation value="A value in a phone contact"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Practitioner"/>
      <profile>
        <reference
                   value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1"/>
      </profile>
      <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="address-postalcode"/>
        <type value="string"/>
        <documentation value="A postalCode specified in an address"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation value="A practitioner&#39;s Identifier"/>
      </searchParam>
      <searchParam>
        <name value="name"/>
        <type value="string"/>
        <documentation
                       value="A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"/>
      </searchParam>
    </resource>
    <resource>
      <type value="PractitionerRole"/>
      <profile>
        <reference
                   value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-PractitionerRole-1"/>
      </profile>
      <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 practitioner&#39;s Identifier"/>
      </searchParam>
      <searchParam>
        <name value="organization"/>
        <type value="reference"/>
        <documentation
                       value="The identity of the organization the practitioner represents / acts on behalf of"/>
      </searchParam>
      <searchParam>
        <name value="practitioner"/>
        <type value="reference"/>
        <documentation
                       value="Practitioner that is able to provide the defined services for the organation"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Procedure"/>
      <profile>
        <reference
                   value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Procedure-1"/>
      </profile>
      <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="date"/>
        <type value="date"/>
        <documentation value="Date/Period the procedure was performed"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation value="A unique identifier for a procedure"/>
      </searchParam>
      <searchParam>
        <name value="patient"/>
        <type value="reference"/>
        <documentation value="Search by subject - a patient"/>
      </searchParam>
      <searchParam>
        <name value="subject"/>
        <type value="reference"/>
        <documentation value="Search by subject"/>
      </searchParam>
    </resource>
  </rest>
</CapabilityStatement>