Administration
This
page
is
part
of
the
FHIR
Specification
v6.0.0-ballot3:
Release
6
Ballot
(3rd
Draft)
(see
Ballot
Notes
).
The
current
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
|
Responsible
Owner:
Orders
and
Observations
Work
Group
|
|
Security Category : Patient | Compartments : Device , Group , Patient , Practitioner , RelatedPerson |
A
record
of
association
or
dissociation
of
a
device
with
a
patient.
subject
(e.g.
patient)
and/or
operator.
Device
Association
records
the
relationship
between
a
device
and
a
subject
and/or
operator.
The
relationsip
may
be
as
the
owner,
patient,
operator
or
cusodian
of
the
device.
The
scope
covers
all
devices
including,
but
not
limited
to:
implantables
(which
previously
was
documented
as
the
.association
in
the
Device
resource),
implantables,
wheelchairs,
RTLS,
personal
health
and
point
of
care
devices,
diagnostic,
imaging
and
durable
medical
equipment.
This
resource
is
intended
to
apply
to
any
delivery
environment
and
discipline
where
a
device
association
is
useful
to
record.
The subjects may include:
These
are
not
exclusive,
i.e.
when
associating
a
device
with
a
patient,
the
it
is
possible
to
capture
the
patient's
clinical
information
with
a
DeviceUsage
resource,
include
the
device
in
a
Procedure
resources
may
be
used
together
—
for
reporting,
and
keep
the
Device's
traceability
information
with
example,
a
DeviceAssociation
resource.
procedure
may
establish
or
end
an
association,
while
DeviceUsage
captures
continued
patient
use.
To
track
changes
in
settings,
the
Observation
resource
can
be
used,
where
Observation.subject
references
the
Device
that
the
settings
apply
to.
If,
e.g.,
the
patient
that
the
Device
is
associated
with
needs
to
be
identified,
then
the
DeviceAssociation
where
DeviceAssociation.period
includes
the
Observation.effective[x]
would
have
that
patient
in
DeviceAssociation.subject.
DeviceAssociation.subject
.
No references for this Resource.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
DeviceAssociation
|
Σ D | DomainResource |
A
record
of
association
or
dissociation
of
a
device
with
a
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
identifier
|
Σ | 0..* | Identifier |
Instance
identifier
|
device
|
Σ | 1..1 | Reference ( Device ) |
Reference
to
the
|
|
relationship
|
Σ | 0..* | CodeableConcept |
Describes
the
relationship
between
the
device
and
subject
Binding: DeviceAssociation Relationship Codes ( Extensible ) |
status
|
Σ | 1..1 |
|
active
|
Binding: DeviceAssociation Status Codes ( Required ) |
|
statusReason
|
Σ | 0..* | CodeableConcept |
The
reasons
given
for
the
current
association
status
Binding: DeviceAssociation Status Reason Codes ( |
|
associationStatus
| Σ | 0..1 | CodeableConcept |
State
of
the
device’s
association
Binding: DeviceAssociation Association Status ( Preferred ) |
|
subject
|
Σ | 0..1 |
Reference
(
|
The
|
|
focus
|
Σ | 0..1 |
Reference
(
|
The
target
of
the
association
|
|
|
Σ | 0..1 |
Reference
(
|
Current
anatomical
location
of
the
device
in/on
subject
|
period
|
Σ | 0..1 | Period |
Begin
and
end
dates
and
times
for
the
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<<DeviceAssociation xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Instance identifier --></identifier>
<</device><device><!-- 1..1 Reference(Device) Reference to the device that is being associated --></device> <relationship><!-- 0..* CodeableConcept Describes the relationship between the device and subject --></relationship><</status><status value="[code]"/><!-- 1..1 active | inactive | entered-in-error | unknown --> <statusReason><!-- 0..* CodeableConcept The reasons given for the current association status --></statusReason><| </subject><associationStatus><!-- 0..1 CodeableConcept State of the device’s association --></associationStatus> <subject><!-- 0..1 Reference(BiologicallyDerivedProduct|CareTeam|Device|Group| Location|Medication|NutritionProduct|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson|Specimen|Substance) The entity(ies) that the device is on or associated with --></subject> <focus><!-- 0..1 Reference(BiologicallyDerivedProduct|CareTeam|Device|Group| Location|Medication|NutritionProduct|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson|Specimen|Substance) The target of the association --></focus> <bodyStructure><!-- 0..1 Reference(BodyStructure) Current anatomical location of the device in/on subject --></bodyStructure> <period><!-- 0..1 Period Begin and end dates and times for the device association --></period>< <</status> <</operator> <</period> </operation></DeviceAssociation>
JSON Template
{
"resourceType" : "",
"resourceType" : "DeviceAssociation",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Instance identifier
"
"device" : { Reference(Device) }, // R! Reference to the device that is being associated
"relationship" : [{ CodeableConcept }], // Describes the relationship between the device and subject
"
"status" : "<code>", // R! active | inactive | entered-in-error | unknown
"statusReason" : [{ CodeableConcept }], // The reasons given for the current association status
"|
"associationStatus" : { CodeableConcept }, // State of the device’s association
"subject" : { Reference(BiologicallyDerivedProduct|CareTeam|Device|Group|
Location|Medication|NutritionProduct|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson|Specimen|Substance) }, // The entity(ies) that the device is on or associated with
"focus" : { Reference(BiologicallyDerivedProduct|CareTeam|Device|Group|
Location|Medication|NutritionProduct|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson|Specimen|Substance) }, // The target of the association
"bodyStructure" : { Reference(BodyStructure) }, // Current anatomical location of the device in/on subject
"
"
"
"
"
}]
"period" : { Period } // Begin and end dates and times for the device association
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:;[ a fhir:DeviceAssociation; fhir:nodeRole fhir:treeRoot; # if this is the parser root# from # from# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* Instance identifierfhir:fhir:device [ Reference(Device) ] ; # 1..1 Reference to the device that is being associated fhir:relationship ( [ CodeableConcept ] ... ) ; # 0..* Describes the relationship between the device and subjectfhir:fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error | unknown fhir:statusReason ( [ CodeableConcept ] ... ) ; # 0..* The reasons given for the current association statusfhir:fhir:associationStatus [ CodeableConcept ] ; # 0..1 State of the device’s association fhir:subject [ Reference(BiologicallyDerivedProduct|CareTeam|Device|Group|Location|Medication| NutritionProduct|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson|Specimen|Substance) ] ; # 0..1 The entity(ies) that the device is on or associated with fhir:focus [ Reference(BiologicallyDerivedProduct|CareTeam|Device|Group|Location|Medication| NutritionProduct|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson|Specimen|Substance) ] ; # 0..1 The target of the association fhir:bodyStructure [ Reference(BodyStructure) ] ; # 0..1 Current anatomical location of the device in/on subject fhir:period [ Period ] ; # 0..1 Begin and end dates and times for the device associationfhir: fhir: fhir: fhir: ] ... ) ;]
Changes from both R4 and R4B
This resource did not exist in Release R4
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
DeviceAssociation
|
Σ D | DomainResource |
A
record
of
association
or
dissociation
of
a
device
with
a
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
identifier
|
Σ | 0..* | Identifier |
Instance
identifier
|
|
device
|
Σ | 1..1 | Reference ( Device ) |
Reference
to
the
|
|
relationship
|
Σ | 0..* | CodeableConcept |
Describes
the
relationship
between
the
device
and
subject
Binding: DeviceAssociation Relationship Codes ( Extensible ) |
|
status
|
Σ | 1..1 |
|
active
|
Binding: DeviceAssociation Status Codes ( Required ) |
|
statusReason
|
Σ | 0..* | CodeableConcept |
The
reasons
given
for
the
current
association
status
Binding: DeviceAssociation Status Reason Codes ( |
|
associationStatus
| Σ | 0..1 | CodeableConcept |
State
of
the
device’s
association
Binding: DeviceAssociation Association Status ( Preferred ) |
|
subject
|
Σ | 0..1 |
Reference
(
|
The
|
|
focus
|
Σ | 0..1 |
Reference
(
|
The
target
of
the
association
|
|
|
Σ | 0..1 |
Reference
(
|
Current
anatomical
location
of
the
device
in/on
subject
|
|
period
|
Σ | 0..1 | Period |
Begin
and
end
dates
and
times
for
the
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<<DeviceAssociation xmlns="http://hl7.org/fhir"><</device><device><!-- 1..1 Reference(Device) Reference to the device that is being associated --></device> <relationship><!-- 0..* CodeableConcept Describes the relationship between the device and subject --></relationship><</status><status value="[code]"/><!-- 1..1 active | inactive | entered-in-error | unknown --> <statusReason><!-- 0..* CodeableConcept The reasons given for the current association status --></statusReason><| </subject><associationStatus><!-- 0..1 CodeableConcept State of the device’s association --></associationStatus> <subject><!-- 0..1 Reference(BiologicallyDerivedProduct|CareTeam|Device|Group| Location|Medication|NutritionProduct|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson|Specimen|Substance) The entity(ies) that the device is on or associated with --></subject> <focus><!-- 0..1 Reference(BiologicallyDerivedProduct|CareTeam|Device|Group| Location|Medication|NutritionProduct|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson|Specimen|Substance) The target of the association --></focus> <bodyStructure><!-- 0..1 Reference(BodyStructure) Current anatomical location of the device in/on subject --></bodyStructure> <period><!-- 0..1 Period Begin and end dates and times for the device association --></period>< <</status> <</operator> <</period> </operation></DeviceAssociation>
JSON Template
{
"resourceType" : "",
"resourceType" : "DeviceAssociation",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Instance identifier
"
"device" : { Reference(Device) }, // R! Reference to the device that is being associated
"relationship" : [{ CodeableConcept }], // Describes the relationship between the device and subject
"
"status" : "<code>", // R! active | inactive | entered-in-error | unknown
"statusReason" : [{ CodeableConcept }], // The reasons given for the current association status
"|
"associationStatus" : { CodeableConcept }, // State of the device’s association
"subject" : { Reference(BiologicallyDerivedProduct|CareTeam|Device|Group|
Location|Medication|NutritionProduct|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson|Specimen|Substance) }, // The entity(ies) that the device is on or associated with
"focus" : { Reference(BiologicallyDerivedProduct|CareTeam|Device|Group|
Location|Medication|NutritionProduct|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson|Specimen|Substance) }, // The target of the association
"bodyStructure" : { Reference(BodyStructure) }, // Current anatomical location of the device in/on subject
"
"
"
"
"
}]
"period" : { Period } // Begin and end dates and times for the device association
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:;[ a fhir:DeviceAssociation; fhir:nodeRole fhir:treeRoot; # if this is the parser root# from # from# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* Instance identifierfhir:fhir:device [ Reference(Device) ] ; # 1..1 Reference to the device that is being associated fhir:relationship ( [ CodeableConcept ] ... ) ; # 0..* Describes the relationship between the device and subjectfhir:fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error | unknown fhir:statusReason ( [ CodeableConcept ] ... ) ; # 0..* The reasons given for the current association statusfhir:fhir:associationStatus [ CodeableConcept ] ; # 0..1 State of the device’s association fhir:subject [ Reference(BiologicallyDerivedProduct|CareTeam|Device|Group|Location|Medication| NutritionProduct|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson|Specimen|Substance) ] ; # 0..1 The entity(ies) that the device is on or associated with fhir:focus [ Reference(BiologicallyDerivedProduct|CareTeam|Device|Group|Location|Medication| NutritionProduct|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson|Specimen|Substance) ] ; # 0..1 The target of the association fhir:bodyStructure [ Reference(BodyStructure) ] ; # 0..1 Current anatomical location of the device in/on subject fhir:period [ Period ] ; # 0..1 Begin and end dates and times for the device associationfhir: fhir: fhir: fhir: ] ... ) ;]
Changes from both R4 and R4B
This resource did not exist in Release R4
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis
| Path | ValueSet | Type | Documentation |
|---|---|---|---|
| DeviceAssociation.relationship | DeviceAssociationCodes (a valid code from DeviceAssociation Relationship Codes ) | Extensible |
DeviceAssociation Relationship Codes |
| DeviceAssociation.status | DeviceAssociationCodes (a valid code from DeviceAssociation Status Codes ) | Required |
DeviceAssociation Status Codes |
| DeviceAssociation.statusReason | DeviceAssociationCodes (a valid code from DeviceAssociation Status Reason Codes ) |
|
DeviceAssociation Status Reason Codes |
| DeviceAssociation.associationStatus |
|
|
|
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
|
date
|
date | Search for associations at or within specific times | DeviceAssociation.period | |
|
device
|
reference | Search for products that match this code |
DeviceAssociation.device
( Device ) |
|
| focus | reference | The focus of an association. |
DeviceAssociation.focus
( Group , Organization , CareTeam , BiologicallyDerivedProduct , Device , Patient , PractitionerRole , RelatedPerson , Practitioner , Specimen , NutritionProduct , Medication , Substance , Location ) | |
|
identifier
|
token | The identifier of the device association | DeviceAssociation.identifier | |
|
|
reference |
The
|
( |
61 Resources |
|
relationship
|
token | Search for specific device association relationships | DeviceAssociation.relationship | |
|
status
|
token | The status of the device associations | DeviceAssociation.status | |
|
subject
|
reference |
The
identity
of
|
DeviceAssociation.subject
( |
FHIR
®©
HL7.org
2011+.
FHIR
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Tue,
Apr
1,
Mon,
Nov
10,
2025
12:24+1100.
04:55+0000.
Links:
Search
|
Version
History
|
Contents
|
Glossary
|
QA
|
Compare
to
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change