eRS-CreateReferralAndSendForTriage-Operation-1

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

HTML View

Parameters (In)

NameCardinalityTypeStructureDefinitionBindingDocumentation
patient1..1Identifier

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

referringClinician0..1Identifier

Required if and only if the logged in user has a role of Referring Clinician Admin. Format: ^[0-9]{12}$

shortlist1..1ListeRS-Shortlist-List-1

When sending for triage, the shortlist must contain exactly one service, and this must support the ‘triage request flow’.

firstReminderFollowUpDays1..1UnsignedInt

This parameter triggers a reminder letter to the patient to prompt them to book an appointment if they haven’t done so after x days. When sending for triage, the only acceptable value is 0, which means no follow up letter will be sent, as the patient does not need to book an appointment.

intentionToAddReferralLetter1..1CodingeRS Referral Letter Intention (required)

When sending for triage, a referral letter is always required; therefore the only acceptable value is NEED_TO_ADD_LATER.

Return Values (Out)

NameCardinalityTypeStructureDefinitionDocumentation
referral1..1ReferralRequesteRS-ReferralRequest-1

The referral request that will be created.

Table View

OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/eRS-CreateReferralAndSendForTriage-Operation-1
OperationDefinition.version[0]1.0.1
OperationDefinition.name[0]eRS-CreateReferralAndSendForTriage-Operation-1
OperationDefinition.status[0]draft
OperationDefinition.kind[0]operation
OperationDefinition.date[0]2019-12-03T00: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]Create a referral for a patient and send it for triage at the selected service.
OperationDefinition.code[0]ers.createReferralAndSendForTriage
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 referral being created is for. Format: ^[0-9]{10}$
OperationDefinition.parameter[0].type[0]Identifier
OperationDefinition.parameter[1].name[0]referringClinician
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]0
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]Required if and only if the logged in user has a role of Referring Clinician Admin. Format: ^[0-9]{12}$
OperationDefinition.parameter[1].type[0]Identifier
OperationDefinition.parameter[2].name[0]shortlist
OperationDefinition.parameter[2].use[0]in
OperationDefinition.parameter[2].min[0]1
OperationDefinition.parameter[2].max[0]1
OperationDefinition.parameter[2].documentation[0]When sending for triage, the shortlist must contain exactly one service, and this must support the ‘triage request flow’.
OperationDefinition.parameter[2].type[0]List
OperationDefinition.parameter[2].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Shortlist-List-1
OperationDefinition.parameter[3].name[0]firstReminderFollowUpDays
OperationDefinition.parameter[3].use[0]in
OperationDefinition.parameter[3].min[0]1
OperationDefinition.parameter[3].max[0]1
OperationDefinition.parameter[3].documentation[0]This parameter triggers a reminder letter to the patient to prompt them to book an appointment if they haven’t done so after x days. When sending for triage, the only acceptable value is 0, which means no follow up letter will be sent, as the patient does not need to book an appointment.
OperationDefinition.parameter[3].type[0]unsignedInt
OperationDefinition.parameter[4].name[0]intentionToAddReferralLetter
OperationDefinition.parameter[4].use[0]in
OperationDefinition.parameter[4].min[0]1
OperationDefinition.parameter[4].max[0]1
OperationDefinition.parameter[4].documentation[0]When sending for triage, a referral letter is always required; therefore the only acceptable value is NEED_TO_ADD_LATER.
OperationDefinition.parameter[4].type[0]Coding
OperationDefinition.parameter[4].binding[0].strength[0]required
OperationDefinition.parameter[4].binding[0].valueSet[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralLetterIntention-1
OperationDefinition.parameter[5].name[0]referral
OperationDefinition.parameter[5].use[0]out
OperationDefinition.parameter[5].min[0]1
OperationDefinition.parameter[5].max[0]1
OperationDefinition.parameter[5].documentation[0]The referral request that will be created.
OperationDefinition.parameter[5].type[0]ReferralRequest
OperationDefinition.parameter[5].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1

XML View

<OperationDefinition xmlns="http://hl7.org/fhir">
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/eRS-CreateReferralAndSendForTriage-Operation-1" />
<version value="1.0.1" />
<name value="eRS-CreateReferralAndSendForTriage-Operation-1" />
<status value="draft" />
<kind value="operation" />
<date value="2019-12-03T00: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="Create a referral for a patient and send it for triage at the selected service." />
<code value="ers.createReferralAndSendForTriage" />
<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 referral being created is for. Format: ^[0-9]{10}$" />
<type value="Identifier" />
</parameter>
<parameter>
<name value="referringClinician" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Required if and only if the logged in user has a role of Referring Clinician Admin. Format: ^[0-9]{12}$" />
<type value="Identifier" />
</parameter>
<parameter>
<name value="shortlist" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="When sending for triage, the shortlist must contain exactly one service, and this must support the ‘triage request flow’." />
<type value="List" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Shortlist-List-1" />
</profile>
</parameter>
<parameter>
<name value="firstReminderFollowUpDays" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="This parameter triggers a reminder letter to the patient to prompt them to book an appointment if they haven’t done so after x days. When sending for triage, the only acceptable value is 0, which means no follow up letter will be sent, as the patient does not need to book an appointment." />
<type value="unsignedInt" />
</parameter>
<parameter>
<name value="intentionToAddReferralLetter" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="When sending for triage, a referral letter is always required; therefore the only acceptable value is NEED_TO_ADD_LATER." />
<type value="Coding" />
<binding>
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralLetterIntention-1" />
</binding>
</parameter>
<parameter>
<name value="referral" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The referral request that will be created." />
<type value="ReferralRequest" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1" />
</profile>
</parameter>
</OperationDefinition>

JSON View

{
"resourceType": "OperationDefinition",
"url": "https://fhir.nhs.uk/STU3/OperationDefinition/eRS-CreateReferralAndSendForTriage-Operation-1",
"version": "1.0.1",
"name": "eRS-CreateReferralAndSendForTriage-Operation-1",
"status": "draft",
"kind": "operation",
"date": "2019-12-03T00:00:00+01:00",
"publisher": "NHS Digital",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work"
}
]
}
],
"description": "Create a referral for a patient and send it for triage at the selected service.",
"code": "ers.createReferralAndSendForTriage",
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "patient",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The NHS Number of the patient who the referral being created is for. Format: ^[0-9]{10}$",
"type": "Identifier"
},
{
"name": "referringClinician",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Required if and only if the logged in user has a role of Referring Clinician Admin. Format: ^[0-9]{12}$",
"type": "Identifier"
},
{
"name": "shortlist",
"use": "in",
"min": 1,
"max": "1",
"documentation": "When sending for triage, the shortlist must contain exactly one service, and this must support the ‘triage request flow’.",
"type": "List",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Shortlist-List-1"
}
},
{
"name": "firstReminderFollowUpDays",
"use": "in",
"min": 1,
"max": "1",
"documentation": "This parameter triggers a reminder letter to the patient to prompt them to book an appointment if they haven’t done so after x days. When sending for triage, the only acceptable value is 0, which means no follow up letter will be sent, as the patient does not need to book an appointment.",
"type": "unsignedInt"
},
{
"name": "intentionToAddReferralLetter",
"use": "in",
"min": 1,
"max": "1",
"documentation": "When sending for triage, a referral letter is always required; therefore the only acceptable value is NEED_TO_ADD_LATER.",
"type": "Coding",
"binding": {
"strength": "required",
"valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralLetterIntention-1"
}
},
{
"name": "referral",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The referral request that will be created.",
"type": "ReferralRequest",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1"
}
}
]
}
---
back to top