This page is part of the Womens Health Technology Coordinated Registry Network FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions
StructureDefinition-devicedefinition-crn
source file: source/pages/_includes/devicedefinition-crn-intro.md
Scope and Usage
The profile is to be used for the WTH CRN project to capture the specific device information used to treat women with various health conditions.
Mandatory Data Elements and Terminology
The following data-elements are mandatory (i.e data MUST be present). blah blah blah
must have:
- deviceName
- manufacturer
Additional Profile specific implementation guidance:
Examples
- Examples to be added after finalization of data elements.
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/us/womens-health-registries/StructureDefinition/devicedefinition-crn
Published on Wed Feb 15 00:00:00 AEST 2017 as a active by .
This profile builds on DeviceDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceDefinition | 0..* | |||
udiDeviceIdentifier | S | 0..1 | BackboneElement | |
deviceIdentifier | S | 1..1 | string | |
issuer | S | 1..1 | uri | |
jurisdiction | S | 1..1 | uri | |
manufacturer[x] | S | 1..1 | string, Reference(Organization) | |
deviceName | S | 1..1 | BackboneElement | |
name | S | 1..1 | string | |
type | S | 1..1 | code | |
modelNumber | S | 0..1 | string | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceDefinition | I | 0..* | An instance of a medical-related component of a medical device | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | Instance identifier | |
udiDeviceIdentifier | SI | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
deviceIdentifier | S | 1..1 | string | The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier |
issuer | S | 1..1 | uri | The organization that assigns the identifier algorithm |
jurisdiction | S | 1..1 | uri | The jurisdiction to which the deviceIdentifier applies |
manufacturer[x] | S | 1..1 | string, Reference(Organization) | Name of device manufacturer |
deviceName | SI | 1..1 | BackboneElement | A name given to the device to identify it |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
name | S | 1..1 | string | The name of the device |
type | S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required) |
modelNumber | S | 0..1 | string | The model number for the device |
type | 0..1 | CodeableConcept | What kind of device or device system this is Binding: FHIRDeviceTypes (example) | |
specialization | I | 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
systemType | 1..1 | string | The standard that is used to operate and communicate | |
version | 0..1 | string | The version of the standard that is used to operate and communicate | |
version | 0..* | string | The actual design of the device or software version running on the device | |
safety | Σ | 0..* | CodeableConcept | Safety characteristics of the device |
shelfLifeStorage | 0..* | ProductShelfLife | Shelf Life and storage information | |
physicalCharacteristics | 0..1 | ProdCharacteristic | Dimensions, color etc. | |
languageCode | 0..* | CodeableConcept | Language code for the human-readable text strings produced by the device (all supported) | |
capability | I | 0..* | BackboneElement | Device capabilities |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
type | 1..1 | CodeableConcept | Type of capability | |
description | 0..* | CodeableConcept | Description of capability | |
property | I | 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
type | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |
valueQuanity | 0..* | Quantity | Property value as a quantity | |
valueCode | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |
owner | 0..1 | Reference(Organization) | Organization responsible for device | |
contact | 0..* | ContactPoint | Details for human/organization for support | |
url | 0..1 | uri | Network address to contact device | |
onlineInformation | 0..1 | uri | Access to on-line information | |
note | 0..* | Annotation | Device notes and comments | |
quantity | 0..1 | Quantity | The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product) | |
parentDevice | Σ | 0..1 | Reference(DeviceDefinition) | The parent device it can be part of |
material | I | 0..* | BackboneElement | A substance used to create the material(s) of which the device is made |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
substance | 1..1 | CodeableConcept | The substance | |
alternate | 0..1 | boolean | Indicates an alternative material of the device | |
allergenicIndicator | 0..1 | boolean | Whether the substance is a known or suspected allergen | |
Documentation for this format |
// { "resourceType" : "DeviceDefinition", "id" : "<id>", // Logical id of this artifact "meta" : {Meta}, // Metadata about the resource "implicitRules" : "<uri>", // A set of rules under which this content was created "language" : "<code>", // Language of the resource content "text" : {Narrative}, // Text summary of the resource, for human interpretation "contained" : [{Resource}], // Contained, inline Resources "extension": [ ], "identifier" : [{Identifier}], // Instance identifier "udiDeviceIdentifier" : [{ // C? Only One! Unique Device Identifier (UDI) Barcode string "extension": [ ], "deviceIdentifier" : "<string>", // R! The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier "issuer" : "<uri>", // R! The organization that assigns the identifier algorithm "jurisdiction" : "<uri>", // R! The jurisdiction to which the deviceIdentifier applies }], // manufacturer[x]: Name of device manufacturer. One of these 2: "manufacturerString" : "<string>", // R! Name of device manufacturer "manufacturerReference" : {Reference(Organization)}, // R! Name of device manufacturer "deviceName" : [{ // C? R! Only One! A name given to the device to identify it "extension": [ ], "name" : "<string>", // R! The name of the device "type" : "<code>", // R! udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other }], "modelNumber" : "<string>", // The model number for the device "type" : {CodeableConcept}, // What kind of device or device system this is "specialization" : [{ // C? The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication "extension": [ ], "systemType" : "<string>", // R! The standard that is used to operate and communicate "version" : "<string>", // The version of the standard that is used to operate and communicate }], "version" : ["<string>"], // The actual design of the device or software version running on the device "safety" : [{CodeableConcept}], // Safety characteristics of the device "shelfLifeStorage" : [{ProductShelfLife}], // Shelf Life and storage information "physicalCharacteristics" : {ProdCharacteristic}, // Dimensions, color etc. "languageCode" : [{CodeableConcept}], // Language code for the human-readable text strings produced by the device (all supported) "capability" : [{ // C? Device capabilities "extension": [ ], "type" : {CodeableConcept}, // R! Type of capability "description" : [{CodeableConcept}], // Description of capability }], "property" : [{ // C? The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties "extension": [ ], "type" : {CodeableConcept}, // R! Code that specifies the property DeviceDefinitionPropetyCode (Extensible) "valueQuanity" : [{Quantity}], // Property value as a quantity "valueCode" : [{CodeableConcept}], // Property value as a code, e.g., NTP4 (synced to NTP) }], "owner" : {Reference(Organization)}, // Organization responsible for device "contact" : [{ContactPoint}], // Details for human/organization for support "url" : "<uri>", // Network address to contact device "onlineInformation" : "<uri>", // Access to on-line information "note" : [{Annotation}], // Device notes and comments "quantity" : {Quantity}, // The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product) "parentDevice" : {Reference(DeviceDefinition)}, // The parent device it can be part of "material" : [{ // C? A substance used to create the material(s) of which the device is made "extension": [ ], "substance" : {CodeableConcept}, // R! The substance "alternate" : <boolean>, // Indicates an alternative material of the device "allergenicIndicator" : <boolean>, // Whether the substance is a known or suspected allergen }] }
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceDefinition | 0..* | |||
udiDeviceIdentifier | S | 0..1 | BackboneElement | |
deviceIdentifier | S | 1..1 | string | |
issuer | S | 1..1 | uri | |
jurisdiction | S | 1..1 | uri | |
manufacturer[x] | S | 1..1 | string, Reference(Organization) | |
deviceName | S | 1..1 | BackboneElement | |
name | S | 1..1 | string | |
type | S | 1..1 | code | |
modelNumber | S | 0..1 | string | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceDefinition | I | 0..* | An instance of a medical-related component of a medical device | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | Instance identifier | |
udiDeviceIdentifier | SI | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
deviceIdentifier | S | 1..1 | string | The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier |
issuer | S | 1..1 | uri | The organization that assigns the identifier algorithm |
jurisdiction | S | 1..1 | uri | The jurisdiction to which the deviceIdentifier applies |
manufacturer[x] | S | 1..1 | string, Reference(Organization) | Name of device manufacturer |
deviceName | SI | 1..1 | BackboneElement | A name given to the device to identify it |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
name | S | 1..1 | string | The name of the device |
type | S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required) |
modelNumber | S | 0..1 | string | The model number for the device |
type | 0..1 | CodeableConcept | What kind of device or device system this is Binding: FHIRDeviceTypes (example) | |
specialization | I | 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
systemType | 1..1 | string | The standard that is used to operate and communicate | |
version | 0..1 | string | The version of the standard that is used to operate and communicate | |
version | 0..* | string | The actual design of the device or software version running on the device | |
safety | Σ | 0..* | CodeableConcept | Safety characteristics of the device |
shelfLifeStorage | 0..* | ProductShelfLife | Shelf Life and storage information | |
physicalCharacteristics | 0..1 | ProdCharacteristic | Dimensions, color etc. | |
languageCode | 0..* | CodeableConcept | Language code for the human-readable text strings produced by the device (all supported) | |
capability | I | 0..* | BackboneElement | Device capabilities |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
type | 1..1 | CodeableConcept | Type of capability | |
description | 0..* | CodeableConcept | Description of capability | |
property | I | 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
type | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |
valueQuanity | 0..* | Quantity | Property value as a quantity | |
valueCode | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |
owner | 0..1 | Reference(Organization) | Organization responsible for device | |
contact | 0..* | ContactPoint | Details for human/organization for support | |
url | 0..1 | uri | Network address to contact device | |
onlineInformation | 0..1 | uri | Access to on-line information | |
note | 0..* | Annotation | Device notes and comments | |
quantity | 0..1 | Quantity | The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product) | |
parentDevice | Σ | 0..1 | Reference(DeviceDefinition) | The parent device it can be part of |
material | I | 0..* | BackboneElement | A substance used to create the material(s) of which the device is made |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
substance | 1..1 | CodeableConcept | The substance | |
alternate | 0..1 | boolean | Indicates an alternative material of the device | |
allergenicIndicator | 0..1 | boolean | Whether the substance is a known or suspected allergen | |
Documentation for this format |
JSON Template
// { "resourceType" : "DeviceDefinition", "id" : "<id>", // Logical id of this artifact "meta" : {Meta}, // Metadata about the resource "implicitRules" : "<uri>", // A set of rules under which this content was created "language" : "<code>", // Language of the resource content "text" : {Narrative}, // Text summary of the resource, for human interpretation "contained" : [{Resource}], // Contained, inline Resources "extension": [ ], "identifier" : [{Identifier}], // Instance identifier "udiDeviceIdentifier" : [{ // C? Only One! Unique Device Identifier (UDI) Barcode string "extension": [ ], "deviceIdentifier" : "<string>", // R! The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier "issuer" : "<uri>", // R! The organization that assigns the identifier algorithm "jurisdiction" : "<uri>", // R! The jurisdiction to which the deviceIdentifier applies }], // manufacturer[x]: Name of device manufacturer. One of these 2: "manufacturerString" : "<string>", // R! Name of device manufacturer "manufacturerReference" : {Reference(Organization)}, // R! Name of device manufacturer "deviceName" : [{ // C? R! Only One! A name given to the device to identify it "extension": [ ], "name" : "<string>", // R! The name of the device "type" : "<code>", // R! udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other }], "modelNumber" : "<string>", // The model number for the device "type" : {CodeableConcept}, // What kind of device or device system this is "specialization" : [{ // C? The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication "extension": [ ], "systemType" : "<string>", // R! The standard that is used to operate and communicate "version" : "<string>", // The version of the standard that is used to operate and communicate }], "version" : ["<string>"], // The actual design of the device or software version running on the device "safety" : [{CodeableConcept}], // Safety characteristics of the device "shelfLifeStorage" : [{ProductShelfLife}], // Shelf Life and storage information "physicalCharacteristics" : {ProdCharacteristic}, // Dimensions, color etc. "languageCode" : [{CodeableConcept}], // Language code for the human-readable text strings produced by the device (all supported) "capability" : [{ // C? Device capabilities "extension": [ ], "type" : {CodeableConcept}, // R! Type of capability "description" : [{CodeableConcept}], // Description of capability }], "property" : [{ // C? The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties "extension": [ ], "type" : {CodeableConcept}, // R! Code that specifies the property DeviceDefinitionPropetyCode (Extensible) "valueQuanity" : [{Quantity}], // Property value as a quantity "valueCode" : [{CodeableConcept}], // Property value as a code, e.g., NTP4 (synced to NTP) }], "owner" : {Reference(Organization)}, // Organization responsible for device "contact" : [{ContactPoint}], // Details for human/organization for support "url" : "<uri>", // Network address to contact device "onlineInformation" : "<uri>", // Access to on-line information "note" : [{Annotation}], // Device notes and comments "quantity" : {Quantity}, // The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product) "parentDevice" : {Reference(DeviceDefinition)}, // The parent device it can be part of "material" : [{ // C? A substance used to create the material(s) of which the device is made "extension": [ ], "substance" : {CodeableConcept}, // R! The substance "alternate" : <boolean>, // Indicates an alternative material of the device "allergenicIndicator" : <boolean>, // Whether the substance is a known or suspected allergen }] }
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Quick Start
Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.
Search Requirements
There are no specific search requirements by the WHT CRN IG beyond what is required by the base resource.