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

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

Resource Profile: Profile_R5_Device_R4

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_R4

This cross-version profile allows R5 Device content to be represented via FHIR R4 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(4.0.1) 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
Constraints: ext-1
.... extension:availabilityStatus 0..1 CodeableConcept R5: lost | damaged | destroyed | available (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.availabilityStatus
Binding: R5DeviceAvailabilityStatusForR4 (0.1.0) (extensible): The availability status reason of the device.
Constraints: ext-1
.... 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
Constraints: ext-1
.... 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: R5DeviceCategoryForR4 (0.1.0) (example): Categories of medical devices.
Constraints: ext-1
.... 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: R5DeviceOperationModeForR4 (0.1.0) (example): Operational mode of a device.
Constraints: ext-1
.... 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
Constraints: ext-1
.... 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
Constraints: ext-1
.... extension:endpoint 0..* Reference(Cross-version Profile for R5.Endpoint for use in FHIR R4(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
Constraints: ext-1
.... 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
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

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

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Device If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Device A resource should have narrative for robust management text.`div`.exists()
ele-1 error Device.implicitRules, Device.extension, Device.extension:availabilityStatus, Device.extension:biologicalSourceEvent, Device.extension:category, Device.extension:mode, Device.extension:cycle, Device.extension:duration, Device.extension:endpoint, Device.extension:gateway, Device.modifierExtension, Device.status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Device.extension, Device.extension:availabilityStatus, Device.extension:biologicalSourceEvent, Device.extension:category, Device.extension:mode, Device.extension:cycle, Device.extension:duration, Device.extension:endpoint, Device.extension:gateway, Device.modifierExtension 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(4.0.1) Item used in healthcare
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:availabilityStatus 0..1 CodeableConcept R5: lost | damaged | destroyed | available (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.availabilityStatus
Binding: R5DeviceAvailabilityStatusForR4 (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: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: R5DeviceCategoryForR4 (0.1.0) (example): Categories of medical devices.
.... 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: R5DeviceOperationModeForR4 (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 R4(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
... definition
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:definition 0..1 CodeableConcept R5: definition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.definition
... udiCarrier
.... 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: R5UdiEntryTypeForR4 (0.1.0) (required): Codes to identify how UDI data was entered.
.... Slices for extension 0..* 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
... specialization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... 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
URL: http://hl7.org/fhir/StructureDefinition/device-conformsTo
..... extension:version 0..1 string R5: Specific form or variant of the standard (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.conformsTo.version
... version
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... 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
... property
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:value 1..1 string, boolean, integer, Range, Attachment R5: Value of the property additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.property.value

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device(4.0.1) 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages . (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
Constraints: ext-1
.... extension:availabilityStatus 0..1 CodeableConcept R5: lost | damaged | destroyed | available (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.availabilityStatus
Binding: R5DeviceAvailabilityStatusForR4 (0.1.0) (extensible): The availability status reason of the device.
Constraints: ext-1
.... 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
Constraints: ext-1
.... 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: R5DeviceCategoryForR4 (0.1.0) (example): Categories of medical devices.
Constraints: ext-1
.... 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: R5DeviceOperationModeForR4 (0.1.0) (example): Operational mode of a device.
Constraints: ext-1
.... 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
Constraints: ext-1
.... 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
Constraints: ext-1
.... extension:endpoint 0..* Reference(Cross-version Profile for R5.Endpoint for use in FHIR R4(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
Constraints: ext-1
.... 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
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier 0..* Identifier Instance identifier
... definition 0..1 Reference(DeviceDefinition) The reference to the definition for the device
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:definition 0..1 CodeableConcept R5: definition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.definition
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... udiCarrier Σ 0..* BackboneElement Unique Device Identifier (UDI) Barcode string
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... deviceIdentifier Σ 0..1 string Mandatory fixed portion of UDI
.... issuer 0..1 uri UDI Issuing Organization
.... jurisdiction 0..1 uri Regional UDI authority
.... carrierAIDC Σ 0..1 base64Binary UDI Machine Readable Barcode String
.... carrierHRF Σ 0..1 string UDI Human Readable Barcode String
.... 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
Constraints: ext-1
...... 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: R5UdiEntryTypeForR4 (0.1.0) (required): Codes to identify how UDI data was entered.
Constraints: ext-1
..... value 0..1 string Primitive value for code
... status ?!Σ 0..1 code active | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.
... statusReason 0..* CodeableConcept online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.
... distinctIdentifier 0..1 string The distinct identification string
... 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)
... lotNumber 0..1 string Lot number of manufacture
... serialNumber 0..1 string Serial number assigned by the manufacturer
... deviceName 0..* BackboneElement The name of the device as given by the manufacturer
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... name 1..1 string The name of the device
.... type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required): The type of name the device is referred by.
... modelNumber 0..1 string The model number for the device
... partNumber 0..1 string The part number of the device
... type 0..1 CodeableConcept The kind or type of device
Binding: DeviceType (example): Codes to identify medical devices.
... specialization 0..* BackboneElement The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... 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
URL: http://hl7.org/fhir/StructureDefinition/device-conformsTo
Constraints: ext-1
..... extension:version 0..1 string R5: Specific form or variant of the standard (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.conformsTo.version
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... systemType 1..1 CodeableConcept The standard that is used to operate and communicate
.... version 0..1 string The version of the standard that is used to operate and communicate
... version 0..* BackboneElement The actual design of the device or software version running on the device
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type 0..1 CodeableConcept The type of the device version
.... component 0..1 Identifier A single component of the device version
.... value 1..1 string The version text
... property 0..* BackboneElement The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:value 1..1 string, boolean, integer, Range, Attachment R5: Value of the property additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.property.value
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuantity 0..* Quantity Property value as a quantity
.... valueCode 0..* CodeableConcept Property value as a code, e.g., NTP4 (synced to NTP)
... patient 0..1 Reference(Patient) Patient to whom Device is affixed
... owner 0..1 Reference(Organization) Organization responsible for device
... contact 0..* ContactPoint Details for human/organization for support
... location 0..1 Reference(Location) Where the device is found
... url 0..1 uri Network address to contact device
... note 0..* Annotation Device notes and comments
... safety Σ 0..* CodeableConcept Safety Characteristics of Device
... parent 0..1 Reference(Device) The parent device

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
Device.definition.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Device.udiCarrier.entryType Base required UDIEntryType . 📍4.0.1 tx.fhir.org
Device.status Base required FHIRDeviceStatus 📍4.0.1 FHIR Std.
Device.statusReason Base extensible FHIRDeviceStatusReason 📍4.0.1 FHIR Std.
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.
Device.type Base example Device Type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Device If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Device A resource should have narrative for robust management text.`div`.exists()
ele-1 error Device.meta, Device.implicitRules, Device.language, Device.text, Device.extension, Device.extension:availabilityStatus, Device.extension:biologicalSourceEvent, Device.extension:category, Device.extension:mode, Device.extension:cycle, Device.extension:duration, Device.extension:endpoint, Device.extension:gateway, Device.modifierExtension, Device.identifier, Device.definition, Device.definition.extension, Device.definition.extension:definition, Device.definition.reference, Device.definition.type, Device.definition.identifier, Device.definition.display, Device.udiCarrier, Device.udiCarrier.extension, Device.udiCarrier.modifierExtension, Device.udiCarrier.deviceIdentifier, Device.udiCarrier.issuer, Device.udiCarrier.jurisdiction, Device.udiCarrier.carrierAIDC, Device.udiCarrier.carrierHRF, Device.udiCarrier.entryType, Device.udiCarrier.entryType.extension, Device.udiCarrier.entryType.extension:entryType, Device.status, Device.statusReason, Device.distinctIdentifier, Device.manufacturer, Device.manufactureDate, Device.expirationDate, Device.lotNumber, Device.serialNumber, Device.deviceName, Device.deviceName.extension, Device.deviceName.extension:displayName, Device.deviceName.modifierExtension, Device.deviceName.name, Device.deviceName.type, Device.modelNumber, Device.partNumber, Device.type, Device.specialization, Device.specialization.extension, Device.specialization.extension:conformsTo, Device.specialization.extension:version, Device.specialization.modifierExtension, Device.specialization.systemType, Device.specialization.version, Device.version, Device.version.extension, Device.version.extension:installDate, Device.version.modifierExtension, Device.version.type, Device.version.component, Device.version.value, Device.property, Device.property.extension, Device.property.extension:value, Device.property.modifierExtension, Device.property.type, Device.property.valueQuantity, Device.property.valueCode, Device.patient, Device.owner, Device.contact, Device.location, Device.url, Device.note, Device.safety, Device.parent All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Device.extension, Device.extension:availabilityStatus, Device.extension:biologicalSourceEvent, Device.extension:category, Device.extension:mode, Device.extension:cycle, Device.extension:duration, Device.extension:endpoint, Device.extension:gateway, Device.modifierExtension, Device.definition.extension, Device.definition.extension:definition, Device.udiCarrier.extension, Device.udiCarrier.modifierExtension, Device.udiCarrier.entryType.extension, Device.udiCarrier.entryType.extension:entryType, Device.deviceName.extension, Device.deviceName.extension:displayName, Device.deviceName.modifierExtension, Device.specialization.extension, Device.specialization.extension:conformsTo, Device.specialization.extension:version, Device.specialization.modifierExtension, Device.version.extension, Device.version.extension:installDate, Device.version.modifierExtension, Device.property.extension, Device.property.extension:value, Device.property.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device(4.0.1) 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
Constraints: ext-1
.... extension:availabilityStatus 0..1 CodeableConcept R5: lost | damaged | destroyed | available (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.availabilityStatus
Binding: R5DeviceAvailabilityStatusForR4 (0.1.0) (extensible): The availability status reason of the device.
Constraints: ext-1
.... 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
Constraints: ext-1
.... 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: R5DeviceCategoryForR4 (0.1.0) (example): Categories of medical devices.
Constraints: ext-1
.... 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: R5DeviceOperationModeForR4 (0.1.0) (example): Operational mode of a device.
Constraints: ext-1
.... 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
Constraints: ext-1
.... 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
Constraints: ext-1
.... extension:endpoint 0..* Reference(Cross-version Profile for R5.Endpoint for use in FHIR R4(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
Constraints: ext-1
.... 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
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

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

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Device If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Device A resource should have narrative for robust management text.`div`.exists()
ele-1 error Device.implicitRules, Device.extension, Device.extension:availabilityStatus, Device.extension:biologicalSourceEvent, Device.extension:category, Device.extension:mode, Device.extension:cycle, Device.extension:duration, Device.extension:endpoint, Device.extension:gateway, Device.modifierExtension, Device.status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Device.extension, Device.extension:availabilityStatus, Device.extension:biologicalSourceEvent, Device.extension:category, Device.extension:mode, Device.extension:cycle, Device.extension:duration, Device.extension:endpoint, Device.extension:gateway, Device.modifierExtension 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(4.0.1) Item used in healthcare
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:availabilityStatus 0..1 CodeableConcept R5: lost | damaged | destroyed | available (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.availabilityStatus
Binding: R5DeviceAvailabilityStatusForR4 (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: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: R5DeviceCategoryForR4 (0.1.0) (example): Categories of medical devices.
.... 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: R5DeviceOperationModeForR4 (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 R4(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
... definition
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:definition 0..1 CodeableConcept R5: definition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.definition
... udiCarrier
.... 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: R5UdiEntryTypeForR4 (0.1.0) (required): Codes to identify how UDI data was entered.
.... Slices for extension 0..* 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
... specialization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... 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
URL: http://hl7.org/fhir/StructureDefinition/device-conformsTo
..... extension:version 0..1 string R5: Specific form or variant of the standard (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.conformsTo.version
... version
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... 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
... property
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:value 1..1 string, boolean, integer, Range, Attachment R5: Value of the property additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.property.value

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device(4.0.1) 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages . (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
Constraints: ext-1
.... extension:availabilityStatus 0..1 CodeableConcept R5: lost | damaged | destroyed | available (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.availabilityStatus
Binding: R5DeviceAvailabilityStatusForR4 (0.1.0) (extensible): The availability status reason of the device.
Constraints: ext-1
.... 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
Constraints: ext-1
.... 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: R5DeviceCategoryForR4 (0.1.0) (example): Categories of medical devices.
Constraints: ext-1
.... 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: R5DeviceOperationModeForR4 (0.1.0) (example): Operational mode of a device.
Constraints: ext-1
.... 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
Constraints: ext-1
.... 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
Constraints: ext-1
.... extension:endpoint 0..* Reference(Cross-version Profile for R5.Endpoint for use in FHIR R4(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
Constraints: ext-1
.... 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
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier 0..* Identifier Instance identifier
... definition 0..1 Reference(DeviceDefinition) The reference to the definition for the device
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:definition 0..1 CodeableConcept R5: definition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.definition
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... udiCarrier Σ 0..* BackboneElement Unique Device Identifier (UDI) Barcode string
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... deviceIdentifier Σ 0..1 string Mandatory fixed portion of UDI
.... issuer 0..1 uri UDI Issuing Organization
.... jurisdiction 0..1 uri Regional UDI authority
.... carrierAIDC Σ 0..1 base64Binary UDI Machine Readable Barcode String
.... carrierHRF Σ 0..1 string UDI Human Readable Barcode String
.... 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
Constraints: ext-1
...... 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: R5UdiEntryTypeForR4 (0.1.0) (required): Codes to identify how UDI data was entered.
Constraints: ext-1
..... value 0..1 string Primitive value for code
... status ?!Σ 0..1 code active | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.
... statusReason 0..* CodeableConcept online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.
... distinctIdentifier 0..1 string The distinct identification string
... 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)
... lotNumber 0..1 string Lot number of manufacture
... serialNumber 0..1 string Serial number assigned by the manufacturer
... deviceName 0..* BackboneElement The name of the device as given by the manufacturer
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... name 1..1 string The name of the device
.... type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required): The type of name the device is referred by.
... modelNumber 0..1 string The model number for the device
... partNumber 0..1 string The part number of the device
... type 0..1 CodeableConcept The kind or type of device
Binding: DeviceType (example): Codes to identify medical devices.
... specialization 0..* BackboneElement The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... 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
URL: http://hl7.org/fhir/StructureDefinition/device-conformsTo
Constraints: ext-1
..... extension:version 0..1 string R5: Specific form or variant of the standard (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.conformsTo.version
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... systemType 1..1 CodeableConcept The standard that is used to operate and communicate
.... version 0..1 string The version of the standard that is used to operate and communicate
... version 0..* BackboneElement The actual design of the device or software version running on the device
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type 0..1 CodeableConcept The type of the device version
.... component 0..1 Identifier A single component of the device version
.... value 1..1 string The version text
... property 0..* BackboneElement The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:value 1..1 string, boolean, integer, Range, Attachment R5: Value of the property additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Device.property.value
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuantity 0..* Quantity Property value as a quantity
.... valueCode 0..* CodeableConcept Property value as a code, e.g., NTP4 (synced to NTP)
... patient 0..1 Reference(Patient) Patient to whom Device is affixed
... owner 0..1 Reference(Organization) Organization responsible for device
... contact 0..* ContactPoint Details for human/organization for support
... location 0..1 Reference(Location) Where the device is found
... url 0..1 uri Network address to contact device
... note 0..* Annotation Device notes and comments
... safety Σ 0..* CodeableConcept Safety Characteristics of Device
... parent 0..1 Reference(Device) The parent device

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
Device.definition.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Device.udiCarrier.entryType Base required UDIEntryType . 📍4.0.1 tx.fhir.org
Device.status Base required FHIRDeviceStatus 📍4.0.1 FHIR Std.
Device.statusReason Base extensible FHIRDeviceStatusReason 📍4.0.1 FHIR Std.
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.
Device.type Base example Device Type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Device If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Device A resource should have narrative for robust management text.`div`.exists()
ele-1 error Device.meta, Device.implicitRules, Device.language, Device.text, Device.extension, Device.extension:availabilityStatus, Device.extension:biologicalSourceEvent, Device.extension:category, Device.extension:mode, Device.extension:cycle, Device.extension:duration, Device.extension:endpoint, Device.extension:gateway, Device.modifierExtension, Device.identifier, Device.definition, Device.definition.extension, Device.definition.extension:definition, Device.definition.reference, Device.definition.type, Device.definition.identifier, Device.definition.display, Device.udiCarrier, Device.udiCarrier.extension, Device.udiCarrier.modifierExtension, Device.udiCarrier.deviceIdentifier, Device.udiCarrier.issuer, Device.udiCarrier.jurisdiction, Device.udiCarrier.carrierAIDC, Device.udiCarrier.carrierHRF, Device.udiCarrier.entryType, Device.udiCarrier.entryType.extension, Device.udiCarrier.entryType.extension:entryType, Device.status, Device.statusReason, Device.distinctIdentifier, Device.manufacturer, Device.manufactureDate, Device.expirationDate, Device.lotNumber, Device.serialNumber, Device.deviceName, Device.deviceName.extension, Device.deviceName.extension:displayName, Device.deviceName.modifierExtension, Device.deviceName.name, Device.deviceName.type, Device.modelNumber, Device.partNumber, Device.type, Device.specialization, Device.specialization.extension, Device.specialization.extension:conformsTo, Device.specialization.extension:version, Device.specialization.modifierExtension, Device.specialization.systemType, Device.specialization.version, Device.version, Device.version.extension, Device.version.extension:installDate, Device.version.modifierExtension, Device.version.type, Device.version.component, Device.version.value, Device.property, Device.property.extension, Device.property.extension:value, Device.property.modifierExtension, Device.property.type, Device.property.valueQuantity, Device.property.valueCode, Device.patient, Device.owner, Device.contact, Device.location, Device.url, Device.note, Device.safety, Device.parent All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Device.extension, Device.extension:availabilityStatus, Device.extension:biologicalSourceEvent, Device.extension:category, Device.extension:mode, Device.extension:cycle, Device.extension:duration, Device.extension:endpoint, Device.extension:gateway, Device.modifierExtension, Device.definition.extension, Device.definition.extension:definition, Device.udiCarrier.extension, Device.udiCarrier.modifierExtension, Device.udiCarrier.entryType.extension, Device.udiCarrier.entryType.extension:entryType, Device.deviceName.extension, Device.deviceName.extension:displayName, Device.deviceName.modifierExtension, Device.specialization.extension, Device.specialization.extension:conformsTo, Device.specialization.extension:version, Device.specialization.modifierExtension, Device.version.extension, Device.version.extension:installDate, Device.version.modifierExtension, Device.property.extension, Device.property.extension:value, Device.property.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron