CapabilityStatement

https://www.hl7.org/fhir/capabilitystatement.html

Status

Released. Further enhancements planned.

Overview

The Capability Statement defines which functionality the PKB FHIR API supports.

Relevant PKB Entities

N/A

Endpoints

InteractionHTTPURLSupported Search ParamsPermitted User TypesDescriptionExamples (more)
capabilitiesGET/metadataNoneAllRetrieve PKB's Capability Statement. 
/metadata

Mappings

FHIRPKBNotes
CapabilityStatement.title"PKB FHIR API" 
CapabilityStatement.status"active" 
CapabilityStatement.experimental<conditional>
If this is a test server:
 true
Else: false
This value can be used by clients to determine whether or not the server supports production data.

For example, it will be true on https://sandbox.patientsknowbest.com.
CapabilityStatement.dateCurrent date and time, e.g. "2018-02-09T09:37:35+00:00"
CapabilityStatement.publisher"Patients Know Best Ltd." 
CapabilityStatement.kind"instance" 
CapabilityStatement.implementation
Details of the installation covered by this CapabilityStatement.
  • implementation: BackboneElement
    • description = "Patients Know Best"

CapabilityStatement.fhirVersion"3.0.1" 
CapabilityStatement.acceptUnknown"no" 
CapabilityStatement.format"application/fhir+json"This is correct for STU3.
CapabilityStatement.implementationGuide"http://dev.patientsknowbest.com/home/fhir-api" 
CapabilityStatement.restTo reflect current functionality.This portion of the Capability Statement will be updated as our supported feature set changes.
Subpages (1): Examples
Comments