eRS-DoSServiceSearch-Operation-1

Canonical_URL	Status
https://fhir.nhs.uk/STU3/OperationDefinition/eRS-DoSServiceSearch-Operation-1	active

HTML View

Parameters (In)

Name	Cardinality	Type	Binding	Documentation
requestType	0..1	CodeableConcept	eRS Request Type (required)	Request Type
priority	0..1	CodeableConcept	eRS Priority (required)	Priority
specialty	1..1	CodeableConcept	eRS Specialty (required)	The service location identifier.
clinicType	0..1	CodeableConcept	eRS Clinic Type (required)	Clinic Type
patientPostcode	0..1	String		Postcode
commissioningProvisioning	1..1	CodeableConcept	eRS Commissioning Provisioning (required)	Commissioning Provisioning

Return Values (Out)

Name	Cardinality	Type	StructureDefinition	Documentation
response	1..1	HealthcareService	eRS-HealthcareService-1	The HealthcareService resource that has been returned in response to the given input parameters

Table View

OperationDefinition.meta[0].lastUpdated[0]	2016-09-22T00:00:00+01:00
OperationDefinition.url[0]	https://fhir.nhs.uk/STU3/OperationDefinition/eRS-DoSServiceSearch-Operation-1
OperationDefinition.version[0]	1.0.0
OperationDefinition.name[0]	eRS-DoSServiceSearch-Operation-1
OperationDefinition.status[0]	active
OperationDefinition.kind[0]	operation
OperationDefinition.date[0]	2016-09-22T00: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]	Request to retrieve a healthcare service using Directory of Services details.
OperationDefinition.code[0]	ers.DoSServiceSearch
OperationDefinition.system[0]	False
OperationDefinition.type[0]	True
OperationDefinition.instance[0]	False
OperationDefinition.parameter[0].name[0]	requestType
OperationDefinition.parameter[0].use[0]	in
OperationDefinition.parameter[0].min[0]	0
OperationDefinition.parameter[0].max[0]	1
OperationDefinition.parameter[0].documentation[0]	Request Type
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-RequestType-1
OperationDefinition.parameter[1].name[0]	priority
OperationDefinition.parameter[1].use[0]	in
OperationDefinition.parameter[1].min[0]	0
OperationDefinition.parameter[1].max[0]	1
OperationDefinition.parameter[1].documentation[0]	Priority
OperationDefinition.parameter[1].type[0]	CodeableConcept
OperationDefinition.parameter[1].binding[0].strength[0]	required
OperationDefinition.parameter[1].binding[0].valueSet[0].reference[0]	https://fhir.nhs.uk/STU3/ValueSet/eRS-Priority-1
OperationDefinition.parameter[2].name[0]	specialty
OperationDefinition.parameter[2].use[0]	in
OperationDefinition.parameter[2].min[0]	1
OperationDefinition.parameter[2].max[0]	1
OperationDefinition.parameter[2].documentation[0]	The service location identifier.
OperationDefinition.parameter[2].type[0]	CodeableConcept
OperationDefinition.parameter[2].binding[0].strength[0]	required
OperationDefinition.parameter[2].binding[0].valueSet[0].reference[0]	https://fhir.nhs.uk/STU3/ValueSet/eRS-Specialty-1
OperationDefinition.parameter[3].name[0]	clinicType
OperationDefinition.parameter[3].use[0]	in
OperationDefinition.parameter[3].min[0]	0
OperationDefinition.parameter[3].max[0]	1
OperationDefinition.parameter[3].documentation[0]	Clinic Type
OperationDefinition.parameter[3].type[0]	CodeableConcept
OperationDefinition.parameter[3].binding[0].strength[0]	required
OperationDefinition.parameter[3].binding[0].valueSet[0].reference[0]	https://fhir.nhs.uk/STU3/ValueSet/eRS-ClinicType-1
OperationDefinition.parameter[4].name[0]	patientPostcode
OperationDefinition.parameter[4].use[0]	in
OperationDefinition.parameter[4].min[0]	0
OperationDefinition.parameter[4].max[0]	1
OperationDefinition.parameter[4].documentation[0]	Postcode
OperationDefinition.parameter[4].type[0]	string
OperationDefinition.parameter[5].name[0]	commissioningProvisioning
OperationDefinition.parameter[5].use[0]	in
OperationDefinition.parameter[5].min[0]	1
OperationDefinition.parameter[5].max[0]	1
OperationDefinition.parameter[5].documentation[0]	Commissioning Provisioning
OperationDefinition.parameter[5].type[0]	CodeableConcept
OperationDefinition.parameter[5].binding[0].strength[0]	required
OperationDefinition.parameter[5].binding[0].valueSet[0].reference[0]	https://fhir.nhs.uk/STU3/ValueSet/eRS-CommissioningProvisioning-1
OperationDefinition.parameter[6].name[0]	response
OperationDefinition.parameter[6].use[0]	out
OperationDefinition.parameter[6].min[0]	1
OperationDefinition.parameter[6].max[0]	1
OperationDefinition.parameter[6].documentation[0]	The HealthcareService resource that has been returned in response to the given input parameters
OperationDefinition.parameter[6].type[0]	HealthcareService
OperationDefinition.parameter[6].profile[0].reference[0]	https://fhir.nhs.uk/STU3/StructureDefinition/eRS-HealthcareService-1

XML View

<meta>

</meta>

<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />

</telecom>

</contact>

<name value="requestType" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Request Type" />
<type value="CodeableConcept" />
<binding>
<strength value="required" />
<valueSetReference>
<reference value="https://fhir.nhs.uk/STU3/ValueSet/eRS-RequestType-1" />
</valueSetReference>
</binding>

</parameter>

<name value="priority" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Priority" />
<type value="CodeableConcept" />
<binding>
<strength value="required" />
<valueSetReference>
<reference value="https://fhir.nhs.uk/STU3/ValueSet/eRS-Priority-1" />
</valueSetReference>
</binding>

</parameter>

<name value="specialty" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The service location identifier." />
<type value="CodeableConcept" />
<binding>
<strength value="required" />
<valueSetReference>
<reference value="https://fhir.nhs.uk/STU3/ValueSet/eRS-Specialty-1" />
</valueSetReference>
</binding>

</parameter>

<name value="clinicType" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Clinic Type" />
<type value="CodeableConcept" />
<binding>
<strength value="required" />
<valueSetReference>
<reference value="https://fhir.nhs.uk/STU3/ValueSet/eRS-ClinicType-1" />
</valueSetReference>
</binding>

</parameter>

<name value="patientPostcode" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Postcode" />
<type value="string" />

</parameter>

<name value="commissioningProvisioning" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="Commissioning Provisioning" />
<type value="CodeableConcept" />
<binding>
<strength value="required" />
<valueSetReference>
<reference value="https://fhir.nhs.uk/STU3/ValueSet/eRS-CommissioningProvisioning-1" />
</valueSetReference>
</binding>

</parameter>

<name value="response" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The HealthcareService resource that has been returned in response to the given input parameters" />
<type value="HealthcareService" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/eRS-HealthcareService-1" />
</profile>

</parameter>

</OperationDefinition>

JSON View

{

"resourceType": "OperationDefinition",
"meta": {
"lastUpdated": "2016-09-22T00:00:00+01:00"
},
"url": "https://fhir.nhs.uk/STU3/OperationDefinition/eRS-DoSServiceSearch-Operation-1",
"version": "1.0.0",
"name": "eRS-DoSServiceSearch-Operation-1",
"status": "active",
"kind": "operation",
"date": "2016-09-22T00:00:00+01:00",
"publisher": "NHS Digital",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work"
}
]
}
],
"description": "Request to retrieve a healthcare service using Directory of Services details.",
"code": "ers.DoSServiceSearch",
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "requestType",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Request Type",
"type": "CodeableConcept",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://fhir.nhs.uk/STU3/ValueSet/eRS-RequestType-1"
}
}
},
{
"name": "priority",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Priority",
"type": "CodeableConcept",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://fhir.nhs.uk/STU3/ValueSet/eRS-Priority-1"
}
}
},
{
"name": "specialty",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The service location identifier.",
"type": "CodeableConcept",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://fhir.nhs.uk/STU3/ValueSet/eRS-Specialty-1"
}
}
},
{
"name": "clinicType",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Clinic Type",
"type": "CodeableConcept",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://fhir.nhs.uk/STU3/ValueSet/eRS-ClinicType-1"
}
}
},
{
"name": "patientPostcode",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Postcode",
"type": "string"
},
{
"name": "commissioningProvisioning",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Commissioning Provisioning",
"type": "CodeableConcept",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://fhir.nhs.uk/STU3/ValueSet/eRS-CommissioningProvisioning-1"
}
}
},
{
"name": "response",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The HealthcareService resource that has been returned in response to the given input parameters",
"type": "HealthcareService",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-HealthcareService-1"
}
}
]

}

---

NHS Digital STU3 FHIR Assets

v1.0.0-pre-release

eRS-DoSServiceSearch-Operation-1

HTML View

Parameters (In)

Return Values (Out)

Table View

XML View

JSON View