This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
Responsible
Owner:
Orders
and
Observations
Work
Group
|
|
Security Category : Anonymous |
Compartments
:
|
Detailed Descriptions for the elements in the DeviceDefinition resource.
| DeviceDefinition | |||||||||
| Element Id | DeviceDefinition | ||||||||
| Definition |
The
|
||||||||
| Short Display | The definition of a kind of device or device component | ||||||||
| Cardinality | 0..* | ||||||||
| Type | CanonicalResource | ||||||||
|
|
false | ||||||||
| Comments |
For the initial scope, this DeviceDefinition resource is only applicable to describe a single node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard and that does not represent a metric. Examples for such a node are MDS, VMD, or Channel. |
||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
| ||||||||
| Short Display | Canonical identifier for this DeviceDefinition, represented as an absolute URI (globally unique) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | uri | ||||||||
| Requirements | Allows the DeviceDefinition to be referenced by a single globally unique identifier. | ||||||||
| Summary | true | ||||||||
| Comments |
Can
be
a
urn:uuid:
or
a
urn:oid:
but
real
http:
addresses
are
preferred.
Multiple
instances
may
share
the
| ||||||||
| Constraints |
| ||||||||
| DeviceDefinition.identifier | |||||||||
| Element Id | DeviceDefinition.identifier | ||||||||
| Definition |
A
formal
identifier
that
is
used
to
identify
this
DeviceDefinition
when
it
is
represented
in
other
|
||||||||
|
| Additional identifier for the DeviceDefinition | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion ) | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Identifier | ||||||||
| Requirements |
Allows externally provided and/or usable business identifiers to be easily associated with the DeviceDefinition. | ||||||||
| Summary | true | ||||||||
|
|
|||||||||
| Element Id | DeviceDefinition.version | ||||||||
|
| The identifier that is used to identify this version of the DeviceDefinition when it is referenced in a specification. | ||||||||
| Short Display | Business version of the DeviceDefinition | ||||||||
| Note | This is a business versionId, not a resource version id (see discussion ) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| Comments | There may be different DeviceDefinitions that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the DeviceDefinition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version . | ||||||||
| DeviceDefinition.versionAlgorithm[x] | |||||||||
| Element Id | DeviceDefinition.versionAlgorithm[x] | ||||||||
| Definition |
Indicates the mechanism used to compare versions to determine which is more current. | ||||||||
| Short Display | How to compare versions | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | Version Algorithm ( Extensible ) | ||||||||
| Type | string | Coding | ||||||||
| [x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
| Summary | true | ||||||||
| Comments |
| ||||||||
| DeviceDefinition.name | |||||||||
| Element Id | DeviceDefinition.name | ||||||||
| Definition |
A
natural
language
name
identifying
the
DeviceDefinition.
This
name
should
be
usable
as
an
identifier
| ||||||||
| Short Display | Name for this DeviceDefinition (computer friendly) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Requirements | Supports code generation. | ||||||||
| Summary | true | ||||||||
| Comments |
The
name
is
not
expected
to
| ||||||||
| DeviceDefinition.title | |||||||||
| Element Id | DeviceDefinition.title | ||||||||
| Definition |
A
short,
descriptive,
user-friendly
title
for
the
| ||||||||
| Short Display | Name for this DeviceDefinition (human friendly) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| Comments |
This
name
does
not
need
to
be
machine-processing
friendly
and
may
| ||||||||
| DeviceDefinition.status | |||||||||
| Element Id | DeviceDefinition.status | ||||||||
| Definition | The current state of this DeviceDefinition. | ||||||||
| Short Display | draft | active | retired | unknown | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | PublicationStatus ( Required ) | ||||||||
| Type | code | ||||||||
| Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired DeviceDefinition without due consideration) | ||||||||
| Requirements | Enables tracking the life-cycle of the content and filtering of DeviceDefinitions that are appropriate for use versus not. | ||||||||
| Summary | true | ||||||||
| Comments | A nominal state-transition diagram can be found in the Definition pattern documentation. Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. See guidance around (not) making local changes to elements here . If a server wishes to reflect whether a given canonical resource is 'supported' or 'enabled' on that server, this is NOT done with status. Instead, expose support for the resource using a 'feature' in the server's CapabilityStatement. (Not all supported canonical resources will necessarily be searchable on a server, and availability of a canonical resource in a search result does not imply support of the resource for any particular usage.) | ||||||||
| DeviceDefinition.experimental | |||||||||
| Element Id | DeviceDefinition.experimental | ||||||||
| Definition | A Boolean value to indicate that this DeviceDefinition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage. | ||||||||
| Short Display | For testing only - never for real usage | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | boolean | ||||||||
| Meaning if Missing |
If
absent,
this
resource
is
treated
as
though
it
| ||||||||
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level DeviceDefinition. | ||||||||
| Summary | true | ||||||||
| Comments |
Allows
filtering
of
DeviceDefinitions
that
are
appropriate
for
use
versus
not.
Experimental
resources
might
include
| ||||||||
| DeviceDefinition.partNumber | |||||||||
| Element Id | DeviceDefinition.partNumber | ||||||||
| Definition | The part number or catalog number of the device. | ||||||||
| Short Display | The part number or catalog number of the device | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| Comments | Alphanumeric Maximum 20. | ||||||||
| DeviceDefinition.manufacturer | |||||||||
| Element Id | DeviceDefinition.manufacturer | ||||||||
| Definition | A name of the manufacturer or legal representative e.g. labeler. Whether this is the actual manufacturer or the labeler or responsible depends on implementation and jurisdiction. | ||||||||
| Short Display | Name of device manufacturer | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference ( Organization ) | ||||||||
| Summary | true | ||||||||
| DeviceDefinition.modelNumber | |||||||||
| Element Id | DeviceDefinition.modelNumber | ||||||||
| Definition | The model number for the device for example as defined by the manufacturer or labeler, or other agency. | ||||||||
| Short Display | The catalog or model number for the device for example as defined by the manufacturer | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| DeviceDefinition.date | |||||||||
| Element Id | DeviceDefinition.date | ||||||||
| Definition | The date (and optionally time) when the DeviceDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the DeviceDefinition changes. | ||||||||
| Short Display | Date last changed | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime | ||||||||
| Alternate Names | Revision Date | ||||||||
| Summary | true | ||||||||
| Comments |
The
date
is
| ||||||||
| DeviceDefinition.contact | |||||||||
| Element Id | DeviceDefinition.contact | ||||||||
| Definition | Contact details for an organization or a particular human that is responsible for the device. | ||||||||
| Short Display | Contact details for the publisher | ||||||||
| Cardinality | 0..* | ||||||||
| Type | ContactDetail | ||||||||
| Summary | true | ||||||||
| Comments | used for troubleshooting etc. | ||||||||
| DeviceDefinition.publisher | |||||||||
| Element Id | DeviceDefinition.publisher | ||||||||
| Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the device definition. | ||||||||
| Short Display | The name of the organization responsible for publishing the definition | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| DeviceDefinition.useContext | |||||||||
| Element Id | DeviceDefinition.useContext | ||||||||
| Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate DeviceDefinitions. | ||||||||
| Short Display | The context that the content is intended to support | ||||||||
| Cardinality | 0..* | ||||||||
| Type | UsageContext | ||||||||
| Requirements | Assist in searching for appropriate content. | ||||||||
| Summary | true | ||||||||
| Comments | When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply. | ||||||||
| DeviceDefinition.jurisdiction | |||||||||
| Element Id | DeviceDefinition.jurisdiction | ||||||||
| Definition | A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use. | ||||||||
| Short Display | Jurisdiction of the authority that maintains the DeviceDefinition (if applicable) | ||||||||
| Cardinality | 0..* | ||||||||
| Terminology Binding |
Jurisdiction
ValueSet
(
Extensible
)
| ||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| Comments |
It
may
be
possible
for
the
DeviceDefinition
to
be
used
in
jurisdictions
other
than
those
for
which
it
| ||||||||
| DeviceDefinition.purpose | |||||||||
| Element Id | DeviceDefinition.purpose | ||||||||
| Definition |
Explanation
of
why
this
DeviceDefinition
is
needed
and
why
it
has
been
|
||||||||
| Short Display | Why this DeviceDefinition is defined | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | markdown | ||||||||
| Summary | false | ||||||||
| Comments | This element does not describe the usage of the DeviceDefinition. Instead, it provides traceability of "why" the resource is either needed or "why" it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this DeviceDefinition. | ||||||||
| DeviceDefinition.copyright | |||||||||
| Element Id | DeviceDefinition.copyright | ||||||||
| Definition | A copyright statement relating to the DeviceDefinition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the DeviceDefinition. | ||||||||
| Short Display | Notice about intellectual property ownership, can include restrictions on use | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | markdown | ||||||||
| Requirements | Consumers must be able to determine any legal restrictions on the use of the DeviceDefinition and/or its content. | ||||||||
| Alternate Names | License; Restrictions | ||||||||
| Summary | false | ||||||||
| Comments | The short copyright declaration (e.g. (c) '2015+ xyz organization') should be sent in the copyrightLabel element without the copyright prefix (i.e., do not include '(c)' or the symbol). | ||||||||
| DeviceDefinition.copyrightLabel | |||||||||
| Element Id | DeviceDefinition.copyrightLabel | ||||||||
| Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved'). | ||||||||
| Short Display | Copyright holder and year(s) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Requirements | Defines the content expected to be rendered in all representations of the artifact. | ||||||||
| Summary | false | ||||||||
| Comments | The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. | ||||||||
| DeviceDefinition.udiDeviceIdentifier | |||||||||
| Element Id | DeviceDefinition.udiDeviceIdentifier | ||||||||
| Definition | The Device Identifier (DI) portion of the Unique Device Identifier (UDI) placed on a device label or package. Also known as UDI-DI. Note that the DeviceDefinition may include multiple UDI-DIs if it is sold in multiple jurisdictions. | ||||||||
| Short Display | Unique Device Identifier (UDI) Barcode string | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.udiDeviceIdentifier.deviceIdentifier | |||||||||
| Element Id | DeviceDefinition.udiDeviceIdentifier.deviceIdentifier | ||||||||
| Definition |
The
identifier
that
is
to
be
associated
with
every
Device
that
references
this
DeviceDefintiion
for
the
issuer
and
|
||||||||
| Short Display | The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.udiDeviceIdentifier.issuer | |||||||||
| Element Id | DeviceDefinition.udiDeviceIdentifier.issuer | ||||||||
| Definition |
The organization that assigns the identifier algorithm. |
||||||||
| Short Display | The organization that assigns the identifier algorithm | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | uri | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.udiDeviceIdentifier.jurisdiction | |||||||||
| Element Id | DeviceDefinition.udiDeviceIdentifier.jurisdiction | ||||||||
| Definition |
The jurisdiction to which the deviceIdentifier applies. |
||||||||
| Short Display | The jurisdiction to which the deviceIdentifier applies | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | uri | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
Indicates where and when the device is available on the market. | ||||||||
| Short Display | Indicates whether and when the device is available on the market | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.udiDeviceIdentifier.marketDistribution.marketPeriod | |||||||||
| Element Id | DeviceDefinition.udiDeviceIdentifier.marketDistribution.marketPeriod | ||||||||
| Definition |
| ||||||||
| Short Display | Begin and end dates for the commercial distribution of the device | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | Period | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.udiDeviceIdentifier.marketDistribution.subJurisdiction | |||||||||
| Element Id | DeviceDefinition.udiDeviceIdentifier.marketDistribution.subJurisdiction | ||||||||
| Definition | National state or territory to which the marketDistribution recers, typically where the device is commercialized. |
||||||||
| Short Display | National state or territory where the device is commercialized | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | uri | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.udiDeviceIdentifier.deviceIdentifierSystem | |||||||||
| Element Id | DeviceDefinition.udiDeviceIdentifier.deviceIdentifierSystem | ||||||||
| Definition | Establishes the namespace for the issuing agency's system (e.g, GS1's GTIN, ICCBBA's ISBT-128) used to create the device identifier. | ||||||||
| Short Display | The namespace for the device identifier value | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | uri | ||||||||
|
|
false | ||||||||
| DeviceDefinition.regulatoryIdentifier | |||||||||
| Element Id | DeviceDefinition.regulatoryIdentifier | ||||||||
| Definition | Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device models sharing the same intended purpose, risk class and essential design and manufacturing characteristics. One example is the Basic UDI-DI in Europe. | ||||||||
| Short Display | Regulatory identifier(s) associated with this device | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| Comments | This should not be used for regulatory authorization numbers which are to be captured elsewhere. | ||||||||
| DeviceDefinition.regulatoryIdentifier.type | |||||||||
| Element Id | DeviceDefinition.regulatoryIdentifier.type | ||||||||
| Definition | The type of identifier itself. | ||||||||
| Short Display |
basic
|
| ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding |
Device
Definition
Regulatory
Identifier
Type
(
|
||||||||
|
| code | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.regulatoryIdentifier.identifier | |||||||||
| Element Id | DeviceDefinition.regulatoryIdentifier.identifier | ||||||||
| Definition | The identifier used in the associated regulatory context. | ||||||||
| Short Display | The identifier itself | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion ) | ||||||||
|
| 1..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.regulatoryIdentifier.issuer | |||||||||
| Element Id | DeviceDefinition.regulatoryIdentifier.issuer | ||||||||
| Definition | The organization that issued this identifier. | ||||||||
| Short Display | The organization that issued this identifier | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | uri | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.regulatoryIdentifier.jurisdiction | |||||||||
| Element Id | DeviceDefinition.regulatoryIdentifier.jurisdiction | ||||||||
| Definition |
The
applicable
jurisdiction
overseeing
the
enforcement
of
| ||||||||
| Short Display | Relevant jurisdiction governing the identifier | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | uri | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.regulatoryIdentifier.identifierSystem | |||||||||
| Element Id | DeviceDefinition.regulatoryIdentifier.identifierSystem | ||||||||
| Definition |
Establishes
the
namespace
for
|
||||||||
| Short Display | The namespace for the device identifier value | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | uri | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.deviceName | |||||||||
| Element Id | DeviceDefinition.deviceName | ||||||||
| Definition |
|
||||||||
| Short Display | The name or names of the device as given by the manufacturer | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | true | ||||||||
| DeviceDefinition.deviceName.name | |||||||||
| Element Id | DeviceDefinition.deviceName.name | ||||||||
| Definition |
|
||||||||
| Short Display | A name that is used to refer to the device | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | string | ||||||||
| Alternate Names | Σ | ||||||||
| Summary | true | ||||||||
| DeviceDefinition.deviceName.type | |||||||||
| Element Id | DeviceDefinition.deviceName.type | ||||||||
| Definition |
The
type
of
deviceName.
| ||||||||
| Short Display |
registered-name
|
|
||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding |
|
||||||||
| Type | CodeableConcept | ||||||||
|
|
true | ||||||||
| Comments |
The implementation or jurisdiction must clarify which name is to be used as the registered-name. As a result a device definition may have multiple names that are the same, but then used for different purposes per the name type and jurisdictional guidance. | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
What kind of device or device system this is. | ||||||||
| Short Display | What kind of device or device system this is | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | true | ||||||||
| Comments |
| ||||||||
| DeviceDefinition.classification.type | |||||||||
| Element Id | DeviceDefinition.classification.type | ||||||||
| Definition |
A
classification
or
risk
class
of
the
|
||||||||
| Short Display | A classification or risk class of the device model | ||||||||
| Cardinality | 1..1 | ||||||||
|
| Device Type ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
|
|
true | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
| ||||||||
| Short Display | Further information qualifying this classification of the device model | ||||||||
| Cardinality | 0..* | ||||||||
| Type | RelatedArtifact | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.conformsTo | |||||||||
| Element Id | DeviceDefinition.conformsTo | ||||||||
| Definition |
Identifies
the
standards,
specifications,
or
formal
guidances
for
the
capabilities
supported
by
the
device.
The
device
|
||||||||
| Short Display | Identifies the standards, specifications, or formal guidances for the capabilities supported by the device | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | true | ||||||||
| DeviceDefinition.conformsTo.category | |||||||||
| Element Id | DeviceDefinition.conformsTo.category | ||||||||
| Definition | Describes the type of the standard, specification, or formal guidance. | ||||||||
| Short Display | Describes the common type of the standard, specification, or formal guidance | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding |
|
||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | Identifies the standard, specification, or formal guidance that the device adheres to the Device Specification type | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | Device Specification Type ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| DeviceDefinition.conformsTo.version | |||||||||
| Element Id | DeviceDefinition.conformsTo.version | ||||||||
| Definition | Identifies the specific form or variant of the standard, specification, or formal guidance. This may be a 'version number', release, document edition, publication year, or other label. | ||||||||
| Short Display | The specific form or variant of the standard, specification or formal guidance | ||||||||
| Note | This is a business versionId, not a resource version id (see discussion ) | ||||||||
| Cardinality | 0..* | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
|
|
|||||||||
| Element Id | DeviceDefinition.conformsTo.source | ||||||||
|
| Standard, regulation, certification, or guidance website, document, or other publication, or similar, supporting the conformance. | ||||||||
| Short Display | Standard, regulation, certification, or guidance website, document, or other publication, or similar, supporting the conformance | ||||||||
| Cardinality | 0..* | ||||||||
| Type | RelatedArtifact | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.hasPart | |||||||||
| Element Id | DeviceDefinition.hasPart | ||||||||
| Definition |
A device that is part (for example a component) of the present device. |
||||||||
| Short Display | A device, part of the current one | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | true | ||||||||
| DeviceDefinition.hasPart.definition[x] | |||||||||
| Element Id | DeviceDefinition.hasPart.definition[x] | ||||||||
| Definition |
The
|
||||||||
| Short Display | Reference to the part | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | Device Type ( Example ) | ||||||||
| Type |
|
||||||||
| [x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
|
| true | ||||||||
|
|
|||||||||
| Element Id | DeviceDefinition.hasPart.count | ||||||||
|
| Number of instances of the component device in the current device. | ||||||||
| Short Display | Number of occurrences of the part | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | integer | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.packaging | |||||||||
| Element Id | DeviceDefinition.packaging | ||||||||
| Definition |
Information about the packaging of the device, i.e. how the device is packaged. | ||||||||
| Short Display | Information about the packaging of the device, i.e. how the device is packaged | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.packaging.identifier | |||||||||
| Element Id | DeviceDefinition.packaging.identifier | ||||||||
| Definition |
The
|
||||||||
|
| Business identifier of the packaged medication | ||||||||
| Note |
This
is
a
business
|
||||||||
| Cardinality | 0..1 | ||||||||
| Type | Identifier | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.packaging.type | |||||||||
| Element Id | DeviceDefinition.packaging.type | ||||||||
| Definition | A code that defines the specific type of packaging. | ||||||||
| Short Display | A code that defines the specific type of packaging | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.packaging.count | |||||||||
| Element Id | DeviceDefinition.packaging.count | ||||||||
| Definition | The number of items contained in the package (devices or sub-packages). | ||||||||
| Short Display | The number of items contained in the package (devices or sub-packages) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | integer | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.packaging.distributor | |||||||||
| Element Id | DeviceDefinition.packaging.distributor | ||||||||
| Definition | An organization that distributes the packaged device. | ||||||||
| Short Display | An organization that distributes the packaged device | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.packaging.distributor.name | |||||||||
| Element Id | DeviceDefinition.packaging.distributor.name | ||||||||
| Definition | Distributor's human-readable name. | ||||||||
| Short Display | Distributor's human-readable name | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id | DeviceDefinition.packaging.distributor.organizationReference | ||||||||
|
| Distributor as an Organization resource. | ||||||||
| Short Display | Distributor as an Organization resource | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Reference ( Organization ) | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.packaging.udiDeviceIdentifier | |||||||||
| Element Id | DeviceDefinition.packaging.udiDeviceIdentifier | ||||||||
| Definition |
Unique Device Identifier (UDI) Barcode string on the packaging. | ||||||||
| Short Display | Unique Device Identifier (UDI) Barcode string on the packaging | ||||||||
| Cardinality | 0..* | ||||||||
| Type | See DeviceDefinition.udiDeviceIdentifier | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.packaging.packaging | |||||||||
| Element Id | DeviceDefinition.packaging.packaging | ||||||||
| Definition | Allows packages within packages. | ||||||||
| Short Display | Allows packages within packages | ||||||||
| Cardinality | 0..* | ||||||||
| Type | See DeviceDefinition.packaging | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.deviceVersion | |||||||||
| Element Id | DeviceDefinition.deviceVersion | ||||||||
| Definition |
The
| ||||||||
| Short Display |
The
version
of
the
device
or
software
|
||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.deviceVersion.type | |||||||||
| Element Id | DeviceDefinition.deviceVersion.type | ||||||||
| Definition | The type of the device version, e.g. manufacturer, approved, internal. |
||||||||
|
|
The type of the device version, e.g. manufacturer, approved, internal | ||||||||
|
| 0..1 | ||||||||
| Type | CodeableConcept | ||||||||
| Alternate Names | Σ | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.deviceVersion.component | |||||||||
| Element Id | DeviceDefinition.deviceVersion.component | ||||||||
| Definition | The hardware or software module of the device to which the version applies. | ||||||||
| Short Display | The hardware or software module of the device to which the version applies | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Identifier | ||||||||
| Summary | false | ||||||||
| Comments |
Note
that
the
module
of
the
device
would
not
need
to
be
tracked
as
a
| ||||||||
|
| |||||||||
| Element Id | DeviceDefinition.deviceVersion.value | ||||||||
| Definition | The version text. | ||||||||
| Short Display | The version text | ||||||||
| Cardinality |
|
||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.safety | |||||||||
| Element Id | DeviceDefinition.safety | ||||||||
| Definition |
Safety characteristics of the device. |
||||||||
| Short Display | Safety characteristics of the device | ||||||||
| Cardinality | 0..* | ||||||||
| Terminology Binding |
Device
|
||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| DeviceDefinition.shelfLifeStorage | |||||||||
| Element Id | DeviceDefinition.shelfLifeStorage | ||||||||
| Definition |
Shelf Life and storage information. |
||||||||
| Short Display | Shelf Life and storage information | ||||||||
| Cardinality | 0..* | ||||||||
| Type | ProductShelfLife | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id | DeviceDefinition.outputLanguage | ||||||||
|
| Language code for the human-readable text strings produced by the device (all supported). | ||||||||
| Short Display | Language code for the human-readable text strings produced by the device (all supported) | ||||||||
| Cardinality | 0..* | ||||||||
| Terminology Binding |
All
Languages
(
Required
)
| ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.property | |||||||||
| Element Id | DeviceDefinition.property | ||||||||
| Definition |
Static or essentially fixed characteristics or features of this kind of device that are otherwise not captured in more specific attributes, e.g., time or timing attributes, resolution, accuracy, and physical attributes. | ||||||||
| Short Display | Inherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| Comments |
| ||||||||
| DeviceDefinition.property.type | |||||||||
| Element Id | DeviceDefinition.property.type | ||||||||
| Definition |
Code
that
specifies
the
property
such
as
a
resolution
or
color
|
||||||||
| Short Display | Code that specifies the property being represented | ||||||||
| Cardinality | 1..1 | ||||||||
|
| Device Property Type (Example only) ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
|
|
false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | Value of the property | ||||||||
| Cardinality |
|
||||||||
| Type | Quantity | CodeableConcept | string | boolean | integer | Range | Attachment | ||||||||
| [x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
| Summary | false | ||||||||
| Comments | This use of string or CodeableConcept is supported to address different purposes The text element of the valueCodeableConcept choice type is used for properties which would usually be coded (such as the size of an implant, or a security classification) but for which there is not currently an appropriate concept in the vocabulary (e.g., a custom implant size, or a security classification which depends on configuration. Otherwise the valueString choice type is used for textual descriptive device properties that cannot be expressed in other elements. | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | The type indicates the relationship of the related device to the device instance | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | Device Definition Relation Type ( Extensible ) | ||||||||
| Type | Coding | ||||||||
|
|
false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | A reference to the linked device | ||||||||
| Cardinality | 1..1 | ||||||||
|
| Device Type ( Example ) | ||||||||
| Type | canonical ( DeviceDefinition )| CodeableConcept | ||||||||
| [x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
Descriptive information, usage information or implantation information that is not captured in an existing element. | ||||||||
| Short Display | Device notes and comments | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Annotation | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.material | |||||||||
| Element Id | DeviceDefinition.material | ||||||||
| Definition |
|
||||||||
| Short Display | A substance used to create the material(s) of which the device is made | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | A relevant substance that the device contains, may contain, or is made of | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | Substance Code ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | Indicates an alternative material of the device | ||||||||
| Cardinality |
|
||||||||
| Type | boolean | ||||||||
|
|
false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | Whether the substance is a known or suspected allergen | ||||||||
| Cardinality |
|
||||||||
| Type | boolean | ||||||||
|
|
false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version | ||||||||
| Cardinality | 0..* | ||||||||
|
| Device Production Identifier In UDI ( Extensible ) | ||||||||
| Type |
|
||||||||
|
Summary
|
false | ||||||||
| Comments |
Jurisdictions may define other production identifier types and by way of regulation and/or implementation guidance indicate which identifier(s) are to be used for that jurisdiction. | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
| ||||||||
| Short Display | Information aimed at providing directions for the usage of this model of device | ||||||||
| Cardinality | 0..1 | ||||||||
| Summary | false | ||||||||
| Comments |
For
more
structured
data,
a
| ||||||||
| DeviceDefinition.guideline.useContext | |||||||||
| Element Id | DeviceDefinition.guideline.useContext | ||||||||
| Definition | The circumstances that form the setting for using the device. |
||||||||
| Short Display | The circumstances that form the setting for using the device | ||||||||
| Cardinality | 0..* | ||||||||
| Type | UsageContext | ||||||||
|
| false | ||||||||
| DeviceDefinition.guideline.usageInstruction | |||||||||
|
| DeviceDefinition.guideline.usageInstruction | ||||||||
| Definition |
|
||||||||
| Short Display | Detailed written and visual directions for the user on how to use the device | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | markdown | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
A source of information or reference for this guideline. | ||||||||
| Short Display | A source of information or reference for this guideline | ||||||||
| Cardinality | 0..* | ||||||||
| Type | RelatedArtifact | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.guideline.indication | |||||||||
| Element Id | DeviceDefinition.guideline.indication | ||||||||
| Definition |
A
|
||||||||
| Short Display | A clinical condition for which the device was designed to be used | ||||||||
| Cardinality |
|
||||||||
| Type | CodeableConcept | ||||||||
|
|
false | ||||||||
| Comments |
| ||||||||
| DeviceDefinition.guideline.contraindication | |||||||||
| Element Id | DeviceDefinition.guideline.contraindication | ||||||||
| Definition |
A
specific
situation
when
a
| ||||||||
| Short Display |
A
specific
situation
when
a
| ||||||||
| Cardinality | 0..* | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| Comments |
A
ClinicalUseDefinition
that
points
to
the
DeviceDefinition
can
be
|
||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | Specific hazard alert information that a user needs to know before using the device | ||||||||
| Cardinality |
|
||||||||
| Type | CodeableConcept | ||||||||
|
|
false | ||||||||
| Comments |
A ClinicalUseDefinition that points to the DeviceDefinition can be used if more structured data is needed. | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | A description of the general purpose or medical use of the device or its function | ||||||||
| Cardinality |
|
||||||||
| Type | string | ||||||||
|
|
false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
| ||||||||
| Short Display | Tracking of latest field safety corrective action | ||||||||
| Cardinality | 0..1 | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.correctiveAction.recall | |||||||||
| Element Id | DeviceDefinition.correctiveAction.recall | ||||||||
| Definition |
Whether
the
last
corrective
action
known
for
this
device
| ||||||||
| Short Display | Whether the corrective action was a recall | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | boolean | ||||||||
| Summary | false | ||||||||
| Comments | When a field safety action has been initiated but not yet resulted in a recall, this element will be set to 'false'. | ||||||||
| DeviceDefinition.correctiveAction.scope | |||||||||
| Element Id | DeviceDefinition.correctiveAction.scope | ||||||||
| Definition |
The
scope
of
the
|
||||||||
| Short Display | model | lot-numbers | serial-numbers | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | Device Corrective Action Scope ( Required ) | ||||||||
| Type | code | ||||||||
|
|
false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | Start and end dates of the corrective action | ||||||||
| Cardinality |
|
||||||||
| Type |
|
||||||||
| Summary |
|
||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
| ||||||||
| Short Display |
Billing
code
or
reference
associated
with
the
device
|
||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
The
|
||||||||
| Short Display | The code or reference for the charge item | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | USCLS Codes ( Example ) | ||||||||
| Type | CodeableReference | ||||||||
|
|
false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | Coefficient applicable to the billing code | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | Quantity | ||||||||
| Summary | false | ||||||||
| DeviceDefinition.chargeItem.effectivePeriod | |||||||||
| Element Id | DeviceDefinition.chargeItem.effectivePeriod | ||||||||
| Definition | A specific time period in which this charge item applies. | ||||||||
| Short Display | A specific time period in which this charge item applies | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Period | ||||||||
|
|
false | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| Short Display | The context to which this charge item applies | ||||||||
| Cardinality |
|
||||||||
| Type | UsageContext | ||||||||
|
|
false | ||||||||