eRS-FetchWorklist-Operation-1

Canonical_URLStatus
https://fhir.nhs.uk/STU3/OperationDefinition/eRS-FetchWorklist-Operation-1active

HTML View

Parameters (In)

NameCardinalityTypeBindingDocumentation
listType0..1CodeableConcepteRS Referral List Selector (required)

Indicates the type of ReferralRequest list requested. Only one 'listType' parameter is supported in each call and must match the type of resource being fetched.

listType0..1CodeableConcepteRS Communication List Selector (required)

Indicates the type of CommunicationRequest list requested. Only one 'listType' parameter is supported in each call and must match the type of resource being fetched.

service0..1Identifier

The service identifier

specialtyAssignedIndicator0..1CodeableConcepteRS Assigned Indicator (required)

Indicates whether a Specialty is assigned to the Request. If 'Assigned' the 'Specialty' parameter must be present. If 'Not Assigned' the 'specialtyAssignedIndicator' and 'Specialty' parameter must be absent.

specialty0..1CodeableConcepthttps://eRS-Specialty-Code (required)

The Specialty for the service. If present, the 'specialtyAssignedIndicator' parameter must be set to 'Assigned'. The specialty list must be retrieved dynamically from the e-RS valueset.

location0..1Identifier

The service location identifier.

clinicianAssignedIndicator0..1CodeableConcepteRS Assigned Indicator (required)

Indicates whether a clinician is assigned to the Request. If 'Assigned' the 'Clinician' parameter must be present. If 'Not Assigned' the 'Clinician' parameter must be absent.

clinician0..1Identifier

The clinician assigned to the Request. If present, the 'ClinicianAssignedIndicator' parameter must be set to 'Assigned'

Return Values (Out)

NameCardinalityTypeStructureDefinitionDocumentation
response1..1ListeRS-FetchWorklist-List-1

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

Table View

OperationDefinition.meta[0].lastUpdated[0]2021-03-08T00:00:00+01:00
OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/eRS-FetchWorklist-Operation-1
OperationDefinition.version[0]1.1.0
OperationDefinition.name[0]eRS-FetchWorklist-Operation-1
OperationDefinition.status[0]active
OperationDefinition.kind[0]operation
OperationDefinition.date[0]2021-03-08T00: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 worklist for a referral request or communication request.
OperationDefinition.code[0]ers.fetchworklist
OperationDefinition.system[0]False
OperationDefinition.type[0]True
OperationDefinition.instance[0]False
OperationDefinition.parameter[0].name[0]listType
OperationDefinition.parameter[0].use[0]in
OperationDefinition.parameter[0].min[0]0
OperationDefinition.parameter[0].max[0]1
OperationDefinition.parameter[0].documentation[0]Indicates the type of ReferralRequest list requested. Only one 'listType' parameter is supported in each call and must match the type of resource being fetched.
OperationDefinition.parameter[0].type[0]CodeableConcept
OperationDefinition.parameter[0].binding[0].strength[0]required
OperationDefinition.parameter[0].binding[0].valueSet[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralListSelector-1
OperationDefinition.parameter[1].name[0]listType
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]0
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]Indicates the type of CommunicationRequest list requested. Only one 'listType' parameter is supported in each call and must match the type of resource being fetched.
OperationDefinition.parameter[1].type[0]CodeableConcept
OperationDefinition.parameter[1].binding[0].strength[0]required
OperationDefinition.parameter[1].binding[0].valueSet[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-CommunicationListSelector-1
OperationDefinition.parameter[2].name[0]service
OperationDefinition.parameter[2].use[0]in
OperationDefinition.parameter[2].min[0]0
OperationDefinition.parameter[2].max[0]1
OperationDefinition.parameter[2].documentation[0]The service identifier
OperationDefinition.parameter[2].type[0]Identifier
OperationDefinition.parameter[3].name[0]specialtyAssignedIndicator
OperationDefinition.parameter[3].use[0]in
OperationDefinition.parameter[3].min[0]0
OperationDefinition.parameter[3].max[0]1
OperationDefinition.parameter[3].documentation[0]Indicates whether a Specialty is assigned to the Request. If 'Assigned' the 'Specialty' parameter must be present. If 'Not Assigned' the 'specialtyAssignedIndicator' and 'Specialty' parameter must be absent.
OperationDefinition.parameter[3].type[0]CodeableConcept
OperationDefinition.parameter[3].binding[0].strength[0]required
OperationDefinition.parameter[3].binding[0].valueSet[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-AssignedIndicator-1
OperationDefinition.parameter[4].name[0]specialty
OperationDefinition.parameter[4].use[0]in
OperationDefinition.parameter[4].min[0]0
OperationDefinition.parameter[4].max[0]1
OperationDefinition.parameter[4].documentation[0]The Specialty for the service. If present, the 'specialtyAssignedIndicator' parameter must be set to 'Assigned'. The specialty list must be retrieved dynamically from the e-RS valueset.
OperationDefinition.parameter[4].type[0]CodeableConcept
OperationDefinition.parameter[4].binding[0].strength[0]required
OperationDefinition.parameter[4].binding[0].valueSet[0]https://eRS-Specialty-Code
OperationDefinition.parameter[5].name[0]location
OperationDefinition.parameter[5].use[0]in
OperationDefinition.parameter[5].min[0]0
OperationDefinition.parameter[5].max[0]1
OperationDefinition.parameter[5].documentation[0]The service location identifier.
OperationDefinition.parameter[5].type[0]Identifier
OperationDefinition.parameter[6].name[0]clinicianAssignedIndicator
OperationDefinition.parameter[6].use[0]in
OperationDefinition.parameter[6].min[0]0
OperationDefinition.parameter[6].max[0]1
OperationDefinition.parameter[6].documentation[0]Indicates whether a clinician is assigned to the Request. If 'Assigned' the 'Clinician' parameter must be present. If 'Not Assigned' the 'Clinician' parameter must be absent.
OperationDefinition.parameter[6].type[0]CodeableConcept
OperationDefinition.parameter[6].binding[0].strength[0]required
OperationDefinition.parameter[6].binding[0].valueSet[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-AssignedIndicator-1
OperationDefinition.parameter[7].name[0]clinician
OperationDefinition.parameter[7].use[0]in
OperationDefinition.parameter[7].min[0]0
OperationDefinition.parameter[7].max[0]1
OperationDefinition.parameter[7].documentation[0]The clinician assigned to the Request. If present, the 'ClinicianAssignedIndicator' parameter must be set to 'Assigned'
OperationDefinition.parameter[7].type[0]Identifier
OperationDefinition.parameter[8].name[0]response
OperationDefinition.parameter[8].use[0]out
OperationDefinition.parameter[8].min[0]1
OperationDefinition.parameter[8].max[0]1
OperationDefinition.parameter[8].documentation[0]The List resource that has been returned in response to the given input parameters
OperationDefinition.parameter[8].type[0]List
OperationDefinition.parameter[8].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-FetchWorklist-List-1

XML View

<OperationDefinition xmlns="http://hl7.org/fhir">
<meta>
<lastUpdated value="2021-03-08T00:00:00+01:00" />
</meta>
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/eRS-FetchWorklist-Operation-1" />
<version value="1.1.0" />
<name value="eRS-FetchWorklist-Operation-1" />
<status value="active" />
<kind value="operation" />
<date value="2021-03-08T00: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 worklist for a referral request or communication request." />
<code value="ers.fetchworklist" />
<system value="false" />
<type value="true" />
<instance value="false" />
<parameter>
<name value="listType" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Indicates the type of ReferralRequest list requested. Only one 'listType' parameter is supported in each call and must match the type of resource being fetched." />
<type value="CodeableConcept" />
<binding>
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralListSelector-1" />
</binding>
</parameter>
<parameter>
<name value="listType" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Indicates the type of CommunicationRequest list requested. Only one 'listType' parameter is supported in each call and must match the type of resource being fetched." />
<type value="CodeableConcept" />
<binding>
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/eRS-CommunicationListSelector-1" />
</binding>
</parameter>
<parameter>
<name value="service" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The service identifier" />
<type value="Identifier" />
</parameter>
<parameter>
<name value="specialtyAssignedIndicator" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Indicates whether a Specialty is assigned to the Request. If 'Assigned' the 'Specialty' parameter must be present. If 'Not Assigned' the 'specialtyAssignedIndicator' and 'Specialty' parameter must be absent." />
<type value="CodeableConcept" />
<binding>
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/eRS-AssignedIndicator-1" />
</binding>
</parameter>
<parameter>
<name value="specialty" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The Specialty for the service. If present, the 'specialtyAssignedIndicator' parameter must be set to 'Assigned'. The specialty list must be retrieved dynamically from the e-RS valueset." />
<type value="CodeableConcept" />
<binding>
<strength value="required" />
<valueSetUri value="https://eRS-Specialty-Code" />
</binding>
</parameter>
<parameter>
<name value="location" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The service location identifier." />
<type value="Identifier" />
</parameter>
<parameter>
<name value="clinicianAssignedIndicator" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Indicates whether a clinician is assigned to the Request. If 'Assigned' the 'Clinician' parameter must be present. If 'Not Assigned' the 'Clinician' parameter must be absent." />
<type value="CodeableConcept" />
<binding>
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/eRS-AssignedIndicator-1" />
</binding>
</parameter>
<parameter>
<name value="clinician" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The clinician assigned to the Request. If present, the 'ClinicianAssignedIndicator' parameter must be set to 'Assigned'" />
<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-FetchWorklist-List-1" />
</profile>
</parameter>
</OperationDefinition>

JSON View

{
"resourceType": "OperationDefinition",
"meta": {
"lastUpdated": "2021-03-08T00:00:00+01:00"
},
"url": "https://fhir.nhs.uk/STU3/OperationDefinition/eRS-FetchWorklist-Operation-1",
"version": "1.1.0",
"name": "eRS-FetchWorklist-Operation-1",
"status": "active",
"kind": "operation",
"date": "2021-03-08T00: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 worklist for a referral request or communication request.",
"code": "ers.fetchworklist",
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "listType",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Indicates the type of ReferralRequest list requested. Only one 'listType' parameter is supported in each call and must match the type of resource being fetched.",
"type": "CodeableConcept",
"binding": {
"strength": "required",
"valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralListSelector-1"
}
},
{
"name": "listType",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Indicates the type of CommunicationRequest list requested. Only one 'listType' parameter is supported in each call and must match the type of resource being fetched.",
"type": "CodeableConcept",
"binding": {
"strength": "required",
"valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/eRS-CommunicationListSelector-1"
}
},
{
"name": "service",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The service identifier",
"type": "Identifier"
},
{
"name": "specialtyAssignedIndicator",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Indicates whether a Specialty is assigned to the Request. If 'Assigned' the 'Specialty' parameter must be present. If 'Not Assigned' the 'specialtyAssignedIndicator' and 'Specialty' parameter must be absent.",
"type": "CodeableConcept",
"binding": {
"strength": "required",
"valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/eRS-AssignedIndicator-1"
}
},
{
"name": "specialty",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The Specialty for the service. If present, the 'specialtyAssignedIndicator' parameter must be set to 'Assigned'. The specialty list must be retrieved dynamically from the e-RS valueset.",
"type": "CodeableConcept",
"binding": {
"strength": "required",
"valueSetUri": "https://eRS-Specialty-Code"
}
},
{
"name": "location",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The service location identifier.",
"type": "Identifier"
},
{
"name": "clinicianAssignedIndicator",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Indicates whether a clinician is assigned to the Request. If 'Assigned' the 'Clinician' parameter must be present. If 'Not Assigned' the 'Clinician' parameter must be absent.",
"type": "CodeableConcept",
"binding": {
"strength": "required",
"valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/eRS-AssignedIndicator-1"
}
},
{
"name": "clinician",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The clinician assigned to the Request. If present, the 'ClinicianAssignedIndicator' parameter must be set to 'Assigned'",
"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-FetchWorklist-List-1"
}
}
]
}
---
back to top