US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401 United States of America flag

Publication Build: This will be filled in by the publication tooling

Resource Profile: Implantable Device: A Lead

Official URL: http://va.gov/fhir/StructureDefinition/ImplantableDeviceALead Version: 1.3.1
Active as of 2025-03-31 Computable Name: ImplantableDeviceALead

This StructureDefinition contains the maps for VistA file A LEAD IMPLANT (698.2) to us-core-implantable-device.

See also the FHIR Shorthand.

Use Case Overview

Use Case: Implantable Device: A Lead«us-core-implantable-device»ImplantableDeviceALeadpatientPatient

Usage:

  • CapabilityStatements using this Resource Profile: Lighthouse Patient Health API
  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..* USCoreImplantableDeviceProfile(5.0.1) 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 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
... identifier 0..* Identifier Instance identifier
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://va.gov/identifiers/$Sta3n/698.2
.... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... modifierExtension ?!Σ 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
.... deviceIdentifier SΣ 1..1 string Mandatory fixed portion of UDI
ele-1: All FHIR elements must have a @value or children
.... carrierHRF SΣ 0..1 string UDI Human Readable Barcode String
ele-1: All FHIR elements must have a @value or children
... status ?!SΣC 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
idal-22-1358: If (698.2-56) is is NULL then fixed value #active
idal-22-1359: If (698.2-56) is is not NULL then fixed value #inactive
... distinctIdentifier S 0..1 string The distinct identification string
ele-1: All FHIR elements must have a @value or children
... manufacturer S 0..1 string Name of device manufacturer
ele-1: All FHIR elements must have a @value or children
... manufactureDate S 0..1 dateTime Date when the device was made
ele-1: All FHIR elements must have a @value or children
... expirationDate 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
... lotNumber S 0..1 string Lot number of manufacture
ele-1: All FHIR elements must have a @value or children
... serialNumber S 0..1 string Serial number assigned by the manufacturer
ele-1: All FHIR elements must have a @value or children
... modelNumber S 0..1 string The model number for the device
ele-1: All FHIR elements must have a @value or children
... type S 1..1 CodeableConcept The kind or type of device
Binding: deviceTypePacemaker FHIR (required): see mapping VF_deviceTypePacemaker


ele-1: All FHIR elements must have a @value or children
... patient S 1..1 Reference(Patient) Patient to whom Device is affixed
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Device.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|4.0.1
from the FHIR Standard
Device.typerequiredDeviceTypePacemaker
http://va.gov/fhir/ValueSet/deviceTypePacemaker
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
idal-22-1358warningDevice.statusIf (698.2-56) is is NULL then fixed value #active
: true
idal-22-1359warningDevice.statusIf (698.2-56) is is not NULL then fixed value #inactive
: true

This structure is derived from USCoreImplantableDeviceProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..* USCoreImplantableDeviceProfile(5.0.1) 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)
... identifier
.... system S 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/$Sta3n/698.2
.... value S 0..1 string The value that is unique
... udiCarrier
.... deviceIdentifier 1..1 string Mandatory fixed portion of UDI
.... carrierHRF 0..1 string UDI Human Readable Barcode String
... status SC 0..1 code active | inactive | entered-in-error | unknown
idal-22-1358: If (698.2-56) is is NULL then fixed value #active
idal-22-1359: If (698.2-56) is is not NULL then fixed value #inactive
... manufacturer S 0..1 string Name of device manufacturer
... manufactureDate 0..1 dateTime Date when the device was made
... expirationDate 0..1 dateTime Date and time of expiry of this device (if applicable)
... lotNumber 0..1 string Lot number of manufacture
... serialNumber 0..1 string Serial number assigned by the manufacturer
... modelNumber S 0..1 string The model number for the device
... type 1..1 CodeableConcept The kind or type of device
Binding: deviceTypePacemaker FHIR (required): see mapping VF_deviceTypePacemaker

... patient 1..1 Reference(Patient) Patient to whom Device is affixed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Device.typerequiredDeviceTypePacemaker
http://va.gov/fhir/ValueSet/deviceTypePacemaker
from this IG

Constraints

IdGradePath(s)DetailsRequirements
idal-22-1358warningDevice.statusIf (698.2-56) is is NULL then fixed value #active
: true
idal-22-1359warningDevice.statusIf (698.2-56) is is not NULL then fixed value #inactive
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..* USCoreImplantableDeviceProfile(5.0.1) 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)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Instance identifier
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/$Sta3n/698.2
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... definition 0..1 Reference(DeviceDefinition) The reference to the definition for the device
... udiCarrier SΣ 0..1 BackboneElement Unique Device Identifier (UDI) Barcode string
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... deviceIdentifier SΣ 1..1 string Mandatory fixed portion of UDI
.... issuer 0..1 uri UDI Issuing Organization
.... jurisdiction 0..1 uri Regional UDI authority
.... carrierAIDC Σ 0..1 base64Binary UDI Machine Readable Barcode String
.... carrierHRF SΣ 0..1 string UDI Human Readable Barcode String
.... entryType 0..1 code barcode | rfid | manual +
Binding: UDIEntryType (required): Codes to identify how UDI data was entered.

... status ?!SΣC 0..1 code active | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.


idal-22-1358: If (698.2-56) is is NULL then fixed value #active
idal-22-1359: If (698.2-56) is is not NULL then fixed value #inactive
... statusReason 0..* CodeableConcept online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.


... distinctIdentifier S 0..1 string The distinct identification string
... manufacturer S 0..1 string Name of device manufacturer
... manufactureDate S 0..1 dateTime Date when the device was made
... expirationDate S 0..1 dateTime Date and time of expiry of this device (if applicable)
... lotNumber S 0..1 string Lot number of manufacture
... serialNumber S 0..1 string Serial number assigned by the manufacturer
... deviceName 0..* BackboneElement The name of the device as given by the manufacturer
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string The name of the device
.... type 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.

... modelNumber S 0..1 string The model number for the device
... partNumber 0..1 string The part number of the device
... type S 1..1 CodeableConcept The kind or type of device
Binding: deviceTypePacemaker FHIR (required): see mapping VF_deviceTypePacemaker

... specialization 0..* BackboneElement The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... systemType 1..1 CodeableConcept The standard that is used to operate and communicate
.... version 0..1 string The version of the standard that is used to operate and communicate
... version 0..* BackboneElement The actual design of the device or software version running on the device
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept The type of the device version
.... component 0..1 Identifier A single component of the device version
.... value 1..1 string The version text
... property 0..* BackboneElement The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuantity 0..* Quantity Property value as a quantity
.... valueCode 0..* CodeableConcept Property value as a code, e.g., NTP4 (synced to NTP)
... patient S 1..1 Reference(Patient) Patient to whom Device is affixed
... owner 0..1 Reference(Organization) Organization responsible for device
... contact 0..* ContactPoint Details for human/organization for support
... location 0..1 Reference(Location) Where the device is found
... url 0..1 uri Network address to contact device
... note 0..* Annotation Device notes and comments
... safety Σ 0..* CodeableConcept Safety Characteristics of Device
... parent 0..1 Reference(Device) The parent device

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Device.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Device.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Device.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Device.udiCarrier.entryTyperequiredUDIEntryType
http://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1
from the FHIR Standard
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|4.0.1
from the FHIR Standard
Device.statusReasonextensibleFHIRDeviceStatusReason
http://hl7.org/fhir/ValueSet/device-status-reason
from the FHIR Standard
Device.deviceName.typerequiredDeviceNameType
http://hl7.org/fhir/ValueSet/device-nametype|4.0.1
from the FHIR Standard
Device.typerequiredDeviceTypePacemaker
http://va.gov/fhir/ValueSet/deviceTypePacemaker
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
idal-22-1358warningDevice.statusIf (698.2-56) is is NULL then fixed value #active
: true
idal-22-1359warningDevice.statusIf (698.2-56) is is not NULL then fixed value #inactive
: true

This structure is derived from USCoreImplantableDeviceProfile

Summary

Must-Support: 5 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..* USCoreImplantableDeviceProfile(5.0.1) 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 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
... identifier 0..* Identifier Instance identifier
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://va.gov/identifiers/$Sta3n/698.2
.... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... modifierExtension ?!Σ 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
.... deviceIdentifier SΣ 1..1 string Mandatory fixed portion of UDI
ele-1: All FHIR elements must have a @value or children
.... carrierHRF SΣ 0..1 string UDI Human Readable Barcode String
ele-1: All FHIR elements must have a @value or children
... status ?!SΣC 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
idal-22-1358: If (698.2-56) is is NULL then fixed value #active
idal-22-1359: If (698.2-56) is is not NULL then fixed value #inactive
... distinctIdentifier S 0..1 string The distinct identification string
ele-1: All FHIR elements must have a @value or children
... manufacturer S 0..1 string Name of device manufacturer
ele-1: All FHIR elements must have a @value or children
... manufactureDate S 0..1 dateTime Date when the device was made
ele-1: All FHIR elements must have a @value or children
... expirationDate 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
... lotNumber S 0..1 string Lot number of manufacture
ele-1: All FHIR elements must have a @value or children
... serialNumber S 0..1 string Serial number assigned by the manufacturer
ele-1: All FHIR elements must have a @value or children
... modelNumber S 0..1 string The model number for the device
ele-1: All FHIR elements must have a @value or children
... type S 1..1 CodeableConcept The kind or type of device
Binding: deviceTypePacemaker FHIR (required): see mapping VF_deviceTypePacemaker


ele-1: All FHIR elements must have a @value or children
... patient S 1..1 Reference(Patient) Patient to whom Device is affixed
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Device.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|4.0.1
from the FHIR Standard
Device.typerequiredDeviceTypePacemaker
http://va.gov/fhir/ValueSet/deviceTypePacemaker
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
idal-22-1358warningDevice.statusIf (698.2-56) is is NULL then fixed value #active
: true
idal-22-1359warningDevice.statusIf (698.2-56) is is not NULL then fixed value #inactive
: true

Differential View

This structure is derived from USCoreImplantableDeviceProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..* USCoreImplantableDeviceProfile(5.0.1) 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)
... identifier
.... system S 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/$Sta3n/698.2
.... value S 0..1 string The value that is unique
... udiCarrier
.... deviceIdentifier 1..1 string Mandatory fixed portion of UDI
.... carrierHRF 0..1 string UDI Human Readable Barcode String
... status SC 0..1 code active | inactive | entered-in-error | unknown
idal-22-1358: If (698.2-56) is is NULL then fixed value #active
idal-22-1359: If (698.2-56) is is not NULL then fixed value #inactive
... manufacturer S 0..1 string Name of device manufacturer
... manufactureDate 0..1 dateTime Date when the device was made
... expirationDate 0..1 dateTime Date and time of expiry of this device (if applicable)
... lotNumber 0..1 string Lot number of manufacture
... serialNumber 0..1 string Serial number assigned by the manufacturer
... modelNumber S 0..1 string The model number for the device
... type 1..1 CodeableConcept The kind or type of device
Binding: deviceTypePacemaker FHIR (required): see mapping VF_deviceTypePacemaker

... patient 1..1 Reference(Patient) Patient to whom Device is affixed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Device.typerequiredDeviceTypePacemaker
http://va.gov/fhir/ValueSet/deviceTypePacemaker
from this IG

Constraints

IdGradePath(s)DetailsRequirements
idal-22-1358warningDevice.statusIf (698.2-56) is is NULL then fixed value #active
: true
idal-22-1359warningDevice.statusIf (698.2-56) is is not NULL then fixed value #inactive
: true

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..* USCoreImplantableDeviceProfile(5.0.1) 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)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Instance identifier
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/$Sta3n/698.2
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... definition 0..1 Reference(DeviceDefinition) The reference to the definition for the device
... udiCarrier SΣ 0..1 BackboneElement Unique Device Identifier (UDI) Barcode string
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... deviceIdentifier SΣ 1..1 string Mandatory fixed portion of UDI
.... issuer 0..1 uri UDI Issuing Organization
.... jurisdiction 0..1 uri Regional UDI authority
.... carrierAIDC Σ 0..1 base64Binary UDI Machine Readable Barcode String
.... carrierHRF SΣ 0..1 string UDI Human Readable Barcode String
.... entryType 0..1 code barcode | rfid | manual +
Binding: UDIEntryType (required): Codes to identify how UDI data was entered.

... status ?!SΣC 0..1 code active | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.


idal-22-1358: If (698.2-56) is is NULL then fixed value #active
idal-22-1359: If (698.2-56) is is not NULL then fixed value #inactive
... statusReason 0..* CodeableConcept online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.


... distinctIdentifier S 0..1 string The distinct identification string
... manufacturer S 0..1 string Name of device manufacturer
... manufactureDate S 0..1 dateTime Date when the device was made
... expirationDate S 0..1 dateTime Date and time of expiry of this device (if applicable)
... lotNumber S 0..1 string Lot number of manufacture
... serialNumber S 0..1 string Serial number assigned by the manufacturer
... deviceName 0..* BackboneElement The name of the device as given by the manufacturer
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string The name of the device
.... type 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.

... modelNumber S 0..1 string The model number for the device
... partNumber 0..1 string The part number of the device
... type S 1..1 CodeableConcept The kind or type of device
Binding: deviceTypePacemaker FHIR (required): see mapping VF_deviceTypePacemaker

... specialization 0..* BackboneElement The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... systemType 1..1 CodeableConcept The standard that is used to operate and communicate
.... version 0..1 string The version of the standard that is used to operate and communicate
... version 0..* BackboneElement The actual design of the device or software version running on the device
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept The type of the device version
.... component 0..1 Identifier A single component of the device version
.... value 1..1 string The version text
... property 0..* BackboneElement The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuantity 0..* Quantity Property value as a quantity
.... valueCode 0..* CodeableConcept Property value as a code, e.g., NTP4 (synced to NTP)
... patient S 1..1 Reference(Patient) Patient to whom Device is affixed
... owner 0..1 Reference(Organization) Organization responsible for device
... contact 0..* ContactPoint Details for human/organization for support
... location 0..1 Reference(Location) Where the device is found
... url 0..1 uri Network address to contact device
... note 0..* Annotation Device notes and comments
... safety Σ 0..* CodeableConcept Safety Characteristics of Device
... parent 0..1 Reference(Device) The parent device

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Device.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Device.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Device.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Device.udiCarrier.entryTyperequiredUDIEntryType
http://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1
from the FHIR Standard
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|4.0.1
from the FHIR Standard
Device.statusReasonextensibleFHIRDeviceStatusReason
http://hl7.org/fhir/ValueSet/device-status-reason
from the FHIR Standard
Device.deviceName.typerequiredDeviceNameType
http://hl7.org/fhir/ValueSet/device-nametype|4.0.1
from the FHIR Standard
Device.typerequiredDeviceTypePacemaker
http://va.gov/fhir/ValueSet/deviceTypePacemaker
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
idal-22-1358warningDevice.statusIf (698.2-56) is is NULL then fixed value #active
: true
idal-22-1359warningDevice.statusIf (698.2-56) is is not NULL then fixed value #inactive
: true

This structure is derived from USCoreImplantableDeviceProfile

Summary

Must-Support: 5 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron