This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions 
Responsible Owner: Orders and Observations Work Group | Draft | Security Category: Patient | Compartments: Device, Group, Patient, Practitioner, RelatedPerson |
A record of association or dissociation of a device with a 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, 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:
when documenting a patient’s use of a device — typically clinical history or their ongoing reliance on the device.These resources may be used together — for example, a 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.
No references for this Resource.
Structure
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><!-- 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 value="[code]"/><!-- 1..1 active | inactive | entered-in-error | unknown --> <statusReason><!-- 0..* CodeableConcept The reasons given for the current association status --></statusReason> <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> </DeviceAssociation>
JSON Template
{
"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:DeviceAssociation; fhir:nodeRole fhir:treeRoot; # if this is the parser root # 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 identifier 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 subject fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error | unknown fhir:statusReason ( [ CodeableConcept ] ... ) ; # 0..* The reasons given for the current association status 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 association ]
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
See the Extensions for this resource
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><!-- 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 value="[code]"/><!-- 1..1 active | inactive | entered-in-error | unknown --> <statusReason><!-- 0..* CodeableConcept The reasons given for the current association status --></statusReason> <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> </DeviceAssociation>
JSON Template
{
"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:DeviceAssociation; fhir:nodeRole fhir:treeRoot; # if this is the parser root # 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 identifier 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 subject fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error | unknown fhir:statusReason ( [ CodeableConcept ] ... ) ; # 0..* The reasons given for the current association status 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 association ]
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) | Extensible | DeviceAssociation Status Reason Codes |
| DeviceAssociation.associationStatus | DeviceAssociationAssociationStatus (a valid code from DeviceAssociation Association Status Codes) | Preferred | Codes that describe the state of a device’s association (e.g., implanted, attached, on, off, standby, defective). |
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 | |
| patient | reference | The patient associated with the device | DeviceAssociation.subject.where(resolve() is Patient) (Patient) |
64 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 the individual(s) or entity for whom to list associations | DeviceAssociation.subject (Group, Organization, CareTeam, BiologicallyDerivedProduct, Device, Patient, PractitionerRole, RelatedPerson, Practitioner, Specimen, NutritionProduct, Medication, Substance, Location) |