. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Profile for device
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health.\" class=\"dict\" href=\"device-definitions.html#Device\"><b>Device</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifiers assigned to this device by various organizations. The most likely organizations to assign identifiers are the manufacturer and the owner, though regulatory agencies may also assign an identifier. The identifiers identify the particular device, not the kind of device.\" class=\"dict\" href=\"device-definitions.html#Device.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Instance id from manufacturer, owner and others</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A kind of this device.\" class=\"dict\" href=\"device-definitions.html#Device.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hit-testing.nist.gov:13110/rtmms/index.htm.html\">What kind of device this is</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A name of the manufacturer.\" class=\"dict\" href=\"device-definitions.html#Device.manufacturer\"><b>manufacturer</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of device manufacturer</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The "model" - 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.\" class=\"dict\" href=\"device-definitions.html#Device.model\"><b>model</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Model id assigned by the manufacturer</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.\" class=\"dict\" href=\"device-definitions.html#Device.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Version number (i.e. software)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Date of expiry of this device (if applicable).\" class=\"dict\" href=\"device-definitions.html#Device.expiry\"><b>expiry</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date of expiry of this device (if applicable)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"FDA Mandated Unique Device Identifier. Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm.\" class=\"dict\" href=\"device-definitions.html#Device.udi\"><b>udi</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">FDA Mandated Unique Device Identifier</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Lot number assigned by the manufacturer.\" class=\"dict\" href=\"device-definitions.html#Device.lotNumber\"><b>lotNumber</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Lot number of manufacture</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An organization that is responsible for the provision and ongoing maintenance of the device.\" class=\"dict\" href=\"device-definitions.html#Device.owner\"><b>owner</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Organization responsible for device</span><span style=\"color: Gray\"> --></span></owner>\r\n <<a title=\"The resource may be found in a literal location (i.e. GPS coordinates), a logical place (i.e. "in/with the patient"), or a coded location.\" class=\"dict\" href=\"device-definitions.html#Device.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where the resource is found</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Patient information, if the resource is affixed to a person.\" class=\"dict\" href=\"device-definitions.html#Device.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">If the resource is affixed to a person</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"Contact details for an organization or a particular human that is responsible for the device.\" class=\"dict\" href=\"device-definitions.html#Device.contact\"><b>contact</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Details for human/organization for support</span><span style=\"color: Gray\"> --></span></contact>\r\n <<a title=\"A network address on which the device may be contacted directly.\" class=\"dict\" href=\"device-definitions.html#Device.url\"><b>url</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Network address to contact device</span><span style=\"color: Gray\"> --></span>\r\n</Device>\r\n</pre></div>"
},
"name": "device",
"publisher": "FHIR Project",
"description": "Basic Profile. This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource is primarily used for recording which device performed an action and can also be used to track device location. It is also used for prescribing and dispensing devices for patient use. If the device is implanted in a patient, then the patient element will be present, and there would be no location. \r\n\r\nDevices that are implanted in a patient differ from medications because they are not \"used up\" - they remain active in a patient in an ongoing fashion. The Medication resource SHOULD not be used to represent implanted devices.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "Device",
"publish": true,
"element": [
{
"path": "Device",
"definition": {
"short": "An instance of a manufactured thing that is used in the provision of healthcare",
"formal": "This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Device"
}
]
}
},
{
"path": "Device.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Device.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"comments": "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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Device.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Device.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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.",
"comments": "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.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Device.identifier",
"definition": {
"short": "Instance id from manufacturer, owner and others",
"formal": "Identifiers assigned to this device by various organizations. The most likely organizations to assign identifiers are the manufacturer and the owner, though regulatory agencies may also assign an identifier. The identifiers identify the particular device, not the kind of device.",
"comments": "Often fixed to the device as a barcode. May include names given to the device in local usage. Note that some of the barcodes affixed to the device identify it's type, not it's instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "Device.type",
"definition": {
"short": "What kind of device this is",
"formal": "A kind of this device.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DeviceKind",
"isExtensible": true,
"conformance": "example",
"referenceUri": "http://hit-testing.nist.gov:13110/rtmms/index.htm"
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Device.manufacturer",
"definition": {
"short": "Name of device manufacturer",
"formal": "A name of the manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=MANU].scoper.name"
}
]
}
},
{
"path": "Device.model",
"definition": {
"short": "Model id assigned by the manufacturer",
"formal": "The \"model\" - 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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=MANU].code"
}
]
}
},
{
"path": "Device.version",
"definition": {
"short": "Version number (i.e. software)",
"formal": "The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".softwareName (included as part)"
}
]
}
},
{
"path": "Device.expiry",
"definition": {
"short": "Date of expiry of this device (if applicable)",
"formal": "Date of expiry of this device (if applicable).",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".expirationTime"
}
]
}
},
{
"path": "Device.udi",
"definition": {
"short": "FDA Mandated Unique Device Identifier",
"formal": "FDA Mandated Unique Device Identifier. Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm.",
"comments": "The unique identifier may identify an instance of a device uniquely, or it may just identify the type of the device. A portion of the UDI - the DI part - can be extracted from the UDI when required, and used to look up information about the device through the GUDID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id[where root is root for UDI]"
}
]
}
},
{
"path": "Device.lotNumber",
"definition": {
"short": "Lot number of manufacture",
"formal": "Lot number assigned by the manufacturer.",
"comments": "Alphanumeric Maximum 20.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".lotNumberText"
}
]
}
},
{
"path": "Device.owner",
"definition": {
"short": "Organization responsible for device",
"formal": "An organization that is responsible for the provision and ongoing maintenance of the device.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=OWN].scoper"
}
]
}
},
{
"path": "Device.location",
"definition": {
"short": "Where the resource is found",
"formal": "The resource may be found in a literal location (i.e. GPS coordinates), a logical place (i.e. \"in/with the patient\"), or a coded location.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=LOCE].scoper"
}
]
}
},
{
"path": "Device.patient",
"definition": {
"short": "If the resource is affixed to a person",
"formal": "Patient information, if the resource is affixed to a person.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=USED].scoper.playedRole[typeCode=PAT]"
}
]
}
},
{
"path": "Device.contact",
"definition": {
"short": "Details for human/organization for support",
"formal": "Contact details for an organization or a particular human that is responsible for the device.",
"comments": "used for troubleshooting etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scopedRole[typeCode=CON].player"
}
]
}
},
{
"path": "Device.url",
"definition": {
"short": "Network address to contact device",
"formal": "A network address on which the device may be contacted directly.",
"comments": "If the device is running a FHIR server, the network address should be the root URL from which a conformance statement may be retrieved.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".telecom"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"type": "token",
"documentation": "Instance id from manufacturer, owner and others",
"xpath": "f:Device/f:identifier"
},
{
"name": "location",
"type": "reference",
"documentation": "A location, where the resource is found",
"xpath": "f:Device/f:location"
},
{
"name": "manufacturer",
"type": "string",
"documentation": "The manufacturer of the device",
"xpath": "f:Device/f:manufacturer"
},
{
"name": "model",
"type": "string",
"documentation": "The model of the device",
"xpath": "f:Device/f:model"
},
{
"name": "organization",
"type": "reference",
"documentation": "The organization responsible for the device",
"xpath": "f:Device/f:owner"
},
{
"name": "patient",
"type": "reference",
"documentation": "Patient information, if the resource is affixed to a person",
"xpath": "f:Device/f:patient"
},
{
"name": "type",
"type": "token",
"documentation": "The type of the device",
"xpath": "f:Device/f:type"
},
{
"name": "udi",
"type": "string",
"documentation": "FDA Mandated Unique Device Identifier",
"xpath": "f:Device/f:udi"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change