Generated Narrative: StructureDefinition profile-DeviceDefinition Name Flags Card. Type Description & Constraints Basic 0..* Basic Resource for non-supported content #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:description 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-description]] R5: Additional information to describe the device (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-description #xD; extension:udiDeviceIdentifier 0..* (Complex) R5: Unique Device Identifier (UDI) Barcode string (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.udiDeviceIdentifier #xD; extension:regulatoryIdentifier 0..* (Complex) R5: Regulatory identifier(s) associated with this device (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.regulatoryIdentifier #xD; extension:partNumber 0..1 string R5: The part number or catalog number of the device (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.partNumber #xD; extension:manufacturer 0..1 Reference(Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization) R5: Name of device manufacturer (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.manufacturer #xD; extension:deviceName 0..* (Complex) R5: The name or names of the device as given by the manufacturer (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.deviceName #xD; extension:modelNumber 0..1 string R5: The catalog or model number for the device for example as defined by the manufacturer (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.modelNumber #xD; extension:classification 0..* (Complex) R5: What kind of device or device system this is (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.classification #xD; extension:conformsTo 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/device-conformsTo]] R5: Identifies the standards, specifications, or formal guidances for the capabilities supported by the device (new) URL: http://hl7.org/fhir/StructureDefinition/device-conformsTo #xD; extension:hasPart 0..* (Complex) R5: A device, part of the current one (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.hasPart #xD; extension:packaging 0..* (Complex) R5: Information about the packaging of the device, i.e. how the device is packaged (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.packaging #xD; extension:udiDeviceIdentifier 0..* (Complex) R5: Unique Device Identifier (UDI) Barcode string on the packaging (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.udiDeviceIdentifier #xD; extension:packaging 0..* (Complex) R5: Allows packages within packages (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.packaging #xD; extension:version 0..* (Complex) R5: The version of the device or software (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.version #xD; extension:safety 0..* CodeableConcept R5: Safety characteristics of the device (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.safety Binding: R5DeviceSafetyForR3 (0.1.0) (example) #xD; extension:shelfLifeStorage 0..* (Complex) R5: Shelf Life and storage information (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.shelfLifeStorage #xD; extension:languageCode 0..* CodeableConcept R5: Language code for the human-readable text strings produced by the device (all supported) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.languageCode #xD; extension:property 0..* (Complex) R5: Inherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.property #xD; extension:owner 0..1 Reference(Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization) R5: Organization responsible for device (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.owner #xD; extension:contact 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-contact]] R5: Details for human/organization for support (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-contact #xD; extension:link 0..* (Complex) R5: An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.link #xD; extension:note 0..* Annotation R5: Device notes and comments (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.note #xD; extension:material 0..* (Complex) R5: A substance used to create the material(s) of which the device is made (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.material #xD; extension:productionIdentifierInUDI 0..* code R5: lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.productionIdentifierInUDI Binding: R5DeviceProductidentifierinudiForR3 (0.1.0) (required): The production identifier(s) that are expected to appear in the UDI carrier. #xD; extension:guideline 0..1 (Complex) R5: Information aimed at providing directions for the usage of this model of device (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.guideline #xD; extension:correctiveAction 0..1 (Complex) R5: Tracking of latest field safety corrective action (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.correctiveAction #xD; extension:chargeItem 0..* (Complex) R5: Billing code or reference associated with the device (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.chargeItem #xD; Documentation for this format
Cross-version Profile for R5.DeviceDefinition for use in FHIR STU3
This cross-version profile allows R5 DeviceDefinition content to be represented via FHIR STU3 Basic resources.
Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL NOT contain any narrative
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
R5: Additional information to describe the device (new)
R5: `DeviceDefinition.description` (new:markdown)
Element `DeviceDefinition.description` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.description` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `DeviceDefinition.description`: `http://hl7.org/fhir/StructureDefinition/artifact-description`.
R5: Unique Device Identifier (UDI) Barcode string (new)
R5: `DeviceDefinition.udiDeviceIdentifier` (new:BackboneElement)
Element `DeviceDefinition.udiDeviceIdentifier` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.udiDeviceIdentifier` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
R5: Regulatory identifier(s) associated with this device (new)
R5: `DeviceDefinition.regulatoryIdentifier` (new:BackboneElement)
Element `DeviceDefinition.regulatoryIdentifier` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.regulatoryIdentifier` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This should not be used for regulatory authorization numbers which are to be captured elsewhere.
R5: The part number or catalog number of the device (new)
R5: `DeviceDefinition.partNumber` (new:string)
Element `DeviceDefinition.partNumber` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.partNumber` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Alphanumeric Maximum 20.
R5: `DeviceDefinition.manufacturer` (new:Reference(Organization))
Element `DeviceDefinition.manufacturer` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.manufacturer` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: The name or names of the device as given by the manufacturer (new)
R5: `DeviceDefinition.deviceName` (new:BackboneElement)
Element `DeviceDefinition.deviceName` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.deviceName` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: The catalog or model number for the device for example as defined by the manufacturer (new)
R5: `DeviceDefinition.modelNumber` (new:string)
Element `DeviceDefinition.modelNumber` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.modelNumber` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: What kind of device or device system this is (new)
R5: `DeviceDefinition.classification` (new:BackboneElement)
Element `DeviceDefinition.classification` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.classification` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.
R5: Identifies the standards, specifications, or formal guidances for the capabilities supported by the device (new)
R5: `DeviceDefinition.conformsTo` (new:BackboneElement)
Element `DeviceDefinition.conformsTo` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.conformsTo` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `DeviceDefinition.conformsTo`: `http://hl7.org/fhir/StructureDefinition/device-conformsTo`.
R5: A device, part of the current one (new)
R5: `DeviceDefinition.hasPart` (new:BackboneElement)
Element `DeviceDefinition.hasPart` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.hasPart` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: Information about the packaging of the device, i.e. how the device is packaged (new)
R5: `DeviceDefinition.packaging` (new:BackboneElement)
Element `DeviceDefinition.packaging` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.packaging` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: Unique Device Identifier (UDI) Barcode string on the packaging (new)
R5: `DeviceDefinition.packaging.udiDeviceIdentifier` (new:DeviceDefinition.udiDeviceIdentifier)
Element `DeviceDefinition.packaging.udiDeviceIdentifier` is part of an existing definition because parent element `DeviceDefinition.packaging` requires a cross-version extension. Element `DeviceDefinition.packaging.udiDeviceIdentifier` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.packaging.udiDeviceIdentifier` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: Allows packages within packages (new)
R5: `DeviceDefinition.packaging.packaging` (new:DeviceDefinition.packaging)
Element `DeviceDefinition.packaging.packaging` is part of an existing definition because parent element `DeviceDefinition.packaging` requires a cross-version extension. Element `DeviceDefinition.packaging.packaging` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.packaging.packaging` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: The version of the device or software (new)
R5: `DeviceDefinition.version` (new:BackboneElement)
Element `DeviceDefinition.version` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.version` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: Safety characteristics of the device (new)
R5: `DeviceDefinition.safety` (new:CodeableConcept)
Element `DeviceDefinition.safety` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.safety` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: Shelf Life and storage information (new)
R5: `DeviceDefinition.shelfLifeStorage` (new:ProductShelfLife)
Element `DeviceDefinition.shelfLifeStorage` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.shelfLifeStorage` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: Language code for the human-readable text strings produced by the device (all supported) (new)
R5: `DeviceDefinition.languageCode` (new:CodeableConcept)
Element `DeviceDefinition.languageCode` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.languageCode` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: Inherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc (new)
R5: `DeviceDefinition.property` (new:BackboneElement)
Element `DeviceDefinition.property` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.property` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific DeviceMetric and recorded using Observation. Static characteristics of an individual device could also be documented in a [Device] instance. The Device instance's properties, and their values, could be, but need not be, the same as in the associated DeviceDefinition.
R5: Organization responsible for device (new)
R5: `DeviceDefinition.owner` (new:Reference(Organization))
Element `DeviceDefinition.owner` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.owner` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: Details for human/organization for support (new)
R5: `DeviceDefinition.contact` (new:ContactPoint)
Element `DeviceDefinition.contact` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.contact` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `DeviceDefinition.contact`: `http://hl7.org/fhir/StructureDefinition/artifact-contact`. used for troubleshooting etc.
R5: An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device (new)
R5: `DeviceDefinition.link` (new:BackboneElement)
Element `DeviceDefinition.link` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.link` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: `DeviceDefinition.note` (new:Annotation)
Element `DeviceDefinition.note` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.note` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: A substance used to create the material(s) of which the device is made (new)
R5: `DeviceDefinition.material` (new:BackboneElement)
Element `DeviceDefinition.material` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.material` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version (new)
R5: `DeviceDefinition.productionIdentifierInUDI` (new:code)
Element `DeviceDefinition.productionIdentifierInUDI` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.productionIdentifierInUDI` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: Information aimed at providing directions for the usage of this model of device (new)
R5: `DeviceDefinition.guideline` (new:BackboneElement)
Element `DeviceDefinition.guideline` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.guideline` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). For more structured data, a ClinicalUseDefinition that points to the DeviceDefinition can be used.
R5: Tracking of latest field safety corrective action (new)
R5: `DeviceDefinition.correctiveAction` (new:BackboneElement)
Element `DeviceDefinition.correctiveAction` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.correctiveAction` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: Billing code or reference associated with the device (new)
R5: `DeviceDefinition.chargeItem` (new:BackboneElement)
Element `DeviceDefinition.chargeItem` is not mapped to FHIR STU3, since FHIR R5 `DeviceDefinition` is not mapped. Element `DeviceDefinition.chargeItem` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Identifier assigned to the resource for business purposes, outside the context of FHIR.
Identifies the 'type' of resource - equivalent to the resource name for other resources.
Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because the it defines the meaning of the resource and cannot be ignored.
Must be able to distinguish different types of Basic resources.
Codes for identifying types of resources not yet defined by FHIR
Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.
Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.
Needed for partitioning the resource by Patient.
./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)
Identifies when the resource was first created.
Allows ordering resource instances by time.
./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)
Indicates who was responsible for creating the resource instance.
./participation[typeCode='SUB'] (possibly through a ControlAct and Role)