{
"description": null,
"_filename": "StructureDefinition-argo-device.json",
"package_name": "fhir.argonaut.r2",
"date": "2016-10-18T00:00:00+11:00",
"publisher": "Argonaut Project",
"fhirVersion": "1.0.2",
"name": "Argonaut Device Profile",
"mapping": [ {
"uri": "http://unknown.org/US Core (STU3)",
"name": "US Core (STU3)",
"identity": "us-core-(stu3)"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": null,
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.0",
"snapshot": {
"element": [ {
"path": "Device",
"min": 0,
"definition": "This resource identifies an instance 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 includes 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.",
"isModifier": false,
"short": "Argonaut Device Profile",
"name": "argoprofile",
"mapping": [ {
"map": "Device",
"identity": "rim"
}, {
"map": "administrative.device",
"identity": "w5"
}, {
"map": "Device",
"identity": "us-core-(stu3)"
} ],
"type": [ {
"code": "Device"
} ],
"mustSupport": false,
"max": "*",
"id": "Device:argoprofile",
"maxLength": 0,
"base": {
"max": "*",
"min": 0,
"path": "Device"
},
"isSummary": false
}, {
"path": "Device.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"name": "Device:argoprofile.id",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"max": "1",
"id": "Device:argoprofile.id",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.id"
},
"isSummary": true
}, {
"path": "Device.meta",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Metadata about the resource",
"name": "Device:argoprofile.meta",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "Device:argoprofile.meta",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.meta"
},
"isSummary": true
}, {
"path": "Device.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"name": "Device:argoprofile.implicitRules",
"comments": "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 as much as possible.",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "Device:argoprofile.implicitRules",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.implicitRules"
},
"isSummary": true
}, {
"path": "Device.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"name": "Device:argoprofile.language",
"comments": "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).",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
},
"max": "1",
"id": "Device:argoprofile.language",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.language"
},
"isSummary": false
}, {
"path": "Device.text",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"name": "Device:argoprofile.text",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Device:argoprofile.text",
"condition": [ "dom-1" ],
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.text"
},
"isSummary": false
}, {
"path": "Device.contained",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Contained, inline Resources",
"name": "Device:argoprofile.contained",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Device:argoprofile.contained",
"maxLength": 0,
"base": {
"max": "*",
"min": 0,
"path": "Device.contained"
},
"isSummary": false
}, {
"path": "Device.extension",
"min": 0,
"definition": "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 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.",
"isModifier": false,
"short": "Additional Content defined by implementations",
"name": "Device:argoprofile.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 level of simplicity for everyone.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Device:argoprofile.extension",
"maxLength": 0,
"base": {
"max": "*",
"min": 0,
"path": "Device.extension"
},
"isSummary": false
}, {
"path": "Device.modifierExtension",
"min": 0,
"definition": "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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"name": "Device:argoprofile.modifierExtension",
"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 level of simplicity for everyone.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Device:argoprofile.modifierExtension",
"maxLength": 0,
"base": {
"max": "*",
"min": 0,
"path": "Device.modifierExtension"
},
"isSummary": false
}, {
"path": "Device.identifier",
"min": 0,
"definition": "Unique instance identifiers assigned to a device by organizations like manufacturers or owners. If the identifier identifies the type of device, Device.type should be used.",
"isModifier": false,
"short": "Instance id from manufacturer, owner, and others",
"name": "Device:argoprofile.identifier",
"comments": "Often fixed to the device as a barcode and may include names given to the device in local usage. Note that some of the barcodes affixed to the device identify its type, not its instance. For the FDA mandated Unique Device Identifier (UDI) use the Device.udi element.",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "Device:argoprofile.identifier",
"maxLength": 0,
"base": {
"max": "*",
"min": 0,
"path": "Device.identifier"
},
"isSummary": false
}, {
"path": "Device.type",
"min": 1,
"definition": "Code or identifier to identify a kind of device.",
"isModifier": false,
"short": "What kind of device this is",
"name": "Device:argoprofile.type",
"comments": "For the FDA mandated Unique Device Identifier (UDI) use the Device.udi element.",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
}, {
"map": "Device.type",
"identity": "us-core-(stu3)"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"description": "Codes to identify medical devices",
"valueSetReference": {
"reference": "http://fhir.org/guides/argonaut/ValueSet/device-kind"
}
},
"max": "1",
"id": "Device:argoprofile.type",
"maxLength": 0,
"base": {
"max": "1",
"min": 1,
"path": "Device.type"
},
"isSummary": false
}, {
"path": "Device.note",
"min": 0,
"definition": "Descriptive information, usage information or implantation information that is not captured in an existing element.",
"isModifier": false,
"short": "Device notes and comments",
"name": "Device:argoprofile.note",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"mustSupport": false,
"max": "*",
"id": "Device:argoprofile.note",
"maxLength": 0,
"base": {
"max": "*",
"min": 0,
"path": "Device.note"
},
"isSummary": false
}, {
"path": "Device.status",
"min": 0,
"definition": "Status of the Device availability.",
"isModifier": true,
"short": "available | not-available | entered-in-error",
"name": "Device:argoprofile.status",
"mapping": [ {
"map": ".statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"description": "The availability status of the device.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/devicestatus"
}
},
"max": "1",
"id": "Device:argoprofile.status",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.status"
},
"isSummary": true
}, {
"path": "Device.manufacturer",
"min": 0,
"definition": "A name of the manufacturer.",
"isModifier": false,
"short": "Name of device manufacturer",
"name": "Device:argoprofile.manufacturer",
"mapping": [ {
"map": ".playedRole[typeCode=MANU].scoper.name",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Device:argoprofile.manufacturer",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.manufacturer"
},
"isSummary": false
}, {
"path": "Device.model",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Model id assigned by the manufacturer",
"name": "Device:argoprofile.model",
"mapping": [ {
"map": ".playedRole[typeCode=MANU].code",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Device:argoprofile.model",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.model"
},
"isSummary": false
}, {
"path": "Device.version",
"min": 0,
"definition": "The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.",
"isModifier": false,
"short": "Version number (i.e. software)",
"name": "Device:argoprofile.version",
"mapping": [ {
"map": ".softwareName (included as part)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Device:argoprofile.version",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.version"
},
"isSummary": false
}, {
"path": "Device.manufactureDate",
"min": 0,
"definition": "The date and time when the device was manufactured.",
"isModifier": false,
"short": "Manufacture date",
"name": "Device:argoprofile.manufactureDate",
"mapping": [ {
"map": ".existenceTime.low",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "Device:argoprofile.manufactureDate",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.manufactureDate"
},
"isSummary": false
}, {
"path": "Device.expiry",
"min": 0,
"definition": "The date and time beyond which this device is no longer valid or should not be used (if applicable).",
"isModifier": false,
"short": "Date and time of expiry of this device (if applicable)",
"name": "Device:argoprofile.expiry",
"mapping": [ {
"map": ".expirationTime",
"identity": "rim"
}, {
"map": "when.done",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "Device:argoprofile.expiry",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.expiry"
},
"isSummary": false
}, {
"path": "Device.udi",
"min": 1,
"definition": "United States Food and Drug Administration mandated Unique Device Identifier (UDI). 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.",
"isModifier": false,
"short": "FDA mandated Unique Device Identifier",
"name": "Device:argoprofile.udi",
"comments": "The unique identifier may identify an instance of a device uniquely, or it may only 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.",
"mapping": [ {
"map": ".id[where root is root for UDI]",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
}, {
"map": "Device.udiCarrier",
"identity": "us-core-(stu3)"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "UDI", "Barcode String" ],
"max": "1",
"id": "Device:argoprofile.udi",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.udi"
},
"isSummary": false
}, {
"path": "Device.lotNumber",
"min": 0,
"definition": "Lot number assigned by the manufacturer.",
"isModifier": false,
"short": "Lot number of manufacture",
"name": "Device:argoprofile.lotNumber",
"comments": "Alphanumeric Maximum 20.",
"mapping": [ {
"map": ".lotNumberText",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Device:argoprofile.lotNumber",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.lotNumber"
},
"isSummary": false
}, {
"path": "Device.owner",
"min": 0,
"definition": "An organization that is responsible for the provision and ongoing maintenance of the device.",
"isModifier": false,
"short": "Organization responsible for device",
"name": "Device:argoprofile.owner",
"mapping": [ {
"map": ".playedRole[typeCode=OWN].scoper",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"profile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Device:argoprofile.owner",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.owner"
},
"isSummary": false
}, {
"path": "Device.location",
"min": 0,
"definition": "The place where the device can be found.",
"isModifier": false,
"short": "Where the resource is found",
"name": "Device:argoprofile.location",
"mapping": [ {
"map": ".playedRole[typeCode=LOCE].scoper",
"identity": "rim"
}, {
"map": "where",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"profile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Device:argoprofile.location",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.location"
},
"isSummary": false
}, {
"path": "Device.patient",
"min": 1,
"definition": "Patient information, if the resource is affixed to a person.",
"isModifier": false,
"short": "If the resource is affixed to a person",
"name": "Device:argoprofile.patient",
"mapping": [ {
"map": ".playedRole[typeCode=USED].scoper.playedRole[typeCode=PAT]",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
}, {
"map": "Device.patient",
"identity": "us-core-(stu3)"
} ],
"type": [ {
"code": "Reference",
"profile": [ "http://fhir.org/guides/argonaut/StructureDefinition/argo-patient" ]
} ],
"mustSupport": true,
"max": "1",
"id": "Device:argoprofile.patient",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.patient"
},
"isSummary": false
}, {
"path": "Device.contact",
"min": 0,
"definition": "Contact details for an organization or a particular human that is responsible for the device.",
"isModifier": false,
"short": "Details for human/organization for support",
"name": "Device:argoprofile.contact",
"comments": "used for troubleshooting etc.",
"mapping": [ {
"map": ".scopedRole[typeCode=CON].player",
"identity": "rim"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"mustSupport": false,
"max": "*",
"id": "Device:argoprofile.contact",
"maxLength": 0,
"base": {
"max": "*",
"min": 0,
"path": "Device.contact"
},
"isSummary": false
}, {
"path": "Device.url",
"min": 0,
"definition": "A network address on which the device may be contacted directly.",
"isModifier": false,
"short": "Network address to contact device",
"name": "Device:argoprofile.url",
"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.",
"mapping": [ {
"map": ".telecom",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "Device:argoprofile.url",
"maxLength": 0,
"base": {
"max": "1",
"min": 0,
"path": "Device.url"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "a40be573-6e09-4ac9-8aa4-30c939b22512",
"kind": "resource",
"url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-device",
"base": "http://hl7.org/fhir/StructureDefinition/Device",
"version": null,
"differential": {
"element": [ {
"path": "Device",
"min": 0,
"isModifier": false,
"short": "Argonaut Device Profile",
"name": "argoprofile",
"mapping": [ {
"map": "Device",
"identity": "us-core-(stu3)"
} ],
"type": [ {
"code": "Device"
} ],
"mustSupport": false,
"id": "Device:argoprofile",
"maxLength": 0,
"isSummary": false
}, {
"path": "Device.type",
"min": 1,
"isModifier": false,
"name": "Device:argoprofile.type",
"mapping": [ {
"map": "Device.type",
"identity": "us-core-(stu3)"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"description": "Codes to identify medical devices",
"valueSetReference": {
"reference": "http://fhir.org/guides/argonaut/ValueSet/device-kind"
}
},
"max": "1",
"id": "Device:argoprofile.type",
"maxLength": 0,
"isSummary": false
}, {
"path": "Device.udi",
"min": 1,
"isModifier": false,
"name": "Device:argoprofile.udi",
"mapping": [ {
"map": "Device.udiCarrier",
"identity": "us-core-(stu3)"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "UDI", "Barcode String" ],
"max": "1",
"id": "Device:argoprofile.udi",
"maxLength": 0,
"isSummary": false
}, {
"path": "Device.patient",
"min": 1,
"isModifier": false,
"name": "Device:argoprofile.patient",
"mapping": [ {
"map": "Device.patient",
"identity": "us-core-(stu3)"
} ],
"type": [ {
"code": "Reference",
"profile": [ "http://fhir.org/guides/argonaut/StructureDefinition/argo-patient" ]
} ],
"mustSupport": true,
"max": "1",
"id": "Device:argoprofile.patient",
"maxLength": 0,
"isSummary": false
} ]
},
"contact": [ {
"telecom": [ {
"rank": 0,
"value": "http://argonautwiki.hl7.org",
"system": "other"
} ]
} ],
"constrainedType": "Device"
}