eRS-CancelReferralRequest-Operation-1

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

HTML View

Parameters (In)

NameCardinalityTypeBindingDocumentation
cancellationReason1..1CodingeRS Referral Cancellation Reason (required)

The Cancellation Reason.

cancellationComments0..1String

Return Values (Out)

NameCardinalityTypeStructureDefinitionDocumentation
updatedReferralRequest1..1ResourceeRS-ReferralRequest-1

The referral request that will be updated.

updateAppointment0..1Boolean

Table View

OperationDefinition.id[0]eRS-CancelReferralRequest-Operation-1
OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/eRS-CancelReferralRequest-Operation-1
OperationDefinition.version[0]1.0.0
OperationDefinition.name[0]eRS-CancelReferralRequest-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]Cancel the Referral Request.
OperationDefinition.code[0]ers.cancelReferral
OperationDefinition.system[0]False
OperationDefinition.type[0]False
OperationDefinition.instance[0]True
OperationDefinition.parameter[0].name[0]cancellationReason
OperationDefinition.parameter[0].use[0]in
OperationDefinition.parameter[0].min[0]1
OperationDefinition.parameter[0].max[0]1
OperationDefinition.parameter[0].documentation[0]The Cancellation Reason.
OperationDefinition.parameter[0].type[0]Coding
OperationDefinition.parameter[0].binding[0].strength[0]required
OperationDefinition.parameter[0].binding[0].valueSet[0].reference[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralCancellationReason-1
OperationDefinition.parameter[1].name[0]cancellationComments
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]0
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].type[0]string
OperationDefinition.parameter[2].name[0]updatedReferralRequest
OperationDefinition.parameter[2].use[0]out
OperationDefinition.parameter[2].min[0]1
OperationDefinition.parameter[2].max[0]1
OperationDefinition.parameter[2].documentation[0]The referral request that will be updated.
OperationDefinition.parameter[2].type[0]Resource
OperationDefinition.parameter[2].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1
OperationDefinition.parameter[3].name[0]updateAppointment
OperationDefinition.parameter[3].use[0]out
OperationDefinition.parameter[3].min[0]0
OperationDefinition.parameter[3].max[0]1
OperationDefinition.parameter[3].type[0]boolean

XML View

<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="eRS-CancelReferralRequest-Operation-1" />
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/eRS-CancelReferralRequest-Operation-1" />
<version value="1.0.0" />
<name value="eRS-CancelReferralRequest-Operation-1" />
<status value="active" />
<kind value="operation" />
<date value="2022-03-10T00:00:00+00:00" />
<publisher value="NHS Digital" />
<name value="Interoperability Team" />
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
</telecom>
</contact>
<description value="Cancel the Referral Request." />
<code value="ers.cancelReferral" />
<system value="false" />
<type value="false" />
<instance value="true" />
<name value="cancellationReason" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The Cancellation Reason." />
<type value="Coding" />
<strength value="required" />
<reference value="https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralCancellationReason-1" />
</valueSetReference>
</binding>
</parameter>
<name value="cancellationComments" />
<use value="in" />
<min value="0" />
<max value="1" />
<type value="string" />
</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" />
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1" />
</profile>
</parameter>
<name value="updateAppointment" />
<use value="out" />
<min value="0" />
<max value="1" />
<type value="boolean" />
</parameter>
</OperationDefinition>

JSON View

{
"resourceType": "OperationDefinition",
"id": "eRS-CancelReferralRequest-Operation-1",
"url": "https://fhir.nhs.uk/STU3/OperationDefinition/eRS-CancelReferralRequest-Operation-1",
"version": "1.0.0",
"name": "eRS-CancelReferralRequest-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": "Cancel the Referral Request.",
"code": "ers.cancelReferral",
"system": false,
"type": false,
"instance": true,
{
"name": "cancellationReason",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The Cancellation Reason.",
"type": "Coding",
"binding": {
"strength": "required",
"reference": "https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralCancellationReason-1"
}
}
},
{
"name": "cancellationComments",
"use": "in",
"min": 0,
"max": "1",
"type": "string"
},
{
"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"
}
},
{
"name": "updateAppointment",
"use": "out",
"min": 0,
"max": "1",
"type": "boolean"
}
]
}
---
back to top