DocumentReference

ITK-Device-1

ITK-Device-1

Device
Definition
Control 0..*
Type Device
Comments
Device.id
Definition

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

Control 0..1 ?
Type Id
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

Device.meta
Definition

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

Control 0..1 ?
Type Meta
Comments
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.

Control 0..1 ?
Type Uri
Is Modifier True
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 as much as possible.

Device.language
Definition

The base language in which the resource is written.

Control 0..1 ?
Binding

A human language.

The codes SHALL be taken from http://tools.ietf.org/html/bcp47

Type Code
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).

Device.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control 0..1 ?
Type Narrative
Aliases narrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Device.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control 0..*
Type Resource
Aliases inline resources, anonymous resources, contained 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.

Device.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, 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.

Control 0..* ?
Type Extension
Aliases extensions, user content
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.

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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control 0..* ?
Type Extension
Is Modifier True
Aliases extensions, user content
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.

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.

Control 0..* ?
Type Identifier
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.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

Device.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control 0..* ?
Type Extension
Aliases extensions, user content
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.

Device.identifier.value
Definition
Control 1..*
Comments
Device.identifier.assigner
Definition
Control 0..*
Type https://fhir.hl7.org.uk/StructureDefinition/CareConnect-Organization-1
Comments
Device.identifier.assigner.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

Device.identifier.assigner.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control 0..* ?
Type Extension
Aliases extensions, user content
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.

Device.identifier.assigner.reference
Definition
Control 1..*
Comments
Device.identifier.assigner.display
Definition

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

Control 0..1 ?
Type String
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
Control 0..*
Binding

The codes SHOULD be taken from https://fhir.nhs.uk/ValueSet/DeviceType-1

; other codes may be used where these codes are not suitable
Comments
Device.type.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

Device.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control 0..* ?
Type Extension
Aliases extensions, user content
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.

Device.type.coding
Definition
Control 0..*
Comments
Device.type.coding.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

Device.type.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control 0..* ?
Type Extension
Aliases extensions, user content
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.

Device.type.coding.system
Definition
Control 1..*
Comments
Device.type.coding.code
Definition
Control 1..*
Comments
Device.type.coding.display
Definition
Control 1..*
Comments
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).

Control 0..1 ?
Type Boolean
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.note
Definition

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

Control 0..* ?
Type Annotation
Comments

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

Device.note.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

Device.note.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control 0..* ?
Type Extension
Aliases extensions, user content
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.

Device.note.author[x]
Definition

The individual responsible for making the annotation.

Control 0..1 ?
Type Choice of:
Comments
Device.note.time
Definition

Indicates when this particular annotation was made.

Control 0..1 ?
Type DateTime
Comments
Device.note.text
Definition

The text of the annotation.

Control 1..1 ?
Type String
Comments

Note that FHIR strings may not exceed 1MB in size

Device.status
Definition

Status of the Device availability.

Control 0..1 ?
Binding

The availability status of the device.

The codes SHALL be taken from http://hl7.org/fhir/DSTU2/valueset-devicestatus.html

Type Code
Is Modifier True
Comments

Note that FHIR strings may not exceed 1MB in size

Device.manufacturer
Definition

A name of the manufacturer.

Control 0..1 ?
Type String
Comments

Note that FHIR strings may not exceed 1MB in size

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.

Control 0..1 ?
Type String
Comments

Note that FHIR strings may not exceed 1MB in size

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.

Control 0..1 ?
Type String
Comments

Note that FHIR strings may not exceed 1MB in size

Device.manufactureDate
Definition

The date and time when the device was manufactured.

Control 0..1 ?
Type DateTime
Comments
Device.expiry
Definition

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

Control 0..1 ?
Type DateTime
Comments
Device.lotNumber
Definition

Lot number assigned by the manufacturer.

Control 0..1 ?
Type String
Comments

Alphanumeric Maximum 20.

Device.owner
Definition
Control 0..*
Type https://fhir.hl7.org.uk/StructureDefinition/CareConnect-Organization-1
Comments
Device.owner.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

Device.owner.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control 0..* ?
Type Extension
Aliases extensions, user content
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.

Device.owner.reference
Definition
Control 1..*
Comments
Device.owner.display
Definition
Control 0..*
Comments
Device.location
Definition
Control 0..*
Type https://fhir.hl7.org.uk/StructureDefinition/CareConnect-Location-1
Comments
Device.location.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

Device.location.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control 0..* ?
Type Extension
Aliases extensions, user content
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.

Device.location.reference
Definition
Control 1..*
Comments
Device.location.display
Definition

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

Control 0..1 ?
Type String
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
Control 0..*
Type https://fhir.hl7.org.uk/StructureDefinition/CareConnect-Patient-1
Comments
Device.patient.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

Device.patient.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control 0..* ?
Type Extension
Aliases extensions, user content
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.

Device.patient.reference
Definition
Control 1..*
Comments
Device.patient.display
Definition

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

Control 0..1 ?
Type String
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.

Control 0..* ?
Type ContactPoint
Comments

used for troubleshooting etc.

Device.contact.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

Device.contact.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control 0..* ?
Type Extension
Aliases extensions, user content
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.

Device.contact.system
Definition
Control 1..*
Comments
Device.contact.value
Definition
Control 1..*
Comments
Device.contact.use
Definition

Identifies the purpose for the contact point.

Control 0..1 ?
Binding

Use of contact point

The codes SHALL be taken from http://hl7.org/fhir/DSTU2/valueset-contact-point-use.html

Type Code
Is Modifier True
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.

Control 0..1 ?
Type PositiveInt
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.

Control 0..1 ?
Type Period
Comments

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.

Device.contact.period.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

Device.contact.period.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control 0..* ?
Type Extension
Aliases extensions, user content
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.

Device.contact.period.start
Definition

The start of the period. The boundary is inclusive.

Control 0..1 ?
Type DateTime
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.

Control 0..1 ?
Type DateTime
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.

Control 0..1 ?
Type Uri
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.