eRS-PatientServiceSearch-Operation-1

Canonical_URLStatus
https://fhir.nhs.uk/STU3/OperationDefinition/eRS-PatientServiceSearch-Operation-1draft

HTML View

Parameters (In)

NameCardinalityTypeStructureDefinitionBindingDocumentation
patient1..1Identifier

The NHS Number of the patient who the search is for. Format: ^[0-9]{10}$

requestType1..1CodingeRS Request Type (required)

The type of request in e-RS which this service search is aimed at creating or updating. The options are appointment request (i.e. referral) or advice and guidance request. Services may support one or the other or both and will be filtered accordingly.

referringClinician0..1Identifier

Users with the role of Referring Clinician Admin need to indicate the Referring Clinician under whose authority they are acting. This parameter is required if and only if the logged in user has a role of Referring Clinician Admin and it is only applicable when searching services for a yet to be created request. Format: ^[0-9]{12}$

searchCriteria1..1eRS-ServiceSearchCriteria-Parameters-1

The search criteria contain details of the specific conditions which the services need to satisfy, such as the specialty supported or the distance from a given postcode.

sortBy1..1CodingeRS Sort By (required)

The service search returns the top results according to the sorting requested. Therefore, the sorting requested affects the selection of services that are included in the response.

commissioningRuleOrganisation0..1Identifier

Defines the organisation which should be utilised as part of the service search for the basis of commissioning rules within the system. System identifier https://fhir.nhs.uk/Id/ods-organization-code

Return Values (Out)

NameCardinalityTypeStructureDefinitionDocumentation
response1..1ListeRS-FetchServices-List-1

The List resource that has been returned in response to the given input parameters

Table View

OperationDefinition.meta[0].lastUpdated[0]2024-10-09T13:55:38.578129+00:00
OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/eRS-PatientServiceSearch-Operation-1
OperationDefinition.version[0]1.3.0
OperationDefinition.name[0]eRS-PatientServiceSearch-Operation-1
OperationDefinition.status[0]draft
OperationDefinition.kind[0]operation
OperationDefinition.date[0]2019-04-15T00:00:00+01:00
OperationDefinition.publisher[0]NHS Digital
OperationDefinition.contact[0].name[0]Interoperability Team
OperationDefinition.contact[0].telecom[0].system[0]email
OperationDefinition.contact[0].telecom[0].value[0]interoperabilityteam@nhs.net
OperationDefinition.contact[0].telecom[0].use[0]work
OperationDefinition.description[0]Request to retrieve a healthcare service using patient specific details.
OperationDefinition.code[0]ers.searchHealthcareServicesForPatient
OperationDefinition.system[0]False
OperationDefinition.type[0]True
OperationDefinition.instance[0]False
OperationDefinition.parameter[0].name[0]patient
OperationDefinition.parameter[0].use[0]in
OperationDefinition.parameter[0].min[0]1
OperationDefinition.parameter[0].max[0]1
OperationDefinition.parameter[0].documentation[0]The NHS Number of the patient who the search is for. Format: ^[0-9]{10}$
OperationDefinition.parameter[0].type[0]Identifier
OperationDefinition.parameter[1].name[0]requestType
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]1
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]The type of request in e-RS which this service search is aimed at creating or updating. The options are appointment request (i.e. referral) or advice and guidance request. Services may support one or the other or both and will be filtered accordingly.
OperationDefinition.parameter[1].type[0]Coding
OperationDefinition.parameter[1].binding[0].strength[0]required
OperationDefinition.parameter[1].binding[0].valueSet[0].reference[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-RequestType-1
OperationDefinition.parameter[2].name[0]referringClinician
OperationDefinition.parameter[2].use[0]in
OperationDefinition.parameter[2].min[0]0
OperationDefinition.parameter[2].max[0]1
OperationDefinition.parameter[2].documentation[0]Users with the role of Referring Clinician Admin need to indicate the Referring Clinician under whose authority they are acting. This parameter is required if and only if the logged in user has a role of Referring Clinician Admin and it is only applicable when searching services for a yet to be created request. Format: ^[0-9]{12}$
OperationDefinition.parameter[2].type[0]Identifier
OperationDefinition.parameter[3].name[0]searchCriteria
OperationDefinition.parameter[3].use[0]in
OperationDefinition.parameter[3].min[0]1
OperationDefinition.parameter[3].max[0]1
OperationDefinition.parameter[3].documentation[0]The search criteria contain details of the specific conditions which the services need to satisfy, such as the specialty supported or the distance from a given postcode.
OperationDefinition.parameter[3].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ServiceSearchCriteria-Parameters-1
OperationDefinition.parameter[4].name[0]sortBy
OperationDefinition.parameter[4].use[0]in
OperationDefinition.parameter[4].min[0]1
OperationDefinition.parameter[4].max[0]1
OperationDefinition.parameter[4].documentation[0]The service search returns the top results according to the sorting requested. Therefore, the sorting requested affects the selection of services that are included in the response.
OperationDefinition.parameter[4].type[0]Coding
OperationDefinition.parameter[4].binding[0].strength[0]required
OperationDefinition.parameter[4].binding[0].valueSet[0].reference[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-SortBy-1
OperationDefinition.parameter[5].name[0]commissioningRuleOrganisation
OperationDefinition.parameter[5].use[0]in
OperationDefinition.parameter[5].min[0]0
OperationDefinition.parameter[5].max[0]1
OperationDefinition.parameter[5].documentation[0]Defines the organisation which should be utilised as part of the service search for the basis of commissioning rules within the system. System identifier https://fhir.nhs.uk/Id/ods-organization-code
OperationDefinition.parameter[5].type[0]Identifier
OperationDefinition.parameter[6].name[0]response
OperationDefinition.parameter[6].use[0]out
OperationDefinition.parameter[6].min[0]1
OperationDefinition.parameter[6].max[0]1
OperationDefinition.parameter[6].documentation[0]The List resource that has been returned in response to the given input parameters
OperationDefinition.parameter[6].type[0]List
OperationDefinition.parameter[6].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-FetchServices-List-1

XML View

<OperationDefinition xmlns="http://hl7.org/fhir">
<meta>
<lastUpdated value="2024-10-09T13:55:38.578129+00:00" />
</meta>
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/eRS-PatientServiceSearch-Operation-1" />
<version value="1.3.0" />
<name value="eRS-PatientServiceSearch-Operation-1" />
<status value="draft" />
<kind value="operation" />
<date value="2019-04-15T00:00:00+01:00" />
<publisher value="NHS Digital" />
<contact>
<name value="Interoperability Team" />
<telecom>
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
</telecom>
</contact>
<description value="Request to retrieve a healthcare service using patient specific details." />
<code value="ers.searchHealthcareServicesForPatient" />
<system value="false" />
<type value="true" />
<instance value="false" />
<parameter>
<name value="patient" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The NHS Number of the patient who the search is for. Format: ^[0-9]{10}$" />
<type value="Identifier" />
</parameter>
<parameter>
<name value="requestType" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The type of request in e-RS which this service search is aimed at creating or updating. The options are appointment request (i.e. referral) or advice and guidance request. Services may support one or the other or both and will be filtered accordingly." />
<type value="Coding" />
<binding>
<strength value="required" />
<valueSetReference>
<reference value="https://fhir.nhs.uk/STU3/ValueSet/eRS-RequestType-1" />
</valueSetReference>
</binding>
</parameter>
<parameter>
<name value="referringClinician" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Users with the role of Referring Clinician Admin need to indicate the Referring Clinician under whose authority they are acting. This parameter is required if and only if the logged in user has a role of Referring Clinician Admin and it is only applicable when searching services for a yet to be created request. Format: ^[0-9]{12}$" />
<type value="Identifier" />
</parameter>
<parameter>
<name value="searchCriteria" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The search criteria contain details of the specific conditions which the services need to satisfy, such as the specialty supported or the distance from a given postcode." />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ServiceSearchCriteria-Parameters-1" />
</profile>
</parameter>
<parameter>
<name value="sortBy" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The service search returns the top results according to the sorting requested. Therefore, the sorting requested affects the selection of services that are included in the response." />
<type value="Coding" />
<binding>
<strength value="required" />
<valueSetReference>
<reference value="https://fhir.nhs.uk/STU3/ValueSet/eRS-SortBy-1" />
</valueSetReference>
</binding>
</parameter>
<parameter>
<name value="commissioningRuleOrganisation" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Defines the organisation which should be utilised as part of the service search for the basis of commissioning rules within the system. System identifier https://fhir.nhs.uk/Id/ods-organization-code" />
<type value="Identifier" />
</parameter>
<parameter>
<name value="response" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The List resource that has been returned in response to the given input parameters" />
<type value="List" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-FetchServices-List-1" />
</profile>
</parameter>
</OperationDefinition>

JSON View

{
"resourceType": "OperationDefinition",
"meta": {
"lastUpdated": "2024-10-09T13:55:38.578129+00:00"
},
"url": "https://fhir.nhs.uk/STU3/OperationDefinition/eRS-PatientServiceSearch-Operation-1",
"version": "1.3.0",
"name": "eRS-PatientServiceSearch-Operation-1",
"status": "draft",
"kind": "operation",
"date": "2019-04-15T00:00:00+01:00",
"publisher": "NHS Digital",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work"
}
]
}
],
"description": "Request to retrieve a healthcare service using patient specific details.",
"code": "ers.searchHealthcareServicesForPatient",
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "patient",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The NHS Number of the patient who the search is for. Format: ^[0-9]{10}$",
"type": "Identifier"
},
{
"name": "requestType",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The type of request in e-RS which this service search is aimed at creating or updating. The options are appointment request (i.e. referral) or advice and guidance request. Services may support one or the other or both and will be filtered accordingly.",
"type": "Coding",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://fhir.nhs.uk/STU3/ValueSet/eRS-RequestType-1"
}
}
},
{
"name": "referringClinician",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Users with the role of Referring Clinician Admin need to indicate the Referring Clinician under whose authority they are acting. This parameter is required if and only if the logged in user has a role of Referring Clinician Admin and it is only applicable when searching services for a yet to be created request. Format: ^[0-9]{12}$",
"type": "Identifier"
},
{
"name": "searchCriteria",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The search criteria contain details of the specific conditions which the services need to satisfy, such as the specialty supported or the distance from a given postcode.",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ServiceSearchCriteria-Parameters-1"
}
},
{
"name": "sortBy",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The service search returns the top results according to the sorting requested. Therefore, the sorting requested affects the selection of services that are included in the response.",
"type": "Coding",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://fhir.nhs.uk/STU3/ValueSet/eRS-SortBy-1"
}
}
},
{
"name": "commissioningRuleOrganisation",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Defines the organisation which should be utilised as part of the service search for the basis of commissioning rules within the system. System identifier https://fhir.nhs.uk/Id/ods-organization-code",
"type": "Identifier"
},
{
"name": "response",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The List resource that has been returned in response to the given input parameters",
"type": "List",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-FetchServices-List-1"
}
}
]
}
---
back to top