eRS-BookAppointment-Operation-1

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

HTML View

Parameters (In)

NameCardinalityTypeBindingDocumentation
slotId1..1Identifier

The identifier for this slot. The namespace for this identifier is "https://fhir.nhs.uk/Id/ers-slot-identifier".

intentionToAddReferralLetter0..1CodingeRS Referral Letter Intention (required)

Intention to add a referral letter.

Return Values (Out)

NameCardinalityTypeStructureDefinitionDocumentation
referral1..1ReferralRequesteRS-ReferralRequest-1

The referral request that has just been updated.

Table View

OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/eRS-BookAppointment-Operation-1
OperationDefinition.version[0]1.0.0
OperationDefinition.name[0]eRS-BookAppointment-Operation-1
OperationDefinition.status[0]draft
OperationDefinition.kind[0]operation
OperationDefinition.date[0]2019-10-14T11:07: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]To book an appointment slot for a referral of a patient.
OperationDefinition.code[0]ers.BookAppointment
OperationDefinition.system[0]False
OperationDefinition.type[0]True
OperationDefinition.instance[0]False
OperationDefinition.parameter[0].name[0]slotId
OperationDefinition.parameter[0].use[0]in
OperationDefinition.parameter[0].min[0]1
OperationDefinition.parameter[0].max[0]1
OperationDefinition.parameter[0].documentation[0]The identifier for this slot. The namespace for this identifier is "https://fhir.nhs.uk/Id/ers-slot-identifier".
OperationDefinition.parameter[0].type[0]Identifier
OperationDefinition.parameter[1].name[0]intentionToAddReferralLetter
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]0
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]Intention to add a referral letter.
OperationDefinition.parameter[1].type[0]Coding
OperationDefinition.parameter[1].binding[0].strength[0]required
OperationDefinition.parameter[1].binding[0].valueSet[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralLetterIntention-1
OperationDefinition.parameter[2].name[0]referral
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 has just been updated.
OperationDefinition.parameter[2].type[0]ReferralRequest
OperationDefinition.parameter[2].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-BookAppointment-Operation-1" />
<version value="1.0.0" />
<name value="eRS-BookAppointment-Operation-1" />
<status value="draft" />
<kind value="operation" />
<date value="2019-10-14T11:07: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="To book an appointment slot for a referral of a patient." />
<code value="ers.BookAppointment" />
<system value="false" />
<type value="true" />
<instance value="false" />
<parameter>
<name value="slotId" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The identifier for this slot. The namespace for this identifier is "https://fhir.nhs.uk/Id/ers-slot-identifier"." />
<type value="Identifier" />
</parameter>
<parameter>
<name value="intentionToAddReferralLetter" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Intention to add a referral letter." />
<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 has just been updated." />
<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-BookAppointment-Operation-1",
"version": "1.0.0",
"name": "eRS-BookAppointment-Operation-1",
"status": "draft",
"kind": "operation",
"date": "2019-10-14T11:07:00+01:00",
"publisher": "NHS Digital",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work"
}
]
}
],
"description": "To book an appointment slot for a referral of a patient.",
"code": "ers.BookAppointment",
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "slotId",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The identifier for this slot. The namespace for this identifier is \"https://fhir.nhs.uk/Id/ers-slot-identifier\".",
"type": "Identifier"
},
{
"name": "intentionToAddReferralLetter",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Intention to add a referral letter.",
"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 has just been updated.",
"type": "ReferralRequest",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1"
}
}
]
}
---
back to top