CapabilityStatement
| Profile uri |
|---|
| https://fhir.nhs.uk/CapabilityStatement/apim-conformance |
REST Capabilities Server
| Mode | Server |
Security
| Service | OAuth2 Token |
Resource Interactions
Search Parameters per resource type
CommunicationRequest
No search parameters are stated for this resource type
Encounter
| Name | Type | Documentation | Level |
|---|---|---|---|
| patient:identifier | token | The patient identifier (e.g. NHS Number) that the encounter is about | Supported |
| patient | reference | The patient that the encounter is about | Supported |
| class | token | Classification of patient encounter | Supported |
| identifier | token | The identifier that the encounter is about | Supported |
DocumentReference
| Name | Type | Documentation | Level |
|---|---|---|---|
| patient:identifier | token | Who/what is the subject of the document (by NHS Number) | Supported |
| patient | reference | Who/what is the subject of the document | Supported |
| type | token | Kind of document (SNOMED if possible) | Supported |
| category | token | Categorization of document | Supported |
| status | token | current | superseded | entered-in-error | Supported |
| date | date | When this document reference was created | Supported |
| period | date | Time of service that is being documented | Supported |
Flag
| Name | Type | Documentation | Level |
|---|---|---|---|
| patient:identifier | token | The patient identifier (e.g. NHS Number) that the flag is about | Supported |
| patient | reference | The patient that the flag is about | Supported |
HealthcareService
| Name | Type | Documentation | Level |
|---|---|---|---|
| identifier | token | A organisation identifier (e.g. ODS Code) | Supported |
| name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | Supported |
| address | string | A server defined search that may match any of the string fields in the Address, including line, city, county, country, postalCode, and/or text | Supported |
Observation
| Name | Type | Documentation | Level |
|---|---|---|---|
| patient:identifier | token | The patient identifier (e.g. NHS Number) that the observation is about | Supported |
| patient | reference | The patient that the observation is about | Supported |
| code | token | The code of the observation type | Supported |
| date | date | The code of the observation type | Supported |
Organization
| Name | Type | Documentation | Level |
|---|---|---|---|
| identifier | token | A organisation identifier (e.g. ODS Code) | Supported |
| name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | Supported |
| address | string | A server defined search that may match any of the string fields in the Address, including line, city, county, country, postalCode, and/or text | Supported |
Patient
| Name | Type | Documentation | Level |
|---|---|---|---|
| identifier | token | A patient identifier (e.g. NHS Number) | Supported |
| name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | Supported |
| birthdate | date | The patient's date of birth | Supported |
| gender | token | Gender of the patient | Supported |
| family | string | A portion of the family name of the patient | Supported |
Practitioner
| Name | Type | Documentation | Level |
|---|---|---|---|
| identifier | token | A practitioner identifier (e.g. GMC Code, GMP Code, GPHC Code, etc) | Supported |
| name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | Supported |
PractitionerRole
| Name | Type | Documentation | Level |
|---|---|---|---|
| organization:identifier | token | A organisation identifier (e.g. ODS Code) | Supported |
| practitioner:identifier | token | A practitioner identifier (e.g. GMC Code, GMP Code, GPHC Code, etc) | Supported |
Device
No search parameters are stated for this resource type
Endpoint
No search parameters are stated for this resource type
{ "resourceType": "CapabilityStatement", "id": "apim-conformance", "url": "https://fhir.nhs.uk/CapabilityStatement/apim-conformance", "version": "3.0.0", "name": "APIMCore", "status": "active", "date": "2021-04-28T00:00:00+00:00", "publisher": "digital.nhs.uk", "description": "Conformance requirements for NHS Digital RESTful Endpoinsts", "kind": "requirements", "fhirVersion": "4.0.1", "format": [ "application/fhir+json", "application/fhir+xml" ], "rest": [ { "mode": "server", "security": { "service": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/restful-security-service", "code": "OAuth", "display": "OAuth2 Token" } ] } ] }, "resource": [ { "type": "CommunicationRequest", "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest" }, { "type": "Encounter", "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Encounter", "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "patient:identifier", "type": "token", "documentation": "The patient identifier (e.g. NHS Number) that the encounter is about" }, { "name": "patient", "type": "reference", "documentation": "The patient that the encounter is about" }, { "name": "class", "type": "token", "documentation": "Classification of patient encounter" }, { "name": "identifier", "type": "token", "documentation": "The identifier that the encounter is about" } ] }, { "type": "DocumentReference", "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-DocumentReference", "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "patient:identifier", "type": "token", "documentation": "Who/what is the subject of the document (by NHS Number)" }, { "name": "patient", "type": "reference", "documentation": "Who/what is the subject of the document" }, { "name": "type", "type": "token", "documentation": "Kind of document (SNOMED if possible)" }, { "name": "category", "type": "token", "documentation": "Categorization of document" }, { "name": "status", "type": "token", "documentation": "current | superseded | entered-in-error" }, { "name": "date", "type": "date", "documentation": "When this document reference was created" }, { "name": "period", "type": "date", "documentation": "Time of service that is being documented" } ] }, { "type": "Flag", "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Flag", "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "patient:identifier", "type": "token", "documentation": "The patient identifier (e.g. NHS Number) that the flag is about" }, { "name": "patient", "type": "reference", "documentation": "The patient that the flag is about" } ] }, { "type": "HealthcareService", "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-HealthcareService", "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "identifier", "type": "token", "documentation": "A organisation identifier (e.g. ODS Code)" }, { "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": "address", "type": "string", "documentation": "A server defined search that may match any of the string fields in the Address, including line, city, county, country, postalCode, and/or text" } ] }, { "type": "Observation", "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Observation", "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "patient:identifier", "type": "token", "documentation": "The patient identifier (e.g. NHS Number) that the observation is about" }, { "name": "patient", "type": "reference", "documentation": "The patient that the observation is about" }, { "name": "code", "type": "token", "documentation": "The code of the observation type" }, { "name": "date", "type": "date", "documentation": "The code of the observation type" } ] }, { "type": "Organization", "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization", "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "identifier", "type": "token", "documentation": "A organisation identifier (e.g. ODS Code)" }, { "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": "address", "type": "string", "documentation": "A server defined search that may match any of the string fields in the Address, including line, city, county, country, postalCode, and/or text" } ] }, { "type": "Patient", "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Patient", "interaction": [ { "code": "read" }, { "code": "search-type" } ], "searchParam": [ { "name": "identifier", "type": "token", "documentation": "A patient identifier (e.g. NHS Number)" }, { "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": "birthdate", "type": "date", "documentation": "The patient's date of birth" }, { "name": "gender", "type": "token", "documentation": "Gender of the patient" }, { "name": "family", "type": "string", "documentation": "A portion of the family name of the patient" } ] }, { "type": "Practitioner", "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Practitioner", "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "identifier", "type": "token", "documentation": "A practitioner identifier (e.g. GMC Code, GMP Code, GPHC Code, etc)" }, { "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": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole", "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "organization:identifier", "type": "token", "documentation": "A organisation identifier (e.g. ODS Code)" }, { "name": "practitioner:identifier", "type": "token", "documentation": "A practitioner identifier (e.g. GMC Code, GMP Code, GPHC Code, etc)" } ] }, { "type": "Device", "profile": "https://fhir.nhs.uk/StructureDefinition/SDS-Device" }, { "type": "Endpoint", "profile": "https://fhir.nhs.uk/StructureDefinition/SDS-Endpoint" } ] } ] }
<CapabilityStatement xmlns="http://hl7.org/fhir"> <id value="apim-conformance" /> <url value="https://fhir.nhs.uk/CapabilityStatement/apim-conformance" /> <version value="3.0.0" /> <name value="APIMCore" /> <status value="active" /> <date value="2021-04-28T00:00:00+00:00" /> <publisher value="digital.nhs.uk" /> <description value="Conformance requirements for NHS Digital RESTful Endpoinsts" /> <kind value="requirements" /> <fhirVersion value="4.0.1" /> <format value="application/fhir+json" /> <format value="application/fhir+xml" /> <rest> <mode value="server" /> <security> <service> <coding> <system value="http://terminology.hl7.org/CodeSystem/restful-security-service" /> <code value="OAuth" /> <display value="OAuth2 Token" /> </coding> </service> </security> <resource> <type value="CommunicationRequest" /> <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest" /> </resource> <resource> <type value="Encounter" /> <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Encounter" /> <interaction> <code value="search-type" /> </interaction> <searchParam> <name value="patient:identifier" /> <type value="token" /> <documentation value="The patient identifier (e.g. NHS Number) that the encounter is about" /> </searchParam> <searchParam> <name value="patient" /> <type value="reference" /> <documentation value="The patient that the encounter is about" /> </searchParam> <searchParam> <name value="class" /> <type value="token" /> <documentation value="Classification of patient encounter" /> </searchParam> <searchParam> <name value="identifier" /> <type value="token" /> <documentation value="The identifier that the encounter is about" /> </searchParam> </resource> <resource> <type value="DocumentReference" /> <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-DocumentReference" /> <interaction> <code value="search-type" /> </interaction> <searchParam> <name value="patient:identifier" /> <type value="token" /> <documentation value="Who/what is the subject of the document (by NHS Number)" /> </searchParam> <searchParam> <name value="patient" /> <type value="reference" /> <documentation value="Who/what is the subject of the document" /> </searchParam> <searchParam> <name value="type" /> <type value="token" /> <documentation value="Kind of document (SNOMED if possible)" /> </searchParam> <searchParam> <name value="category" /> <type value="token" /> <documentation value="Categorization of document" /> </searchParam> <searchParam> <name value="status" /> <type value="token" /> <documentation value="current | superseded | entered-in-error" /> </searchParam> <searchParam> <name value="date" /> <type value="date" /> <documentation value="When this document reference was created" /> </searchParam> <searchParam> <name value="period" /> <type value="date" /> <documentation value="Time of service that is being documented" /> </searchParam> </resource> <resource> <type value="Flag" /> <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Flag" /> <interaction> <code value="search-type" /> </interaction> <searchParam> <name value="patient:identifier" /> <type value="token" /> <documentation value="The patient identifier (e.g. NHS Number) that the flag is about" /> </searchParam> <searchParam> <name value="patient" /> <type value="reference" /> <documentation value="The patient that the flag is about" /> </searchParam> </resource> <resource> <type value="HealthcareService" /> <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-HealthcareService" /> <interaction> <code value="search-type" /> </interaction> <searchParam> <name value="identifier" /> <type value="token" /> <documentation value="A organisation identifier (e.g. ODS Code)" /> </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="address" /> <type value="string" /> <documentation value="A server defined search that may match any of the string fields in the Address, including line, city, county, country, postalCode, and/or text" /> </searchParam> </resource> <resource> <type value="Observation" /> <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Observation" /> <interaction> <code value="search-type" /> </interaction> <searchParam> <name value="patient:identifier" /> <type value="token" /> <documentation value="The patient identifier (e.g. NHS Number) that the observation is about" /> </searchParam> <searchParam> <name value="patient" /> <type value="reference" /> <documentation value="The patient that the observation is about" /> </searchParam> <searchParam> <name value="code" /> <type value="token" /> <documentation value="The code of the observation type" /> </searchParam> <searchParam> <name value="date" /> <type value="date" /> <documentation value="The code of the observation type" /> </searchParam> </resource> <resource> <type value="Organization" /> <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization" /> <interaction> <code value="search-type" /> </interaction> <searchParam> <name value="identifier" /> <type value="token" /> <documentation value="A organisation identifier (e.g. ODS Code)" /> </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="address" /> <type value="string" /> <documentation value="A server defined search that may match any of the string fields in the Address, including line, city, county, country, postalCode, and/or text" /> </searchParam> </resource> <resource> <type value="Patient" /> <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Patient" /> <interaction> <code value="read" /> </interaction> <interaction> <code value="search-type" /> </interaction> <searchParam> <name value="identifier" /> <type value="token" /> <documentation value="A patient identifier (e.g. NHS Number)" /> </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="birthdate" /> <type value="date" /> <documentation value="The patient's date of birth" /> </searchParam> <searchParam> <name value="gender" /> <type value="token" /> <documentation value="Gender of the patient" /> </searchParam> <searchParam> <name value="family" /> <type value="string" /> <documentation value="A portion of the family name of the patient" /> </searchParam> </resource> <resource> <type value="Practitioner" /> <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Practitioner" /> <interaction> <code value="search-type" /> </interaction> <searchParam> <name value="identifier" /> <type value="token" /> <documentation value="A practitioner identifier (e.g. GMC Code, GMP Code, GPHC Code, etc)" /> </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 value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole" /> <interaction> <code value="search-type" /> </interaction> <searchParam> <name value="organization:identifier" /> <type value="token" /> <documentation value="A organisation identifier (e.g. ODS Code)" /> </searchParam> <searchParam> <name value="practitioner:identifier" /> <type value="token" /> <documentation value="A practitioner identifier (e.g. GMC Code, GMP Code, GPHC Code, etc)" /> </searchParam> </resource> <resource> <type value="Device" /> <profile value="https://fhir.nhs.uk/StructureDefinition/SDS-Device" /> </resource> <resource> <type value="Endpoint" /> <profile value="https://fhir.nhs.uk/StructureDefinition/SDS-Endpoint" /> </resource> </rest> </CapabilityStatement>