eRS-CreateFromCommunicationRequestActionLater-Operation-1

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

HTML View

Parameters (In)

NameCardinalityTypeStructureDefinitionBindingDocumentation
createFrom1..1CommunicationRequesteRS-CommunicationRequest-1

Identifies the Advice and Guidance Request that is to become a Referral

guidance1..1String

Mandatory guidance which provides the referrer with notes on what action to take. Max 2000 characters.

guidanceAttachmentFile0..*ResourceeRS-DocumentReference-1

Optional logical reference to file(s) that will be associated with the newly created Referral. DocumentReference.type value should be GUIDANCE_RESPONSE.

reviewComments1..1String

Mandatory note to be added to the newly created Referral. Will be visible to the person picking up the Referral. Max 2000 characters.

reviewAttachmentFile0..*ResourceeRS-DocumentReference-1

Optional logical reference to file(s) that will be associated with the newly created Referral. DocumentReference.type value should be PROVIDER.

newReferralPriority1..1CodingeRS Priority (required)

The Priority the created Referral should be set to.

Return Values (Out)

NameCardinalityTypeStructureDefinitionDocumentation
return1..1ResourceeRS-ReferralRequest-1

The newly created Referral.

Table View

OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/eRS-CreateFromCommunicationRequestActionLater-Operation-1
OperationDefinition.version[0]1.0.0
OperationDefinition.name[0]eRS-CreateFromCommunicationRequestActionLater-Operation-1
OperationDefinition.status[0]draft
OperationDefinition.kind[0]operation
OperationDefinition.date[0]2021-03-01T00: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]Provider creates Referral from Advice and Guidance Request.
OperationDefinition.code[0]ers.createFromCommunicationRequestActionLater
OperationDefinition.system[0]False
OperationDefinition.type[0]True
OperationDefinition.instance[0]False
OperationDefinition.parameter[0].name[0]createFrom
OperationDefinition.parameter[0].use[0]in
OperationDefinition.parameter[0].min[0]1
OperationDefinition.parameter[0].max[0]1
OperationDefinition.parameter[0].documentation[0]Identifies the Advice and Guidance Request that is to become a Referral
OperationDefinition.parameter[0].type[0]CommunicationRequest
OperationDefinition.parameter[0].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-CommunicationRequest-1
OperationDefinition.parameter[1].name[0]guidance
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]1
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]Mandatory guidance which provides the referrer with notes on what action to take. Max 2000 characters.
OperationDefinition.parameter[1].type[0]string
OperationDefinition.parameter[2].name[0]guidanceAttachmentFile
OperationDefinition.parameter[2].use[0]in
OperationDefinition.parameter[2].min[0]0
OperationDefinition.parameter[2].max[0]*
OperationDefinition.parameter[2].documentation[0]Optional logical reference to file(s) that will be associated with the newly created Referral. DocumentReference.type value should be GUIDANCE_RESPONSE.
OperationDefinition.parameter[2].type[0]Resource
OperationDefinition.parameter[2].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-DocumentReference-1
OperationDefinition.parameter[3].name[0]reviewComments
OperationDefinition.parameter[3].use[0]in
OperationDefinition.parameter[3].min[0]1
OperationDefinition.parameter[3].max[0]1
OperationDefinition.parameter[3].documentation[0]Mandatory note to be added to the newly created Referral. Will be visible to the person picking up the Referral. Max 2000 characters.
OperationDefinition.parameter[3].type[0]string
OperationDefinition.parameter[4].name[0]reviewAttachmentFile
OperationDefinition.parameter[4].use[0]in
OperationDefinition.parameter[4].min[0]0
OperationDefinition.parameter[4].max[0]*
OperationDefinition.parameter[4].documentation[0]Optional logical reference to file(s) that will be associated with the newly created Referral. DocumentReference.type value should be PROVIDER.
OperationDefinition.parameter[4].type[0]Resource
OperationDefinition.parameter[4].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-DocumentReference-1
OperationDefinition.parameter[5].name[0]newReferralPriority
OperationDefinition.parameter[5].use[0]in
OperationDefinition.parameter[5].min[0]1
OperationDefinition.parameter[5].max[0]1
OperationDefinition.parameter[5].documentation[0]The Priority the created Referral should be set to.
OperationDefinition.parameter[5].type[0]Coding
OperationDefinition.parameter[5].binding[0].strength[0]required
OperationDefinition.parameter[5].binding[0].valueSet[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-Priority-1
OperationDefinition.parameter[6].name[0]return
OperationDefinition.parameter[6].use[0]out
OperationDefinition.parameter[6].min[0]1
OperationDefinition.parameter[6].max[0]1
OperationDefinition.parameter[6].documentation[0]The newly created Referral.
OperationDefinition.parameter[6].type[0]Resource
OperationDefinition.parameter[6].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-CreateFromCommunicationRequestActionLater-Operation-1" />
<version value="1.0.0" />
<name value="eRS-CreateFromCommunicationRequestActionLater-Operation-1" />
<status value="draft" />
<kind value="operation" />
<date value="2021-03-01T00: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="Provider creates Referral from Advice and Guidance Request." />
<code value="ers.createFromCommunicationRequestActionLater" />
<system value="false" />
<type value="true" />
<instance value="false" />
<parameter>
<name value="createFrom" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="Identifies the Advice and Guidance Request that is to become a Referral" />
<type value="CommunicationRequest" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-CommunicationRequest-1" />
</profile>
</parameter>
<parameter>
<name value="guidance" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="Mandatory guidance which provides the referrer with notes on what action to take. Max 2000 characters." />
<type value="string" />
</parameter>
<parameter>
<name value="guidanceAttachmentFile" />
<use value="in" />
<min value="0" />
<max value="*" />
<documentation value="Optional logical reference to file(s) that will be associated with the newly created Referral. DocumentReference.type value should be GUIDANCE_RESPONSE." />
<type value="Resource" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-DocumentReference-1" />
</profile>
</parameter>
<parameter>
<name value="reviewComments" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="Mandatory note to be added to the newly created Referral. Will be visible to the person picking up the Referral. Max 2000 characters." />
<type value="string" />
</parameter>
<parameter>
<name value="reviewAttachmentFile" />
<use value="in" />
<min value="0" />
<max value="*" />
<documentation value="Optional logical reference to file(s) that will be associated with the newly created Referral. DocumentReference.type value should be PROVIDER." />
<type value="Resource" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-DocumentReference-1" />
</profile>
</parameter>
<parameter>
<name value="newReferralPriority" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The Priority the created Referral should be set to." />
<type value="Coding" />
<binding>
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/eRS-Priority-1" />
</binding>
</parameter>
<parameter>
<name value="return" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The newly created Referral." />
<type value="Resource" />
<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-CreateFromCommunicationRequestActionLater-Operation-1",
"version": "1.0.0",
"name": "eRS-CreateFromCommunicationRequestActionLater-Operation-1",
"status": "draft",
"kind": "operation",
"date": "2021-03-01T00:00:00+01:00",
"publisher": "NHS Digital",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work"
}
]
}
],
"description": "Provider creates Referral from Advice and Guidance Request.",
"code": "ers.createFromCommunicationRequestActionLater",
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "createFrom",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Identifies the Advice and Guidance Request that is to become a Referral",
"type": "CommunicationRequest",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-CommunicationRequest-1"
}
},
{
"name": "guidance",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Mandatory guidance which provides the referrer with notes on what action to take. Max 2000 characters.",
"type": "string"
},
{
"name": "guidanceAttachmentFile",
"use": "in",
"min": 0,
"max": "*",
"documentation": "Optional logical reference to file(s) that will be associated with the newly created Referral. DocumentReference.type value should be GUIDANCE_RESPONSE.",
"type": "Resource",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-DocumentReference-1"
}
},
{
"name": "reviewComments",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Mandatory note to be added to the newly created Referral. Will be visible to the person picking up the Referral. Max 2000 characters.",
"type": "string"
},
{
"name": "reviewAttachmentFile",
"use": "in",
"min": 0,
"max": "*",
"documentation": "Optional logical reference to file(s) that will be associated with the newly created Referral. DocumentReference.type value should be PROVIDER.",
"type": "Resource",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-DocumentReference-1"
}
},
{
"name": "newReferralPriority",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The Priority the created Referral should be set to.",
"type": "Coding",
"binding": {
"strength": "required",
"valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/eRS-Priority-1"
}
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The newly created Referral.",
"type": "Resource",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1"
}
}
]
}
---
back to top