NHS Digital FHIR Implementation Guide (Retired

Device Search Interactions

The SCR API SHALL support a search interaction to return Device resources using search parameters for:

[Mandatory] Organisation code - ODS code of the target organisation (i.e. GP practice operating the software instance)
[Mandatory] MHS Interaction ID - type of Interaction supported by software instance
[Optional ] Manufacturer's organisation code - ODS code of the manufacturer's organisation (i.e. GP System supplier)
[Optional ] Party Key - identifier representing the target organisation and service interaction

Device resources are returned as a searchset Bundle containing 0, 1 or many matching Endpoint resources

SearchParameter-SDS-ManagingOrganisation has been defined to specify search on the managingOrganisation extension

The Device Search Interaction supports GP Connect use cases by allowing a consumer system to retrieve the Accredited System (AS) record for a capability at a target GP provider organisation OR at their own organisation

Search Parameter

Data Item	Query Parameter	Query Target	Example
Organisation code	organization	Device.owner	organization=[GPSystemODSCode]
MHS Interaction ID	identifier	Device.identifier:NhsEndpointServiceId	identifier=https://fhir.nhs.uk/Id/nhsEndpointServiceId\|[interactionId]
Manufacturer organisation code	managing-organisation	Device.extension:Extension-SDS-ManagingOrganisation	managing-organisation=[supplierODSCode]
Party Key	identifier	Device.identifier:NhsMhsPartyKey	identifier=https://fhir.nhs.uk/Id/nhsMhsPartyKey\|[partyKey]

Request pattern

GET [baseURL]/Device?
  organization=[ODSNamingSystem]|[GPSystemODSCode]&
  identifier=[EndpointServiceIdNamingSystem]|[interactionId]&
  managing-organisation=[ODSNamingSystem]|[supplierODSCode]&
  identifier=[PartyKeyNamingSystem]|[partyKey]

Example request

GET [baseURL]/Device?
  organization=https://fhir.nhs.uk/Id/ods-organization-code|R8008&
  identifier=https://fhir.nhs.uk/Id/nhsEndpointServiceId|urn:nhs:names:services:psis:REPC_IN150016UK05&
  managing-organisation=https://fhir.nhs.uk/Id/ods-organization-code|T10101&
  identifier=https://fhir.nhs.uk/Id/nhsMhsPartyKey|R8008-0000806

Example response payload

<link>

</link>

<entry>

</identifier>

</valueReference>

</extension>

</identifier>

</identifier>

</identifier>

<owner>

</identifier>

</owner>

</Device>

</resource>

</search>

</entry>

</Bundle>

{

"resourceType": "Bundle",

"id": "6cf80168-a1ef-49a2-bb92-e870c8e11e3c",

"type": "searchset",

"total": 1,

"link": [

{

"relation": "self",

"url": "[baseURL]/Device?organization=https://fhir.nhs.uk/Id/ods-organization-code|R8008&identifier=https://fhir.nhs.uk/Id/nhsEndpointServiceId|urn:nhs:names:services:psis:REPC_IN150016UK05&managing-organisation=https://fhir.nhs.uk/Id/ods-organization-code|T10101&identifier=https://fhir.nhs.uk/Id/nhsMhsPartyKey|R8008-0000806"

}

"entry": [

{

"fullUrl": "[baseURL]/Device/ef4a9244-cec1-474a-8694-775dd385d2cc",

"resource": {

"resourceType": "Device",

"id": "ef4a9244-cec1-474a-8694-775dd385d2cc",

"extension": [

{

"url": "https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ManagingOrganisation",

"valueReference": {

"identifier": {