WARNING
This guidance is under active development by NHS England and content may be added or updated on a regular basis.Capability Statements
The Capability Statement documents the required capabilities (behaviours) of a FHIR Server or Client Application.
The CPIS-FHIR-API-Consuer Capability Statement documents required capabilities for Client applications connecting to the National CP-IS FHIR Service.
REST Capabilities Client
Mode | Client |
Security
Cors | False |
Service | OAuth |
Description | OIDC and OAuth2 via user present CIS2 |
Resource Interactions
Resource Type | Profile | Supported Profiles | Read |
---|---|---|---|
CareTeam | CareTeam | ✓ | |
AuditEvent | AuditEvent | ✓ |
Search Parameters per resource type
CareTeam
Name | Type | Level |
---|---|---|
patient | token | Supported |
AuditEvent
Name | Type | Documentation | Level |
---|---|---|---|
patient | token | AuditEvent.agent.who.where(resolve() is Patient) | AuditEvent.entity.what.where(resolve() is Patient) | Supported |
Supported Includes:
- PractitionerRole
CapabilityStatement |
id : CPIS-FHIR-API-Consumer |
url : https://fhir.nhs.uk/CapabilityStatement/CPIS-FHIR-API-Consumer |
version : 1.0.0 |
name : CPISFHIRAPIConsumer |
title : CPIS FHIR API Consumer |
status : draft |
experimental : False |
date : 2023-10-02 |
publisher : NHS England |
contact |
name : NHS England |
telecom |
system : email |
value : interoperabilityteam@nhs.net |
use : work |
rank : 1 |
description : Conformance requirements for NHS England CPIS FHIR API Consumer Implementation Guide |
purpose : Conformance requirements for NHS England CPIS FHIR API Consumer Implementation Guide |
copyright : Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
kind : requirements |
fhirVersion : 4.0.1 |
format : json |
rest |
mode : client |
security |
cors : False |
service |
coding |
system : http://terminology.hl7.org/CodeSystem/restful-security-service |
code : OAuth |
description : OIDC and OAuth2 via user present CIS2 |
resource |
type : CareTeam |
profile : http://hl7.org/fhir/StructureDefinition/CareTeam |
interaction |
code : read |
searchParam |
name : patient |
definition : http://hl7.org/fhir/SearchParameter/clinical-patient |
type : token |
resource |
type : AuditEvent |
profile : http://hl7.org/fhir/StructureDefinition/AuditEvent |
interaction |
code : read |
searchInclude : PractitionerRole |
searchParam |
name : patient |
definition : http://hl7.org/fhir/SearchParameter/clinical-patient |
type : token |
documentation : AuditEvent.agent.who.where(resolve() is Patient) | AuditEvent.entity.what.where(resolve() is Patient) |
CapabilityStatement.id[0] | CPIS-FHIR-API-Consumer |
CapabilityStatement.url[0] | https://fhir.nhs.uk/CapabilityStatement/CPIS-FHIR-API-Consumer |
CapabilityStatement.version[0] | 1.0.0 |
CapabilityStatement.name[0] | CPISFHIRAPIConsumer |
CapabilityStatement.title[0] | CPIS FHIR API Consumer |
CapabilityStatement.status[0] | draft |
CapabilityStatement.experimental[0] | False |
CapabilityStatement.date[0] | 2023-10-02 |
CapabilityStatement.publisher[0] | NHS England |
CapabilityStatement.contact[0].name[0] | NHS England |
CapabilityStatement.contact[0].telecom[0].system[0] | |
CapabilityStatement.contact[0].telecom[0].value[0] | interoperabilityteam@nhs.net |
CapabilityStatement.contact[0].telecom[0].use[0] | work |
CapabilityStatement.contact[0].telecom[0].rank[0] | 1 |
CapabilityStatement.description[0] | Conformance requirements for NHS England CPIS FHIR API Consumer Implementation Guide |
CapabilityStatement.purpose[0] | Conformance requirements for NHS England CPIS FHIR API Consumer Implementation Guide |
CapabilityStatement.copyright[0] | Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
CapabilityStatement.kind[0] | requirements |
CapabilityStatement.fhirVersion[0] | 4.0.1 |
CapabilityStatement.format[0] | json |
CapabilityStatement.rest[0].mode[0] | client |
CapabilityStatement.rest[0].security[0].cors[0] | False |
CapabilityStatement.rest[0].security[0].service[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/restful-security-service |
CapabilityStatement.rest[0].security[0].service[0].coding[0].code[0] | OAuth |
CapabilityStatement.rest[0].security[0].description[0] | OIDC and OAuth2 via user present CIS2 |
CapabilityStatement.rest[0].resource[0].type[0] | CareTeam |
CapabilityStatement.rest[0].resource[0].profile[0] | http://hl7.org/fhir/StructureDefinition/CareTeam |
CapabilityStatement.rest[0].resource[0].interaction[0].code[0] | read |
CapabilityStatement.rest[0].resource[0].searchParam[0].name[0] | patient |
CapabilityStatement.rest[0].resource[0].searchParam[0].definition[0] | http://hl7.org/fhir/SearchParameter/clinical-patient |
CapabilityStatement.rest[0].resource[0].searchParam[0].type[0] | token |
CapabilityStatement.rest[0].resource[1].type[0] | AuditEvent |
CapabilityStatement.rest[0].resource[1].profile[0] | http://hl7.org/fhir/StructureDefinition/AuditEvent |
CapabilityStatement.rest[0].resource[1].interaction[0].code[0] | read |
CapabilityStatement.rest[0].resource[1].searchInclude[0] | PractitionerRole |
CapabilityStatement.rest[0].resource[1].searchParam[0].name[0] | patient |
CapabilityStatement.rest[0].resource[1].searchParam[0].definition[0] | http://hl7.org/fhir/SearchParameter/clinical-patient |
CapabilityStatement.rest[0].resource[1].searchParam[0].type[0] | token |
CapabilityStatement.rest[0].resource[1].searchParam[0].documentation[0] | AuditEvent.agent.who.where(resolve() is Patient) | AuditEvent.entity.what.where(resolve() is Patient) |
<CapabilityStatement xmlns="http://hl7.org/fhir"> <id value="CPIS-FHIR-API-Consumer" /> <url value="https://fhir.nhs.uk/CapabilityStatement/CPIS-FHIR-API-Consumer" /> <version value="1.0.0" /> <name value="CPISFHIRAPIConsumer" /> <title value="CPIS FHIR API Consumer" /> <status value="draft" /> <experimental value="false" /> <date value="2023-10-02" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="Conformance requirements for NHS England CPIS FHIR API Consumer Implementation Guide" /> <purpose value="Conformance requirements for NHS England CPIS FHIR API Consumer Implementation Guide" /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <kind value="requirements" /> <fhirVersion value="4.0.1" /> <format value="json" /> <rest> <mode value="client" /> <security> <cors value="false" /> <service> <coding> <system value="http://terminology.hl7.org/CodeSystem/restful-security-service" /> <code value="OAuth" /> </coding> </service> <description value="OIDC and OAuth2 via user present CIS2" /> </security> <resource> <type value="CareTeam" /> <profile value="http://hl7.org/fhir/StructureDefinition/CareTeam" /> <interaction> <code value="read" /> </interaction> <searchParam> <name value="patient" /> <definition value="http://hl7.org/fhir/SearchParameter/clinical-patient" /> <type value="token" /> </searchParam> </resource> <resource> <type value="AuditEvent" /> <profile value="http://hl7.org/fhir/StructureDefinition/AuditEvent" /> <interaction> <code value="read" /> </interaction> <searchInclude value="PractitionerRole" /> <searchParam> <name value="patient" /> <definition value="http://hl7.org/fhir/SearchParameter/clinical-patient" /> <type value="token" /> <documentation value="AuditEvent.agent.who.where(resolve() is Patient) | AuditEvent.entity.what.where(resolve() is Patient)" /> </searchParam> </resource> </rest> </CapabilityStatement>
{ "resourceType": "CapabilityStatement", "id": "CPIS-FHIR-API-Consumer", "url": "https://fhir.nhs.uk/CapabilityStatement/CPIS-FHIR-API-Consumer", "version": "1.0.0", "name": "CPISFHIRAPIConsumer", "title": "CPIS FHIR API Consumer", "status": "draft", "experimental": false, "date": "2023-10-02", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "Conformance requirements for NHS England CPIS FHIR API Consumer Implementation Guide", "purpose": "Conformance requirements for NHS England CPIS FHIR API Consumer Implementation Guide", "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "kind": "requirements", "fhirVersion": "4.0.1", "format": [ "json" ], "rest": [ { "mode": "client", "security": { "cors": false, "service": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/restful-security-service", "code": "OAuth" } ] } ], "description": "OIDC and OAuth2 via user present CIS2" }, "resource": [ { "type": "CareTeam", "profile": "http://hl7.org/fhir/StructureDefinition/CareTeam", "interaction": [ { "code": "read" } ], "searchParam": [ { "name": "patient", "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "type": "token" } ] }, { "type": "AuditEvent", "profile": "http://hl7.org/fhir/StructureDefinition/AuditEvent", "interaction": [ { "code": "read" } ], "searchInclude": [ "PractitionerRole" ], "searchParam": [ { "name": "patient", "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "type": "token", "documentation": "AuditEvent.agent.who.where(resolve() is Patient) | AuditEvent.entity.what.where(resolve() is Patient)" } ] } ] } ] }