Diagnostic Data Services

DDS-Report-Device-1-0

DDS-Report-Device-1-0

Device
Definition

This resource identifies an instance of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices includes durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.

Control0..*
TypeDevice
Comments
Device.identifier
Definition

Unique instance identifiers assigned to a device by organizations like manufacturers or owners. If the identifier identifies the type of device, Device.type should be used.

Control0..*
TypeIdentifier
Comments

Often fixed to the device as a barcode and may include names given to the device in local usage. Note that some of the barcodes affixed to the device identify its type, not its instance. For the FDA mandated Unique Device Identifier (UDI) use the Device.udi element.

Device.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use
TypeCode
Is ModifierTrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Device.identifier.type
Definition

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

Control0..1
BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/identifier-type
TypeCodeableConcept
Requirements

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

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.

Device.identifier.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

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 labelled as UserSelected = true.

Device.identifier.type.coding.system
Definition

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

Control1..1
TypeUri
Requirements

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

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 de-reference to some definition that establish the system clearly and unambiguously.

Examplehttp://hl7.org/fhir/ValueSet/identifier-type
Device.identifier.type.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.

Control0..1
TypeString
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.

Device.identifier.type.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).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
ExampleSNO
Device.identifier.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1
TypeString
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
ExampleSerial Number
Device.identifier.type.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
TypeBoolean
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.

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.

Device.identifier.type.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.

Control0..1
TypeString
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.

Comments

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

Device.identifier.system
Definition

Establishes the namespace in which set of possible id values is unique.

Control1..1
TypeUri
Requirements

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

Comments
Examplehttp://acme.com/devices/pacemakers/octane/serial
Device.identifier.value
Definition

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

Control1..1
TypeString
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.

Example1234-5678-90AB-CDEF
Device.identifier.period
Definition

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

Control0..1
TypePeriod
Comments
Device.identifier.period.start
Definition

The start of the period. The boundary is inclusive.

Control1..1 ?
TypeDateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Device.identifier.period.end
Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control0..1 ?
TypeDateTime
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Device.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeOrganization
Comments

The reference may be just a text description of the assigner.

Device.identifier.assigner.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 ?
TypeString
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Device.identifier.assigner.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
TypeString
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Device.type
Definition

Code or identifier to identify a kind of device.

Control1..1
BindingDefines the nature of the device and the kind of functionality/services/behavior that may be expected from it.
The codes SHOULD be taken from http://acme.com/devices; other codes may be used where these codes are not suitable
TypeCodeableConcept
Comments

For the FDA mandated Unique Device Identifier (UDI) use the Device.udi element.

Device.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

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 labelled as UserSelected = true.

Device.type.coding.system
Definition

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

Control1..1
TypeUri
Requirements

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

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 de-reference to some definition that establish the system clearly and unambiguously.

Examplehttp://acme.com/devices
Device.type.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.

Control0..1
TypeString
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.

Device.type.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).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
Exampleoctane2014
Device.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1
TypeString
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
ExamplePerformance pace maker for high octane patients
Device.type.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
TypeBoolean
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.

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.

Device.type.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.

Control0..1
TypeString
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.

Comments

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

Device.note
Definition

Descriptive information, usage information or implantation information that is not captured in an existing element.

Control0..*
TypeAnnotation
Comments
Device.note.author[x]
Definition

The individual responsible for making the annotation.

Control0..1
TypeChoice of:
Comments
Device.note.time
Definition

Indicates when this particular annotation was made.

Control0..1
TypeDateTime
Comments
Device.note.text
Definition

The text of the annotation.

Control1..1
TypeString
Comments
Device.status
Definition

Status of the Device availability.

Control0..1
BindingThe availability status of the device.
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/devicestatus
TypeCode
Is ModifierTrue
Comments
Device.manufacturer
Definition

A name of the manufacturer.

Control0..1
TypeString
Comments
ExampleAcme Devices, Inc
Device.model
Definition

The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.

Control0..1
TypeString
Comments
ExamplePM/Octane 2014
Device.version
Definition

The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.

Control0..1
TypeString
Comments
Device.manufactureDate
Definition

The date and time when the device was manufactured.

Control0..1
TypeDateTime
Comments
Device.expiry
Definition

The date and time beyond which this device is no longer valid or should not be used (if applicable).

Control0..1
TypeDateTime
Comments
Device.udi
Definition

United States Food and Drug Administration mandated Unique Device Identifier (UDI). Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm.

Control0..1
TypeString
Comments

The unique identifier may identify an instance of a device uniquely, or it may only identify the type of the device. A portion of the UDI - the DI part - can be extracted from the UDI when required, and used to look up information about the device through the GUDID.

Device.lotNumber
Definition

Lot number assigned by the manufacturer.

Control0..1
TypeString
Comments

Alphanumeric Maximum 20.

Example1234-5678
Device.owner
Definition

An organization that is responsible for the provision and ongoing maintenance of the device.

Control0..1
TypeOrganization
Comments
Device.owner.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 ?
TypeString
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Device.owner.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
TypeString
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Device.location
Definition

The place where the device can be found.

Control0..1
TypeLocation
Comments
Device.location.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 ?
TypeString
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Device.location.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
TypeString
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Device.patient
Definition

Patient information, if the resource is affixed to a person.

Control0..1
TypePatient
Comments
Device.patient.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 ?
TypeString
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Device.patient.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
TypeString
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Device.contact
Definition

Contact details for an organization or a particular human that is responsible for the device.

Control0..*
TypeContactPoint
Comments

used for troubleshooting etc.

Device.contact.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Control1..1 ?
BindingTelecommunications form for contact point
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-system
TypeCode
Comments
Examplephone
Device.contact.value
Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Control1..1
TypeString
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Exampleext 4352
Device.contact.use
Definition

Identifies the purpose for the contact point.

Control0..1
BindingUse of contact point
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-use
TypeCode
Is ModifierTrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Device.contact.rank
Definition

Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.

Control0..1
TypePositiveInt
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Device.contact.period
Definition

Time period when the contact point was/is in use.

Control0..1
TypePeriod
Comments
Device.contact.period.start
Definition

The start of the period. The boundary is inclusive.

Control1..1 ?
TypeDateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Device.contact.period.end
Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control0..1 ?
TypeDateTime
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Device.url
Definition

A network address on which the device may be contacted directly.

Control0..1
TypeUri
Comments

If the device is running a FHIR server, the network address should be the root URL from which a conformance statement may be retrieved.