CardX - Cardiac Implantable Electronic Devices
2.0.0 - ci-build International flag

CardX - Cardiac Implantable Electronic Devices, published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CardX-CIED/ and changes regularly. See the Directory of published versions

Resource Profile: Device Association - Cardiovascular Implantable Electronic Device (CIED)

Official URL: http://hl7.org/fhir/uv/cardx-cied/StructureDefinition/cied-device-association Version: 2.0.0
Standards status: Trial-use Active as of 2026-04-09 Maturity Level: 2 Computable Name: CIEDDeviceAssociation

Device association contains to relationship between the CIED, leads, and other devices associated with a patient. The resource may contain both active and historical associations.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceAssociation 0..* DeviceAssociation A record of association or dissociation of a device with a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... status SΣ 1..1 CodeableConcept implanted | explanted | attached | entered-in-error | unknown
Binding: DeviceAssociationCodes (required): Describes the lifecycle of the association.
... statusReason SΣ 0..* CodeableConcept The reasons given for the current association status
Binding: DeviceAssociationCodes (required): Describes the reason for changing the status of the association.
... subject SΣ 0..1 Reference(Patient - CIED Patient Profile) The individual, group of individuals or device that the device is on or associated with
... period SΣ 0..1 Period Begin and end dates and times for the device association

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceAssociation.status Base required DeviceAssociation Status Codes 📍5.0.0 FHIR Std.
DeviceAssociation.statusReason Base required DeviceAssociation Status Reason Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceAssociation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceAssociation 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DeviceAssociation 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 DeviceAssociation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceAssociation 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()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceAssociation 0..* DeviceAssociation A record of association or dissociation of a device with a patient
... device S 1..1 Reference(Device) Reference to the devices associated with the patient or group
... status S 1..1 CodeableConcept implanted | explanted | attached | entered-in-error | unknown
... statusReason S 0..* CodeableConcept The reasons given for the current association status
... period S 0..1 Period Begin and end dates and times for the device association

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceAssociation 0..* DeviceAssociation A record of association or dissociation of a device with a patient
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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
... device SΣ 1..1 Reference(Device) Reference to the devices associated with the patient or group
... category Σ 0..* CodeableConcept Describes the relationship between the device and subject
... status SΣ 1..1 CodeableConcept implanted | explanted | attached | entered-in-error | unknown
Binding: DeviceAssociationCodes (required): Describes the lifecycle of the association.
... statusReason SΣ 0..* CodeableConcept The reasons given for the current association status
Binding: DeviceAssociationCodes (required): Describes the reason for changing the status of the association.
... subject SΣ 0..1 Reference(Patient - CIED Patient Profile) The individual, group of individuals or device that the device is on or associated with
... bodyStructure Σ 0..1 Reference(BodyStructure) Current anatomical location of the device in/on subject
... period SΣ 0..1 Period Begin and end dates and times for the device association
... operation Σ 0..* BackboneElement The details about the device when it is in use to describe its operation
.... 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
.... status Σ 1..1 CodeableConcept Device operational condition
Binding: FHIRDeviceAssociationOperationStatus (example): Describes the the status of the association operation.
.... operator Σ 0..* Reference(Patient | Practitioner | RelatedPerson) The individual performing the action enabled by the device
.... period Σ 0..1 Period Begin and end dates and times for the device's operation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceAssociation.language Base required All Languages 📍5.0.0 FHIR Std.
DeviceAssociation.status Base required DeviceAssociation Status Codes 📍5.0.0 FHIR Std.
DeviceAssociation.statusReason Base required DeviceAssociation Status Reason Codes 📍5.0.0 FHIR Std.
DeviceAssociation.operation.​status Base example FHIR Device Association Operation Status 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceAssociation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceAssociation 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DeviceAssociation 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 DeviceAssociation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceAssociation 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()

Summary

Must-Support: 5 elements

Structures

This structure refers to these other structures:

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceAssociation 0..* DeviceAssociation A record of association or dissociation of a device with a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... status SΣ 1..1 CodeableConcept implanted | explanted | attached | entered-in-error | unknown
Binding: DeviceAssociationCodes (required): Describes the lifecycle of the association.
... statusReason SΣ 0..* CodeableConcept The reasons given for the current association status
Binding: DeviceAssociationCodes (required): Describes the reason for changing the status of the association.
... subject SΣ 0..1 Reference(Patient - CIED Patient Profile) The individual, group of individuals or device that the device is on or associated with
... period SΣ 0..1 Period Begin and end dates and times for the device association

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceAssociation.status Base required DeviceAssociation Status Codes 📍5.0.0 FHIR Std.
DeviceAssociation.statusReason Base required DeviceAssociation Status Reason Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceAssociation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceAssociation 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DeviceAssociation 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 DeviceAssociation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceAssociation 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceAssociation 0..* DeviceAssociation A record of association or dissociation of a device with a patient
... device S 1..1 Reference(Device) Reference to the devices associated with the patient or group
... status S 1..1 CodeableConcept implanted | explanted | attached | entered-in-error | unknown
... statusReason S 0..* CodeableConcept The reasons given for the current association status
... period S 0..1 Period Begin and end dates and times for the device association

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceAssociation 0..* DeviceAssociation A record of association or dissociation of a device with a patient
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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
... device SΣ 1..1 Reference(Device) Reference to the devices associated with the patient or group
... category Σ 0..* CodeableConcept Describes the relationship between the device and subject
... status SΣ 1..1 CodeableConcept implanted | explanted | attached | entered-in-error | unknown
Binding: DeviceAssociationCodes (required): Describes the lifecycle of the association.
... statusReason SΣ 0..* CodeableConcept The reasons given for the current association status
Binding: DeviceAssociationCodes (required): Describes the reason for changing the status of the association.
... subject SΣ 0..1 Reference(Patient - CIED Patient Profile) The individual, group of individuals or device that the device is on or associated with
... bodyStructure Σ 0..1 Reference(BodyStructure) Current anatomical location of the device in/on subject
... period SΣ 0..1 Period Begin and end dates and times for the device association
... operation Σ 0..* BackboneElement The details about the device when it is in use to describe its operation
.... 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
.... status Σ 1..1 CodeableConcept Device operational condition
Binding: FHIRDeviceAssociationOperationStatus (example): Describes the the status of the association operation.
.... operator Σ 0..* Reference(Patient | Practitioner | RelatedPerson) The individual performing the action enabled by the device
.... period Σ 0..1 Period Begin and end dates and times for the device's operation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceAssociation.language Base required All Languages 📍5.0.0 FHIR Std.
DeviceAssociation.status Base required DeviceAssociation Status Codes 📍5.0.0 FHIR Std.
DeviceAssociation.statusReason Base required DeviceAssociation Status Reason Codes 📍5.0.0 FHIR Std.
DeviceAssociation.operation.​status Base example FHIR Device Association Operation Status 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceAssociation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceAssociation 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DeviceAssociation 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 DeviceAssociation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceAssociation 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()

Summary

Must-Support: 5 elements

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron