Personal Health Device Implementation Guide
3.0.0-ballot - STU 3 Ballot Global (Whole world)

Personal Health Device Implementation Guide, published by HL7 International / Devices. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/phd/ and changes regularly. See the Directory of published versions

Resource Profile: PhdDevice - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the PhdDevice resource profile

See the documentation on how to interpret the contents of this table

0. Device
Definition

his resource describes the primary features of a Personal Health Device (PHD). It contains the properties, production specification, specializations, and overall type of the PHD.


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.

ShortItem used in healthcare
Comments

This profile applies to PHDs that adhere to the IEEE 11073-10206 ACOM standard or that can be mapped to it. The profile is based on the Device resource and contains additional elements that are specific to PHDs.

Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdev-1: only one Device.name.display SHALL be true when there is more than one Device.name (name.where(display=true).count() <= 1)
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Device.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the additionalImplicitRules extension.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Device.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Device.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
8. Device.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. Device.identifier
Definition

The assigned unique identification of the device that is semantically meaningful outside of the FHIR resource context. An example would be the IEEE EUI-64 System-Id or transport address. For PHDs the systemIdentifier is highly recommended and also a transportAddressIdentifier is recommended as this is what most end users see and can obtain from the device itself or device packaging.


Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

ShortInformation that uniquely describes the personal health deviceInstance identifier
Comments

Certain attributes, like serial number and UDI Carrier (the HRF or AIDC barcode string) are not device instance identifiers as they are not consistently able to uniquely identify the instance of a device, thus are not appropriate to be used to value Device.identifier. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. The identifier is typically valued if the serialNumber or lotNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Names11073-10206 System id, transport address, etc.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.identifier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

12. Device.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|6.0.0-snapshot1
(required to http://hl7.org/fhir/ValueSet/identifier-use|6.0.0-snapshot1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Device.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortThe type of identifierDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from MDC Device Identifier Typeshttp://hl7.org/fhir/ValueSet/identifier-type|6.0.0-snapshot1
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/MDCDeviceIdentifierTypes)

MDC Device Identifier Types


A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Device.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processor to be confident that non-case-sensitive processing is safe.

Control0..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Device.identifier:systemIdIdentifier
Slice NamesystemIdIdentifier
Definition

This entry contains the IEEE EUI-64.


Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

ShortSystem Id identifierInstance identifier
Comments

Certain attributes, like serial number and UDI Carrier (the HRF or AIDC barcode string) are not device instance identifiers as they are not consistently able to uniquely identify the instance of a device, thus are not appropriate to be used to value Device.identifier. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. The identifier is typically valued if the serialNumber or lotNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Names11073-10206 System id
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Device.identifier:systemIdIdentifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|6.0.0-snapshot1
(required to http://hl7.org/fhir/ValueSet/identifier-use|6.0.0-snapshot1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Device.identifier:systemIdIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortRequired IEEE 11073-10206 System Id code system codingDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control10..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|6.0.0-snapshot1
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|6.0.0-snapshot1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers",
      "code" : "SYSID"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers"/>
    <code value="SYSID"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Device.identifier:systemIdIdentifier.system
Definition

Identifies the system as an IEEE EUI.


Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortEUI-64 system identifierThe namespace for the identifier value
Comments

Identifier.system is always case sensitive. The FHIR specification, terminology.hl7.org and HL7 affiliates (for identifiers specific to their jurisdiction) define identifier systems that SHALL be used for certain types of identifiers. Specific rules can be found here.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "urn:oid:1.2.840.10004.1.1.1.0.0.1.0.0.1.2680"
}
<system value="urn:oid:1.2.840.10004.1.1.1.0.0.1.0.0.1.2680"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Device.identifier:systemIdIdentifier.value
Definition

The System id from the System-Id attribute as an 8-byte HEX string where each byte is separated by dashes, for example FE-ED-AB-EE-DE-AD-77-C3.


The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortSystem id value from System-Id attributeThe value that is unique
Comments

The formatting is specified in the IEEE RA Guidelines for use of EUIs.


If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processor to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Device.identifier:btmacAddressIdentifier
Slice NamebtmacAddressIdentifier
Definition

This entry contains the Bluetooth MAC transport address.


Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

ShortBluetooth MAC Transport address identifierInstance identifier
Comments

Certain attributes, like serial number and UDI Carrier (the HRF or AIDC barcode string) are not device instance identifiers as they are not consistently able to uniquely identify the instance of a device, thus are not appropriate to be used to value Device.identifier. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. The identifier is typically valued if the serialNumber or lotNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesBluetooth MAC Transport address
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Device.identifier:btmacAddressIdentifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|6.0.0-snapshot1
(required to http://hl7.org/fhir/ValueSet/identifier-use|6.0.0-snapshot1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Device.identifier:btmacAddressIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortRequired Bluetooth MAC address code system codingDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control10..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|6.0.0-snapshot1
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|6.0.0-snapshot1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers",
      "code" : "BTMAC"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers"/>
    <code value="BTMAC"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Device.identifier:btmacAddressIdentifier.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive. The FHIR specification, terminology.hl7.org and HL7 affiliates (for identifiers specific to their jurisdiction) define identifier systems that SHALL be used for certain types of identifiers. Specific rules can be found here.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "http://hl7.org/fhir/sid/eui-48/bluetooth"
}
<system value="http://hl7.org/fhir/sid/eui-48/bluetooth"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Device.identifier:btmacAddressIdentifier.value
Definition

The Bluetooth MAC as an EUI-48 such as 00-E5-DE-AD-77-C3.


The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

Transport addresses are supposed to be unique for a given device.


If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processor to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Device.identifier:macAddressIdentifier
Slice NamemacAddressIdentifier
Definition

This entry contains the MAC transport address.


Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

ShortMAC Transport address identifierInstance identifier
Comments

Certain attributes, like serial number and UDI Carrier (the HRF or AIDC barcode string) are not device instance identifiers as they are not consistently able to uniquely identify the instance of a device, thus are not appropriate to be used to value Device.identifier. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. The identifier is typically valued if the serialNumber or lotNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesMAC Transport address
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Device.identifier:macAddressIdentifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|6.0.0-snapshot1
(required to http://hl7.org/fhir/ValueSet/identifier-use|6.0.0-snapshot1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Device.identifier:macAddressIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortRequired Ethernet MAC address code system codingDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control10..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|6.0.0-snapshot1
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|6.0.0-snapshot1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers",
      "code" : "ETHMAC"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers"/>
    <code value="ETHMAC"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Device.identifier:macAddressIdentifier.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive. The FHIR specification, terminology.hl7.org and HL7 affiliates (for identifiers specific to their jurisdiction) define identifier systems that SHALL be used for certain types of identifiers. Specific rules can be found here.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "http://hl7.org/fhir/sid/eui-48/ethernet"
}
<system value="http://hl7.org/fhir/sid/eui-48/ethernet"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Device.identifier:macAddressIdentifier.value
Definition

The MAC as an EUI-48 such as 00-E5-DE-AD-77-C8.


The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

Transport addresses are supposed to be unique for a given device.


If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processor to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Device.udiCarrier
Definition

Unique Device Identifier (UDI) placed on a device label or package. Note that the Device may include multiple UDIs if it is sold in multiple jurisdictions.

ShortUnique Device Identifier (UDI) value
Comments

UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.


UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.udiCarrier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ entryType
50. Device.udiCarrier.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.udiCarrier.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
52. Device.udiCarrier.deviceIdentifier
Definition

The device identifier (UDI-DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device. The UDI-DI portion is placed on a device label or package. Note that the DeviceDefinition may include multiple UDI-DIs if it is sold in multiple jurisdictions.

ShortMandatory fixed portion of UDI
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesDI
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Device.udiCarrier.issuer
Definition

Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include:

  1. GS1: http://hl7.org/fhir/NamingSystem/gs1-di,
  2. HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-diI,
  3. ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di,
  4. ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di # Informationsstelle für Arzneispezialitäten (IFA GmbH) (EU only): http://hl7.org/fhir/NamingSystem/ifa-gmbh-di.
ShortUDI Issuing Organization
Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesBarcode System
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Device.udiCarrier:PhdProvidedUdi
Slice NamePhdProvidedUdi
Definition

The UDI of the PHD as provided by protocol. The UDI is an optional attribute in the IEEE 11073-10206 standard and is also supported by Bluetooth Low Energy DIS and GHS specifications.


Unique Device Identifier (UDI) placed on a device label or package. Note that the Device may include multiple UDIs if it is sold in multiple jurisdictions.

ShortThe UDI of the PHD as provided by protocolUnique Device Identifier (UDI) value
Comments

UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.


UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.

Control0..1*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
58. Device.udiCarrier:PhdProvidedUdi.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.udiCarrier.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
60. Device.udiCarrier:PhdProvidedUdi.deviceIdentifier
Definition

The device identifier (UDI-DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device. The UDI-DI portion is placed on a device label or package. Note that the DeviceDefinition may include multiple UDI-DIs if it is sold in multiple jurisdictions.

ShortMandatory fixed portion of UDI
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesDI
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Device.udiCarrier:PhdProvidedUdi.issuer
Definition

Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include:

  1. GS1: http://hl7.org/fhir/NamingSystem/gs1-di,
  2. HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-diI,
  3. ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di,
  4. ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di # Informationsstelle für Arzneispezialitäten (IFA GmbH) (EU only): http://hl7.org/fhir/NamingSystem/ifa-gmbh-di.
ShortUDI Issuing Organization
Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesBarcode System
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Device.udiCarrier:PhdProvidedUdi.carrierAIDC
Definition

The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation as printed on the packaging of the device - e.g., a barcode , 2D Matrix, or RFID. Some AIDC representations contain non-printable characters and cannot be represented in a string format. For this reason, AIDC format SHALL be base64Binary encoded.

ShortUDI Machine Readable value
Comments

The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.

Control0..01
Typebase64Binary
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesAutomatic Identification and Data Capture
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Device.udiCarrier:PhdProvidedUdi.carrierHRF
Definition

The full UDI carrier as the human readable form (HRF) representation as printed on the packaging of the device.

ShortThe UDI Human Readable Barcode String form is supported in ACOM and GHS.UDI Human Readable value
Comments

If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesHuman Readable Form
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Device.udiCarrier:PhdProvidedUdi.entryType
Definition

A coded entry to indicate how the data was entered.

Shortbarcode | rfid | manual | card | self-reported | electronic-transmission | unknown
Control10..1
BindingThe codes SHALL be taken from UDIEntryTypehttp://hl7.org/fhir/ValueSet/udi-entry-type|6.0.0-snapshot1
(required to http://hl7.org/fhir/ValueSet/udi-entry-type|6.0.0-snapshot1)

Codes to identify how UDI data was entered.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Requirements

Supports a way to distinguish hand entered from machine read data.

Pattern Value
{
  "entryType" : "electronic-transmission"
}
<entryType value="electronic-transmission"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Device.status
Definition

The Device record status. This is not the status of the device like availability.

Shortactive | inactive | entered-in-error | unknown
Control0..1
BindingThe codes SHALL be taken from FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|6.0.0-snapshot1
(required to http://hl7.org/fhir/ValueSet/device-status|6.0.0-snapshot1)

The record status of the device.

Typecode
Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Device.manufacturer
Definition

The manufacturer name as reported in the IEEE 11073-10206 SystemInfo.


A name of the manufacturer or entity legally responsible for the device.

ShortManufacturer name from SystemInfo.system-manufacturerName of device manufacturer
Comments

The system manufacturer attribute is required by the IEEE 11073-10206 specification

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Device.serialNumber
Definition

The serial number assigned by the organization when the device was manufactured.

ShortA production identifier that indicates the Serial number assigned by the manufacturer
Comments

Alphanumeric Maximum 20. While a serial number is a type of identifier, in the context of devices for which a UDI is required, thus a serial number may be part of the production identifier, it is more informative to have the serial number as a dedicated attribute together with the other UDI production identifier. When the device is not subject to including the UDI (e.g., its presence and exchange is not mandated by local regulatory requirements or specific use case at hand), thus the concept of production identifiers is not relevant as a set, it remains helpful for consistency to still use Device.serialNumber rather than using Device.identifier with an appropriate type. Systems that do not realize an identifier is a serial number may place it in Device.identifier or if the identifier.system is known for the serial number, it may also be populated in the Device.identifier as a globally unique id_.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Device.modelNumber
Definition

The model number as reported by the SystemInfo attribute.


The manufacturer's model number for the device.

ShortModel number from SystemInfo.model-numberThe manufacturer's model number for the device
Comments

The model number attribute is required by the IEEE 11073-10206 specification

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Device.type
Definition

The kind or type of device. A device instance may have more than one type - in which case those are the types that apply to the specific instance of the device.

ShortThe kind or type of device
Comments

Multiple device types are use when a device is categorized in more than one context – for example, hybrid devices in which the device is both of type gateway and sensor. Device.type relates DeviceDefinition.classification.type using the same binding enabling referencing.

Control10..*
BindingFor example codes, see DeviceTypehttp://hl7.org/fhir/ValueSet/device-type|6.0.0-snapshot1
(example to http://hl7.org/fhir/ValueSet/device-type|6.0.0-snapshot1)

Codes to identify medical devices.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.type. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
80. Device.type:PhdType
Slice NamePhdType
Definition

The kind or type of device. A device instance may have more than one type - in which case those are the types that apply to the specific instance of the device.

ShortIndicates the device is a PHD.The kind or type of device
Comments

Multiple device types are use when a device is categorized in more than one context – for example, hybrid devices in which the device is both of type gateway and sensor. Device.type relates DeviceDefinition.classification.type using the same binding enabling referencing.

Control10..1*
BindingFor example codes, see DeviceTypehttp://hl7.org/fhir/ValueSet/device-type|6.0.0-snapshot1
(example to http://hl7.org/fhir/ValueSet/device-type|6.0.0-snapshot1)

Codes to identify medical devices.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "65573"
    }
  ]
}
<type>
  <coding>
    <system value="urn:iso:std:iso:11073:10101"/>
    <code value="65573"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Device.type:MainFunction
Slice NameMainFunction
Definition

The kind or type of device. A device instance may have more than one type - in which case those are the types that apply to the specific instance of the device.

ShortMDC profile code matching the PHD's main function.The kind or type of device
Comments

Multiple device types are use when a device is categorized in more than one context – for example, hybrid devices in which the device is both of type gateway and sensor. Device.type relates DeviceDefinition.classification.type using the same binding enabling referencing.

Control0..1*
BindingThe codes SHALL be taken from For example codes, see MDC Device Specialization codeshttp://hl7.org/fhir/ValueSet/device-type|6.0.0-snapshot1
(required to http://hl7.org/fhir/uv/phd/ValueSet/DeviceTypes11073MDC)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Device.deviceVersion
Definition

The actual design of the device or software version running on the device.

ShortA PHD may report firmware, hardware, software, internal protocol, nomenclature and ACOM versions.The actual design of the device or software version running on the device
Comments

There are several versions that are reported from a PHD. Firmware, Hardware, Protocol (internal, not IEEE 11073-10206), and Software versions come from the System Information object. The nomenclature and ACOM version comes from the ACOM base class. PHDs compliant to this IG report at least one of these versions. A separate version entry is needed for each of the versions reported by the PHD.


The combination of type and component SHOULD be unique across all repetitions of version.

Control10..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.deviceVersion. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
86. Device.deviceVersion.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.deviceVersion.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
88. Device.deviceVersion.value
Definition

The version text.

ShortThe version text
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Device.deviceVersion:MDCType
Slice NameMDCType
Definition

The actual design of the device or software version running on the device.

ShortRequired MDC device version type entryThe actual design of the device or software version running on the device
Comments

The combination of type and component SHOULD be unique across all repetitions of version.

Control10..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
92. Device.deviceVersion:MDCType.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.deviceVersion.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
94. Device.deviceVersion:MDCType.type
Definition

The type of the device version, e.g. manufacturer, approved, internal.

ShortThe type of the device version, e.g. manufacturer, approved, internal
Control0..1
BindingThe codes SHALL be taken from For example codes, see MDC Device Version Type codeshttp://hl7.org/fhir/ValueSet/device-versiontype|6.0.0-snapshot1
(required to http://hl7.org/fhir/uv/phd/ValueSet/MDCDeviceVersionTypes)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesΣ
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. Device.deviceVersion:MDCType.component
Definition

The hardware or software module of the device to which the version applies.

ShortThe hardware or software module of the device to which the version applies
Comments

Note that the module of the device would not need to be tracked as a separate device, e.g., using different UDI, thus would typically involve one or more software modules. For example, a device may involve two software modules each on a different version.

Control0..01
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. Device.deviceVersion:MDCType.value
Definition

The version text.

ShortThe versionThe version text
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. Device.conformsTo
Definition

Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.

ShortIdentifies the standards, specifications, or formal guidances for the capabilities supported by the device
Control10..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.conformsTo. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ specification.coding
102. Device.conformsTo.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.conformsTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
104. Device.conformsTo.specification
Definition

Code that identifies the specific standard, specification, protocol, formal guidance, regulation, legislation, or certification scheme to which the device adheres.

ShortIdentifies the standard, specification, or formal guidance that the device adheres to
Control1..1
BindingFor example codes, see DeviceSpecificationTypehttp://hl7.org/fhir/ValueSet/device-specification-type|6.0.0-snapshot1
(example to http://hl7.org/fhir/ValueSet/device-specification-type|6.0.0-snapshot1)

The type of version indicated for the device.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. Device.conformsTo:MDCType
Slice NameMDCType
Definition

The specialization(s) of the PHD. This element contains an entry for each supported specialization.


Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.

ShortThis element contains an entry for each supported specializationIdentifies the standards, specifications, or formal guidances for the capabilities supported by the device
Comments

There shall be a specialization entry for each specialization reported in the required System-Type-Spec-List attribute. A specialization in this case defines not only what type of measurements the PHD reports but that the PHD reports these measurements according to one of the 11073-114xx specialization standards. Most PHDs support only a single specialization such as the Blood Pressure or Pulse Oximeter specialization.

Control10..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
108. Device.conformsTo:MDCType.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.conformsTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
110. Device.conformsTo:MDCType.specification
Definition

Code that identifies the specific standard, specification, protocol, formal guidance, regulation, legislation, or certification scheme to which the device adheres.

ShortThe specialization standard supported by the PHD.Identifies the standard, specification, or formal guidance that the device adheres to
Comments

The IEEE 11073-10101 specialization code from a System-Type-Spec-List[i].type.

Control1..1
BindingFor example codes, see DeviceSpecificationTypehttp://hl7.org/fhir/ValueSet/device-specification-type|6.0.0-snapshot1
(example to http://hl7.org/fhir/ValueSet/device-specification-type|6.0.0-snapshot1)

The type of version indicated for the device.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. Device.conformsTo:MDCType.specification.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control10..*
BindingThe codes SHALL be taken from For codes, see MDC Device Specialization codes
(required to http://hl7.org/fhir/uv/phd/ValueSet/DeviceTypes11073MDC)
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. Device.conformsTo:MDCType.specification.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. Device.conformsTo:MDCType.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.

ShortThe version of the specialization standard supported by the PHD from the System-Type-Spec-List[i].versionSpecific form or variant of the standard
Comments

The version of the specialization comes from the System-Type-Spec-List specialization entry. If a PHD supports multiple versions of the same specialization a separate Device.specialization entry is needed where the systemType elements are repeated. If the PHD reports a generic specialization (using MDC_DEV_SPEC_PROFILE_HYDRA or MDC_DEV_SPEC_PROFILE_GENERIC), the version is the 11073-10206 version.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. Device.property
Definition

Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.

ShortInherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
120. Device.property.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
122. Device.property.type
Definition

Code that specifies the property, such as resolution, color, size, being represented.

ShortCode that specifies the property being represented
Control1..1
BindingFor example codes, see DevicePropertyTypehttp://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1
(example to http://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1)

Device property type.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. Device.property.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Attachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. Device.property:timeSyncProperty
Slice NametimeSyncProperty
Definition

This element represents the time synchronization method used by the PHD. It is an MDC coded value.


Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.

ShortTime synchronization methodInherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
Comments

The clock set method is a required attribute in the IEEE 11073-10206 standard. It is also supported by Bluetooth Low Energy ETS and GHS specifications. Strictly speaking, the time synchronization method is not a property of the PHD but rather a property of the PHG. However, it is included here as it is a required attribute in the IEEE 11073-10206 standard and is often used by the PHG to determine how to set the time on the PHD. In most cases it reflects the time synchronization method used to set the PHG's clock and strictly speaking it should not be reported as a static device property, but as part of a coincident timestamp.


Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..1*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
128. Device.property:timeSyncProperty.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
130. Device.property:timeSyncProperty.type
Definition

Code that specifies the property, such as resolution, color, size, being represented.

ShortCode that specifies the property being represented
Control1..1
BindingFor example codes, see DevicePropertyTypehttp://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1
(example to http://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1)

Device property type.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "68220"
    }
  ]
}
<type>
  <coding>
    <system value="urn:iso:std:iso:11073:10101"/>
    <code value="68220"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
132. Device.property:timeSyncProperty.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Attachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

134. Device.property:timeSyncProperty.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control01..1
TypeCodeableConcept, boolean, string, Quantity, Attachment, integer, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control10..*
BindingUnless not suitable, these codes SHALL be taken from For codes, see MDC Time Synchronization Methods
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/MDCTimeSyncMethods)
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. Device.property:continuaCertProperty
Slice NamecontinuaCertProperty
Definition

This element represents a Continua certified interface that is supported by the PHD. It is an MDC coded value.


Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.

ShortContinua certified PHD interfaces (from IEEE 11073-20601)Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
148. Device.property:continuaCertProperty.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
150. Device.property:continuaCertProperty.type
Definition

Code that specifies the property, such as resolution, color, size, being represented.

ShortCode that specifies the property being represented
Control1..1
BindingFor example codes, see DevicePropertyTypehttp://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1
(example to http://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1)

Device property type.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "532353"
    }
  ]
}
<type>
  <coding>
    <system value="urn:iso:std:iso:11073:10101"/>
    <code value="532353"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
152. Device.property:continuaCertProperty.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Attachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

154. Device.property:continuaCertProperty.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control01..1
BindingUnless not suitable, these codes SHALL be taken from For codes, see Continua PHD-PHG Device Interfaces ValueSet
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/ContinuaPHDInterfaces)
TypeCodeableConcept, boolean, string, Quantity, Attachment, integer, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
166. Device.property:clockBitProperty
Slice NameclockBitProperty
Definition

For each Boolean clock capability reported by a PHD a property element is used.


Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.

ShortBoolean Properties reported by the ClockInherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
168. Device.property:clockBitProperty.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
170. Device.property:clockBitProperty.type
Definition

One of the capabilities of the clock as reported by the PHD.


Code that specifies the property, such as resolution, color, size, being represented.

ShortTells what the clock capability item isCode that specifies the property being represented
Control1..1
BindingThe codes SHALL be taken from For example codes, see ANS1ToHL7 codes defined for Boolean Clock attributeshttp://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1
(required to http://hl7.org/fhir/uv/phd/ValueSet/ASN1ClockBits)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. Device.property:clockBitProperty.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Attachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

174. Device.property:clockBitProperty.value[x]:valueBoolean
Slice NamevalueBoolean
Definition

The value of the clock capability item as reported by the PHD.


The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control01..1
Typeboolean, string, Quantity, Attachment, integer, Range, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. Device.property:clockBitProperty.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control01..1
TypeCodeableConcept, boolean, string, Quantity, Attachment, integer, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. Device.property:clockBitProperty.value[x]:valueCodeableConcept.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. Device.property:clockBitProperty.value[x]:valueCodeableConcept.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
187. Device.property:isRegulatedProperty
Slice NameisRegulatedProperty
Definition

This element represents the regulatory status of the PHD.


Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.

ShortRegulatory status of the PHDInherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..1*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
189. Device.property:isRegulatedProperty.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
191. Device.property:isRegulatedProperty.type
Definition

This element represents the negated regulatory status of the PHD.


Code that specifies the property, such as resolution, color, size, being represented.

ShortNegated regulatory status of the PHDCode that specifies the property being represented
Control1..1
BindingFor example codes, see DevicePropertyTypehttp://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1
(example to http://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1)

Device property type.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ASN1ToHL7",
      "code" : "532354.0"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ASN1ToHL7"/>
    <code value="532354.0"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
193. Device.property:isRegulatedProperty.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Attachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

195. Device.property:isRegulatedProperty.value[x]:valueBoolean
Slice NamevalueBoolean
Definition

If true, the device is not regulated. If false, the device is regulated.


The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control01..1
Typeboolean, string, Quantity, Attachment, integer, Range, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
203. Device.property:clockResolutionProperty
Slice NameclockResolutionProperty
Definition

The clock resolution as reported by the PHD in microseconds.


Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.

ShortClock Resolution as reported by the PHDInherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..1*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
205. Device.property:clockResolutionProperty.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
207. Device.property:clockResolutionProperty.type
Definition

The resolution of the clock as reported by the PHD.


Code that specifies the property, such as resolution, color, size, being represented.

ShortTells what the clock resolution type isCode that specifies the property being represented
Control1..1
BindingThe codes SHALL be taken from For example codes, see MDC Clock Resolution Typeshttp://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1
(required to http://hl7.org/fhir/uv/phd/ValueSet/MDCClockResolutionTypes)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
209. Device.property:clockResolutionProperty.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeQuantity, boolean, string, Attachment, integer, Range, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
211. Device.property:clockResolutionProperty.value[x]:valueQuantity
Slice NamevalueQuantity
Definition

The value. All the time fields are scaled to microseconds


The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeQuantity, boolean, string, Attachment, integer, Range, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
213. Device.property:clockResolutionProperty.value[x]:valueQuantity.comparator
Definition

How the value should be understood and represented - whether the actual value is greater than, less than, or approximately equal to the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Short< | <= | >= | > | ~ | ad - how to understand the value
Control0..1
BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|6.0.0-snapshot1
(required to http://hl7.org/fhir/ValueSet/quantity-comparator|6.0.0-snapshot1)

How the Quantity should be understood and represented.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning if MissingIf there is no comparator, then there is no modification of the value
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
215. Device.property:clockResolutionProperty.value[x]:valueQuantity.system
Definition

The identification of the system that provides the coded form of the unit.

ShortSystem that defines coded unit form
Control10..1
This element is affected by the following invariants: qty-3
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to know the system that defines the coded form of the unit.

Pattern Value
{
  "system" : "http://unitsofmeasure.org"
}
<system value="http://unitsofmeasure.org"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
217. Device.property:clockResolutionProperty.value[x]:valueQuantity.code
Definition

The UCUM code for microseconds is 'us'.


A computer processable form of the unit in some unit representation system.

ShortCoded form of the unit
Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Control0..1
This element is affected by the following invariants: qty-3
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Pattern Value
{
  "code" : "us"
}
<code value="us"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
219. Device.property:timeSyncAccuracyProperty
Slice NametimeSyncAccuracyProperty
Definition

The time synchronization accuracy as reported by the PHD in microseconds.


Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.

ShortTime Synchronization Accuracy as reported by the PHDInherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..1*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
221. Device.property:timeSyncAccuracyProperty.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
223. Device.property:timeSyncAccuracyProperty.type
Definition

The time synchronization accuracy of the clock as reported by the PHD.


Code that specifies the property, such as resolution, color, size, being represented.

ShortTells what the time synchronization accuracy isCode that specifies the property being represented
Control1..1
BindingFor example codes, see DevicePropertyTypehttp://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1
(example to http://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1)

Device property type.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "68221"
    }
  ]
}
<type>
  <coding>
    <system value="urn:iso:std:iso:11073:10101"/>
    <code value="68221"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
225. Device.property:timeSyncAccuracyProperty.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeQuantity, boolean, string, Attachment, integer, Range, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
227. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity
Slice NamevalueQuantity
Definition

The value. All the time fields are scaled to microseconds


The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeQuantity, boolean, string, Attachment, integer, Range, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
229. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity.comparator
Definition

How the value should be understood and represented - whether the actual value is greater than, less than, or approximately equal to the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Short< | <= | >= | > | ~ | ad - how to understand the value
Control0..1
BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|6.0.0-snapshot1
(required to http://hl7.org/fhir/ValueSet/quantity-comparator|6.0.0-snapshot1)

How the Quantity should be understood and represented.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning if MissingIf there is no comparator, then there is no modification of the value
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
231. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity.system
Definition

The identification of the system that provides the coded form of the unit.

ShortSystem that defines coded unit form
Control10..1
This element is affected by the following invariants: qty-3
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to know the system that defines the coded form of the unit.

Pattern Value
{
  "system" : "http://unitsofmeasure.org"
}
<system value="http://unitsofmeasure.org"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
233. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity.code
Definition

The UCUM code for microseconds is 'us'.


A computer processable form of the unit in some unit representation system.

ShortCoded form of the unit
Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Control0..1
This element is affected by the following invariants: qty-3
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Pattern Value
{
  "code" : "us"
}
<code value="us"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
235. Device.property:USB-VID-PID
Slice NameUSB-VID-PID
Definition

The USB Vendor and Product ID as reported by the PHD.


Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.

ShortUSB Vendor and Product IDInherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..1*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
237. Device.property:USB-VID-PID.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
239. Device.property:USB-VID-PID.type
Definition

The USB Vendor and Product ID as reported by the PHD.


Code that specifies the property, such as resolution, color, size, being represented.

ShortUSB Vendor and Product IDCode that specifies the property being represented
Control1..1
BindingFor example codes, see DevicePropertyTypehttp://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1
(example to http://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1)

Device property type.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers",
      "code" : "USB"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers"/>
    <code value="USB"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
241. Device.property:USB-VID-PID.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeCodeableConcept, boolean, string, Quantity, Attachment, integer, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
243. Device.property:USB-VID-PID.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeCodeableConcept, boolean, string, Quantity, Attachment, integer, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
245. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
247. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.coding.system
Definition

The USB Vendor and Product ID naming system id is http://hl7.org/fhir/sid/usb-vid-pid, but that cannot be used here as this is not a code system in FHIR.


The identification of the code system that defines the meaning of the symbol in the code.

ShortUSB Vendor and Product ID code systemIdentity of the terminology system
Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
249. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.text
Definition

The USB Vendor and Product ID as reported by the PHD in the form of a coded string such as '1234:56AB'.


A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

The USB Vendor and Product ID is not a required attribute in the IEEE 11073-10206 standard but is often reported by PHDs that support USB transport.


Very often the text is the same as a displayName of one of the codings.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
251. Device.parent
Definition

The higher level or encompassing device that this device is a logical part of.

ShortNo reference to a parent device in PHD. PHDs are not part of a device hierarchy.The higher level or encompassing device that this device is a logical part of
Comments

For example a vital signs monitor (parent) where three separate modules can be plugged into such as interchangeable blood pressure, oximeter, temperature modules. These modules are represented as devices with the .parent valued to the vital signs monitor when plugged in.

Control0..01
TypeReference(Device)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

See the documentation on how to interpret the contents of this table

0. Device
Definition

his resource describes the primary features of a Personal Health Device (PHD). It contains the properties, production specification, specializations, and overall type of the PHD.

Comments

This profile applies to PHDs that adhere to the IEEE 11073-10206 ACOM standard or that can be mapped to it. The profile is based on the Device resource and contains additional elements that are specific to PHDs.

2. Device.identifier
Definition

The assigned unique identification of the device that is semantically meaningful outside of the FHIR resource context. An example would be the IEEE EUI-64 System-Id or transport address. For PHDs the systemIdentifier is highly recommended and also a transportAddressIdentifier is recommended as this is what most end users see and can obtain from the device itself or device packaging.

ShortInformation that uniquely describes the personal health device
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
Alternate Names11073-10206 System id, transport address, etc.
SlicingThis element introduces a set of slices on Device.identifier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

4. Device.identifier.type
ShortThe type of identifier
BindingUnless not suitable, these codes SHALL be taken from MDC Device Identifier Types
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/MDCDeviceIdentifierTypes)

MDC Device Identifier Types

6. Device.identifier.value
8. Device.identifier:systemIdIdentifier
Slice NamesystemIdIdentifier
Definition

This entry contains the IEEE EUI-64.

ShortSystem Id identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
Alternate Names11073-10206 System id
10. Device.identifier:systemIdIdentifier.type
ShortRequired IEEE 11073-10206 System Id code system coding
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers",
      "code" : "SYSID"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers"/>
    <code value="SYSID"/>
  </coding>
</type>
12. Device.identifier:systemIdIdentifier.system
Definition

Identifies the system as an IEEE EUI.

ShortEUI-64 system identifier
Control1..?
Pattern Value
{
  "system" : "urn:oid:1.2.840.10004.1.1.1.0.0.1.0.0.1.2680"
}
<system value="urn:oid:1.2.840.10004.1.1.1.0.0.1.0.0.1.2680"/>
14. Device.identifier:systemIdIdentifier.value
Definition

The System id from the System-Id attribute as an 8-byte HEX string where each byte is separated by dashes, for example FE-ED-AB-EE-DE-AD-77-C3.

ShortSystem id value from System-Id attribute
Comments

The formatting is specified in the IEEE RA Guidelines for use of EUIs.

Control1..?
16. Device.identifier:btmacAddressIdentifier
Slice NamebtmacAddressIdentifier
Definition

This entry contains the Bluetooth MAC transport address.

ShortBluetooth MAC Transport address identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
Alternate NamesBluetooth MAC Transport address
18. Device.identifier:btmacAddressIdentifier.type
ShortRequired Bluetooth MAC address code system coding
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers",
      "code" : "BTMAC"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers"/>
    <code value="BTMAC"/>
  </coding>
</type>
20. Device.identifier:btmacAddressIdentifier.system
Control1..?
Pattern Value
{
  "system" : "http://hl7.org/fhir/sid/eui-48/bluetooth"
}
<system value="http://hl7.org/fhir/sid/eui-48/bluetooth"/>
22. Device.identifier:btmacAddressIdentifier.value
Definition

The Bluetooth MAC as an EUI-48 such as 00-E5-DE-AD-77-C3.

Comments

Transport addresses are supposed to be unique for a given device.

Control1..?
24. Device.identifier:macAddressIdentifier
Slice NamemacAddressIdentifier
Definition

This entry contains the MAC transport address.

ShortMAC Transport address identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
Alternate NamesMAC Transport address
26. Device.identifier:macAddressIdentifier.type
ShortRequired Ethernet MAC address code system coding
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers",
      "code" : "ETHMAC"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers"/>
    <code value="ETHMAC"/>
  </coding>
</type>
28. Device.identifier:macAddressIdentifier.system
Control1..?
Pattern Value
{
  "system" : "http://hl7.org/fhir/sid/eui-48/ethernet"
}
<system value="http://hl7.org/fhir/sid/eui-48/ethernet"/>
30. Device.identifier:macAddressIdentifier.value
Definition

The MAC as an EUI-48 such as 00-E5-DE-AD-77-C8.

Comments

Transport addresses are supposed to be unique for a given device.

Control1..?
32. Device.udiCarrier
SlicingThis element introduces a set of slices on Device.udiCarrier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ entryType
34. Device.udiCarrier:PhdProvidedUdi
Slice NamePhdProvidedUdi
Definition

The UDI of the PHD as provided by protocol. The UDI is an optional attribute in the IEEE 11073-10206 standard and is also supported by Bluetooth Low Energy DIS and GHS specifications.

ShortThe UDI of the PHD as provided by protocol
Control0..1
36. Device.udiCarrier:PhdProvidedUdi.carrierAIDC
Control0..0
38. Device.udiCarrier:PhdProvidedUdi.carrierHRF
ShortThe UDI Human Readable Barcode String form is supported in ACOM and GHS.
Control1..?
40. Device.udiCarrier:PhdProvidedUdi.entryType
Control1..?
Pattern Value
{
  "entryType" : "electronic-transmission"
}
<entryType value="electronic-transmission"/>
42. Device.manufacturer
Definition

The manufacturer name as reported in the IEEE 11073-10206 SystemInfo.

ShortManufacturer name from SystemInfo.system-manufacturer
Comments

The system manufacturer attribute is required by the IEEE 11073-10206 specification

Control1..?
44. Device.serialNumber
46. Device.modelNumber
Definition

The model number as reported by the SystemInfo attribute.

ShortModel number from SystemInfo.model-number
Comments

The model number attribute is required by the IEEE 11073-10206 specification

Control1..?
48. Device.type
Control1..?
SlicingThis element introduces a set of slices on Device.type. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
50. Device.type:PhdType
Slice NamePhdType
ShortIndicates the device is a PHD.
Control1..1
Pattern Value
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "65573"
    }
  ]
}
<type>
  <coding>
    <system value="urn:iso:std:iso:11073:10101"/>
    <code value="65573"/>
  </coding>
</type>
52. Device.type:MainFunction
Slice NameMainFunction
ShortMDC profile code matching the PHD's main function.
Control0..1
BindingThe codes SHALL be taken from MDC Device Specialization codes
(required to http://hl7.org/fhir/uv/phd/ValueSet/DeviceTypes11073MDC)
54. Device.deviceVersion
ShortA PHD may report firmware, hardware, software, internal protocol, nomenclature and ACOM versions.
Comments

There are several versions that are reported from a PHD. Firmware, Hardware, Protocol (internal, not IEEE 11073-10206), and Software versions come from the System Information object. The nomenclature and ACOM version comes from the ACOM base class. PHDs compliant to this IG report at least one of these versions. A separate version entry is needed for each of the versions reported by the PHD.

Control1..?
SlicingThis element introduces a set of slices on Device.deviceVersion. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
56. Device.deviceVersion:MDCType
Slice NameMDCType
ShortRequired MDC device version type entry
Control1..*
58. Device.deviceVersion:MDCType.type
BindingThe codes SHALL be taken from MDC Device Version Type codes
(required to http://hl7.org/fhir/uv/phd/ValueSet/MDCDeviceVersionTypes)
60. Device.deviceVersion:MDCType.component
Control0..0
62. Device.deviceVersion:MDCType.value
ShortThe version
64. Device.conformsTo
Control1..?
SlicingThis element introduces a set of slices on Device.conformsTo. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ specification.coding
66. Device.conformsTo:MDCType
Slice NameMDCType
Definition

The specialization(s) of the PHD. This element contains an entry for each supported specialization.

ShortThis element contains an entry for each supported specialization
Comments

There shall be a specialization entry for each specialization reported in the required System-Type-Spec-List attribute. A specialization in this case defines not only what type of measurements the PHD reports but that the PHD reports these measurements according to one of the 11073-114xx specialization standards. Most PHDs support only a single specialization such as the Blood Pressure or Pulse Oximeter specialization.

Control1..*
68. Device.conformsTo:MDCType.specification
ShortThe specialization standard supported by the PHD.
Comments

The IEEE 11073-10101 specialization code from a System-Type-Spec-List[i].type.

70. Device.conformsTo:MDCType.specification.coding
Control1..?
BindingThe codes SHALL be taken from MDC Device Specialization codes
(required to http://hl7.org/fhir/uv/phd/ValueSet/DeviceTypes11073MDC)
72. Device.conformsTo:MDCType.specification.coding.code
74. Device.conformsTo:MDCType.version
ShortThe version of the specialization standard supported by the PHD from the System-Type-Spec-List[i].version
Comments

The version of the specialization comes from the System-Type-Spec-List specialization entry. If a PHD supports multiple versions of the same specialization a separate Device.specialization entry is needed where the systemType elements are repeated. If the PHD reports a generic specialization (using MDC_DEV_SPEC_PROFILE_HYDRA or MDC_DEV_SPEC_PROFILE_GENERIC), the version is the 11073-10206 version.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control1..?
76. Device.property
SlicingThis element introduces a set of slices on Device.property. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
78. Device.property:timeSyncProperty
Slice NametimeSyncProperty
Definition

This element represents the time synchronization method used by the PHD. It is an MDC coded value.

ShortTime synchronization method
Comments

The clock set method is a required attribute in the IEEE 11073-10206 standard. It is also supported by Bluetooth Low Energy ETS and GHS specifications. Strictly speaking, the time synchronization method is not a property of the PHD but rather a property of the PHG. However, it is included here as it is a required attribute in the IEEE 11073-10206 standard and is often used by the PHG to determine how to set the time on the PHD. In most cases it reflects the time synchronization method used to set the PHG's clock and strictly speaking it should not be reported as a static device property, but as part of a coincident timestamp.

Control0..1
80. Device.property:timeSyncProperty.type
Pattern Value
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "68220"
    }
  ]
}
<type>
  <coding>
    <system value="urn:iso:std:iso:11073:10101"/>
    <code value="68220"/>
  </coding>
</type>
82. Device.property:timeSyncProperty.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

84. Device.property:timeSyncProperty.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Control0..1
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
86. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.coding
Control1..?
BindingUnless not suitable, these codes SHALL be taken from MDC Time Synchronization Methods
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/MDCTimeSyncMethods)
88. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.coding.code
90. Device.property:continuaCertProperty
Slice NamecontinuaCertProperty
Definition

This element represents a Continua certified interface that is supported by the PHD. It is an MDC coded value.

ShortContinua certified PHD interfaces (from IEEE 11073-20601)
Control0..*
92. Device.property:continuaCertProperty.type
Pattern Value
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "532353"
    }
  ]
}
<type>
  <coding>
    <system value="urn:iso:std:iso:11073:10101"/>
    <code value="532353"/>
  </coding>
</type>
94. Device.property:continuaCertProperty.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

96. Device.property:continuaCertProperty.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Control0..1
BindingUnless not suitable, these codes SHALL be taken from Continua PHD-PHG Device Interfaces ValueSet
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/ContinuaPHDInterfaces)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
98. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.coding
100. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.coding.code
102. Device.property:clockBitProperty
Slice NameclockBitProperty
Definition

For each Boolean clock capability reported by a PHD a property element is used.

ShortBoolean Properties reported by the Clock
Control0..*
104. Device.property:clockBitProperty.type
Definition

One of the capabilities of the clock as reported by the PHD.

ShortTells what the clock capability item is
BindingThe codes SHALL be taken from ANS1ToHL7 codes defined for Boolean Clock attributes
(required to http://hl7.org/fhir/uv/phd/ValueSet/ASN1ClockBits)
106. Device.property:clockBitProperty.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

108. Device.property:clockBitProperty.value[x]:valueBoolean
Slice NamevalueBoolean
Definition

The value of the clock capability item as reported by the PHD.

Control0..1
Typeboolean
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
110. Device.property:clockBitProperty.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Control0..1
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
112. Device.property:clockBitProperty.value[x]:valueCodeableConcept.coding
114. Device.property:clockBitProperty.value[x]:valueCodeableConcept.coding.code
116. Device.property:isRegulatedProperty
Slice NameisRegulatedProperty
Definition

This element represents the regulatory status of the PHD.

ShortRegulatory status of the PHD
Control0..1
118. Device.property:isRegulatedProperty.type
Definition

This element represents the negated regulatory status of the PHD.

ShortNegated regulatory status of the PHD
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ASN1ToHL7",
      "code" : "532354.0"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ASN1ToHL7"/>
    <code value="532354.0"/>
  </coding>
</type>
120. Device.property:isRegulatedProperty.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

122. Device.property:isRegulatedProperty.value[x]:valueBoolean
Slice NamevalueBoolean
Definition

If true, the device is not regulated. If false, the device is regulated.

Control0..1
Typeboolean
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
124. Device.property:clockResolutionProperty
Slice NameclockResolutionProperty
Definition

The clock resolution as reported by the PHD in microseconds.

ShortClock Resolution as reported by the PHD
Control0..1
126. Device.property:clockResolutionProperty.type
Definition

The resolution of the clock as reported by the PHD.

ShortTells what the clock resolution type is
BindingThe codes SHALL be taken from MDC Clock Resolution Types
(required to http://hl7.org/fhir/uv/phd/ValueSet/MDCClockResolutionTypes)
128. Device.property:clockResolutionProperty.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
130. Device.property:clockResolutionProperty.value[x]:valueQuantity
Slice NamevalueQuantity
Definition

The value. All the time fields are scaled to microseconds

Control1..1
TypeQuantity
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
132. Device.property:clockResolutionProperty.value[x]:valueQuantity.system
Control1..?
Pattern Value
{
  "system" : "http://unitsofmeasure.org"
}
<system value="http://unitsofmeasure.org"/>
134. Device.property:clockResolutionProperty.value[x]:valueQuantity.code
Definition

The UCUM code for microseconds is 'us'.

Pattern Value
{
  "code" : "us"
}
<code value="us"/>
136. Device.property:timeSyncAccuracyProperty
Slice NametimeSyncAccuracyProperty
Definition

The time synchronization accuracy as reported by the PHD in microseconds.

ShortTime Synchronization Accuracy as reported by the PHD
Control0..1
138. Device.property:timeSyncAccuracyProperty.type
Definition

The time synchronization accuracy of the clock as reported by the PHD.

ShortTells what the time synchronization accuracy is
Pattern Value
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "68221"
    }
  ]
}
<type>
  <coding>
    <system value="urn:iso:std:iso:11073:10101"/>
    <code value="68221"/>
  </coding>
</type>
140. Device.property:timeSyncAccuracyProperty.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
142. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity
Slice NamevalueQuantity
Definition

The value. All the time fields are scaled to microseconds

Control1..1
TypeQuantity
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
144. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity.system
Control1..?
Pattern Value
{
  "system" : "http://unitsofmeasure.org"
}
<system value="http://unitsofmeasure.org"/>
146. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity.code
Definition

The UCUM code for microseconds is 'us'.

Pattern Value
{
  "code" : "us"
}
<code value="us"/>
148. Device.property:USB-VID-PID
Slice NameUSB-VID-PID
Definition

The USB Vendor and Product ID as reported by the PHD.

ShortUSB Vendor and Product ID
Control0..1
150. Device.property:USB-VID-PID.type
Definition

The USB Vendor and Product ID as reported by the PHD.

ShortUSB Vendor and Product ID
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers",
      "code" : "USB"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers"/>
    <code value="USB"/>
  </coding>
</type>
152. Device.property:USB-VID-PID.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
154. Device.property:USB-VID-PID.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Control1..1
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
156. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.coding
158. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.coding.system
Definition

The USB Vendor and Product ID naming system id is http://hl7.org/fhir/sid/usb-vid-pid, but that cannot be used here as this is not a code system in FHIR.

ShortUSB Vendor and Product ID code system
160. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.text
Definition

The USB Vendor and Product ID as reported by the PHD in the form of a coded string such as '1234:56AB'.

Comments

The USB Vendor and Product ID is not a required attribute in the IEEE 11073-10206 standard but is often reported by PHDs that support USB transport.

Control1..?
162. Device.parent
ShortNo reference to a parent device in PHD. PHDs are not part of a device hierarchy.
Control0..0

See the documentation on how to interpret the contents of this table

0. Device
Definition

his resource describes the primary features of a Personal Health Device (PHD). It contains the properties, production specification, specializations, and overall type of the PHD.

ShortItem used in healthcare
Comments

This profile applies to PHDs that adhere to the IEEE 11073-10206 ACOM standard or that can be mapped to it. The profile is based on the Device resource and contains additional elements that are specific to PHDs.

Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdev-1: only one Device.name.display SHALL be true when there is more than one Device.name (name.where(display=true).count() <= 1)
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Device.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resource id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. Device.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Device.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the additionalImplicitRules extension.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Device.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-snapshot1)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Device.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Device.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. Device.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. Device.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
18. Device.identifier
Definition

The assigned unique identification of the device that is semantically meaningful outside of the FHIR resource context. An example would be the IEEE EUI-64 System-Id or transport address. For PHDs the systemIdentifier is highly recommended and also a transportAddressIdentifier is recommended as this is what most end users see and can obtain from the device itself or device packaging.

ShortInformation that uniquely describes the personal health device
Comments

Certain attributes, like serial number and UDI Carrier (the HRF or AIDC barcode string) are not device instance identifiers as they are not consistently able to uniquely identify the instance of a device, thus are not appropriate to be used to value Device.identifier. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. The identifier is typically valued if the serialNumber or lotNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Names11073-10206 System id, transport address, etc.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.identifier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

20. Device.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
22. Device.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
24. Device.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|6.0.0-snapshot1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Device.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortThe type of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from MDC Device Identifier Types
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/MDCDeviceIdentifierTypes)

MDC Device Identifier Types

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Device.identifier.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive. The FHIR specification, terminology.hl7.org and HL7 affiliates (for identifiers specific to their jurisdiction) define identifier systems that SHALL be used for certain types of identifiers. Specific rules can be found here.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Device.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processor to be confident that non-case-sensitive processing is safe.

Control0..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Device.identifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Device.identifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Device.identifier:systemIdIdentifier
Slice NamesystemIdIdentifier
Definition

This entry contains the IEEE EUI-64.

ShortSystem Id identifier
Comments

Certain attributes, like serial number and UDI Carrier (the HRF or AIDC barcode string) are not device instance identifiers as they are not consistently able to uniquely identify the instance of a device, thus are not appropriate to be used to value Device.identifier. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. The identifier is typically valued if the serialNumber or lotNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Names11073-10206 System id
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Device.identifier:systemIdIdentifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
40. Device.identifier:systemIdIdentifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
42. Device.identifier:systemIdIdentifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|6.0.0-snapshot1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Device.identifier:systemIdIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortRequired IEEE 11073-10206 System Id code system coding
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|6.0.0-snapshot1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers",
      "code" : "SYSID"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers"/>
    <code value="SYSID"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Device.identifier:systemIdIdentifier.system
Definition

Identifies the system as an IEEE EUI.

ShortEUI-64 system identifier
Comments

Identifier.system is always case sensitive. The FHIR specification, terminology.hl7.org and HL7 affiliates (for identifiers specific to their jurisdiction) define identifier systems that SHALL be used for certain types of identifiers. Specific rules can be found here.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "urn:oid:1.2.840.10004.1.1.1.0.0.1.0.0.1.2680"
}
<system value="urn:oid:1.2.840.10004.1.1.1.0.0.1.0.0.1.2680"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Device.identifier:systemIdIdentifier.value
Definition

The System id from the System-Id attribute as an 8-byte HEX string where each byte is separated by dashes, for example FE-ED-AB-EE-DE-AD-77-C3.

ShortSystem id value from System-Id attribute
Comments

The formatting is specified in the IEEE RA Guidelines for use of EUIs.

Control1..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Device.identifier:systemIdIdentifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Device.identifier:systemIdIdentifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Device.identifier:btmacAddressIdentifier
Slice NamebtmacAddressIdentifier
Definition

This entry contains the Bluetooth MAC transport address.

ShortBluetooth MAC Transport address identifier
Comments

Certain attributes, like serial number and UDI Carrier (the HRF or AIDC barcode string) are not device instance identifiers as they are not consistently able to uniquely identify the instance of a device, thus are not appropriate to be used to value Device.identifier. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. The identifier is typically valued if the serialNumber or lotNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesBluetooth MAC Transport address
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Device.identifier:btmacAddressIdentifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
58. Device.identifier:btmacAddressIdentifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
60. Device.identifier:btmacAddressIdentifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|6.0.0-snapshot1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Device.identifier:btmacAddressIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortRequired Bluetooth MAC address code system coding
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|6.0.0-snapshot1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers",
      "code" : "BTMAC"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers"/>
    <code value="BTMAC"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Device.identifier:btmacAddressIdentifier.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive. The FHIR specification, terminology.hl7.org and HL7 affiliates (for identifiers specific to their jurisdiction) define identifier systems that SHALL be used for certain types of identifiers. Specific rules can be found here.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "http://hl7.org/fhir/sid/eui-48/bluetooth"
}
<system value="http://hl7.org/fhir/sid/eui-48/bluetooth"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Device.identifier:btmacAddressIdentifier.value
Definition

The Bluetooth MAC as an EUI-48 such as 00-E5-DE-AD-77-C3.

ShortThe value that is unique
Comments

Transport addresses are supposed to be unique for a given device.

Control1..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Device.identifier:btmacAddressIdentifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Device.identifier:btmacAddressIdentifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Device.identifier:macAddressIdentifier
Slice NamemacAddressIdentifier
Definition

This entry contains the MAC transport address.

ShortMAC Transport address identifier
Comments

Certain attributes, like serial number and UDI Carrier (the HRF or AIDC barcode string) are not device instance identifiers as they are not consistently able to uniquely identify the instance of a device, thus are not appropriate to be used to value Device.identifier. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. The identifier is typically valued if the serialNumber or lotNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesMAC Transport address
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Device.identifier:macAddressIdentifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
76. Device.identifier:macAddressIdentifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
78. Device.identifier:macAddressIdentifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|6.0.0-snapshot1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Device.identifier:macAddressIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortRequired Ethernet MAC address code system coding
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|6.0.0-snapshot1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers",
      "code" : "ETHMAC"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers"/>
    <code value="ETHMAC"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Device.identifier:macAddressIdentifier.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive. The FHIR specification, terminology.hl7.org and HL7 affiliates (for identifiers specific to their jurisdiction) define identifier systems that SHALL be used for certain types of identifiers. Specific rules can be found here.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "http://hl7.org/fhir/sid/eui-48/ethernet"
}
<system value="http://hl7.org/fhir/sid/eui-48/ethernet"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Device.identifier:macAddressIdentifier.value
Definition

The MAC as an EUI-48 such as 00-E5-DE-AD-77-C8.

ShortThe value that is unique
Comments

Transport addresses are supposed to be unique for a given device.

Control1..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Device.identifier:macAddressIdentifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Device.identifier:macAddressIdentifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Device.definition
Definition

The reference to the definition for the device.

ShortThe reference to the definition for the device
Control0..1
Typecanonical(DeviceDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. Device.udiCarrier
Definition

Unique Device Identifier (UDI) placed on a device label or package. Note that the Device may include multiple UDIs if it is sold in multiple jurisdictions.

ShortUnique Device Identifier (UDI) value
Comments

UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.udiCarrier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ entryType
94. Device.udiCarrier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
96. Device.udiCarrier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.udiCarrier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
98. Device.udiCarrier.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.udiCarrier.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
100. Device.udiCarrier.deviceIdentifier
Definition

The device identifier (UDI-DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device. The UDI-DI portion is placed on a device label or package. Note that the DeviceDefinition may include multiple UDI-DIs if it is sold in multiple jurisdictions.

ShortMandatory fixed portion of UDI
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesDI
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. Device.udiCarrier.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.

ShortThe namespace for the device identifier value
Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. Device.udiCarrier.issuer
Definition

Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include:

  1. GS1: http://hl7.org/fhir/NamingSystem/gs1-di,
  2. HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-diI,
  3. ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di,
  4. ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di # Informationsstelle für Arzneispezialitäten (IFA GmbH) (EU only): http://hl7.org/fhir/NamingSystem/ifa-gmbh-di.
ShortUDI Issuing Organization
Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesBarcode System
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. Device.udiCarrier.jurisdiction
Definition

The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/us-fda-udi or in the European Union by the European Commission http://hl7.org/fhir/NamingSystem/eu-ec-udi.

ShortRegional UDI authority
Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Requirements

Allows a recipient of a UDI to know which database will contain the UDI-associated metadata.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. Device.udiCarrier.carrierAIDC
Definition

The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation as printed on the packaging of the device - e.g., a barcode , 2D Matrix, or RFID. Some AIDC representations contain non-printable characters and cannot be represented in a string format. For this reason, AIDC format SHALL be base64Binary encoded.

ShortUDI Machine Readable value
Comments

The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.

Control0..1
Typebase64Binary
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesAutomatic Identification and Data Capture
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. Device.udiCarrier.carrierHRF
Definition

The full UDI carrier as the human readable form (HRF) representation as printed on the packaging of the device.

ShortUDI Human Readable value
Comments

If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesHuman Readable Form
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. Device.udiCarrier.entryType
Definition

A coded entry to indicate how the data was entered.

Shortbarcode | rfid | manual | card | self-reported | electronic-transmission | unknown
Control0..1
BindingThe codes SHALL be taken from UDIEntryType
(required to http://hl7.org/fhir/ValueSet/udi-entry-type|6.0.0-snapshot1)

Codes to identify how UDI data was entered.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Requirements

Supports a way to distinguish hand entered from machine read data.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. Device.udiCarrier:PhdProvidedUdi
Slice NamePhdProvidedUdi
Definition

The UDI of the PHD as provided by protocol. The UDI is an optional attribute in the IEEE 11073-10206 standard and is also supported by Bluetooth Low Energy DIS and GHS specifications.

ShortThe UDI of the PHD as provided by protocol
Comments

UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.

Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
116. Device.udiCarrier:PhdProvidedUdi.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
118. Device.udiCarrier:PhdProvidedUdi.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.udiCarrier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
120. Device.udiCarrier:PhdProvidedUdi.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.udiCarrier.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
122. Device.udiCarrier:PhdProvidedUdi.deviceIdentifier
Definition

The device identifier (UDI-DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device. The UDI-DI portion is placed on a device label or package. Note that the DeviceDefinition may include multiple UDI-DIs if it is sold in multiple jurisdictions.

ShortMandatory fixed portion of UDI
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesDI
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. Device.udiCarrier:PhdProvidedUdi.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.

ShortThe namespace for the device identifier value
Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. Device.udiCarrier:PhdProvidedUdi.issuer
Definition

Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include:

  1. GS1: http://hl7.org/fhir/NamingSystem/gs1-di,
  2. HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-diI,
  3. ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di,
  4. ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di # Informationsstelle für Arzneispezialitäten (IFA GmbH) (EU only): http://hl7.org/fhir/NamingSystem/ifa-gmbh-di.
ShortUDI Issuing Organization
Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesBarcode System
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. Device.udiCarrier:PhdProvidedUdi.jurisdiction
Definition

The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/us-fda-udi or in the European Union by the European Commission http://hl7.org/fhir/NamingSystem/eu-ec-udi.

ShortRegional UDI authority
Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Requirements

Allows a recipient of a UDI to know which database will contain the UDI-associated metadata.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. Device.udiCarrier:PhdProvidedUdi.carrierAIDC
Definition

The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation as printed on the packaging of the device - e.g., a barcode , 2D Matrix, or RFID. Some AIDC representations contain non-printable characters and cannot be represented in a string format. For this reason, AIDC format SHALL be base64Binary encoded.

ShortUDI Machine Readable value
Comments

The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.

Control0..0
Typebase64Binary
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesAutomatic Identification and Data Capture
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
132. Device.udiCarrier:PhdProvidedUdi.carrierHRF
Definition

The full UDI carrier as the human readable form (HRF) representation as printed on the packaging of the device.

ShortThe UDI Human Readable Barcode String form is supported in ACOM and GHS.
Comments

If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesHuman Readable Form
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. Device.udiCarrier:PhdProvidedUdi.entryType
Definition

A coded entry to indicate how the data was entered.

Shortbarcode | rfid | manual | card | self-reported | electronic-transmission | unknown
Control1..1
BindingThe codes SHALL be taken from UDIEntryType
(required to http://hl7.org/fhir/ValueSet/udi-entry-type|6.0.0-snapshot1)

Codes to identify how UDI data was entered.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Requirements

Supports a way to distinguish hand entered from machine read data.

Pattern Value
{
  "entryType" : "electronic-transmission"
}
<entryType value="electronic-transmission"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. Device.status
Definition

The Device record status. This is not the status of the device like availability.

Shortactive | inactive | entered-in-error | unknown
Control0..1
BindingThe codes SHALL be taken from FHIRDeviceStatus
(required to http://hl7.org/fhir/ValueSet/device-status|6.0.0-snapshot1)

The record status of the device.

Typecode
Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. Device.availabilityStatus
Definition

The availability of the device.

Shortlost | damaged | destroyed | available
Control0..1
BindingThe codes SHOULD be taken from FHIR Device Availability Status
(preferred to http://terminology.hl7.org/ValueSet/device-availability-status)

The availability status reason of the device.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. Device.biologicalSourceEvent
Definition

A production identifier of the donor, donation, or pooling event associated with the biological material incorporated into the device.

ShortA production identifier of the donor, donation, or pooling event associated with the biological material incorporated into the device
Comments

Necessary to support mandatory requirements for traceability from donor/source to recipient and vice versa, while also satisfying donor anonymity requirements. The element is defined consistently across BiologicallyDerivedProduct, NutritionProduct, and Device. The identifier references an event that links to a single biological entity such as a blood donor, or to multiple biological entities (e.g. when the product is an embryo or a pooled platelet product). A single biologicalSourceEvent identifier may appear on multiple products of many types derived from a single donation event or source extraction. As an example, a single donation event may provide 2 kidneys and a liver for organ transplantation, 2 corneas for eye surgery, heart valves and arterial tissue for cardiovascular surgery, multiple skin grafts, tendons, multiple shaped bone grafts and a large number of bone putty/paste products; and each of them may be assigned to the same biological source event identifier.

Control0..1
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesDistinct Identification Code (DIC)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
142. Device.manufacturer
Definition

The manufacturer name as reported in the IEEE 11073-10206 SystemInfo.

ShortManufacturer name from SystemInfo.system-manufacturer
Comments

The system manufacturer attribute is required by the IEEE 11073-10206 specification

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
144. Device.manufactureDate
Definition

The date and time when the device was manufactured.

ShortA production identifier that indicates the date when the device was made
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. Device.expirationDate
Definition

The date and time beyond which this device is no longer valid or should not be used (if applicable).

ShortA production identifier that indicates the date and time of expiry of this device (if applicable)
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. Device.lotNumber
Definition

Lot number assigned by the manufacturer.

ShortA production identifier that indicates the Lot number of manufacture
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
150. Device.serialNumber
Definition

The serial number assigned by the organization when the device was manufactured.

ShortA production identifier that indicates the Serial number assigned by the manufacturer
Comments

Alphanumeric Maximum 20. While a serial number is a type of identifier, in the context of devices for which a UDI is required, thus a serial number may be part of the production identifier, it is more informative to have the serial number as a dedicated attribute together with the other UDI production identifier. When the device is not subject to including the UDI (e.g., its presence and exchange is not mandated by local regulatory requirements or specific use case at hand), thus the concept of production identifiers is not relevant as a set, it remains helpful for consistency to still use Device.serialNumber rather than using Device.identifier with an appropriate type. Systems that do not realize an identifier is a serial number may place it in Device.identifier or if the identifier.system is known for the serial number, it may also be populated in the Device.identifier as a globally unique id_.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
152. Device.name
Definition

This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.

ShortThe name or names of the device as known to the manufacturer and/or patient
Control0..*
This element is affected by the following invariants: dev-1
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
154. Device.name.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
156. Device.name.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.name.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
158. Device.name.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.name.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
160. Device.name.value
Definition

The actual name that identifies the device.

ShortThe term that names the device
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesΣ
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
162. Device.name.type
Definition

Indicates the kind of name. RegisteredName | UserFriendlyName | PatientReportedName.

Shortregistered-name | user-friendly-name | patient-reported-name
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.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from Device Name Type
(extensible to http://terminology.hl7.org/ValueSet/device-nametype)

The type of name the device is referred by.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
164. Device.name.display
Definition

Indicates the default or preferred name to be displayed.

ShortThe preferred device name
Control0..1
This element is affected by the following invariants: dev-1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
166. Device.modelNumber
Definition

The model number as reported by the SystemInfo attribute.

ShortModel number from SystemInfo.model-number
Comments

The model number attribute is required by the IEEE 11073-10206 specification

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
168. Device.partNumber
Definition

The part number or catalog number of the device.

ShortThe part number or catalog number of the device
Comments

Alphanumeric Maximum 20.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. Device.category
Definition

Devices may be associated with one or more categories.

ShortIndicates a high-level grouping of the device
Control0..*
BindingFor example codes, see FHIR Device Category
(example to http://terminology.hl7.org/ValueSet/device-category)

Categories of medical devices.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. Device.type
Definition

The kind or type of device. A device instance may have more than one type - in which case those are the types that apply to the specific instance of the device.

ShortThe kind or type of device
Comments

Multiple device types are use when a device is categorized in more than one context – for example, hybrid devices in which the device is both of type gateway and sensor. Device.type relates DeviceDefinition.classification.type using the same binding enabling referencing.

Control1..*
BindingFor example codes, see DeviceType
(example to http://hl7.org/fhir/ValueSet/device-type|6.0.0-snapshot1)

Codes to identify medical devices.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.type. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
174. Device.type:PhdType
Slice NamePhdType
Definition

The kind or type of device. A device instance may have more than one type - in which case those are the types that apply to the specific instance of the device.

ShortIndicates the device is a PHD.
Comments

Multiple device types are use when a device is categorized in more than one context – for example, hybrid devices in which the device is both of type gateway and sensor. Device.type relates DeviceDefinition.classification.type using the same binding enabling referencing.

Control1..1
BindingFor example codes, see DeviceType
(example to http://hl7.org/fhir/ValueSet/device-type|6.0.0-snapshot1)

Codes to identify medical devices.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "65573"
    }
  ]
}
<type>
  <coding>
    <system value="urn:iso:std:iso:11073:10101"/>
    <code value="65573"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. Device.type:MainFunction
Slice NameMainFunction
Definition

The kind or type of device. A device instance may have more than one type - in which case those are the types that apply to the specific instance of the device.

ShortMDC profile code matching the PHD's main function.
Comments

Multiple device types are use when a device is categorized in more than one context – for example, hybrid devices in which the device is both of type gateway and sensor. Device.type relates DeviceDefinition.classification.type using the same binding enabling referencing.

Control0..1
BindingThe codes SHALL be taken from MDC Device Specialization codes
(required to http://hl7.org/fhir/uv/phd/ValueSet/DeviceTypes11073MDC)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. Device.deviceVersion
Definition

The actual design of the device or software version running on the device.

ShortA PHD may report firmware, hardware, software, internal protocol, nomenclature and ACOM versions.
Comments

There are several versions that are reported from a PHD. Firmware, Hardware, Protocol (internal, not IEEE 11073-10206), and Software versions come from the System Information object. The nomenclature and ACOM version comes from the ACOM base class. PHDs compliant to this IG report at least one of these versions. A separate version entry is needed for each of the versions reported by the PHD.

Control1..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.deviceVersion. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
180. Device.deviceVersion.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
182. Device.deviceVersion.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.deviceVersion.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
184. Device.deviceVersion.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.deviceVersion.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
186. Device.deviceVersion.type
Definition

The type of the device version, e.g. manufacturer, approved, internal.

ShortThe type of the device version, e.g. manufacturer, approved, internal
Control0..1
BindingFor example codes, see DeviceVersionType
(example to http://hl7.org/fhir/ValueSet/device-versiontype|6.0.0-snapshot1)

The type of version indicated for the device.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesΣ
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. Device.deviceVersion.component
Definition

The hardware or software module of the device to which the version applies.

ShortThe hardware or software module of the device to which the version applies
Comments

Note that the module of the device would not need to be tracked as a separate device, e.g., using different UDI, thus would typically involve one or more software modules. For example, a device may involve two software modules each on a different version.

Control0..1
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. Device.deviceVersion.installDate
Definition

The date the version was installed on the device.

ShortThe date the version was installed on the device
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
192. Device.deviceVersion.value
Definition

The version text.

ShortThe version text
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
194. Device.deviceVersion:MDCType
Slice NameMDCType
Definition

The actual design of the device or software version running on the device.

ShortRequired MDC device version type entry
Comments

The combination of type and component SHOULD be unique across all repetitions of version.

Control1..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
196. Device.deviceVersion:MDCType.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
198. Device.deviceVersion:MDCType.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.deviceVersion.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
200. Device.deviceVersion:MDCType.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.deviceVersion.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
202. Device.deviceVersion:MDCType.type
Definition

The type of the device version, e.g. manufacturer, approved, internal.

ShortThe type of the device version, e.g. manufacturer, approved, internal
Control0..1
BindingThe codes SHALL be taken from MDC Device Version Type codes
(required to http://hl7.org/fhir/uv/phd/ValueSet/MDCDeviceVersionTypes)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesΣ
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
204. Device.deviceVersion:MDCType.component
Definition

The hardware or software module of the device to which the version applies.

ShortThe hardware or software module of the device to which the version applies
Comments

Note that the module of the device would not need to be tracked as a separate device, e.g., using different UDI, thus would typically involve one or more software modules. For example, a device may involve two software modules each on a different version.

Control0..0
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
206. Device.deviceVersion:MDCType.installDate
Definition

The date the version was installed on the device.

ShortThe date the version was installed on the device
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
208. Device.deviceVersion:MDCType.value
Definition

The version text.

ShortThe version
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
210. Device.conformsTo
Definition

Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.

ShortIdentifies the standards, specifications, or formal guidances for the capabilities supported by the device
Control1..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.conformsTo. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ specification.coding
212. Device.conformsTo.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
214. Device.conformsTo.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.conformsTo.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
216. Device.conformsTo.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.conformsTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
218. Device.conformsTo.category
Definition

Describes the type of the standard, specification, or formal guidance.

ShortDescribes the common type of the standard, specification, or formal guidance. communication | performance | measurement
Control0..1
BindingFor example codes, see Device Specification Category
(example to http://terminology.hl7.org/ValueSet/device-specification-category)

The kind of standards used by the device.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
220. Device.conformsTo.specification
Definition

Code that identifies the specific standard, specification, protocol, formal guidance, regulation, legislation, or certification scheme to which the device adheres.

ShortIdentifies the standard, specification, or formal guidance that the device adheres to
Control1..1
BindingFor example codes, see DeviceSpecificationType
(example to http://hl7.org/fhir/ValueSet/device-specification-type|6.0.0-snapshot1)

The type of version indicated for the device.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
222. Device.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.

ShortSpecific form or variant of the standard
NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
224. Device.conformsTo:MDCType
Slice NameMDCType
Definition

The specialization(s) of the PHD. This element contains an entry for each supported specialization.

ShortThis element contains an entry for each supported specialization
Comments

There shall be a specialization entry for each specialization reported in the required System-Type-Spec-List attribute. A specialization in this case defines not only what type of measurements the PHD reports but that the PHD reports these measurements according to one of the 11073-114xx specialization standards. Most PHDs support only a single specialization such as the Blood Pressure or Pulse Oximeter specialization.

Control1..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
226. Device.conformsTo:MDCType.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
228. Device.conformsTo:MDCType.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.conformsTo.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
230. Device.conformsTo:MDCType.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.conformsTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
232. Device.conformsTo:MDCType.category
Definition

Describes the type of the standard, specification, or formal guidance.

ShortDescribes the common type of the standard, specification, or formal guidance. communication | performance | measurement
Control0..1
BindingFor example codes, see Device Specification Category
(example to http://terminology.hl7.org/ValueSet/device-specification-category)

The kind of standards used by the device.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
234. Device.conformsTo:MDCType.specification
Definition

Code that identifies the specific standard, specification, protocol, formal guidance, regulation, legislation, or certification scheme to which the device adheres.

ShortThe specialization standard supported by the PHD.
Comments

The IEEE 11073-10101 specialization code from a System-Type-Spec-List[i].type.

Control1..1
BindingFor example codes, see DeviceSpecificationType
(example to http://hl7.org/fhir/ValueSet/device-specification-type|6.0.0-snapshot1)

The type of version indicated for the device.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
236. Device.conformsTo:MDCType.specification.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
238. Device.conformsTo:MDCType.specification.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.conformsTo.specification.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
240. Device.conformsTo:MDCType.specification.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..*
BindingThe codes SHALL be taken from MDC Device Specialization codes
(required to http://hl7.org/fhir/uv/phd/ValueSet/DeviceTypes11073MDC)
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
242. Device.conformsTo:MDCType.specification.coding.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
244. Device.conformsTo:MDCType.specification.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.conformsTo.specification.coding.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
246. Device.conformsTo:MDCType.specification.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

ShortIdentity of the terminology system
Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
248. Device.conformsTo:MDCType.specification.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

ShortVersion of the system - if relevant
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
250. Device.conformsTo:MDCType.specification.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
252. Device.conformsTo:MDCType.specification.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

ShortRepresentation defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
254. Device.conformsTo:MDCType.specification.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

ShortIf this coding was chosen directly by the user
Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
256. Device.conformsTo:MDCType.specification.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
258. Device.conformsTo:MDCType.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.

ShortThe version of the specialization standard supported by the PHD from the System-Type-Spec-List[i].version
Comments

The version of the specialization comes from the System-Type-Spec-List specialization entry. If a PHD supports multiple versions of the same specialization a separate Device.specialization entry is needed where the systemType elements are repeated. If the PHD reports a generic specialization (using MDC_DEV_SPEC_PROFILE_HYDRA or MDC_DEV_SPEC_PROFILE_GENERIC), the version is the 11073-10206 version.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
260. Device.property
Definition

Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.

ShortInherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
262. Device.property.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
264. Device.property.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
266. Device.property.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
268. Device.property.type
Definition

Code that specifies the property, such as resolution, color, size, being represented.

ShortCode that specifies the property being represented
Control1..1
BindingFor example codes, see DevicePropertyType
(example to http://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1)

Device property type.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
270. Device.property.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Attachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
272. Device.property:timeSyncProperty
Slice NametimeSyncProperty
Definition

This element represents the time synchronization method used by the PHD. It is an MDC coded value.

ShortTime synchronization method
Comments

The clock set method is a required attribute in the IEEE 11073-10206 standard. It is also supported by Bluetooth Low Energy ETS and GHS specifications. Strictly speaking, the time synchronization method is not a property of the PHD but rather a property of the PHG. However, it is included here as it is a required attribute in the IEEE 11073-10206 standard and is often used by the PHG to determine how to set the time on the PHD. In most cases it reflects the time synchronization method used to set the PHG's clock and strictly speaking it should not be reported as a static device property, but as part of a coincident timestamp.

Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
274. Device.property:timeSyncProperty.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
276. Device.property:timeSyncProperty.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
278. Device.property:timeSyncProperty.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
280. Device.property:timeSyncProperty.type
Definition

Code that specifies the property, such as resolution, color, size, being represented.

ShortCode that specifies the property being represented
Control1..1
BindingFor example codes, see DevicePropertyType
(example to http://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1)

Device property type.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "68220"
    }
  ]
}
<type>
  <coding>
    <system value="urn:iso:std:iso:11073:10101"/>
    <code value="68220"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
282. Device.property:timeSyncProperty.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Attachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

284. Device.property:timeSyncProperty.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control0..1
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
286. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
288. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
290. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..*
BindingUnless not suitable, these codes SHALL be taken from MDC Time Synchronization Methods
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/MDCTimeSyncMethods)
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
292. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.coding.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
294. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x].coding.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
296. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

ShortIdentity of the terminology system
Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
298. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

ShortVersion of the system - if relevant
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
300. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
302. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

ShortRepresentation defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
304. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

ShortIf this coding was chosen directly by the user
Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
306. Device.property:timeSyncProperty.value[x]:valueCodeableConcept.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
314. Device.property:continuaCertProperty
Slice NamecontinuaCertProperty
Definition

This element represents a Continua certified interface that is supported by the PHD. It is an MDC coded value.

ShortContinua certified PHD interfaces (from IEEE 11073-20601)
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
316. Device.property:continuaCertProperty.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
318. Device.property:continuaCertProperty.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
320. Device.property:continuaCertProperty.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
322. Device.property:continuaCertProperty.type
Definition

Code that specifies the property, such as resolution, color, size, being represented.

ShortCode that specifies the property being represented
Control1..1
BindingFor example codes, see DevicePropertyType
(example to http://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1)

Device property type.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "532353"
    }
  ]
}
<type>
  <coding>
    <system value="urn:iso:std:iso:11073:10101"/>
    <code value="532353"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
324. Device.property:continuaCertProperty.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Attachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

326. Device.property:continuaCertProperty.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Continua PHD-PHG Device Interfaces ValueSet
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/ContinuaPHDInterfaces)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
328. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
330. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
332. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
334. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.coding.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
336. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x].coding.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
338. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

ShortIdentity of the terminology system
Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
340. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

ShortVersion of the system - if relevant
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
342. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
344. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

ShortRepresentation defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
346. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

ShortIf this coding was chosen directly by the user
Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
348. Device.property:continuaCertProperty.value[x]:valueCodeableConcept.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
356. Device.property:clockBitProperty
Slice NameclockBitProperty
Definition

For each Boolean clock capability reported by a PHD a property element is used.

ShortBoolean Properties reported by the Clock
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
358. Device.property:clockBitProperty.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
360. Device.property:clockBitProperty.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
362. Device.property:clockBitProperty.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
364. Device.property:clockBitProperty.type
Definition

One of the capabilities of the clock as reported by the PHD.

ShortTells what the clock capability item is
Control1..1
BindingThe codes SHALL be taken from ANS1ToHL7 codes defined for Boolean Clock attributes
(required to http://hl7.org/fhir/uv/phd/ValueSet/ASN1ClockBits)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
366. Device.property:clockBitProperty.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Attachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

368. Device.property:clockBitProperty.value[x]:valueBoolean
Slice NamevalueBoolean
Definition

The value of the clock capability item as reported by the PHD.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control0..1
Typeboolean
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
370. Device.property:clockBitProperty.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control0..1
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
372. Device.property:clockBitProperty.value[x]:valueCodeableConcept.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
374. Device.property:clockBitProperty.value[x]:valueCodeableConcept.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
376. Device.property:clockBitProperty.value[x]:valueCodeableConcept.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
378. Device.property:clockBitProperty.value[x]:valueCodeableConcept.coding.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
380. Device.property:clockBitProperty.value[x]:valueCodeableConcept.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x].coding.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
382. Device.property:clockBitProperty.value[x]:valueCodeableConcept.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

ShortIdentity of the terminology system
Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
384. Device.property:clockBitProperty.value[x]:valueCodeableConcept.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

ShortVersion of the system - if relevant
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
386. Device.property:clockBitProperty.value[x]:valueCodeableConcept.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
388. Device.property:clockBitProperty.value[x]:valueCodeableConcept.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

ShortRepresentation defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
390. Device.property:clockBitProperty.value[x]:valueCodeableConcept.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

ShortIf this coding was chosen directly by the user
Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
392. Device.property:clockBitProperty.value[x]:valueCodeableConcept.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
399. Device.property:isRegulatedProperty
Slice NameisRegulatedProperty
Definition

This element represents the regulatory status of the PHD.

ShortRegulatory status of the PHD
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
401. Device.property:isRegulatedProperty.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
403. Device.property:isRegulatedProperty.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
405. Device.property:isRegulatedProperty.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
407. Device.property:isRegulatedProperty.type
Definition

This element represents the negated regulatory status of the PHD.

ShortNegated regulatory status of the PHD
Control1..1
BindingFor example codes, see DevicePropertyType
(example to http://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1)

Device property type.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ASN1ToHL7",
      "code" : "532354.0"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ASN1ToHL7"/>
    <code value="532354.0"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
409. Device.property:isRegulatedProperty.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Attachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

411. Device.property:isRegulatedProperty.value[x]:valueBoolean
Slice NamevalueBoolean
Definition

If true, the device is not regulated. If false, the device is regulated.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control0..1
Typeboolean
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
419. Device.property:clockResolutionProperty
Slice NameclockResolutionProperty
Definition

The clock resolution as reported by the PHD in microseconds.

ShortClock Resolution as reported by the PHD
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
421. Device.property:clockResolutionProperty.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
423. Device.property:clockResolutionProperty.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
425. Device.property:clockResolutionProperty.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
427. Device.property:clockResolutionProperty.type
Definition

The resolution of the clock as reported by the PHD.

ShortTells what the clock resolution type is
Control1..1
BindingThe codes SHALL be taken from MDC Clock Resolution Types
(required to http://hl7.org/fhir/uv/phd/ValueSet/MDCClockResolutionTypes)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
429. Device.property:clockResolutionProperty.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeQuantity
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
431. Device.property:clockResolutionProperty.value[x]:valueQuantity
Slice NamevalueQuantity
Definition

The value. All the time fields are scaled to microseconds

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeQuantity
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
433. Device.property:clockResolutionProperty.value[x]:valueQuantity.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
435. Device.property:clockResolutionProperty.value[x]:valueQuantity.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
437. Device.property:clockResolutionProperty.value[x]:valueQuantity.value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

ShortNumerical value (with implicit precision)
Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
439. Device.property:clockResolutionProperty.value[x]:valueQuantity.comparator
Definition

How the value should be understood and represented - whether the actual value is greater than, less than, or approximately equal to the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Short< | <= | >= | > | ~ | ad - how to understand the value
Control0..1
BindingThe codes SHALL be taken from QuantityComparator
(required to http://hl7.org/fhir/ValueSet/quantity-comparator|6.0.0-snapshot1)

How the Quantity should be understood and represented.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning if MissingIf there is no comparator, then there is no modification of the value
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
441. Device.property:clockResolutionProperty.value[x]:valueQuantity.unit
Definition

A human-readable form of the unit.

ShortUnit representation
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
443. Device.property:clockResolutionProperty.value[x]:valueQuantity.system
Definition

The identification of the system that provides the coded form of the unit.

ShortSystem that defines coded unit form
Control1..1
This element is affected by the following invariants: qty-3
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to know the system that defines the coded form of the unit.

Pattern Value
{
  "system" : "http://unitsofmeasure.org"
}
<system value="http://unitsofmeasure.org"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
445. Device.property:clockResolutionProperty.value[x]:valueQuantity.code
Definition

The UCUM code for microseconds is 'us'.

ShortCoded form of the unit
Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Control0..1
This element is affected by the following invariants: qty-3
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Pattern Value
{
  "code" : "us"
}
<code value="us"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
447. Device.property:timeSyncAccuracyProperty
Slice NametimeSyncAccuracyProperty
Definition

The time synchronization accuracy as reported by the PHD in microseconds.

ShortTime Synchronization Accuracy as reported by the PHD
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
449. Device.property:timeSyncAccuracyProperty.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
451. Device.property:timeSyncAccuracyProperty.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
453. Device.property:timeSyncAccuracyProperty.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
455. Device.property:timeSyncAccuracyProperty.type
Definition

The time synchronization accuracy of the clock as reported by the PHD.

ShortTells what the time synchronization accuracy is
Control1..1
BindingFor example codes, see DevicePropertyType
(example to http://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1)

Device property type.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "urn:iso:std:iso:11073:10101",
      "code" : "68221"
    }
  ]
}
<type>
  <coding>
    <system value="urn:iso:std:iso:11073:10101"/>
    <code value="68221"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
457. Device.property:timeSyncAccuracyProperty.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeQuantity
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
459. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity
Slice NamevalueQuantity
Definition

The value. All the time fields are scaled to microseconds

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeQuantity
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
461. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
463. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
465. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity.value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

ShortNumerical value (with implicit precision)
Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
467. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity.comparator
Definition

How the value should be understood and represented - whether the actual value is greater than, less than, or approximately equal to the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Short< | <= | >= | > | ~ | ad - how to understand the value
Control0..1
BindingThe codes SHALL be taken from QuantityComparator
(required to http://hl7.org/fhir/ValueSet/quantity-comparator|6.0.0-snapshot1)

How the Quantity should be understood and represented.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning if MissingIf there is no comparator, then there is no modification of the value
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
469. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity.unit
Definition

A human-readable form of the unit.

ShortUnit representation
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
471. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity.system
Definition

The identification of the system that provides the coded form of the unit.

ShortSystem that defines coded unit form
Control1..1
This element is affected by the following invariants: qty-3
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to know the system that defines the coded form of the unit.

Pattern Value
{
  "system" : "http://unitsofmeasure.org"
}
<system value="http://unitsofmeasure.org"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
473. Device.property:timeSyncAccuracyProperty.value[x]:valueQuantity.code
Definition

The UCUM code for microseconds is 'us'.

ShortCoded form of the unit
Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Control0..1
This element is affected by the following invariants: qty-3
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Pattern Value
{
  "code" : "us"
}
<code value="us"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
475. Device.property:USB-VID-PID
Slice NameUSB-VID-PID
Definition

The USB Vendor and Product ID as reported by the PHD.

ShortUSB Vendor and Product ID
Comments

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
477. Device.property:USB-VID-PID.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
479. Device.property:USB-VID-PID.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
481. Device.property:USB-VID-PID.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
483. Device.property:USB-VID-PID.type
Definition

The USB Vendor and Product ID as reported by the PHD.

ShortUSB Vendor and Product ID
Control1..1
BindingFor example codes, see DevicePropertyType
(example to http://hl7.org/fhir/ValueSet/device-property-type|6.0.0-snapshot1)

Device property type.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers",
      "code" : "USB"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/ContinuaDeviceIdentifiers"/>
    <code value="USB"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
485. Device.property:USB-VID-PID.value[x]
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
487. Device.property:USB-VID-PID.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

The value of the property specified by the associated property.type code.

ShortValue of the property
Comments

The text element in CodeableConcept.text 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 string choice type is used for descriptive properties, or instructions.

Control1..1
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
489. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
491. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
493. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
495. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.coding.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
497. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.property.value[x].coding.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
499. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.coding.system
Definition

The USB Vendor and Product ID naming system id is http://hl7.org/fhir/sid/usb-vid-pid, but that cannot be used here as this is not a code system in FHIR.

ShortUSB Vendor and Product ID code system
Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
501. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

ShortVersion of the system - if relevant
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
503. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
505. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

ShortRepresentation defined by the system
Control0..1
This element is affected by the following invariants: cod-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
507. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

ShortIf this coding was chosen directly by the user
Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
509. Device.property:USB-VID-PID.value[x]:valueCodeableConcept.text
Definition

The USB Vendor and Product ID as reported by the PHD in the form of a coded string such as '1234:56AB'.

ShortPlain text representation of the concept
Comments

The USB Vendor and Product ID is not a required attribute in the IEEE 11073-10206 standard but is often reported by PHDs that support USB transport.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
511. Device.additive
Definition

Material added to a container device (typically used in specimen collection or initial processing). The material may be added by the device manufacturer or by a different party subsequent to manufacturing.

ShortMaterial added to a container device
Comments

A Procedure can be used to document details of the addition of a substance to the device.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
513. Device.additive.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
515. Device.additive.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.additive.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
517. Device.additive.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Device.additive.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
519. Device.additive.type
Definition

The type of the substance added to the container. This is represented as a concept from a code system or described in a Substance or SubstanceDefinition resource.

ShortThe additive substance
Control1..1
BindingFor example codes, see SubstanceCode
(example to http://hl7.org/fhir/ValueSet/substance-code|6.0.0-snapshot1)

Device additive substance type codes.

TypeCodeableReference(SubstanceDefinition, Substance)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
521. Device.additive.quantity
Definition

The quantity of the additive substance in the container; may be volume, dimensions, or other appropriate measurements, depending on the container and additive substance type.

ShortQuantity of additive substance within container
Control0..1
TypeQuantity(SimpleQuantity)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
523. Device.contact
Definition

Contact details for an organization or a particular human that is responsible for the device.

ShortDetails for human/organization for support
Comments

used for troubleshooting etc.

Control0..*
TypeContactPoint
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
525. Device.location
Definition

The place where the device can be found.

ShortWhere the device is found
Control0..1
TypeReference(Location)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Device.location can be used to track device location.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
527. Device.note
Definition

Descriptive information, usage information or implantation information that is not captured in an existing element.

ShortDevice notes and comments
Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
529. Device.safety
Definition

Provides additional safety characteristics about a medical device. For example devices containing latex.

ShortSafety Characteristics of Device
Control0..*
BindingFor example codes, see DeviceSafety
(example to http://hl7.org/fhir/ValueSet/device-safety|6.0.0-snapshot1)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
531. Device.parent
Definition

The higher level or encompassing device that this device is a logical part of.

ShortNo reference to a parent device in PHD. PHDs are not part of a device hierarchy.
Comments

For example a vital signs monitor (parent) where three separate modules can be plugged into such as interchangeable blood pressure, oximeter, temperature modules. These modules are represented as devices with the .parent valued to the vital signs monitor when plugged in.

Control0..0
TypeReference(Device)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))