eRS-sendCommunicationToRequester-Operation-1

HTML View

Parameters (In)

NameCardinalityTypeStructureDefinitionBindingDocumentation
guidance1..1String

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

updatedPriority1..1CodingeRS Priority (required)

The priority the Advice and Guidance Request should be set to.

guidanceOutcome1..1CodingeRS Guidance Response Outcome (required)

Summary of action

guidanceIntendedRecommendation0..1CodingeRS Guidance Intended Recommendation (required)

Summary of advice given. Must only be provided if guidanceOutcome Code is RETURN_TO_REFERRER_WITH_ADVICE

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.

Return Values (Out)

NameCardinalityTypeStructureDefinitionDocumentation
createdCommunication1..1ResourceeRS-Communication-1

The newly created Communication

updatedCommunicationRequest1..1ResourceeRS-CommunicationRequest-1

The newly created Communication Request

Table View

OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/eRS-SendCommunicationToRequester-Operation-1
OperationDefinition.version[0]1.0.0
OperationDefinition.name[0]eRS-SendCommunicationToRequester-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 Responds to Advice and Guidance Request.
OperationDefinition.code[0]ers.sendCommunicationToRequester
OperationDefinition.system[0]False
OperationDefinition.type[0]False
OperationDefinition.instance[0]True
OperationDefinition.parameter[0].name[0]guidance
OperationDefinition.parameter[0].use[0]in
OperationDefinition.parameter[0].min[0]1
OperationDefinition.parameter[0].max[0]1
OperationDefinition.parameter[0].documentation[0]Mandatory guidance which provides the referrer with notes on what action to take. Max 2000 characters.
OperationDefinition.parameter[0].type[0]string
OperationDefinition.parameter[1].name[0]updatedPriority
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]1
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]The priority the Advice and Guidance Request should be set to.
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-Priority-1
OperationDefinition.parameter[2].name[0]guidanceOutcome
OperationDefinition.parameter[2].use[0]in
OperationDefinition.parameter[2].min[0]1
OperationDefinition.parameter[2].max[0]1
OperationDefinition.parameter[2].documentation[0]Summary of action
OperationDefinition.parameter[2].type[0]Coding
OperationDefinition.parameter[2].binding[0].strength[0]required
OperationDefinition.parameter[2].binding[0].valueSet[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-GuidanceResponseOutcome-1
OperationDefinition.parameter[3].name[0]guidanceIntendedRecommendation
OperationDefinition.parameter[3].use[0]in
OperationDefinition.parameter[3].min[0]0
OperationDefinition.parameter[3].max[0]1
OperationDefinition.parameter[3].documentation[0]Summary of advice given. Must only be provided if guidanceOutcome Code is RETURN_TO_REFERRER_WITH_ADVICE
OperationDefinition.parameter[3].type[0]Coding
OperationDefinition.parameter[3].binding[0].strength[0]required
OperationDefinition.parameter[3].binding[0].valueSet[0]https://fhir.nhs.uk/STU3/ValueSet/eRS-GuidanceIntendedRecommendation-1
OperationDefinition.parameter[4].name[0]guidanceAttachmentFile
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 GUIDANCE_RESPONSE.
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]createdCommunication
OperationDefinition.parameter[5].use[0]out
OperationDefinition.parameter[5].min[0]1
OperationDefinition.parameter[5].max[0]1
OperationDefinition.parameter[5].documentation[0]The newly created Communication
OperationDefinition.parameter[5].type[0]Resource
OperationDefinition.parameter[5].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Communication-1
OperationDefinition.parameter[6].name[0]updatedCommunicationRequest
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 Communication Request
OperationDefinition.parameter[6].type[0]Resource
OperationDefinition.parameter[6].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/eRS-CommunicationRequest-1

XML View

<OperationDefinition xmlns="http://hl7.org/fhir">
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/eRS-SendCommunicationToRequester-Operation-1" />
<version value="1.0.0" />
<name value="eRS-SendCommunicationToRequester-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 Responds to Advice and Guidance Request." />
<code value="ers.sendCommunicationToRequester" />
<system value="false" />
<type value="false" />
<instance value="true" />
<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="updatedPriority" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The priority the Advice and Guidance Request 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="guidanceOutcome" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="Summary of action" />
<type value="Coding" />
<binding>
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/eRS-GuidanceResponseOutcome-1" />
</binding>
</parameter>
<parameter>
<name value="guidanceIntendedRecommendation" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Summary of advice given. Must only be provided if guidanceOutcome Code is RETURN_TO_REFERRER_WITH_ADVICE" />
<type value="Coding" />
<binding>
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/eRS-GuidanceIntendedRecommendation-1" />
</binding>
</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="createdCommunication" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The newly created Communication" />
<type value="Resource" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Communication-1" />
</profile>
</parameter>
<parameter>
<name value="updatedCommunicationRequest" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The newly created Communication Request" />
<type value="Resource" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-CommunicationRequest-1" />
</profile>
</parameter>
</OperationDefinition>

JSON View

{
"resourceType": "OperationDefinition",
"url": "https://fhir.nhs.uk/STU3/OperationDefinition/eRS-SendCommunicationToRequester-Operation-1",
"version": "1.0.0",
"name": "eRS-SendCommunicationToRequester-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 Responds to Advice and Guidance Request.",
"code": "ers.sendCommunicationToRequester",
"system": false,
"type": false,
"instance": true,
"parameter": [
{
"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": "updatedPriority",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The priority the Advice and Guidance Request should be set to.",
"type": "Coding",
"binding": {
"strength": "required",
"valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/eRS-Priority-1"
}
},
{
"name": "guidanceOutcome",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Summary of action",
"type": "Coding",
"binding": {
"strength": "required",
"valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/eRS-GuidanceResponseOutcome-1"
}
},
{
"name": "guidanceIntendedRecommendation",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Summary of advice given. Must only be provided if guidanceOutcome Code is RETURN_TO_REFERRER_WITH_ADVICE",
"type": "Coding",
"binding": {
"strength": "required",
"valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/eRS-GuidanceIntendedRecommendation-1"
}
},
{
"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": "createdCommunication",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The newly created Communication",
"type": "Resource",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Communication-1"
}
},
{
"name": "updatedCommunicationRequest",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The newly created Communication Request",
"type": "Resource",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-CommunicationRequest-1"
}
}
]
}
---
back to top