Care Connect API
- CI Build
Care Connect API - Local Development build (vnull). See the Directory of published versions
Source view
{
"resourceType" : "CapabilityStatement",
"id" : "foundation",
"text" : {
"status" : "generated",
"div" : "<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>\n</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>"
},
"url" : "https://kevinmayfield.github.io/careconnect-api-stu3/CapabilityStatement/foundation",
"version" : "3.0.0",
"name" : "Care Connect Foundation API Capability Statement",
"status" : "active",
"date" : "2020-01-04T08:01:49+00:00",
"publisher" : "mayfield-is.co.uk",
"contact" : [
{
"telecom" : [
{
"system" : "email",
"value" : "kevin.mayfield@mayfield-is.co.uk"
}
]
}
],
"description" : "Minimal conformance requirements for a Foundation API. This would typically be found on health Systems",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "826"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "3.0.2",
"acceptUnknown" : "extensions",
"format" : [
"application/fhir+json"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"type" : "Flag",
"profile" : {
"reference" : "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Flag-1"
},
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "The ID of the resource"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "Business identifier"
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "The identity of a subject to list flags for"
}
]
},
{
"type" : "HealthcareService",
"profile" : {
"reference" : "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-HealthcareService-1"
},
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "The ID of the resource"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "Business identifier"
}
]
},
{
"type" : "Location",
"profile" : {
"reference" : "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1"
},
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "The ID of the resource"
},
{
"name" : "address-postalcode",
"type" : "string",
"documentation" : "A postal code specified in an address"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "An identifier for the location"
},
{
"name" : "name",
"type" : "string",
"documentation" : "A portion of the location's name or alias"
}
]
},
{
"type" : "Organization",
"profile" : {
"reference" : "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1"
},
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"conditionalUpdate" : true,
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "The ID of the resource"
},
{
"name" : "address-postalcode",
"type" : "string",
"documentation" : "A postal code specified in an address"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "Any identifier for the organization (not the accreditation issuer's identifier)"
},
{
"name" : "name",
"type" : "string",
"documentation" : "A portion of the organization's name or alias"
}
]
},
{
"type" : "Patient",
"profile" : {
"reference" : "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1"
},
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"conditionalUpdate" : true,
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "The ID of the resource"
},
{
"name" : "address-postalcode",
"type" : "string",
"documentation" : "A postalCode specified in an address"
},
{
"name" : "birthdate",
"type" : "date",
"documentation" : "The patient's date of birth"
},
{
"name" : "email",
"type" : "string",
"documentation" : "A value in an email contact"
},
{
"name" : "family",
"type" : "string",
"documentation" : "A portion of the family name of the patient"
},
{
"name" : "gender",
"definition" : "https://fhir.hl7.orguk/STU3/SearchParameter/careconnect-patient-gender",
"type" : "string",
"documentation" : "Gender of the patient"
},
{
"name" : "given",
"type" : "string",
"documentation" : "A portion of the given name of the patient"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "A patient identifier"
},
{
"name" : "name",
"type" : "string",
"documentation" : "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
},
{
"name" : "phone",
"type" : "string",
"documentation" : "A value in a phone contact"
}
]
},
{
"type" : "Practitioner",
"profile" : {
"reference" : "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1"
},
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"conditionalUpdate" : true,
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "The ID of the resource"
},
{
"name" : "address-postalcode",
"type" : "string",
"documentation" : "A postalCode specified in an address"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "A practitioner's Identifier"
},
{
"name" : "name",
"type" : "string",
"documentation" : "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
}
]
},
{
"type" : "PractitionerRole",
"profile" : {
"reference" : "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-PractitionerRole-1"
},
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"conditionalUpdate" : true,
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "The ID of the resource"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "A practitioner's Identifier"
},
{
"name" : "organization",
"type" : "reference",
"documentation" : "The identity of the organization the practitioner represents / acts on behalf of"
},
{
"name" : "practitioner",
"type" : "reference",
"documentation" : "Practitioner that is able to provide the defined services for the organation"
}
]
},
{
"type" : "Procedure",
"profile" : {
"reference" : "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Procedure-1"
},
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"conditionalUpdate" : true,
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "The ID of the resource"
},
{
"name" : "date",
"type" : "date",
"documentation" : "Date/Period the procedure was performed"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "A unique identifier for a procedure"
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "Search by subject - a patient"
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "Search by subject"
}
]
}
]
}
]
}