HL7.FHIR.US.DME-ORDERS\PAO DeviceDefinition Profile

This page is part of the Post Acute Orders FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: PAOxDeviceDefinition

PAO DeviceDefinition Resource Profile

The official URL for this profile is:

http://hl7.org/fhir/us/dme-orders/StructureDefinition/PAOX-devicedefinition

Intro

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from DeviceDefinition

Summary

This structure is derived from DeviceDefinition

Name	Flags	Card.	Type	Description & Constraints
DeviceDefinition		0..*	DeviceDefinition	An instance of a medical-related component of a medical device
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
DeviceDefinition	I	0..*	DeviceDefinition	An instance of a medical-related component of a medical device
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	I	0..*	Identifier	Instance identifier
udiDeviceIdentifier	I	0..*	BackboneElement	Unique Device Identifier (UDI) Barcode string
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
deviceIdentifier	I	1..1	string	The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
issuer	I	1..1	uri	The organization that assigns the identifier algorithm
jurisdiction	I	1..1	uri	The jurisdiction to which the deviceIdentifier applies
manufacturer[x]	I	0..1		Name of device manufacturer
manufacturerString			string
manufacturerReference			Reference(Organization)
deviceName	I	0..*	BackboneElement	A name given to the device to identify it
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	I	1..1	string	The name of the device
type	I	1..1	code	udi-label-name \| user-friendly-name \| patient-reported-name \| manufacturer-name \| model-name \| other Binding: DeviceNameType (required)
modelNumber	I	0..1	string	The model number for the device
type	I	0..1	CodeableConcept	What kind of device or device system this is Binding: FHIRDeviceTypes (example)
specialization	I	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
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
systemType	I	1..1	string	The standard that is used to operate and communicate
version	I	0..1	string	The version of the standard that is used to operate and communicate
version	I	0..*	string	Available versions
safety	ΣI	0..*	CodeableConcept	Safety characteristics of the device Binding: DeviceSafety (example)
shelfLifeStorage	I	0..*	ProductShelfLife	Shelf Life and storage information
physicalCharacteristics	I	0..1	ProdCharacteristic	Dimensions, color etc.
languageCode	I	0..*	CodeableConcept	Language code for the human-readable text strings produced by the device (all supported)
capability	I	0..*	BackboneElement	Device capabilities
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	I	1..1	CodeableConcept	Type of capability
description	I	0..*	CodeableConcept	Description of capability
property	I	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
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	I	1..1	CodeableConcept	Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
valueQuantity	I	0..*	Quantity	Property value as a quantity
valueCode	I	0..*	CodeableConcept	Property value as a code, e.g., NTP4 (synced to NTP)
owner	I	0..1	Reference(Organization)	Organization responsible for device
contact	I	0..*	ContactPoint	Details for human/organization for support
url	I	0..1	uri	Network address to contact device
onlineInformation	I	0..1	uri	Access to on-line information
note	I	0..*	Annotation	Device notes and comments
quantity	I	0..1	Quantity	The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)
parentDevice	ΣI	0..1	Reference(DeviceDefinition)	The parent device it can be part of
material	I	0..*	BackboneElement	A substance used to create the material(s) of which the device is made
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
substance	I	1..1	CodeableConcept	The substance
alternate	I	0..1	boolean	Indicates an alternative material of the device
allergenicIndicator	I	0..1	boolean	Whether the substance is a known or suspected allergen
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
DeviceDefinition	I	0..*	DeviceDefinition	An instance of a medical-related component of a medical device
Documentation for this format

This structure is derived from DeviceDefinition

Summary

Differential View

This structure is derived from DeviceDefinition

Name	Flags	Card.	Type	Description & Constraints
DeviceDefinition		0..*	DeviceDefinition	An instance of a medical-related component of a medical device
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
DeviceDefinition	I	0..*	DeviceDefinition	An instance of a medical-related component of a medical device
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	I	0..*	Identifier	Instance identifier
udiDeviceIdentifier	I	0..*	BackboneElement	Unique Device Identifier (UDI) Barcode string
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
deviceIdentifier	I	1..1	string	The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
issuer	I	1..1	uri	The organization that assigns the identifier algorithm
jurisdiction	I	1..1	uri	The jurisdiction to which the deviceIdentifier applies
manufacturer[x]	I	0..1		Name of device manufacturer
manufacturerString			string
manufacturerReference			Reference(Organization)
deviceName	I	0..*	BackboneElement	A name given to the device to identify it
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	I	1..1	string	The name of the device
type	I	1..1	code	udi-label-name \| user-friendly-name \| patient-reported-name \| manufacturer-name \| model-name \| other Binding: DeviceNameType (required)
modelNumber	I	0..1	string	The model number for the device
type	I	0..1	CodeableConcept	What kind of device or device system this is Binding: FHIRDeviceTypes (example)
specialization	I	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
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
systemType	I	1..1	string	The standard that is used to operate and communicate
version	I	0..1	string	The version of the standard that is used to operate and communicate
version	I	0..*	string	Available versions
safety	ΣI	0..*	CodeableConcept	Safety characteristics of the device Binding: DeviceSafety (example)
shelfLifeStorage	I	0..*	ProductShelfLife	Shelf Life and storage information
physicalCharacteristics	I	0..1	ProdCharacteristic	Dimensions, color etc.
languageCode	I	0..*	CodeableConcept	Language code for the human-readable text strings produced by the device (all supported)
capability	I	0..*	BackboneElement	Device capabilities
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	I	1..1	CodeableConcept	Type of capability
description	I	0..*	CodeableConcept	Description of capability
property	I	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
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	I	1..1	CodeableConcept	Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
valueQuantity	I	0..*	Quantity	Property value as a quantity
valueCode	I	0..*	CodeableConcept	Property value as a code, e.g., NTP4 (synced to NTP)
owner	I	0..1	Reference(Organization)	Organization responsible for device
contact	I	0..*	ContactPoint	Details for human/organization for support
url	I	0..1	uri	Network address to contact device
onlineInformation	I	0..1	uri	Access to on-line information
note	I	0..*	Annotation	Device notes and comments
quantity	I	0..1	Quantity	The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)
parentDevice	ΣI	0..1	Reference(DeviceDefinition)	The parent device it can be part of
material	I	0..*	BackboneElement	A substance used to create the material(s) of which the device is made
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
substance	I	1..1	CodeableConcept	The substance
alternate	I	0..1	boolean	Indicates an alternative material of the device
allergenicIndicator	I	0..1	boolean	Whether the substance is a known or suspected allergen
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet
DeviceDefinition.language	preferred	CommonLanguages Max Binding: AllLanguages
DeviceDefinition.deviceName.type	required	DeviceNameType
DeviceDefinition.type	example	FHIRDeviceTypes
DeviceDefinition.safety	example	DeviceSafety

Constraints

Id	Path	Details	Requirements
dom-2	DeviceDefinition	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	DeviceDefinition	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	DeviceDefinition	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	DeviceDefinition	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	DeviceDefinition	A resource should have narrative for robust management : text.`div`.exists()
ele-1	DeviceDefinition.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.udiDeviceIdentifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.udiDeviceIdentifier.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.udiDeviceIdentifier.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.udiDeviceIdentifier.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.udiDeviceIdentifier.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.udiDeviceIdentifier.deviceIdentifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.udiDeviceIdentifier.issuer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.udiDeviceIdentifier.jurisdiction	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.manufacturer[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.deviceName	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.deviceName.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.deviceName.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.deviceName.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.deviceName.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.deviceName.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.deviceName.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.modelNumber	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.specialization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.specialization.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.specialization.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.specialization.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.specialization.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.specialization.systemType	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.specialization.version	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.version	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.safety	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.shelfLifeStorage	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.physicalCharacteristics	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.languageCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.capability	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.capability.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.capability.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.capability.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.capability.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.capability.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.capability.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.property	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.property.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.property.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.property.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.property.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.property.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.property.valueQuantity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.property.valueCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.owner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.contact	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.url	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.onlineInformation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.note	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.quantity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.parentDevice	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.material	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.material.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.material.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.material.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.material.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.material.substance	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.material.alternate	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.material.allergenicIndicator	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Notes:

Notes