Generated Narrative: StructureDefinition profile-DeviceAssociation-for-Device Name Flags Card. Type Description & Constraints Device 0..* Device Item used in healthcare #xD; Slices for extension 2..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:device 1..1 Reference(Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device) R5: Reference to the devices associated with the patient or group (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceAssociation.device #xD; extension:category 0..* CodeableConcept R5: Describes the relationship between the device and subject (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceAssociation.category #xD; extension:status 1..1 CodeableConcept R5: implanted | explanted | attached | entered-in-error | unknown (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceAssociation.status Binding: R5DeviceassociationStatusForR3 (0.1.0) (required): Describes the lifecycle of the association. #xD; extension:statusReason 0..* CodeableConcept R5: The reasons given for the current association status (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceAssociation.statusReason Binding: R5DeviceassociationStatusReasonForR3 (0.1.0) (required): Describes the reason for changing the status of the association. #xD; extension:bodyStructure 0..1 Reference(Cross-version Profile for R5.BodyStructure for use in FHIR STU3(0.1.0) | BodySite) R5: Current anatomical location of the device in/on subject (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceAssociation.bodyStructure #xD; extension:period 0..1 Period R5: Begin and end dates and times for the device association (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceAssociation.period #xD; extension:operation 0..* (Complex) R5: The details about the device when it is in use to describe its operation (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceAssociation.operation #xD; patient #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The individual, group of individuals or device that the device is on or associated with URL: http://hl7.org/fhir/StructureDefinition/alternate-reference #xD; Documentation for this format
Cross-version Profile for R5.DeviceAssociation for use in FHIR STU3
This cross-version profile allows R5 DeviceAssociation content to be represented via FHIR STU3 Device resources.
This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.
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: Reference to the devices associated with the patient or group (new)
R5: `DeviceAssociation.device` (new:Reference(Device))
Element `DeviceAssociation.device` has a context of Device based on following the parent source element upwards and mapping to `Device`. Element `DeviceAssociation.device` 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: Describes the relationship between the device and subject (new)
R5: `DeviceAssociation.category` (new:CodeableConcept)
Element `DeviceAssociation.category` has a context of Device based on following the parent source element upwards and mapping to `Device`. Element `DeviceAssociation.category` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: implanted | explanted | attached | entered-in-error | unknown (new)
R5: `DeviceAssociation.status` (new:CodeableConcept)
Element `DeviceAssociation.status` has a context of Device based on following the parent source element upwards and mapping to `Device`. Element `DeviceAssociation.status` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: The reasons given for the current association status (new)
R5: `DeviceAssociation.statusReason` (new:CodeableConcept)
Element `DeviceAssociation.statusReason` has a context of Device based on following the parent source element upwards and mapping to `Device`. Element `DeviceAssociation.statusReason` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: Current anatomical location of the device in/on subject (new)
R5: `DeviceAssociation.bodyStructure` (new:Reference(BodyStructure))
Element `DeviceAssociation.bodyStructure` has a context of Device based on following the parent source element upwards and mapping to `Device`. Element `DeviceAssociation.bodyStructure` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: Begin and end dates and times for the device association (new)
R5: `DeviceAssociation.period` (new:Period)
Element `DeviceAssociation.period` has a context of Device based on following the parent source element upwards and mapping to `Device`. Element `DeviceAssociation.period` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: The details about the device when it is in use to describe its operation (new)
R5: `DeviceAssociation.operation` (new:BackboneElement)
Element `DeviceAssociation.operation` has a context of Device based on following the parent source element upwards and mapping to `Device`. Element `DeviceAssociation.operation` 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.
Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. For [UDI](http://hl7.org/fhir/STU3/device.html#5.11.3.2.2), this element corresponds to the variable portion of the UDI that identifies the serial number of a specific device. See [UDI mappings](http://hl7.org/fhir/STU3/device-mappings.html#udi) for a complete mapping of UDI parts to Device.
The serial number which is a component of the production identifier (PI), a conditional, variable portion of a UDI. The identifier.type code should be set to “SNO”(Serial Number) and the system left empty.
Unique Device Identifier (UDI) Barcode string
[Unique device identifier (UDI)](http://hl7.org/fhir/STU3/device.html#5.11.3.2.2) assigned to device label or package.
UDI may identify an unique instance of a device, or it may only identify the type of the device. See [UDI mappings](http://hl7.org/fhir/STU3/device-mappings.html#udi) for a complete mapping of UDI parts to Device.
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Additional Content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. 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.
May be used to represent additional information that is not part of the basic definition of the element, 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.
The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.
The device identifier (DI), a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.
Name of device as used in labeling or catalog.
Use the `Device.type` for a generic type or kind of device name. Note the [GUDID](http://www.fda.gov/medicaldevices/deviceregulationandguidance/uniquedeviceidentification/globaludidatabasegudid/default.htm) lists the name as the 'Brand Name'.
Propietary/Trade Name of the medical Device as used in the labeling or catalog
The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace. with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.
Allows a recipient of a UDI to know which database will contain the UDI-associated metadata.
The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.
A unique device identifier (UDI) on a device label in plain text
The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - E.g a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats *SHALL* be base64 encoded.
The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.
Automatic Identification and Data Capture
A unique device identifier (UDI) on a device label a form that uses automatic identification and data capture (AIDC) technology.
Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.
All UDIs are to be issued under a system operated by an Jurisdiction-accredited issuing agency. GS1 DIs: http://hl7.org/fhir/NamingSystem/gs1 HIBCC DIs: http://hl7.org/fhir/NamingSystem/hibcc ICCBBA DIs for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood ICCBA DIs for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other
A coded entry to indicate how the data was entered.
Supports a way to distinguish hand entered from machine read data.
Codes to identify how UDI data was entered
active | inactive | entered-in-error | unknown
This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the device (record)as not currently valid.
Code or identifier to identify a kind of device.
Type description using GMDN or other code system
Lot number assigned by the manufacturer.
The lot or batch number within which a device was manufactured - which is a component of the production identifier (PI), a conditional, variable portion of a UDI.
The date and time when the device was manufactured.
The date a specific device was manufactured - which is a component of the production identifier (PI), a conditional, variable portion of a UDI. For FHIR, The datetime syntax must converted to YYYY-MM-DD[THH:MM:SS]. If hour is present, the minutes and seconds should both be set to “00”.
Date and time of expiry of this device (if applicable)
The date and time beyond which this device is no longer valid or should not be used (if applicable).
the expiration date of a specific device - which is a component of the production identifier (PI), a conditional, variable portion of a UDI. For FHIR, The datetime syntax must converted to YYYY-MM-DD[THH:MM:SS]. If hour is present, the minutes and seconds should both be set to “00”.
The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.
The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.
Patient information, If the device is affixed to a person.
If the device is implanted in a patient, then need to associate the device to the patient.
Extensions are always sliced by (at least) url
R5: The individual, group of individuals or device that the device is on or associated with
Element `DeviceAssociation.subject` is mapped to FHIR STU3 element `Device.patient` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `DeviceAssociation.subject` with unmapped reference targets: Device, Group, Patient, Practitioner, RelatedPerson.
Literal reference, Relative, internal or absolute URL
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Logical reference, when literal reference is not known
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Plain text narrative that identifies the resource in addition to the resource reference.
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
An organization that is responsible for the provision and ongoing maintenance of the device.
Details for human/organization for support
Contact details for an organization or a particular human that is responsible for the device.
The place where the device can be found.
Device.location can be used to track device location.
A network address on which the device may be contacted directly.
If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.
Descriptive information, usage information or implantation information that is not captured in an existing element.
Provides additional safety characteristics about a medical device. For example devices containing latex.
Codes used to identify medical devices safety characterics. These codes are derived in part from the [United States Food and Drug Administration recommendations](http://www.fda.gov/downloads/medicaldevices/deviceregulationandguidance/guidancedocuments/ucm107708.pdf) and are provided here as a suggestive example.