CapabilityStatement-ers-futures
REST Capabilities Server
Mode | Server |
---|
Security
Service | OAuth2 Token |
---|
Resource Interactions
Resource Type | Profile | Supported Profiles | Create | SearchType | Read | Update |
---|---|---|---|---|---|---|
Appointment | NHSDigitalAppointment | ✓ | ✓ | |||
ServiceRequest | NHSDigitalServiceRequest | ✓ | ✓ | ✓ | ✓ | |
Task | NHSDigitalTask | ✓ | ✓ | ✓ | ✓ | |
Slot | EnglandSlot | ✓ | ||||
Questionnaire | NHSDigitalQuestionnaire | |||||
QuestionnaireResponse | NHSDigitalQuestionnaireResponse | ✓ | ✓ | |||
CodeSystem | CodeSystem | ✓ | ||||
HealthcareService | NHSDigitalHealthcareService | ✓ | ✓ | |||
DocumentReference | NHSDigitalDocumentReference | ✓ | ✓ | |||
Binary | NHSDigitalBinary | ✓ | ✓ |
Search Parameters per resource type
Appointment
Name | Type | Documentation | Level |
---|---|---|---|
patient:identifier | token | Search for appointment for a patient by NHS Number | Supported |
date | date | Appointment date/time. | Supported |
ServiceRequest
Name | Type | Documentation | Level |
---|---|---|---|
patient:identifier | token | The patient identifier (e.g. NHS Number) that the service request is about | Supported |
category | token | Classification of service | Supported |
_revinclude | composite | Inclusions that drive the rescursive depth of the search | Supported |
Supported Reverse Includes:
- Appointment:based-on
- Task:focus
- *
Task
Name | Type | Documentation | Level |
---|---|---|---|
owner | reference | Search by task owner | Supported |
code | token | Search by task code | Supported |
focus:identifier | token | Supported | |
focus | reference | Supported |
Slot
Name | Type | Documentation | Level |
---|---|---|---|
appointment-type | token | The style of appointment or patient that may be booked in the slot (not service type) | Supported |
schedule.actor:HealthcareService | reference | A single service ID is required to indicate the service for which appointment slots are required. | Supported |
status | token | The free/busy status of the appointment | Supported |
Questionnaire
No search parameters are stated for this resource type
QuestionnaireResponse
No search parameters are stated for this resource type
CodeSystem
Name | Type | Documentation | Level |
---|---|---|---|
url | uri | The uri that identifies the code system | Supported |
HealthcareService
Name | Type | Documentation | Level |
---|---|---|---|
service-type | token | The type of service provided by this healthcare service | Supported |
identifier | token | Can't find this parameter presume need to: External identifiers for this item | Supported |
DocumentReference
No search parameters are stated for this resource type
Binary
No search parameters are stated for this resource type