Pharmaceutical Quality (Industry)
1.0.0-ballot - ballot International flag

This page is part of the Pharmaceutical Quality (Industry) (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: DeviceDefinition - Drug

Official URL: http://hl7.org/fhir/uv/pharm-quality/StructureDefinition/DeviceDefinition-drug-pq Version: 1.0.0-ballot
Active as of 2023-12-18 Computable Name: DeviceDefinitionDrugPq

This DeviceDefinition profile represents information about devices and equipment used in pharmaceutical quality (PQ) data gathering.

Usage:

Formal Views of Profile Content

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

This structure is derived from DeviceDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..*DeviceDefinitionAn instance of a medical-related component of a medical device
... deviceName S0..*BackboneElementThe name or names of the device as given by the manufacturer
... classification S0..*BackboneElementWhat kind of device or device system this is
.... type S1..1CodeableConceptA classification or risk class of the device model
Binding: ValueSet - Device Type (example)
... property S0..*BackboneElementInherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc
.... type S1..1CodeableConceptCode that specifies the property being represented
Binding: ValueSet - Device Property (example)
.... value[x] S1..1Value of the property
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueAttachmentAttachment

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
DeviceDefinition.classification.typeexampleVsDeviceTypePQ (a valid code from CodeSystem - Device Type)
DeviceDefinition.property.typeexampleVsDevicePropertyPQ (a valid code from CodeSystem - Device Property)
NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..*DeviceDefinitionAn instance of a medical-related component of a medical device
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ1..1stringA name that is used to refer to the device
.... type Σ1..1coderegistered-name | user-friendly-name | patient-reported-name
Binding: DeviceNameType (required): The type of name the device is referred by.

... classification SΣ0..*BackboneElementWhat kind of device or device system this is
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ1..1CodeableConceptA classification or risk class of the device model
Binding: ValueSet - Device Type (example)
... property S0..*BackboneElementInherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type S1..1CodeableConceptCode that specifies the property being represented
Binding: ValueSet - Device Property (example)
.... value[x] S1..1Value of the property
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueAttachmentAttachment

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DeviceDefinition.deviceName.typerequiredDeviceNameType
DeviceDefinition.classification.typeexampleVsDeviceTypePQ (a valid code from CodeSystem - Device Type)
DeviceDefinition.property.typeexampleVsDevicePropertyPQ (a valid code from CodeSystem - Device Property)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceDefinitionIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDeviceDefinitionIf 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-5errorDeviceDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..*DeviceDefinitionAn instance of a medical-related component of a medical device
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... description 0..1markdownAdditional information to describe the device
... identifier Σ0..*IdentifierInstance identifier
... udiDeviceIdentifier 0..*BackboneElementUnique Device Identifier (UDI) Barcode string
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... deviceIdentifier 1..1stringThe identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier
.... issuer 1..1uriThe organization that assigns the identifier algorithm
.... jurisdiction 1..1uriThe jurisdiction to which the deviceIdentifier applies
.... marketDistribution 0..*BackboneElementIndicates whether and when the device is available on the market
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... marketPeriod 1..1PeriodBegin and end dates for the commercial distribution of the device
..... subJurisdiction 1..1uriNational state or territory where the device is commercialized
... regulatoryIdentifier 0..*BackboneElementRegulatory identifier(s) associated with this device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1codebasic | master | license
Binding: DeviceDefinitionRegulatoryIdentifierType (required): Device regulatory identifier type.

.... deviceIdentifier 1..1stringThe identifier itself
.... issuer 1..1uriThe organization that issued this identifier
.... jurisdiction 1..1uriThe jurisdiction to which the deviceIdentifier applies
... partNumber 0..1stringThe part number or catalog number of the device
... manufacturer Σ0..1Reference(Organization)Name of device manufacturer
... deviceName SΣ0..*BackboneElementThe name or names of the device as given by the manufacturer
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ1..1stringA name that is used to refer to the device
.... type Σ1..1coderegistered-name | user-friendly-name | patient-reported-name
Binding: DeviceNameType (required): The type of name the device is referred by.

... modelNumber Σ0..1stringThe catalog or model number for the device for example as defined by the manufacturer
... classification SΣ0..*BackboneElementWhat kind of device or device system this is
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ1..1CodeableConceptA classification or risk class of the device model
Binding: ValueSet - Device Type (example)
.... justification 0..*RelatedArtifactFurther information qualifying this classification of the device model
... conformsTo Σ0..*BackboneElementIdentifies the standards, specifications, or formal guidances for the capabilities supported by the device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category Σ0..1CodeableConceptDescribes the common type of the standard, specification, or formal guidance
Binding: DeviceSpecificationCategory (example)
.... specification Σ1..1CodeableConceptIdentifies the standard, specification, or formal guidance that the device adheres to the Device Specification type
Binding: DeviceSpecificationType (example)
.... version Σ0..*stringThe specific form or variant of the standard, specification or formal guidance
.... source 0..*RelatedArtifactStandard, regulation, certification, or guidance website, document, or other publication, or similar, supporting the conformance
... hasPart Σ0..*BackboneElementA device, part of the current one
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... reference Σ1..1Reference(DeviceDefinition)Reference to the part
.... count 0..1integerNumber of occurrences of the part
... packaging 0..*BackboneElementInformation about the packaging of the device, i.e. how the device is packaged
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..1IdentifierBusiness identifier of the packaged medication
.... type 0..1CodeableConceptA code that defines the specific type of packaging
.... count 0..1integerThe number of items contained in the package (devices or sub-packages)
.... distributor 0..*BackboneElementAn organization that distributes the packaged device
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 0..1stringDistributor's human-readable name
..... organizationReference 0..*Reference(Organization)Distributor as an Organization resource
.... udiDeviceIdentifier 0..*See udiDeviceIdentifier (DeviceDefinition)Unique Device Identifier (UDI) Barcode string on the packaging
.... packaging 0..*See packaging (DeviceDefinition)Allows packages within packages
... version 0..*BackboneElementThe version of the device or software
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptThe type of the device version, e.g. manufacturer, approved, internal
.... component 0..1IdentifierThe hardware or software module of the device to which the version applies
.... value 1..1stringThe version text
... safety Σ0..*CodeableConceptSafety characteristics of the device
Binding: DeviceSafety (example)
... shelfLifeStorage 0..*ProductShelfLifeShelf Life and storage information
... languageCode 0..*CodeableConceptLanguage code for the human-readable text strings produced by the device (all supported)
... property S0..*BackboneElementInherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type S1..1CodeableConceptCode that specifies the property being represented
Binding: ValueSet - Device Property (example)
.... value[x] S1..1Value of the property
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueAttachmentAttachment
... owner 0..1Reference(Organization)Organization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... link 0..*BackboneElementAn associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation 1..1CodingThe type indicates the relationship of the related device to the device instance
Binding: DeviceDefinitionRelationType (extensible): The type of relation between this and the linked device.

.... relatedDevice 1..1CodeableReference(DeviceDefinition)A reference to the linked device
... note 0..*AnnotationDevice notes and comments
... material 0..*BackboneElementA substance used to create the material(s) of which the device is made
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance 1..1CodeableConceptA relevant substance that the device contains, may contain, or is made of
.... alternate 0..1booleanIndicates an alternative material of the device
.... allergenicIndicator 0..1booleanWhether the substance is a known or suspected allergen
... productionIdentifierInUDI 0..*codelot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version
Binding: DeviceProductionIdentifierInUDI (required): The production identifier(s) that are expected to appear in the UDI carrier.


... guideline 0..1BackboneElementInformation aimed at providing directions for the usage of this model of device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... useContext 0..*UsageContextThe circumstances that form the setting for using the device
.... usageInstruction 0..1markdownDetailed written and visual directions for the user on how to use the device
.... relatedArtifact 0..*RelatedArtifactA source of information or reference for this guideline
.... indication 0..*CodeableConceptA clinical condition for which the device was designed to be used
.... contraindication 0..*CodeableConceptA specific situation when a device should not be used because it may cause harm
.... warning 0..*CodeableConceptSpecific hazard alert information that a user needs to know before using the device
.... intendedUse 0..1stringA description of the general purpose or medical use of the device or its function
... correctiveAction 0..1BackboneElementTracking of latest field safety corrective action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... recall 1..1booleanWhether the corrective action was a recall
.... scope 0..1codemodel | lot-numbers | serial-numbers
Binding: DeviceCorrectiveActionScope (required): The type or scope of the corrective action.

.... period 1..1PeriodStart and end dates of the corrective action
... chargeItem 0..*BackboneElementBilling code or reference associated with the device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... chargeItemCode 1..1CodeableReference(ChargeItemDefinition)The code or reference for the charge item
.... count 1..1QuantityCoefficient applicable to the billing code
.... effectivePeriod 0..1PeriodA specific time period in which this charge item applies
.... useContext 0..*UsageContextThe context to which this charge item applies

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DeviceDefinition.languagerequiredAllLanguages
DeviceDefinition.regulatoryIdentifier.typerequiredDeviceDefinitionRegulatoryIdentifierType
DeviceDefinition.deviceName.typerequiredDeviceNameType
DeviceDefinition.classification.typeexampleVsDeviceTypePQ (a valid code from CodeSystem - Device Type)
DeviceDefinition.conformsTo.categoryexampleDeviceSpecificationCategory
DeviceDefinition.conformsTo.specificationexampleDeviceSpecificationType
DeviceDefinition.safetyexampleDeviceSafety
DeviceDefinition.property.typeexampleVsDevicePropertyPQ (a valid code from CodeSystem - Device Property)
DeviceDefinition.link.relationextensibleDeviceDefinitionRelationType
DeviceDefinition.productionIdentifierInUDIrequiredDeviceProductionIdentifierInUDI
DeviceDefinition.correctiveAction.scoperequiredDeviceCorrectiveActionScope

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceDefinitionIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDeviceDefinitionIf 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-5errorDeviceDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DeviceDefinition

Summary

Must-Support: 6 elements

Differential View

This structure is derived from DeviceDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..*DeviceDefinitionAn instance of a medical-related component of a medical device
... deviceName S0..*BackboneElementThe name or names of the device as given by the manufacturer
... classification S0..*BackboneElementWhat kind of device or device system this is
.... type S1..1CodeableConceptA classification or risk class of the device model
Binding: ValueSet - Device Type (example)
... property S0..*BackboneElementInherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc
.... type S1..1CodeableConceptCode that specifies the property being represented
Binding: ValueSet - Device Property (example)
.... value[x] S1..1Value of the property
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueAttachmentAttachment

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
DeviceDefinition.classification.typeexampleVsDeviceTypePQ (a valid code from CodeSystem - Device Type)
DeviceDefinition.property.typeexampleVsDevicePropertyPQ (a valid code from CodeSystem - Device Property)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..*DeviceDefinitionAn instance of a medical-related component of a medical device
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ1..1stringA name that is used to refer to the device
.... type Σ1..1coderegistered-name | user-friendly-name | patient-reported-name
Binding: DeviceNameType (required): The type of name the device is referred by.

... classification SΣ0..*BackboneElementWhat kind of device or device system this is
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ1..1CodeableConceptA classification or risk class of the device model
Binding: ValueSet - Device Type (example)
... property S0..*BackboneElementInherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type S1..1CodeableConceptCode that specifies the property being represented
Binding: ValueSet - Device Property (example)
.... value[x] S1..1Value of the property
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueAttachmentAttachment

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DeviceDefinition.deviceName.typerequiredDeviceNameType
DeviceDefinition.classification.typeexampleVsDeviceTypePQ (a valid code from CodeSystem - Device Type)
DeviceDefinition.property.typeexampleVsDevicePropertyPQ (a valid code from CodeSystem - Device Property)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceDefinitionIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDeviceDefinitionIf 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-5errorDeviceDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..*DeviceDefinitionAn instance of a medical-related component of a medical device
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... description 0..1markdownAdditional information to describe the device
... identifier Σ0..*IdentifierInstance identifier
... udiDeviceIdentifier 0..*BackboneElementUnique Device Identifier (UDI) Barcode string
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... deviceIdentifier 1..1stringThe identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier
.... issuer 1..1uriThe organization that assigns the identifier algorithm
.... jurisdiction 1..1uriThe jurisdiction to which the deviceIdentifier applies
.... marketDistribution 0..*BackboneElementIndicates whether and when the device is available on the market
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... marketPeriod 1..1PeriodBegin and end dates for the commercial distribution of the device
..... subJurisdiction 1..1uriNational state or territory where the device is commercialized
... regulatoryIdentifier 0..*BackboneElementRegulatory identifier(s) associated with this device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1codebasic | master | license
Binding: DeviceDefinitionRegulatoryIdentifierType (required): Device regulatory identifier type.

.... deviceIdentifier 1..1stringThe identifier itself
.... issuer 1..1uriThe organization that issued this identifier
.... jurisdiction 1..1uriThe jurisdiction to which the deviceIdentifier applies
... partNumber 0..1stringThe part number or catalog number of the device
... manufacturer Σ0..1Reference(Organization)Name of device manufacturer
... deviceName SΣ0..*BackboneElementThe name or names of the device as given by the manufacturer
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ1..1stringA name that is used to refer to the device
.... type Σ1..1coderegistered-name | user-friendly-name | patient-reported-name
Binding: DeviceNameType (required): The type of name the device is referred by.

... modelNumber Σ0..1stringThe catalog or model number for the device for example as defined by the manufacturer
... classification SΣ0..*BackboneElementWhat kind of device or device system this is
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ1..1CodeableConceptA classification or risk class of the device model
Binding: ValueSet - Device Type (example)
.... justification 0..*RelatedArtifactFurther information qualifying this classification of the device model
... conformsTo Σ0..*BackboneElementIdentifies the standards, specifications, or formal guidances for the capabilities supported by the device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category Σ0..1CodeableConceptDescribes the common type of the standard, specification, or formal guidance
Binding: DeviceSpecificationCategory (example)
.... specification Σ1..1CodeableConceptIdentifies the standard, specification, or formal guidance that the device adheres to the Device Specification type
Binding: DeviceSpecificationType (example)
.... version Σ0..*stringThe specific form or variant of the standard, specification or formal guidance
.... source 0..*RelatedArtifactStandard, regulation, certification, or guidance website, document, or other publication, or similar, supporting the conformance
... hasPart Σ0..*BackboneElementA device, part of the current one
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... reference Σ1..1Reference(DeviceDefinition)Reference to the part
.... count 0..1integerNumber of occurrences of the part
... packaging 0..*BackboneElementInformation about the packaging of the device, i.e. how the device is packaged
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..1IdentifierBusiness identifier of the packaged medication
.... type 0..1CodeableConceptA code that defines the specific type of packaging
.... count 0..1integerThe number of items contained in the package (devices or sub-packages)
.... distributor 0..*BackboneElementAn organization that distributes the packaged device
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 0..1stringDistributor's human-readable name
..... organizationReference 0..*Reference(Organization)Distributor as an Organization resource
.... udiDeviceIdentifier 0..*See udiDeviceIdentifier (DeviceDefinition)Unique Device Identifier (UDI) Barcode string on the packaging
.... packaging 0..*See packaging (DeviceDefinition)Allows packages within packages
... version 0..*BackboneElementThe version of the device or software
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptThe type of the device version, e.g. manufacturer, approved, internal
.... component 0..1IdentifierThe hardware or software module of the device to which the version applies
.... value 1..1stringThe version text
... safety Σ0..*CodeableConceptSafety characteristics of the device
Binding: DeviceSafety (example)
... shelfLifeStorage 0..*ProductShelfLifeShelf Life and storage information
... languageCode 0..*CodeableConceptLanguage code for the human-readable text strings produced by the device (all supported)
... property S0..*BackboneElementInherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type S1..1CodeableConceptCode that specifies the property being represented
Binding: ValueSet - Device Property (example)
.... value[x] S1..1Value of the property
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueAttachmentAttachment
... owner 0..1Reference(Organization)Organization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... link 0..*BackboneElementAn associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation 1..1CodingThe type indicates the relationship of the related device to the device instance
Binding: DeviceDefinitionRelationType (extensible): The type of relation between this and the linked device.

.... relatedDevice 1..1CodeableReference(DeviceDefinition)A reference to the linked device
... note 0..*AnnotationDevice notes and comments
... material 0..*BackboneElementA substance used to create the material(s) of which the device is made
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance 1..1CodeableConceptA relevant substance that the device contains, may contain, or is made of
.... alternate 0..1booleanIndicates an alternative material of the device
.... allergenicIndicator 0..1booleanWhether the substance is a known or suspected allergen
... productionIdentifierInUDI 0..*codelot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version
Binding: DeviceProductionIdentifierInUDI (required): The production identifier(s) that are expected to appear in the UDI carrier.


... guideline 0..1BackboneElementInformation aimed at providing directions for the usage of this model of device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... useContext 0..*UsageContextThe circumstances that form the setting for using the device
.... usageInstruction 0..1markdownDetailed written and visual directions for the user on how to use the device
.... relatedArtifact 0..*RelatedArtifactA source of information or reference for this guideline
.... indication 0..*CodeableConceptA clinical condition for which the device was designed to be used
.... contraindication 0..*CodeableConceptA specific situation when a device should not be used because it may cause harm
.... warning 0..*CodeableConceptSpecific hazard alert information that a user needs to know before using the device
.... intendedUse 0..1stringA description of the general purpose or medical use of the device or its function
... correctiveAction 0..1BackboneElementTracking of latest field safety corrective action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... recall 1..1booleanWhether the corrective action was a recall
.... scope 0..1codemodel | lot-numbers | serial-numbers
Binding: DeviceCorrectiveActionScope (required): The type or scope of the corrective action.

.... period 1..1PeriodStart and end dates of the corrective action
... chargeItem 0..*BackboneElementBilling code or reference associated with the device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... chargeItemCode 1..1CodeableReference(ChargeItemDefinition)The code or reference for the charge item
.... count 1..1QuantityCoefficient applicable to the billing code
.... effectivePeriod 0..1PeriodA specific time period in which this charge item applies
.... useContext 0..*UsageContextThe context to which this charge item applies

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DeviceDefinition.languagerequiredAllLanguages
DeviceDefinition.regulatoryIdentifier.typerequiredDeviceDefinitionRegulatoryIdentifierType
DeviceDefinition.deviceName.typerequiredDeviceNameType
DeviceDefinition.classification.typeexampleVsDeviceTypePQ (a valid code from CodeSystem - Device Type)
DeviceDefinition.conformsTo.categoryexampleDeviceSpecificationCategory
DeviceDefinition.conformsTo.specificationexampleDeviceSpecificationType
DeviceDefinition.safetyexampleDeviceSafety
DeviceDefinition.property.typeexampleVsDevicePropertyPQ (a valid code from CodeSystem - Device Property)
DeviceDefinition.link.relationextensibleDeviceDefinitionRelationType
DeviceDefinition.productionIdentifierInUDIrequiredDeviceProductionIdentifierInUDI
DeviceDefinition.correctiveAction.scoperequiredDeviceCorrectiveActionScope

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceDefinitionIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDeviceDefinitionIf 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-5errorDeviceDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DeviceDefinition

Summary

Must-Support: 6 elements

 

Other representations of profile: CSV, Excel, Schematron