eRS-ChangeShortlist-Operation-1

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

HTML View

Parameters (In)

NameCardinalityTypeStructureDefinitionBindingDocumentation
shortlist1..1ResourceeRS-Shortlist-List-1

A list of 1 to 20 services that will form the shortlist for the referral.

firstReminderLetterFollowUpDays1..1UnsignedInt

If > 0, the system will send an automated letter to the patient after the number of days stated, if the patient hasn't yet booked or deferred to a Service. If = 0, the system will not send reminder letters for this referral.

intentionToAddReferralLetter1..1CodingeRS Referral Letter Intention (required)

If a referral letter is required by one or more services on the shortlist and a referral letter has not yet been added then the only acceptable value is NEED_TO_ADD_LATER; if a referral letter has already been added then the only acceptable value is NOT_INTENDING_TO_ADD.

Return Values (Out)

NameCardinalityTypeStructureDefinitionDocumentation
updatedReferralRequest1..1ResourceeRS-ReferralRequest-1

The referral request that will be updated.

Table View

OperationDefinition.id[0]eRS-ChangeShortlist-Operation-1
OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/eRS-ChangeShortlist-Operation-1
OperationDefinition.version[0]1.0.0
OperationDefinition.name[0]eRS-ChangeShortlist-Operation-1
OperationDefinition.status[0]active
OperationDefinition.kind[0]operation
OperationDefinition.date[0]2022-03-10T00:00:00+00: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]Change the shortlist to preferred services. Preferred services cannot be Triage services.
OperationDefinition.code[0]ers.changeShortlist
OperationDefinition.system[0]False
OperationDefinition.type[0]False
OperationDefinition.instance[0]True
OperationDefinition.parameter[0].name[0]shortlist
OperationDefinition.parameter[0].use[0]in
OperationDefinition.parameter[0].min[0]1
OperationDefinition.parameter[0].max[0]1
OperationDefinition.parameter[0].documentation[0]A list of 1 to 20 services that will form the shortlist for the referral.
OperationDefinition.parameter[0].type[0]Resource
OperationDefinition.parameter[0].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Shortlist-List-1
OperationDefinition.parameter[1].name[0]firstReminderLetterFollowUpDays
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]1
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]If > 0, the system will send an automated letter to the patient after the number of days stated, if the patient hasn't yet booked or deferred to a Service. If = 0, the system will not send reminder letters for this referral.
OperationDefinition.parameter[1].type[0]unsignedInt
OperationDefinition.parameter[2].name[0]intentionToAddReferralLetter
OperationDefinition.parameter[2].use[0]in
OperationDefinition.parameter[2].min[0]1
OperationDefinition.parameter[2].max[0]1
OperationDefinition.parameter[2].documentation[0]If a referral letter is required by one or more services on the shortlist and a referral letter has not yet been added then the only acceptable value is NEED_TO_ADD_LATER; if a referral letter has already been added then the only acceptable value is NOT_INTENDING_TO_ADD.
OperationDefinition.parameter[2].type[0]Coding
OperationDefinition.parameter[2].binding[0].strength[0]required
OperationDefinition.parameter[2].binding[0].valueSet[0].reference[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralLetterIntention-1
OperationDefinition.parameter[3].name[0]updatedReferralRequest
OperationDefinition.parameter[3].use[0]out
OperationDefinition.parameter[3].min[0]1
OperationDefinition.parameter[3].max[0]1
OperationDefinition.parameter[3].documentation[0]The referral request that will be updated.
OperationDefinition.parameter[3].type[0]Resource
OperationDefinition.parameter[3].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1

XML View

<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="eRS-ChangeShortlist-Operation-1" />
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/eRS-ChangeShortlist-Operation-1" />
<version value="1.0.0" />
<name value="eRS-ChangeShortlist-Operation-1" />
<status value="active" />
<kind value="operation" />
<date value="2022-03-10T00:00:00+00: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="Change the shortlist to preferred services. Preferred services cannot be Triage services." />
<code value="ers.changeShortlist" />
<system value="false" />
<type value="false" />
<instance value="true" />
<parameter>
<name value="shortlist" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="A list of 1 to 20 services that will form the shortlist for the referral." />
<type value="Resource" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Shortlist-List-1" />
</profile>
</parameter>
<parameter>
<name value="firstReminderLetterFollowUpDays" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="If > 0, the system will send an automated letter to the patient after the number of days stated, if the patient hasn't yet booked or deferred to a Service. If = 0, the system will not send reminder letters for this referral." />
<type value="unsignedInt" />
</parameter>
<parameter>
<name value="intentionToAddReferralLetter" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="If a referral letter is required by one or more services on the shortlist and a referral letter has not yet been added then the only acceptable value is NEED_TO_ADD_LATER; if a referral letter has already been added then the only acceptable value is NOT_INTENDING_TO_ADD." />
<type value="Coding" />
<binding>
<strength value="required" />
<valueSetReference>
<reference value="https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralLetterIntention-1" />
</valueSetReference>
</binding>
</parameter>
<parameter>
<name value="updatedReferralRequest" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The referral request that will be updated." />
<type value="Resource" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1" />
</profile>
</parameter>
</OperationDefinition>

JSON View

{
"resourceType": "OperationDefinition",
"id": "eRS-ChangeShortlist-Operation-1",
"url": "https://fhir.nhs.uk/STU3/OperationDefinition/eRS-ChangeShortlist-Operation-1",
"version": "1.0.0",
"name": "eRS-ChangeShortlist-Operation-1",
"status": "active",
"kind": "operation",
"date": "2022-03-10T00:00:00+00:00",
"publisher": "NHS Digital",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work"
}
]
}
],
"description": "Change the shortlist to preferred services. Preferred services cannot be Triage services.",
"code": "ers.changeShortlist",
"system": false,
"type": false,
"instance": true,
"parameter": [
{
"name": "shortlist",
"use": "in",
"min": 1,
"max": "1",
"documentation": "A list of 1 to 20 services that will form the shortlist for the referral.",
"type": "Resource",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Shortlist-List-1"
}
},
{
"name": "firstReminderLetterFollowUpDays",
"use": "in",
"min": 1,
"max": "1",
"documentation": "If > 0, the system will send an automated letter to the patient after the number of days stated, if the patient hasn't yet booked or deferred to a Service. If = 0, the system will not send reminder letters for this referral.",
"type": "unsignedInt"
},
{
"name": "intentionToAddReferralLetter",
"use": "in",
"min": 1,
"max": "1",
"documentation": "If a referral letter is required by one or more services on the shortlist and a referral letter has not yet been added then the only acceptable value is NEED_TO_ADD_LATER; if a referral letter has already been added then the only acceptable value is NOT_INTENDING_TO_ADD.",
"type": "Coding",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralLetterIntention-1"
}
}
},
{
"name": "updatedReferralRequest",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The referral request that will be updated.",
"type": "Resource",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1"
}
}
]
}
---
back to top