US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401
Publication Build: This will be filled in by the publication tooling
Official URL: http://va.gov/fhir/StructureDefinition/ImplantableDevice | Version: 1.3.1 | |||
Active as of 2025-03-31 | Computable Name: ImplantableDevice |
This StructureDefinition contains the maps for VistA file undefined (undefined) to us-core-implantable-device.
See also the FHIR Shorthand.
This is an abstract profile that is copied by other, concrete profiles. Each descendant concrete profile inherits the maps from this more general case. This way, we don’t have to maintain multiple copies of maps for closely related profiles. (Note that this inheritance is managed by the mapping team with a script; we’re not using the FHIR baseDefinition property for this.)
Sometimes, you will notice that an abstract profile includes only "target not supported" maps, so it doesn't look very useful. However, for every profile, we not only map the fields for which we find source data; we also stipulate "target not supported" for any unmapped fields that are tagged "must support" in the US Core. This way, implementers who might be concerned about these fields if they were not mentioned are fully informed about the reason they are not mapped. When there are several concrete profiles that require these clarifying maps, we collect them in an abstract parent, just as we would for cases where we have source element maps.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreImplantableDeviceProfile(5.0.1) | This is an abstract profile. Item used in healthcare This profile also complies with the profiles US Core Implantable Device Profile (6.1.0) and US Core Implantable Device Profile (7.0.0) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Mandatory fixed portion of UDI ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | UDI Human Readable Barcode String ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | string | The distinct identification string ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | dateTime | Date when the device was made ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | dateTime | Date and time of expiry of this device (if applicable) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | string | Lot number of manufacture ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | string | Serial number assigned by the manufacturer ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | The kind or type of device Binding: FHIRDeviceTypes (extensible): Codes to identify medical devices ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..1 | Reference(US Core Patient Profile(5.0.1)) | Patient to whom Device is affixed ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard | |
Device.type | extensible | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Device | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Device | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Device | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreImplantableDeviceProfile
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreImplantableDeviceProfile(5.0.1) | This is an abstract profile. Item used in healthcare This profile also complies with the profiles US Core Implantable Device Profile (6.1.0) and US Core Implantable Device Profile (7.0.0) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | string | Mandatory fixed portion of UDI | |
![]() ![]() ![]() ![]() |
0..1 | string | UDI Human Readable Barcode String | |
![]() ![]() ![]() |
0..1 | code | active | inactive | entered-in-error | unknown | |
![]() ![]() ![]() |
0..1 | string | The distinct identification string | |
![]() ![]() ![]() |
0..1 | dateTime | Date when the device was made | |
![]() ![]() ![]() |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
![]() ![]() ![]() |
0..1 | string | Lot number of manufacture | |
![]() ![]() ![]() |
0..1 | string | Serial number assigned by the manufacturer | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreImplantableDeviceProfile(5.0.1) | This is an abstract profile. Item used in healthcare This profile also complies with the profiles US Core Implantable Device Profile (6.1.0) and US Core Implantable Device Profile (7.0.0) | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..* | Identifier | Instance identifier | |||||
![]() ![]() ![]() |
0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | |||||
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() ![]() |
0..1 | uri | UDI Issuing Organization | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | Regional UDI authority | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | UDI Human Readable Barcode String | ||||
![]() ![]() ![]() ![]() |
0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |||||
![]() ![]() ![]() |
S | 0..1 | string | The distinct identification string | ||||
![]() ![]() ![]() |
0..1 | string | Name of device manufacturer | |||||
![]() ![]() ![]() |
S | 0..1 | dateTime | Date when the device was made | ||||
![]() ![]() ![]() |
S | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | ||||
![]() ![]() ![]() |
S | 0..1 | string | Lot number of manufacture | ||||
![]() ![]() ![]() |
S | 0..1 | string | Serial number assigned by the manufacturer | ||||
![]() ![]() ![]() |
0..* | BackboneElement | The name of the device as given by the manufacturer | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | string | The name of the device | |||||
![]() ![]() ![]() ![]() |
1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. | |||||
![]() ![]() ![]() |
0..1 | string | The model number for the device | |||||
![]() ![]() ![]() |
0..1 | string | The part number of the device | |||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | The kind or type of device Binding: FHIRDeviceTypes (extensible): Codes to identify medical devices | ||||
![]() ![]() ![]() |
0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The standard that is used to operate and communicate | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The version of the standard that is used to operate and communicate | |||||
![]() ![]() ![]() |
0..* | BackboneElement | The actual design of the device or software version running on the device | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The type of the device version | |||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | A single component of the device version | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The version text | |||||
![]() ![]() ![]() |
0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||
![]() ![]() ![]() ![]() |
0..* | Quantity | Property value as a quantity | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
![]() ![]() ![]() |
S | 1..1 | Reference(US Core Patient Profile(5.0.1)) | Patient to whom Device is affixed | ||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization responsible for device | |||||
![]() ![]() ![]() |
0..* | ContactPoint | Details for human/organization for support | |||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Where the device is found | |||||
![]() ![]() ![]() |
0..1 | uri | Network address to contact device | |||||
![]() ![]() ![]() |
0..* | Annotation | Device notes and comments | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
![]() ![]() ![]() |
0..1 | Reference(Device) | The parent device | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Device.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Device.udiCarrier.entryType | required | UDIEntryTypehttp://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1 from the FHIR Standard | ||||
Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard | ||||
Device.statusReason | extensible | FHIRDeviceStatusReasonhttp://hl7.org/fhir/ValueSet/device-status-reason from the FHIR Standard | ||||
Device.deviceName.type | required | DeviceNameTypehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard | ||||
Device.type | extensible | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Device | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Device | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Device | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreImplantableDeviceProfile
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreImplantableDeviceProfile(5.0.1) | This is an abstract profile. Item used in healthcare This profile also complies with the profiles US Core Implantable Device Profile (6.1.0) and US Core Implantable Device Profile (7.0.0) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Mandatory fixed portion of UDI ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | UDI Human Readable Barcode String ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | string | The distinct identification string ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | dateTime | Date when the device was made ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | dateTime | Date and time of expiry of this device (if applicable) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | string | Lot number of manufacture ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | string | Serial number assigned by the manufacturer ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | The kind or type of device Binding: FHIRDeviceTypes (extensible): Codes to identify medical devices ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..1 | Reference(US Core Patient Profile(5.0.1)) | Patient to whom Device is affixed ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard | |
Device.type | extensible | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Device | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Device | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Device | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from USCoreImplantableDeviceProfile
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreImplantableDeviceProfile(5.0.1) | This is an abstract profile. Item used in healthcare This profile also complies with the profiles US Core Implantable Device Profile (6.1.0) and US Core Implantable Device Profile (7.0.0) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | string | Mandatory fixed portion of UDI | |
![]() ![]() ![]() ![]() |
0..1 | string | UDI Human Readable Barcode String | |
![]() ![]() ![]() |
0..1 | code | active | inactive | entered-in-error | unknown | |
![]() ![]() ![]() |
0..1 | string | The distinct identification string | |
![]() ![]() ![]() |
0..1 | dateTime | Date when the device was made | |
![]() ![]() ![]() |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
![]() ![]() ![]() |
0..1 | string | Lot number of manufacture | |
![]() ![]() ![]() |
0..1 | string | Serial number assigned by the manufacturer | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreImplantableDeviceProfile(5.0.1) | This is an abstract profile. Item used in healthcare This profile also complies with the profiles US Core Implantable Device Profile (6.1.0) and US Core Implantable Device Profile (7.0.0) | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..* | Identifier | Instance identifier | |||||
![]() ![]() ![]() |
0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | |||||
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() ![]() |
0..1 | uri | UDI Issuing Organization | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | Regional UDI authority | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | UDI Human Readable Barcode String | ||||
![]() ![]() ![]() ![]() |
0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |||||
![]() ![]() ![]() |
S | 0..1 | string | The distinct identification string | ||||
![]() ![]() ![]() |
0..1 | string | Name of device manufacturer | |||||
![]() ![]() ![]() |
S | 0..1 | dateTime | Date when the device was made | ||||
![]() ![]() ![]() |
S | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | ||||
![]() ![]() ![]() |
S | 0..1 | string | Lot number of manufacture | ||||
![]() ![]() ![]() |
S | 0..1 | string | Serial number assigned by the manufacturer | ||||
![]() ![]() ![]() |
0..* | BackboneElement | The name of the device as given by the manufacturer | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | string | The name of the device | |||||
![]() ![]() ![]() ![]() |
1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. | |||||
![]() ![]() ![]() |
0..1 | string | The model number for the device | |||||
![]() ![]() ![]() |
0..1 | string | The part number of the device | |||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | The kind or type of device Binding: FHIRDeviceTypes (extensible): Codes to identify medical devices | ||||
![]() ![]() ![]() |
0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The standard that is used to operate and communicate | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The version of the standard that is used to operate and communicate | |||||
![]() ![]() ![]() |
0..* | BackboneElement | The actual design of the device or software version running on the device | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The type of the device version | |||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | A single component of the device version | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The version text | |||||
![]() ![]() ![]() |
0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||
![]() ![]() ![]() ![]() |
0..* | Quantity | Property value as a quantity | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
![]() ![]() ![]() |
S | 1..1 | Reference(US Core Patient Profile(5.0.1)) | Patient to whom Device is affixed | ||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization responsible for device | |||||
![]() ![]() ![]() |
0..* | ContactPoint | Details for human/organization for support | |||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Where the device is found | |||||
![]() ![]() ![]() |
0..1 | uri | Network address to contact device | |||||
![]() ![]() ![]() |
0..* | Annotation | Device notes and comments | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
![]() ![]() ![]() |
0..1 | Reference(Device) | The parent device | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Device.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Device.udiCarrier.entryType | required | UDIEntryTypehttp://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1 from the FHIR Standard | ||||
Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard | ||||
Device.statusReason | extensible | FHIRDeviceStatusReasonhttp://hl7.org/fhir/ValueSet/device-status-reason from the FHIR Standard | ||||
Device.deviceName.type | required | DeviceNameTypehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard | ||||
Device.type | extensible | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Device | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Device | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Device | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreImplantableDeviceProfile
Other representations of profile: CSV, Excel, Schematron