Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_Device_R3

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Device Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_Device_R3

This cross-version profile allows R5 Device content to be represented via FHIR STU3 Device resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..1 (Complex) R5: The reference to the definition for the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.definition
.... extension:availabilityStatus 0..1 CodeableConcept R5: lost | damaged | destroyed | available (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.availabilityStatus
Binding: R5DeviceAvailabilityStatusForR3 (0.1.0) (extensible): The availability status reason of the device.
.... extension:biologicalSourceEvent 0..1 Identifier R5: An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.biologicalSourceEvent
.... extension:serialNumber 0..1 string R5: Serial number assigned by the manufacturer (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.serialNumber
.... extension:partNumber 0..1 string R5: The part number or catalog number of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.partNumber
.... extension:category 0..* CodeableConcept R5: Indicates a high-level grouping of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.category
Binding: R5DeviceCategoryForR3 (0.1.0) (example): Categories of medical devices.
.... extension:conformsTo 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/device-conformsTo]] R5: Identifies the standards, specifications, or formal guidances for the capabilities supported by the device (new)
URL: http://hl7.org/fhir/StructureDefinition/device-conformsTo
.... extension:property 0..* (Complex) R5: Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.property
.... extension:mode 0..1 CodeableConcept R5: The designated condition for performing a task (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.mode
Binding: R5DeviceOperationModeForR3 (0.1.0) (example): Operational mode of a device.
.... extension:cycle 0..1 Count R5: The series of occurrences that repeats during the operation of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.cycle
.... extension:duration 0..1 Duration R5: A measurement of time during the device's operation (e.g., days, hours, mins, etc.) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.duration
.... extension:endpoint 0..* Reference(Cross-version Profile for R5.Endpoint for use in FHIR STU3(0.1.0) | Endpoint) R5: Technical endpoints providing access to electronic services provided by the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.endpoint
.... extension:gateway 0..* (Complex) R5: Linked device acting as a communication/data collector, translator or controller (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.gateway
.... extension:parent 0..1 Reference(Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device) R5: The higher level or encompassing device that this device is a logical part of (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.parent
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.status Base required FHIRDeviceStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Device If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Device If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Device If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Device If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..1 (Complex) R5: The reference to the definition for the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.definition
.... extension:availabilityStatus 0..1 CodeableConcept R5: lost | damaged | destroyed | available (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.availabilityStatus
Binding: R5DeviceAvailabilityStatusForR3 (0.1.0) (extensible): The availability status reason of the device.
.... extension:biologicalSourceEvent 0..1 Identifier R5: An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.biologicalSourceEvent
.... extension:serialNumber 0..1 string R5: Serial number assigned by the manufacturer (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.serialNumber
.... extension:partNumber 0..1 string R5: The part number or catalog number of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.partNumber
.... extension:category 0..* CodeableConcept R5: Indicates a high-level grouping of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.category
Binding: R5DeviceCategoryForR3 (0.1.0) (example): Categories of medical devices.
.... extension:conformsTo 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/device-conformsTo]] R5: Identifies the standards, specifications, or formal guidances for the capabilities supported by the device (new)
URL: http://hl7.org/fhir/StructureDefinition/device-conformsTo
.... extension:property 0..* (Complex) R5: Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.property
.... extension:mode 0..1 CodeableConcept R5: The designated condition for performing a task (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.mode
Binding: R5DeviceOperationModeForR3 (0.1.0) (example): Operational mode of a device.
.... extension:cycle 0..1 Count R5: The series of occurrences that repeats during the operation of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.cycle
.... extension:duration 0..1 Duration R5: A measurement of time during the device's operation (e.g., days, hours, mins, etc.) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.duration
.... extension:endpoint 0..* Reference(Cross-version Profile for R5.Endpoint for use in FHIR STU3(0.1.0) | Endpoint) R5: Technical endpoints providing access to electronic services provided by the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.endpoint
.... extension:gateway 0..* (Complex) R5: Linked device acting as a communication/data collector, translator or controller (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.gateway
.... extension:parent 0..1 Reference(Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device) R5: The higher level or encompassing device that this device is a logical part of (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.parent
... udi
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:displayName 0..1 string R5: The name used to display by default when the device is referenced additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.displayName
..... extension:value 1..1 string R5: The term that names the device additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.name.value
..... extension:type 1..1 code R5: registered-name | user-friendly-name | patient-reported-name (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.name.type
Binding: R5DeviceNametypeForR3 (0.1.0) (required): The type of name the device is referred by.
.... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... modifierExtension:display 0..1 boolean R5: The preferred device name additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.name.display
.... entryType
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:entryType 0..1 code R5: barcode | rfid | manual | card | self-reported | electronic-transmission | unknown additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.udiCarrier.entryType
Binding: R5UdiEntryTypeForR3 (0.1.0) (required): Codes to identify how UDI data was entered.
... version
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:type 0..1 CodeableConcept R5: The type of the device version, e.g. manufacturer, approved, internal (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.type
..... extension:component 0..1 Identifier R5: The hardware or software module of the device to which the version applies (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.component
..... extension:installDate 0..1 dateTime R5: The date the version was installed on the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.installDate
..... extension:value 1..1 string R5: The version text (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.value
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:owner 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: owner additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... location
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Where the device is found additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..1 (Complex) R5: The reference to the definition for the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.definition
.... extension:availabilityStatus 0..1 CodeableConcept R5: lost | damaged | destroyed | available (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.availabilityStatus
Binding: R5DeviceAvailabilityStatusForR3 (0.1.0) (extensible): The availability status reason of the device.
.... extension:biologicalSourceEvent 0..1 Identifier R5: An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.biologicalSourceEvent
.... extension:serialNumber 0..1 string R5: Serial number assigned by the manufacturer (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.serialNumber
.... extension:partNumber 0..1 string R5: The part number or catalog number of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.partNumber
.... extension:category 0..* CodeableConcept R5: Indicates a high-level grouping of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.category
Binding: R5DeviceCategoryForR3 (0.1.0) (example): Categories of medical devices.
.... extension:conformsTo 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/device-conformsTo]] R5: Identifies the standards, specifications, or formal guidances for the capabilities supported by the device (new)
URL: http://hl7.org/fhir/StructureDefinition/device-conformsTo
.... extension:property 0..* (Complex) R5: Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.property
.... extension:mode 0..1 CodeableConcept R5: The designated condition for performing a task (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.mode
Binding: R5DeviceOperationModeForR3 (0.1.0) (example): Operational mode of a device.
.... extension:cycle 0..1 Count R5: The series of occurrences that repeats during the operation of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.cycle
.... extension:duration 0..1 Duration R5: A measurement of time during the device's operation (e.g., days, hours, mins, etc.) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.duration
.... extension:endpoint 0..* Reference(Cross-version Profile for R5.Endpoint for use in FHIR STU3(0.1.0) | Endpoint) R5: Technical endpoints providing access to electronic services provided by the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.endpoint
.... extension:gateway 0..* (Complex) R5: Linked device acting as a communication/data collector, translator or controller (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.gateway
.... extension:parent 0..1 Reference(Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device) R5: The higher level or encompassing device that this device is a logical part of (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.parent
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Instance identifier
... udi Σ 0..1 BackboneElement Unique Device Identifier (UDI) Barcode string
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:displayName 0..1 string R5: The name used to display by default when the device is referenced additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.displayName
..... extension:value 1..1 string R5: The term that names the device additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.name.value
..... extension:type 1..1 code R5: registered-name | user-friendly-name | patient-reported-name (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.name.type
Binding: R5DeviceNametypeForR3 (0.1.0) (required): The type of name the device is referred by.
.... Slices for modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Open by value:url
..... modifierExtension:display ?!Σ 0..1 boolean R5: The preferred device name additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.name.display
.... deviceIdentifier Σ 0..1 string Mandatory fixed portion of UDI
.... name Σ 0..1 string Device Name as appears on UDI label
.... jurisdiction 0..1 uri Regional UDI authority
.... carrierHRF Σ 0..1 string UDI Human Readable Barcode String
.... carrierAIDC Σ 0..1 base64Binary UDI Machine Readable Barcode String
.... issuer 0..1 uri UDI Issuing Organization
.... entryType 0..1 code barcode | rfid | manual +
Binding: UDIEntryType . (required): Codes to identify how UDI data was entered
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:entryType 0..1 code R5: barcode | rfid | manual | card | self-reported | electronic-transmission | unknown additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.udiCarrier.entryType
Binding: R5UdiEntryTypeForR3 (0.1.0) (required): Codes to identify how UDI data was entered.
..... value 0..1 code Primitive value for code
... status ?!Σ 0..1 code active | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.
... type 0..1 CodeableConcept What kind of device this is
Binding: FHIR Device Types (example): Codes to identify medical devices
... lotNumber 0..1 string Lot number of manufacture
... manufacturer 0..1 string Name of device manufacturer
... manufactureDate 0..1 dateTime Date when the device was made
... expirationDate 0..1 dateTime Date and time of expiry of this device (if applicable)
... model 0..1 string Model id assigned by the manufacturer
... version 0..1 string Version number (i.e. software)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:type 0..1 CodeableConcept R5: The type of the device version, e.g. manufacturer, approved, internal (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.type
..... extension:component 0..1 Identifier R5: The hardware or software module of the device to which the version applies (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.component
..... extension:installDate 0..1 dateTime R5: The date the version was installed on the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.installDate
..... extension:value 1..1 string R5: The version text (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.value
.... value 0..1 string Primitive value for string
Max Length:1048576
... patient 0..1 Reference(Patient) Patient to whom Device is affixed
... owner 0..1 Reference(Organization) Organization responsible for device
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:owner 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: owner additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... contact 0..* ContactPoint Details for human/organization for support
... location 0..1 Reference(Location) Where the resource is found
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Where the device is found additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... url 0..1 uri Network address to contact device
... note 0..* Annotation Device notes and comments
... safety Σ 0..* CodeableConcept Safety Characteristics of Device
Binding: DeviceSafety (example): Codes used to identify medical devices safety characterics. These codes are derived in part from the United States Food and Drug Administration recommendations and are provided here as a suggestive example.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
Device.udi.entryType Base required UDIEntryType . 📍3.0.2 tx.fhir.org
Device.status Base required FHIRDeviceStatus 📍3.0.2 FHIR Std.
Device.type Base example FHIR Device Types 📍3.0.2 FHIR Std.
Device.safety Base example DeviceSafety 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Device If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Device If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Device If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Device If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Device

Summary

Mandatory: 0 element(4 nested mandatory elements)

Extensions

This structure refers to these extensions:

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..1 (Complex) R5: The reference to the definition for the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.definition
.... extension:availabilityStatus 0..1 CodeableConcept R5: lost | damaged | destroyed | available (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.availabilityStatus
Binding: R5DeviceAvailabilityStatusForR3 (0.1.0) (extensible): The availability status reason of the device.
.... extension:biologicalSourceEvent 0..1 Identifier R5: An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.biologicalSourceEvent
.... extension:serialNumber 0..1 string R5: Serial number assigned by the manufacturer (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.serialNumber
.... extension:partNumber 0..1 string R5: The part number or catalog number of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.partNumber
.... extension:category 0..* CodeableConcept R5: Indicates a high-level grouping of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.category
Binding: R5DeviceCategoryForR3 (0.1.0) (example): Categories of medical devices.
.... extension:conformsTo 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/device-conformsTo]] R5: Identifies the standards, specifications, or formal guidances for the capabilities supported by the device (new)
URL: http://hl7.org/fhir/StructureDefinition/device-conformsTo
.... extension:property 0..* (Complex) R5: Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.property
.... extension:mode 0..1 CodeableConcept R5: The designated condition for performing a task (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.mode
Binding: R5DeviceOperationModeForR3 (0.1.0) (example): Operational mode of a device.
.... extension:cycle 0..1 Count R5: The series of occurrences that repeats during the operation of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.cycle
.... extension:duration 0..1 Duration R5: A measurement of time during the device's operation (e.g., days, hours, mins, etc.) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.duration
.... extension:endpoint 0..* Reference(Cross-version Profile for R5.Endpoint for use in FHIR STU3(0.1.0) | Endpoint) R5: Technical endpoints providing access to electronic services provided by the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.endpoint
.... extension:gateway 0..* (Complex) R5: Linked device acting as a communication/data collector, translator or controller (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.gateway
.... extension:parent 0..1 Reference(Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device) R5: The higher level or encompassing device that this device is a logical part of (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.parent
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.status Base required FHIRDeviceStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Device If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Device If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Device If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Device If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..1 (Complex) R5: The reference to the definition for the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.definition
.... extension:availabilityStatus 0..1 CodeableConcept R5: lost | damaged | destroyed | available (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.availabilityStatus
Binding: R5DeviceAvailabilityStatusForR3 (0.1.0) (extensible): The availability status reason of the device.
.... extension:biologicalSourceEvent 0..1 Identifier R5: An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.biologicalSourceEvent
.... extension:serialNumber 0..1 string R5: Serial number assigned by the manufacturer (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.serialNumber
.... extension:partNumber 0..1 string R5: The part number or catalog number of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.partNumber
.... extension:category 0..* CodeableConcept R5: Indicates a high-level grouping of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.category
Binding: R5DeviceCategoryForR3 (0.1.0) (example): Categories of medical devices.
.... extension:conformsTo 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/device-conformsTo]] R5: Identifies the standards, specifications, or formal guidances for the capabilities supported by the device (new)
URL: http://hl7.org/fhir/StructureDefinition/device-conformsTo
.... extension:property 0..* (Complex) R5: Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.property
.... extension:mode 0..1 CodeableConcept R5: The designated condition for performing a task (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.mode
Binding: R5DeviceOperationModeForR3 (0.1.0) (example): Operational mode of a device.
.... extension:cycle 0..1 Count R5: The series of occurrences that repeats during the operation of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.cycle
.... extension:duration 0..1 Duration R5: A measurement of time during the device's operation (e.g., days, hours, mins, etc.) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.duration
.... extension:endpoint 0..* Reference(Cross-version Profile for R5.Endpoint for use in FHIR STU3(0.1.0) | Endpoint) R5: Technical endpoints providing access to electronic services provided by the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.endpoint
.... extension:gateway 0..* (Complex) R5: Linked device acting as a communication/data collector, translator or controller (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.gateway
.... extension:parent 0..1 Reference(Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device) R5: The higher level or encompassing device that this device is a logical part of (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.parent
... udi
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:displayName 0..1 string R5: The name used to display by default when the device is referenced additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.displayName
..... extension:value 1..1 string R5: The term that names the device additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.name.value
..... extension:type 1..1 code R5: registered-name | user-friendly-name | patient-reported-name (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.name.type
Binding: R5DeviceNametypeForR3 (0.1.0) (required): The type of name the device is referred by.
.... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... modifierExtension:display 0..1 boolean R5: The preferred device name additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.name.display
.... entryType
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:entryType 0..1 code R5: barcode | rfid | manual | card | self-reported | electronic-transmission | unknown additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.udiCarrier.entryType
Binding: R5UdiEntryTypeForR3 (0.1.0) (required): Codes to identify how UDI data was entered.
... version
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:type 0..1 CodeableConcept R5: The type of the device version, e.g. manufacturer, approved, internal (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.type
..... extension:component 0..1 Identifier R5: The hardware or software module of the device to which the version applies (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.component
..... extension:installDate 0..1 dateTime R5: The date the version was installed on the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.installDate
..... extension:value 1..1 string R5: The version text (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.value
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:owner 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: owner additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... location
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Where the device is found additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..1 (Complex) R5: The reference to the definition for the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.definition
.... extension:availabilityStatus 0..1 CodeableConcept R5: lost | damaged | destroyed | available (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.availabilityStatus
Binding: R5DeviceAvailabilityStatusForR3 (0.1.0) (extensible): The availability status reason of the device.
.... extension:biologicalSourceEvent 0..1 Identifier R5: An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.biologicalSourceEvent
.... extension:serialNumber 0..1 string R5: Serial number assigned by the manufacturer (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.serialNumber
.... extension:partNumber 0..1 string R5: The part number or catalog number of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.partNumber
.... extension:category 0..* CodeableConcept R5: Indicates a high-level grouping of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.category
Binding: R5DeviceCategoryForR3 (0.1.0) (example): Categories of medical devices.
.... extension:conformsTo 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/device-conformsTo]] R5: Identifies the standards, specifications, or formal guidances for the capabilities supported by the device (new)
URL: http://hl7.org/fhir/StructureDefinition/device-conformsTo
.... extension:property 0..* (Complex) R5: Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.property
.... extension:mode 0..1 CodeableConcept R5: The designated condition for performing a task (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.mode
Binding: R5DeviceOperationModeForR3 (0.1.0) (example): Operational mode of a device.
.... extension:cycle 0..1 Count R5: The series of occurrences that repeats during the operation of the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.cycle
.... extension:duration 0..1 Duration R5: A measurement of time during the device's operation (e.g., days, hours, mins, etc.) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.duration
.... extension:endpoint 0..* Reference(Cross-version Profile for R5.Endpoint for use in FHIR STU3(0.1.0) | Endpoint) R5: Technical endpoints providing access to electronic services provided by the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.endpoint
.... extension:gateway 0..* (Complex) R5: Linked device acting as a communication/data collector, translator or controller (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.gateway
.... extension:parent 0..1 Reference(Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device) R5: The higher level or encompassing device that this device is a logical part of (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.parent
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Instance identifier
... udi Σ 0..1 BackboneElement Unique Device Identifier (UDI) Barcode string
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:displayName 0..1 string R5: The name used to display by default when the device is referenced additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.displayName
..... extension:value 1..1 string R5: The term that names the device additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.name.value
..... extension:type 1..1 code R5: registered-name | user-friendly-name | patient-reported-name (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.name.type
Binding: R5DeviceNametypeForR3 (0.1.0) (required): The type of name the device is referred by.
.... Slices for modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Open by value:url
..... modifierExtension:display ?!Σ 0..1 boolean R5: The preferred device name additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.name.display
.... deviceIdentifier Σ 0..1 string Mandatory fixed portion of UDI
.... name Σ 0..1 string Device Name as appears on UDI label
.... jurisdiction 0..1 uri Regional UDI authority
.... carrierHRF Σ 0..1 string UDI Human Readable Barcode String
.... carrierAIDC Σ 0..1 base64Binary UDI Machine Readable Barcode String
.... issuer 0..1 uri UDI Issuing Organization
.... entryType 0..1 code barcode | rfid | manual +
Binding: UDIEntryType . (required): Codes to identify how UDI data was entered
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:entryType 0..1 code R5: barcode | rfid | manual | card | self-reported | electronic-transmission | unknown additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.udiCarrier.entryType
Binding: R5UdiEntryTypeForR3 (0.1.0) (required): Codes to identify how UDI data was entered.
..... value 0..1 code Primitive value for code
... status ?!Σ 0..1 code active | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.
... type 0..1 CodeableConcept What kind of device this is
Binding: FHIR Device Types (example): Codes to identify medical devices
... lotNumber 0..1 string Lot number of manufacture
... manufacturer 0..1 string Name of device manufacturer
... manufactureDate 0..1 dateTime Date when the device was made
... expirationDate 0..1 dateTime Date and time of expiry of this device (if applicable)
... model 0..1 string Model id assigned by the manufacturer
... version 0..1 string Version number (i.e. software)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:type 0..1 CodeableConcept R5: The type of the device version, e.g. manufacturer, approved, internal (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.type
..... extension:component 0..1 Identifier R5: The hardware or software module of the device to which the version applies (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.component
..... extension:installDate 0..1 dateTime R5: The date the version was installed on the device (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.installDate
..... extension:value 1..1 string R5: The version text (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.version.value
.... value 0..1 string Primitive value for string
Max Length:1048576
... patient 0..1 Reference(Patient) Patient to whom Device is affixed
... owner 0..1 Reference(Organization) Organization responsible for device
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:owner 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: owner additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... contact 0..* ContactPoint Details for human/organization for support
... location 0..1 Reference(Location) Where the resource is found
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Where the device is found additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... url 0..1 uri Network address to contact device
... note 0..* Annotation Device notes and comments
... safety Σ 0..* CodeableConcept Safety Characteristics of Device
Binding: DeviceSafety (example): Codes used to identify medical devices safety characterics. These codes are derived in part from the United States Food and Drug Administration recommendations and are provided here as a suggestive example.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
Device.udi.entryType Base required UDIEntryType . 📍3.0.2 tx.fhir.org
Device.status Base required FHIRDeviceStatus 📍3.0.2 FHIR Std.
Device.type Base example FHIR Device Types 📍3.0.2 FHIR Std.
Device.safety Base example DeviceSafety 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Device If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Device If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Device If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Device If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Device

Summary

Mandatory: 0 element(4 nested mandatory elements)

Extensions

This structure refers to these extensions:

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron