MaxIntegration V1.0 Documentation CCDS Support - Unique Device Identifiers

Unique Device Identifiers

In FHIR STU3 standard, Device resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity.

Immunizations is an administrative resource that tracks individual device types or instances of a device and their location. The device may be a medical or non-medical device. The substructure of udi of this resource is adapated to represent the CCDS element unique device identifiers.

Required or some important fields and parameters would be given in the following tables. Operations and parameters of this resource would also be listed.

Resource Element Fields

Name Description Type
identifier Instance identifier Identifier
udi (BackboneElement) Unique Device Identifier (UDI) Barcode string deviceIdentifier: string
name: string
jurisdiction: uri
carrierHRF: string
carrierAIDC: base64Binary
issuer: uri
entryType: code (UDIEntryType)
status The status code code (FHIRDeviceStatus)
type What kind of device this is CodeableConcept (FHIR Device Types)
lotNumber Lot number of manufacture string
manufacturer Name of device manufacturer string
model Model id assigned by the manufacturer string
version Version number (i.e. software) string
patient Patient to whom Device is affixed References (Patient)
owner Organization responsible for device References (Organization)

Get Unique Device Identifiers by Patient

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Device?patient={id}&udi-di={UDI}

Example:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Device?patient=726&udi-di=(01)00643169007222(17)160128(21)BLC200461H
                {
    "resourceType": "Bundle",
    "id": "74f83518-7b1d-4b5c-a9bb-9c24474b503d",
    "meta": {
        "lastUpdated": "2017-12-26T11:07:05.038-06:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Device?patient=726&udi-di=%2801%2900643169007222%2817%29160128%2821%29BLC200461H"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Device/783",
            "resource": {
                "resourceType": "Device",
                "id": "783",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2017-12-26T09:21:57.000-06:00"
                },
                "udi": {
                    "deviceIdentifier": "(01)00643169007222(17)160128(21)BLC200461H",
                    "jurisdiction": "FDA"
                },
                "type": {
                    "coding": [
                        {
                            "system": "SNOMED CT",
                            "code": "704708004",
                            "display": "Cardiac resynchronization therapy implantable pacemaker"
                        }
                    ]
                },
                "patient": {
                    "reference": "Patient/726"
                }
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}
                
    

For this resource, users are able to search using parameters like type, patient, and udi-di etc. Important searching parameters would be listed in the following table.

Parameter Name Description Type Required
_id The Id of the certain resource string False
identifier The unique identifier for this UDI string False
patient The Id representing the specific patient related with this resource integer True (If the query is concerning a specific patient)
type Type of the device string False
status The status of the certain device string False
udi-di The UDI ID for this UDI string True (Used to access for this certain device)