Device
The Device resource represents personal aids and devices registered for a patient in Open Aidn.
Open Aidn supports selected fields from the base HL7 FHIR R4 Device resource. A formal Aidn
profile may be published later.
Standards and profiles
- HL7 FHIR R4: Device
- HL7 FHIR R4 search: FHIR search
Endpoints
| Method | Path | Required scope | Description |
|---|---|---|---|
POST |
/Device/_search |
device.search |
Search using application/x-www-form-urlencoded body parameters. |
Search responses are returned as FHIR Bundle resources with type set to searchset.
Search parameters
| Parameter | Type | Description |
|---|---|---|
patient.Identifier |
identifier | Patient identifier used to filter devices for one patient. |
_include |
token, repeatable | Adds supported referenced resources to the response bundle. |
patient.Identifier is required for search.
Supported includes
_include value |
Included resource | Description |
|---|---|---|
Device:patient |
Patient |
Adds referenced patient resources. |
Response fields
Open Aidn may add fields over time. Integrations should expect the following fields to be available:
| Field | Description |
|---|---|
id |
Device identifier. |
meta.lastUpdated |
Last update timestamp when available. |
type.coding |
Device code and display text. |
type.coding.extension |
Device category extension at https://aidn.no/fhir/extensions/deviceCategory when category is known. |
patient.reference |
Reference to the patient. |
Example search
POST /Device/_search HTTP/1.1
Host: <OPEN_AIDN_FHIR_HOST>
Accept: application/fhir+json
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer <ACCESS_TOKEN>
patient.Identifier=<PATIENT_IDENTIFIER>&_include=Device:patientThe response is a FHIR Bundle containing matching Device resources and any requested included
resources.