Device Resource

The FHIR Device resource represents an acquisition device configured within AdvaPACS, such as a DICOM modality or other imaging equipment. Device resources can be referenced by other FHIR resources, most commonly a ServiceRequest, where they identify the modality that will perform the requested procedure.

AdvaPACS uses the referenced Device to populate DICOM Modality Worklist information such as the Scheduled Station AE Title and Scheduled Station Name. For full information on the Device resource, refer to the FHIR standard.

Supported Transactions

AdvaPACS supports the following transactions for the Device resource:

Function	Method	Endpoint	Description
Get Device	GET	/Device/{id}	Retrieves a specific Device resource by its logical ID.
Search Devices	GET	/Device	Searches for Device resources using one or more supported search parameters.

Examples

The following examples show how to retrieve and search Device resources using the AdvaPACS FHIR API. These examples are intended to help you understand how devices are represented within FHIR and how device information can be retrieved using supported search parameters.

Get a Device

Retrieve a specific Device resource using its logical ID. The logical ID is assigned to the resource by AdvaPACS and can be obtained by searching for Device resources.

GET /Device/0b4fc2fb-f61d-495f-97ca-2e8765c2f0fb
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>

A successful request returns the Device resource, including information such as its identifiers, status, type, owner, location, and connection details.

{
  "resourceType": "Device",
  "id": "0b4fc2fb-f61d-495f-97ca-2e8765c2f0fb",
  "identifier": [
    {
      "type": {
        "coding": [
          {
            "system": "http://dicom.nema.org/resources/ontology/DCM",
            "code": "110119",
            "display": "Station AE Title"
          }
        ]
      },
      "value": "CT_SCANNER_01"
    }
  ],
  "status": "active",
  "type": {
    "coding": [
      {
        "system": "http://dicom.nema.org/resources/ontology/DCM",
        "code": "109101",
        "display": "Acquisition Equipment"
      }
    ]
  },
  "owner": {
    "reference": "Organization/b0eef8ff-6f17-4222-a85e-5f5fd3259618"
  },
  "location": {
    "display": "Main Imaging Department"
  },
  "url": "192.168.1.20:104"
}

Search Devices

Search for Device resources using one or more supported search parameters. Multiple parameters can be combined to further refine the search results. The following search parameters are supported for the Device resource:

Parameter	Type	Description
_id	token	Search by the logical FHIR resource ID.
identifier	token	Search by a device identifier, such as the Station AE Title.
status	token	Search by the device status.
type	token	Search by the device type.
owner	reference	Search for devices associated with a specific Organization.
location	reference	Search for devices associated with a specific Location.

The following request searches for a Device with the Station AE Title CT_SCANNER_01:

GET /Device?identifier=CT_SCANNER_01
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>

A successful request returns a FHIR Bundle containing the Device resources that match the supplied search parameters. Each matching Device is returned as an entry in the bundle.

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 1,
  "entry": [
    {
      "resource": {
        "resourceType": "Device",
        "id": "0b4fc2fb-f61d-495f-97ca-2e8765c2f0fb",
        "status": "active",
        "identifier": [
          {
            "value": "CT_SCANNER_01"
          }
        ],
        "type": {
          "coding": [
            {
              "display": "Acquisition Equipment"
            }
          ]
        }
      }
    }
  ]
}

If no matching Devices are found, an empty searchset bundle is returned.