Athena Core Implementation Guide
5.10.2 - release

Athena Core Implementation Guide - Local Development build (v5.10.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: athenahealth Device

Official URL: https://fhir.athena.io/StructureDefinition/ah-device Version: 5.10.2
Active as of 2026-05-26 Computable Name: AthenahealthDevice
Keywords: Wire Format

A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

Device is used to record and transmit Unique Device Identifier (UDI) information about a device such as a patient’s implant.It is referenced by other resources for recording which device performed an action such as a procedure or an observation, referenced when prescribing and dispensing devices for patient use or for ordering supplies.

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 of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... meta
.... lastUpdated 0..1 instant When the resource version last changed
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
.... extension:ahDeviceImplantDetails 0..1 (Complex) athenahealth Device Implant Details
URL: https://fhir.athena.io/StructureDefinition/ah-device-implant-details
... identifier 0..0 Instance identifier
... udiCarrier 0..1 BackboneElement Unique Device Identifier (UDI) Barcode string
.... issuer 0..0 UDI Issuing Organization
.... carrierAIDC 0..0 UDI Machine Readable Barcode String
.... entryType 0..0 barcode | rfid | manual +
... statusReason 0..0 online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
... manufacturer 0..0 Name of device manufacturer
... deviceName 0..0 The name of the device as given by the manufacturer
... modelNumber 0..0 The model number for the device
... partNumber 0..0 The part number of the device
... specialization 0..0 The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
... property 0..0 The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
... owner 0..0 Organization responsible for device
... contact 0..0 Details for human/organization for support
... location 0..0 Where the device is found
... url 0..0 Network address to contact device
... safety 0..0 Safety Characteristics of Device
... parent 0..0 The parent device

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
.... extension:ahDeviceImplantDetails 0..1 (Complex) athenahealth Device Implant Details
URL: https://fhir.athena.io/StructureDefinition/ah-device-implant-details
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... status ?!Σ 0..1 code active | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.status Base required FHIRDeviceStatus 📍4.0.1 FHIR Std.
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
.... extension:ahDeviceImplantDetails 0..1 (Complex) athenahealth Device Implant Details
URL: https://fhir.athena.io/StructureDefinition/ah-device-implant-details
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... udiCarrier Σ 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 Σ 0..1 string Mandatory fixed portion of UDI
.... jurisdiction 0..1 uri Regional UDI authority
.... carrierHRF Σ 0..1 string UDI Human Readable Barcode String
... status ?!Σ 0..1 code active | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.
... distinctIdentifier 0..1 string The distinct identification string
... 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
... type 0..1 CodeableConcept The kind or type of device
Binding: DeviceType (example): Codes to identify medical devices.
... 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
... patient 0..1 Reference(Patient) Patient to whom Device is affixed
... note 0..* Annotation Device notes and comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Device.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Device.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Device.status Base required FHIRDeviceStatus 📍4.0.1 FHIR Std.
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.
Device.type Base example Device Type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 Device

Differential View

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... meta
.... lastUpdated 0..1 instant When the resource version last changed
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
.... extension:ahDeviceImplantDetails 0..1 (Complex) athenahealth Device Implant Details
URL: https://fhir.athena.io/StructureDefinition/ah-device-implant-details
... identifier 0..0 Instance identifier
... udiCarrier 0..1 BackboneElement Unique Device Identifier (UDI) Barcode string
.... issuer 0..0 UDI Issuing Organization
.... carrierAIDC 0..0 UDI Machine Readable Barcode String
.... entryType 0..0 barcode | rfid | manual +
... statusReason 0..0 online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
... manufacturer 0..0 Name of device manufacturer
... deviceName 0..0 The name of the device as given by the manufacturer
... modelNumber 0..0 The model number for the device
... partNumber 0..0 The part number of the device
... specialization 0..0 The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
... property 0..0 The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
... owner 0..0 Organization responsible for device
... contact 0..0 Details for human/organization for support
... location 0..0 Where the device is found
... url 0..0 Network address to contact device
... safety 0..0 Safety Characteristics of Device
... parent 0..0 The parent device

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
.... extension:ahDeviceImplantDetails 0..1 (Complex) athenahealth Device Implant Details
URL: https://fhir.athena.io/StructureDefinition/ah-device-implant-details
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... status ?!Σ 0..1 code active | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.status Base required FHIRDeviceStatus 📍4.0.1 FHIR Std.
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
.... extension:ahDeviceImplantDetails 0..1 (Complex) athenahealth Device Implant Details
URL: https://fhir.athena.io/StructureDefinition/ah-device-implant-details
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... udiCarrier Σ 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 Σ 0..1 string Mandatory fixed portion of UDI
.... jurisdiction 0..1 uri Regional UDI authority
.... carrierHRF Σ 0..1 string UDI Human Readable Barcode String
... status ?!Σ 0..1 code active | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.
... distinctIdentifier 0..1 string The distinct identification string
... 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
... type 0..1 CodeableConcept The kind or type of device
Binding: DeviceType (example): Codes to identify medical devices.
... 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
... patient 0..1 Reference(Patient) Patient to whom Device is affixed
... note 0..* Annotation Device notes and comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Device.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Device.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Device.status Base required FHIRDeviceStatus 📍4.0.1 FHIR Std.
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.
Device.type Base example Device Type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 Device

 

​Other representations of profile: CSV, Excel, Schematron