IE (Ireland) Core Implementation Guide
1.0.0-ballot - Ballot
Publication Build: This will be filled in by the publication tooling
Official URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-implantable-device | Version: 1.0.0-ballot | |||
Standards status: Trial-use | Maturity Level: 3 | Computable Name: IECoreImplantableDeviceProfile | ||
Other Identifiers: OID:1.3.6.1.4.1.54392.5.2690.42.30 | ||||
Copyright/Legal: iEHR.ai, all rights reserved Creative Commons License |
The IE Core Device Profile inherits from the FHIR Device resource; refer to it for scope and usage definitions. This profile meets the requirements of the iEHR IE Core Data for Interoperability (IECDI) Unique Device Identifier - Implantable Data Element. It sets minimum expectations for the Device resource to record, search, and fetch UDI information associated with a patient's implantable device(s). It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.
Example Usage Scenarios:
The following are example usage scenarios for this profile:
The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.
Each Implantable Device Must Have:
In addition, the following data elements must be supported if the data is present in the sending system (Must Support definition):
Each Implantable Device Must Support:
Profile Specific Implementation Guidance:
A unique device identifier (UDI) is a unique numeric or alphanumeric code. There is a machine-readable version (AIDC - the Automatic Identification and Data Capture) and a human-readable version of the UDI (HRF - Human Readable Form string). This profile specifies that only the HRF must be supported. Considering the complexity of parsing AIDCs, there is no expectation at this time that one converts an AIDC to HRF upon receipt from a FHIR source that is not conformant to this profile or is using another interchange standard (e.g., C-CDA, HL7 v2, etc.). The UDI generally consists of a mandatory Device Identifier (DI) and a conditional Production identifier (PI) that identifies one or more of the five UDI-PI elements. The UDI and its components are mapped to the IE Core Implantable Device Profile elements in the table below:
UDI component | IE Core Implantable Device Profile element |
---|---|
UDI HRF string | Device.udiCarrier.carrierHRF |
DI | Device.udiCarrier.deviceIdentifier |
manufacture date (UDI-PI element) | Device.manufactureDate |
expiration dat (UDI-PI elemente | Device.expirationDate |
lot number (UDI-PI element) | Device.lotNumber |
serial number (UDI-PI element) | Device.serialNumber |
distinct identifier (UDI-PI element) | Device.distinctIdentifier |
Implementers are encouraged to use the EU or FDA Global UDI Database (GUDID) and associated APIs to parse and validate the UDI:
Implantable medical devices with UDI information SHALL represent the UDI code in Device.udiCarrier.carrierHRF
. All five UDI-PI elements defined in the UDI code may not always be present in every UDI instance. However, those UDI-PI elements present SHALL be represented in the corresponding IE Core Implantable Device Profile elements.
UDI may not be present in all scenarios, such as historical implantable devices, patient-reported implant information, payer-reported devices, or improperly documented implants. If UDI is not present and the manufacturer or model number information is available, they SHOULD be included to support historical reports of implantable medical devices as follows:
data element | IE Core Implantable Device Profile element |
---|---|
manufacturer | Device.manufacturer |
model | Device.model |
Device.type
to allow clients to request the patient's devices by a specific type. Note: Device.type
is too granular to differentiate implantable vs. non-implantable devices.The Quick Start section below describes searching for all devices. Records of implanted devices MAY be queried against UDI data, including:
udi-carrier
)udi-di
)manufacturer
)model
)Implementers MAY also adopt custom SearchParameters for searching by:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the IE Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only IE Core Profiles (Profile Only Support) are not required to support these interactions. See the IE Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.
Servers providing access to implantable device data SHALL support these IE Core SMART Scopes:
<patient|user|system>/Device.rs
SHALL support searching for all devices for a patient, including implantable devices using the patient
search parameter:
GET [base]/Device?patient={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all Device resources for the specified patient (how to search by reference)
The following search parameter combinations SHOULD be supported:
SHOULD support searching using the combination of the patient
and type
search parameters:
GET [base]/Device?patient={Type/}[id]&type={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all Device resources for the specified patient and type. (how to search by reference and how to search by token)
SHOULD support searching using the combination of the patient
and status
search parameters:
status
(e.g.status={system|}[code],{system|}[code],...
)GET [base]/Device?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle of all Device resources for the specified patient and status (how to search by reference and how to search by token)