UEC-CheckServices-Operation-1

HTML View

Invocations

URL: [base]/$check-services

Parameters (In)

NameCardinalityTypeDocumentation
requestId0..1Id

An optional client-provided identifier to track the request.

referralRequest1..1ReferralRequest

The core of the $check-services operation is based on the outcome of triage, represented as a chief concern, next activity and acuity. These are all captured in the ReferralRequest, so this resource contains all that is required for the outcome of triage.

patient0..1Patient

The patient for whom the triage took place. There are a number of patient elements which are used by some of the directories such as age and gender.

location0..1Location

The location represents the patient's current location.

requester0..1Any

The person initiating the the $check-services request. The requester is the user of the EMS. This will typically be a Patient or RelatedPerson if the EMS is being used by a member of the public (e.g. a patient-facting public internet system) or a Practitioner where there has been an initiatingOrganisation as part of the triage.

registeredGPPractice0..1Organization

The organization representing the registered GP of the Patient.

inputParameters0..1Parameters

The input parameters for a request, if any. These parameters are defined by the Directory of Services that is the target of the check operation.

searchDistance0..*Quantity

The distance/duration to search within.

Return Values (Out)

NameCardinalityTypeDocumentation
services1..1Parameters

The output is a set of HealthcareService resources and related information which can deliver the patient's health needs.

services.parameters0..*BackboneElement

Each healthcare service returned MUST have it's own parameter.

services.parameters.name1..1String

This MUST be populated with the serviceId.

services.parameters.part1..*String

Named parts of this parameter. This MUST contain a parameter named service which MUST contain the HealthcareService resource. This MAY also contain other implementation-specific information about the HealthcareService such as it's distance from the patient's location or capacity.

outputParameters0..*Parameters

The output parameters for a request, if any. These parameters are defined by the target DoS.

Table View

OperationDefinition.id[0]UEC-CheckServices-Operation-1
OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/UEC-CheckServices-Operation-1
OperationDefinition.version[0]1.1.0
OperationDefinition.name[0]UEC-CheckServices-Operation
OperationDefinition.status[0]draft
OperationDefinition.kind[0]operation
OperationDefinition.date[0]2020-04-15T00:00:00+00:00
OperationDefinition.publisher[0]NHS Digital
OperationDefinition.contact[0].name[0]UEC Interoperability Team
OperationDefinition.contact[0].telecom[0].value[0]uecintegration@nhs.net
OperationDefinition.contact[0].telecom[0].use[0]work
OperationDefinition.description[0]This is a FHIR Operation performed by a Directory of Services (DoS). It is performed at a server level at the end of a triage journey with a generic Referral Request defined in order to find a specific set of nearby services which can deal with the patient.
OperationDefinition.code[0]check-services
OperationDefinition.system[0]True
OperationDefinition.type[0]False
OperationDefinition.instance[0]False
OperationDefinition.parameter[0].name[0]requestId
OperationDefinition.parameter[0].use[0]in
OperationDefinition.parameter[0].min[0]0
OperationDefinition.parameter[0].max[0]1
OperationDefinition.parameter[0].documentation[0]An optional client-provided identifier to track the request.
OperationDefinition.parameter[0].type[0]id
OperationDefinition.parameter[1].name[0]referralRequest
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]1
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]The core of the $check-services operation is based on the outcome of triage, represented as a chief concern, next activity and acuity. These are all captured in the ReferralRequest, so this resource contains all that is required for the outcome of triage.
OperationDefinition.parameter[1].type[0]ReferralRequest
OperationDefinition.parameter[2].name[0]patient
OperationDefinition.parameter[2].use[0]in
OperationDefinition.parameter[2].min[0]0
OperationDefinition.parameter[2].max[0]1
OperationDefinition.parameter[2].documentation[0]The patient for whom the triage took place. There are a number of patient elements which are used by some of the directories such as age and gender.
OperationDefinition.parameter[2].type[0]Patient
OperationDefinition.parameter[3].name[0]location
OperationDefinition.parameter[3].use[0]in
OperationDefinition.parameter[3].min[0]0
OperationDefinition.parameter[3].max[0]1
OperationDefinition.parameter[3].documentation[0]The location represents the patient's current location.
OperationDefinition.parameter[3].type[0]Location
OperationDefinition.parameter[4].name[0]requester
OperationDefinition.parameter[4].use[0]in
OperationDefinition.parameter[4].min[0]0
OperationDefinition.parameter[4].max[0]1
OperationDefinition.parameter[4].documentation[0]The person initiating the the $check-services request. The requester is the user of the EMS. This will typically be a Patient or RelatedPerson if the EMS is being used by a member of the public (e.g. a patient-facting public internet system) or a Practitioner where there has been an initiatingOrganisation as part of the triage.
OperationDefinition.parameter[4].type[0]Any
OperationDefinition.parameter[5].name[0]registeredGPPractice
OperationDefinition.parameter[5].use[0]in
OperationDefinition.parameter[5].min[0]0
OperationDefinition.parameter[5].max[0]1
OperationDefinition.parameter[5].documentation[0]The organization representing the registered GP of the Patient.
OperationDefinition.parameter[5].type[0]Organization
OperationDefinition.parameter[6].name[0]inputParameters
OperationDefinition.parameter[6].use[0]in
OperationDefinition.parameter[6].min[0]0
OperationDefinition.parameter[6].max[0]1
OperationDefinition.parameter[6].documentation[0]The input parameters for a request, if any. These parameters are defined by the Directory of Services that is the target of the check operation.
OperationDefinition.parameter[6].type[0]Parameters
OperationDefinition.parameter[7].name[0]searchDistance
OperationDefinition.parameter[7].use[0]in
OperationDefinition.parameter[7].min[0]0
OperationDefinition.parameter[7].max[0]*
OperationDefinition.parameter[7].documentation[0]The distance/duration to search within.
OperationDefinition.parameter[7].type[0]Quantity
OperationDefinition.parameter[8].name[0]services
OperationDefinition.parameter[8].use[0]out
OperationDefinition.parameter[8].min[0]1
OperationDefinition.parameter[8].max[0]1
OperationDefinition.parameter[8].documentation[0]The output is a set of HealthcareService resources and related information which can deliver the patient's health needs.
OperationDefinition.parameter[8].type[0]Parameters
OperationDefinition.parameter[9].name[0]services.parameters
OperationDefinition.parameter[9].use[0]out
OperationDefinition.parameter[9].min[0]0
OperationDefinition.parameter[9].max[0]*
OperationDefinition.parameter[9].documentation[0]Each healthcare service returned MUST have it's own parameter.
OperationDefinition.parameter[9].type[0]BackboneElement
OperationDefinition.parameter[10].name[0]services.parameters.name
OperationDefinition.parameter[10].use[0]out
OperationDefinition.parameter[10].min[0]1
OperationDefinition.parameter[10].max[0]1
OperationDefinition.parameter[10].documentation[0]This MUST be populated with the serviceId.
OperationDefinition.parameter[10].type[0]string
OperationDefinition.parameter[11].name[0]services.parameters.part
OperationDefinition.parameter[11].use[0]out
OperationDefinition.parameter[11].min[0]1
OperationDefinition.parameter[11].max[0]*
OperationDefinition.parameter[11].documentation[0]Named parts of this parameter. This MUST contain a parameter named service which MUST contain the HealthcareService resource. This MAY also contain other implementation-specific information about the HealthcareService such as it's distance from the patient's location or capacity.
OperationDefinition.parameter[11].type[0]string
OperationDefinition.parameter[12].name[0]outputParameters
OperationDefinition.parameter[12].use[0]out
OperationDefinition.parameter[12].min[0]0
OperationDefinition.parameter[12].max[0]*
OperationDefinition.parameter[12].documentation[0]The output parameters for a request, if any. These parameters are defined by the target DoS.
OperationDefinition.parameter[12].type[0]Parameters

XML View

<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="UEC-CheckServices-Operation-1" />
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/UEC-CheckServices-Operation-1" />
<version value="1.1.0" />
<name value="UEC-CheckServices-Operation" />
<status value="draft" />
<kind value="operation" />
<date value="2020-04-15T00:00:00+00:00" />
<publisher value="NHS Digital" />
<contact>
<name value="UEC Interoperability Team" />
<telecom>
<value value="uecintegration@nhs.net" />
<use value="work" />
</telecom>
</contact>
<description value="This is a FHIR Operation performed by a Directory of Services (DoS). It is performed at a server level at the end of a triage journey with a generic Referral Request defined in order to find a specific set of nearby services which can deal with the patient." />
<code value="check-services" />
<system value="true" />
<type value="false" />
<instance value="false" />
<parameter>
<name value="requestId" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="An optional client-provided identifier to track the request." />
<type value="id" />
</parameter>
<parameter>
<name value="referralRequest" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The core of the $check-services operation is based on the outcome of triage, represented as a chief concern, next activity and acuity. These are all captured in the ReferralRequest, so this resource contains all that is required for the outcome of triage." />
<type value="ReferralRequest" />
</parameter>
<parameter>
<name value="patient" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The patient for whom the triage took place. There are a number of patient elements which are used by some of the directories such as age and gender." />
<type value="Patient" />
</parameter>
<parameter>
<name value="location" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The location represents the patient's current location." />
<type value="Location" />
</parameter>
<parameter>
<name value="requester" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The person initiating the the $check-services request. The requester is the user of the EMS. This will typically be a Patient or RelatedPerson if the EMS is being used by a member of the public (e.g. a patient-facting public internet system) or a Practitioner where there has been an initiatingOrganisation as part of the triage." />
<type value="Any" />
</parameter>
<parameter>
<name value="registeredGPPractice" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The organization representing the registered GP of the Patient." />
<type value="Organization" />
</parameter>
<parameter>
<name value="inputParameters" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The input parameters for a request, if any. These parameters are defined by the Directory of Services that is the target of the check operation." />
<type value="Parameters" />
</parameter>
<parameter>
<name value="searchDistance" />
<use value="in" />
<min value="0" />
<max value="*" />
<documentation value="The distance/duration to search within." />
<type value="Quantity" />
</parameter>
<parameter>
<name value="services" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The output is a set of HealthcareService resources and related information which can deliver the patient's health needs." />
<type value="Parameters" />
</parameter>
<parameter>
<name value="services.parameters" />
<use value="out" />
<min value="0" />
<max value="*" />
<documentation value="Each healthcare service returned MUST have it's own parameter." />
<type value="BackboneElement" />
</parameter>
<parameter>
<name value="services.parameters.name" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="This MUST be populated with the serviceId." />
<type value="string" />
</parameter>
<parameter>
<name value="services.parameters.part" />
<use value="out" />
<min value="1" />
<max value="*" />
<documentation value="Named parts of this parameter. This MUST contain a parameter named service which MUST contain the HealthcareService resource. This MAY also contain other implementation-specific information about the HealthcareService such as it's distance from the patient's location or capacity." />
<type value="string" />
</parameter>
<parameter>
<name value="outputParameters" />
<use value="out" />
<min value="0" />
<max value="*" />
<documentation value="The output parameters for a request, if any. These parameters are defined by the target DoS." />
<type value="Parameters" />
</parameter>
</OperationDefinition>

JSON View

{
"resourceType": "OperationDefinition",
"id": "UEC-CheckServices-Operation-1",
"url": "https://fhir.nhs.uk/STU3/OperationDefinition/UEC-CheckServices-Operation-1",
"version": "1.1.0",
"name": "UEC-CheckServices-Operation",
"status": "draft",
"kind": "operation",
"date": "2020-04-15T00:00:00+00:00",
"publisher": "NHS Digital",
"contact": [
{
"name": "UEC Interoperability Team",
"telecom": [
{
"value": "uecintegration@nhs.net",
"use": "work"
}
]
}
],
"description": "This is a FHIR Operation performed by a Directory of Services (DoS). It is performed at a server level at the end of a triage journey with a generic Referral Request defined in order to find a specific set of nearby services which can deal with the patient.",
"code": "check-services",
"system": true,
"type": false,
"instance": false,
"parameter": [
{
"name": "requestId",
"use": "in",
"min": 0,
"max": "1",
"documentation": "An optional client-provided identifier to track the request.",
"type": "id"
},
{
"name": "referralRequest",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The core of the $check-services operation is based on the outcome of triage, represented as a chief concern, next activity and acuity. These are all captured in the ReferralRequest, so this resource contains all that is required for the outcome of triage.",
"type": "ReferralRequest"
},
{
"name": "patient",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The patient for whom the triage took place. There are a number of patient elements which are used by some of the directories such as age and gender.",
"type": "Patient"
},
{
"name": "location",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The location represents the patient's current location.",
"type": "Location"
},
{
"name": "requester",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The person initiating the the $check-services request. The requester is the user of the EMS. This will typically be a Patient or RelatedPerson if the EMS is being used by a member of the public (e.g. a patient-facting public internet system) or a Practitioner where there has been an initiatingOrganisation as part of the triage.",
"type": "Any"
},
{
"name": "registeredGPPractice",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The organization representing the registered GP of the Patient.",
"type": "Organization"
},
{
"name": "inputParameters",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The input parameters for a request, if any. These parameters are defined by the Directory of Services that is the target of the check operation.",
"type": "Parameters"
},
{
"name": "searchDistance",
"use": "in",
"min": 0,
"max": "*",
"documentation": "The distance/duration to search within.",
"type": "Quantity"
},
{
"name": "services",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The output is a set of HealthcareService resources and related information which can deliver the patient's health needs.",
"type": "Parameters"
},
{
"name": "services.parameters",
"use": "out",
"min": 0,
"max": "*",
"documentation": "Each healthcare service returned MUST have it's own parameter.",
"type": "BackboneElement"
},
{
"name": "services.parameters.name",
"use": "out",
"min": 1,
"max": "1",
"documentation": "This MUST be populated with the serviceId.",
"type": "string"
},
{
"name": "services.parameters.part",
"use": "out",
"min": 1,
"max": "*",
"documentation": "Named parts of this parameter. This MUST contain a parameter named service which MUST contain the HealthcareService resource. This MAY also contain other implementation-specific information about the HealthcareService such as it's distance from the patient's location or capacity.",
"type": "string"
},
{
"name": "outputParameters",
"use": "out",
"min": 0,
"max": "*",
"documentation": "The output parameters for a request, if any. These parameters are defined by the target DoS.",
"type": "Parameters"
}
]
}
---
back to top