eRS-cancelAppointmentActionLater-Operation-1

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

HTML View

Parameters (In)

NameCardinalityTypeStructureDefinitionBindingDocumentation
priority0..1CodeableConcepteRS Priority (required)

Priority

appointmentCancelledinPAS0..1Boolean

If true, the appointment has been cancelled in the PAS system.

comments1..1String

Max 2000 characters.

providerAttachmentFile0..*DocumentReferenceeRS-DocumentReference-1

The reference to the DocumentReference profile

Return Values (Out)

NameCardinalityTypeStructureDefinitionDocumentation
return1..1ReferralRequesteRS-ReferralRequest-1

The updated Referral Request.

Table View

OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/eRS-cancelAppointmentActionLater-Operation-1
OperationDefinition.version[0]1.0.0
OperationDefinition.name[0]eRS-cancelAppointmentActionLater-Operation-1
OperationDefinition.status[0]active
OperationDefinition.kind[0]operation
OperationDefinition.date[0]2020-03-02T00: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]Following a clinicians review, this Operation is to cancel current booked appointment, retain responsibility for the Referral, add a comment, and pass to an administrator to manage the next action. administrator to manage the next action .
OperationDefinition.code[0]ers.cancelAppointmentActionLater
OperationDefinition.system[0]False
OperationDefinition.type[0]False
OperationDefinition.instance[0]True
OperationDefinition.parameter[0].name[0]priority
OperationDefinition.parameter[0].use[0]in
OperationDefinition.parameter[0].min[0]0
OperationDefinition.parameter[0].max[0]1
OperationDefinition.parameter[0].documentation[0]Priority
OperationDefinition.parameter[0].type[0]CodeableConcept
OperationDefinition.parameter[0].binding[0].strength[0]required
OperationDefinition.parameter[0].binding[0].valueSet[0].reference[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-Priority-1
OperationDefinition.parameter[1].name[0]appointmentCancelledinPAS
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]0
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]If true, the appointment has been cancelled in the PAS system.
OperationDefinition.parameter[1].type[0]boolean
OperationDefinition.parameter[2].name[0]comments
OperationDefinition.parameter[2].use[0]in
OperationDefinition.parameter[2].min[0]1
OperationDefinition.parameter[2].max[0]1
OperationDefinition.parameter[2].documentation[0]Max 2000 characters.
OperationDefinition.parameter[2].type[0]string
OperationDefinition.parameter[3].name[0]providerAttachmentFile
OperationDefinition.parameter[3].use[0]in
OperationDefinition.parameter[3].min[0]0
OperationDefinition.parameter[3].max[0]*
OperationDefinition.parameter[3].documentation[0]The reference to the DocumentReference profile
OperationDefinition.parameter[3].type[0]DocumentReference
OperationDefinition.parameter[3].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-DocumentReference-1
OperationDefinition.parameter[4].name[0]return
OperationDefinition.parameter[4].use[0]out
OperationDefinition.parameter[4].min[0]1
OperationDefinition.parameter[4].max[0]1
OperationDefinition.parameter[4].documentation[0]The updated Referral Request.
OperationDefinition.parameter[4].type[0]ReferralRequest
OperationDefinition.parameter[4].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-cancelAppointmentActionLater-Operation-1" />
<version value="1.0.0" />
<name value="eRS-cancelAppointmentActionLater-Operation-1" />
<status value="active" />
<kind value="operation" />
<date value="2020-03-02T00:00:00+01:00" />
<publisher value="NHS Digital" />
<name value="Interoperability Team" />
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
</telecom>
</contact>
<description value="Following a clinicians review, this Operation is to cancel current booked appointment, retain responsibility for the Referral, add a comment, and pass to an administrator to manage the next action. administrator to manage the next action ." />
<code value="ers.cancelAppointmentActionLater" />
<system value="false" />
<type value="false" />
<instance value="true" />
<name value="priority" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Priority" />
<type value="CodeableConcept" />
<strength value="required" />
<reference value="https://fhir.nhs.uk/STU3/ValueSet/eRS-Priority-1" />
</valueSetReference>
</binding>
</parameter>
<name value="appointmentCancelledinPAS" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="If true, the appointment has been cancelled in the PAS system." />
<type value="boolean" />
</parameter>
<name value="comments" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="Max 2000 characters." />
<type value="string" />
</parameter>
<name value="providerAttachmentFile" />
<use value="in" />
<min value="0" />
<max value="*" />
<documentation value="The reference to the DocumentReference profile" />
<type value="DocumentReference" />
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-DocumentReference-1" />
</profile>
</parameter>
<name value="return" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The updated Referral Request." />
<type value="ReferralRequest" />
<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-cancelAppointmentActionLater-Operation-1",
"version": "1.0.0",
"name": "eRS-cancelAppointmentActionLater-Operation-1",
"status": "active",
"kind": "operation",
"date": "2020-03-02T00:00:00+01:00",
"publisher": "NHS Digital",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work"
}
]
}
],
"description": "Following a clinicians review, this Operation is to cancel current booked appointment, retain responsibility for the Referral, add a comment, and pass to an administrator to manage the next action. administrator to manage the next action .",
"code": "ers.cancelAppointmentActionLater",
"system": false,
"type": false,
"instance": true,
{
"name": "priority",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Priority",
"type": "CodeableConcept",
"binding": {
"strength": "required",
"reference": "https://fhir.nhs.uk/STU3/ValueSet/eRS-Priority-1"
}
}
},
{
"name": "appointmentCancelledinPAS",
"use": "in",
"min": 0,
"max": "1",
"documentation": "If true, the appointment has been cancelled in the PAS system.",
"type": "boolean"
},
{
"name": "comments",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Max 2000 characters.",
"type": "string"
},
{
"name": "providerAttachmentFile",
"use": "in",
"min": 0,
"max": "*",
"documentation": "The reference to the DocumentReference profile",
"type": "DocumentReference",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-DocumentReference-1"
}
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The updated Referral Request.",
"type": "ReferralRequest",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1"
}
}
]
}
---
back to top