FHIR IG analytics| Package | hl7.fhir.uv.xver-r4b.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-profile-Device.json |
| FHIR Version | R3 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition profile-Device
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Device | 0..* | Device | Item used in healthcare | |
  meta | ||||
   Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:meta | 0..1 | Meta | R4B: meta additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.meta | |
| text | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:text | 0..1 | (Complex) | R4B: text additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.text | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:definition | 0..1 | Reference(Cross-version Profile for R4B.DeviceDefinition for use in FHIR STU3(0.1.0) | Basic) | R4B: The reference to the definition for the device (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.definition | |
| extension:statusReason | 0..* | CodeableConcept | R4B: online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.statusReason Binding: R4BDeviceStatusReasonForR3 (0.1.0) (extensible): The availability status reason of the device. | |
| extension:distinctIdentifier | 0..1 | string | R4B: The distinct identification string (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.distinctIdentifier | |
| extension:serialNumber | 0..1 | string | R4B: Serial number assigned by the manufacturer (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.serialNumber | |
| extension:partNumber | 0..1 | string | R4B: The part number or catalog number of the device (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.partNumber | |
| extension:specialization | 0..* | (Complex) | R4B: The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.specialization | |
| extension:property | 0..* | (Complex) | R4B: The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.property | |
| extension:parent | 0..1 | Reference(Cross-version Profile for R4B.Device for use in FHIR STU3(0.1.0) | Device) | R4B: The device that this device is attached to or is part of (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.parent | |
| identifier | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:identifier | 0..* | Identifier | R4B: identifier additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.identifier | |
| udi | ||||
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:name | 1..1 | string | R4B: The name that identifies the device (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.deviceName.name | |
| extension:type | 1..1 | code | R4B: udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.deviceName.type Binding: R4BDeviceNametypeForR3 (0.1.0) (required): The type of name the device is referred by. | |
| version | ||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:type | 0..1 | CodeableConcept | R4B: The type of the device version, e.g. manufacturer, approved, internal (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.version.type | |
| extension:component | 0..1 | Identifier | R4B: A single component of the device version (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.version.component | |
| extension:value | 1..1 | string | R4B: The version text (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.version.value | |
| patient | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:patient | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: patient additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| owner | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:owner | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: owner additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| contact | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:contact | 0..* | ContactPoint | R4B: contact additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.contact | |
| location | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:location | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: Where the device is found additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| note | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:note | 0..* | Annotation | R4B: note additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.note | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "profile-Device",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"extension": [
{
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r4b.r3"
},
{
"url": "version",
"valueString": "0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
]
}
}
],
"url": "http://hl7.org/fhir/4.3/StructureDefinition/profile-Device",
"version": "0.1.0",
"name": "Profile_R4B_Device_R3",
"title": "Cross-version Profile for R4B.Device for use in FHIR STU3",
"status": "active",
"experimental": false,
"date": "2026-03-17T16:04:25.0046846-05:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "This cross-version profile allows R4B Device content to be represented via FHIR STU3 Device resources.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "udi",
"uri": "http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm",
"name": "UDI Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "Device",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Device",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Device",
"path": "Device",
"short": "Item used in healthcare",
"definition": "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.",
"min": 0,
"max": "*",
"base": {
"path": "Device",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "Device"
},
{
"identity": "w5",
"map": "administrative.device"
}
]
},
{
"id": "Device.id",
"path": "Device.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "Device.meta",
"path": "Device.meta",
"short": "Metadata about the resource",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "Device.meta.id",
"path": "Device.meta.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Device.meta.extension",
"path": "Device.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Device.meta.extension:meta",
"path": "Device.meta.extension",
"sliceName": "meta",
"short": "R4B: meta additional types",
"definition": "R4B: `Device.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)",
"comment": "Element `Device.meta` is mapped to FHIR STU3 element `Device.meta` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.meta` do not cover the following types: Meta.\nThe mappings for `Device.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.meta|0.1.0"
}
]
},
{
"id": "Device.meta.versionId",
"path": "Device.meta.versionId",
"short": "Version specific identifier",
"definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.versionId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "Device.meta.lastUpdated",
"path": "Device.meta.lastUpdated",
"short": "When the resource version last changed",
"definition": "When the resource last changed - e.g. when the version changed.",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.lastUpdated",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"isSummary": true
},
{
"id": "Device.meta.profile",
"path": "Device.meta.profile",
"short": "Profiles this resource claims to conform to",
"definition": "A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/STU3/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/STU3/).",
"comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.profile",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "Device.meta.security",
"path": "Device.meta.security",
"short": "Security Labels applied to this resource",
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.security",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}
],
"strength": "extensible",
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels|3.0.2"
}
}
},
{
"id": "Device.meta.tag",
"path": "Device.meta.tag",
"short": "Tags applied to this resource",
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.tag",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
}
],
"strength": "example",
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/common-tags|3.0.2"
}
}
},
{
"id": "Device.implicitRules",
"path": "Device.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "Device.language",
"path": "Device.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages|3.0.2"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages|3.0.2"
}
}
},
{
"id": "Device.text",
"path": "Device.text",
"short": "Text summary of the resource, for human interpretation",
"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.",
"comment": "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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "Device.text.id",
"path": "Device.text.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Device.text.extension",
"path": "Device.text.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Device.text.extension:text",
"path": "Device.text.extension",
"sliceName": "text",
"short": "R4B: text additional types",
"definition": "R4B: `Device.text` additional types (Narrative) additional types from child elements (div, status)",
"comment": "Element `Device.text` is mapped to FHIR STU3 element `Device.text` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.text` do not cover the following types: Narrative.\nThe mappings for `Device.text` do not cover the following types based on type expansion: div, status.\nContained 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 information is added later.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.text|0.1.0"
}
]
},
{
"id": "Device.text.status",
"path": "Device.text.status",
"short": "generated | extensions | additional | empty",
"definition": "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.",
"min": 1,
"max": "1",
"base": {
"path": "Narrative.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NarrativeStatus"
}
],
"strength": "required",
"description": "The status of a resource narrative",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/narrative-status|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Device.text.div",
"path": "Device.text.div",
"short": "Limited xhtml content",
"definition": "The actual narrative content, a stripped down version of XHTML.",
"comment": "The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.",
"min": 1,
"max": "1",
"base": {
"path": "Narrative.div",
"min": 1,
"max": "1"
},
"type": [
{
"code": "xhtml"
}
],
"constraint": [
{
"key": "txt-1",
"severity": "error",
"human": "The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes",
"expression": "htmlchecks()",
"xpath": "not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))]) and not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])",
"source": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"key": "txt-2",
"severity": "error",
"human": "The narrative SHALL have some non-whitespace content",
"expression": "htmlchecks()",
"xpath": "descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]",
"source": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Device.contained",
"path": "Device.contained",
"short": "Contained, inline Resources",
"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.",
"comment": "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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Device.extension",
"path": "Device.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Device.extension:definition",
"path": "Device.extension",
"sliceName": "definition",
"short": "R4B: The reference to the definition for the device (new)",
"definition": "R4B: `Device.definition` (new:Reference(DeviceDefinition))",
"comment": "Element `Device.definition` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.definition` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.definition|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.extension:statusReason",
"path": "Device.extension",
"sliceName": "statusReason",
"short": "R4B: online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off (new)",
"definition": "R4B: `Device.statusReason` (new:CodeableConcept)",
"comment": "Element `Device.statusReason` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.statusReason` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.statusReason|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.extension:distinctIdentifier",
"path": "Device.extension",
"sliceName": "distinctIdentifier",
"short": "R4B: The distinct identification string (new)",
"definition": "R4B: `Device.distinctIdentifier` (new:string)",
"comment": "Element `Device.distinctIdentifier` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.distinctIdentifier` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nFor example, this applies to devices in the United States regulated under *Code of Federal Regulation 21CFR§1271.290(c)*.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.distinctIdentifier|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.extension:serialNumber",
"path": "Device.extension",
"sliceName": "serialNumber",
"short": "R4B: Serial number assigned by the manufacturer (new)",
"definition": "R4B: `Device.serialNumber` (new:string)",
"comment": "Element `Device.serialNumber` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.serialNumber` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nAlphanumeric Maximum 20.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.serialNumber|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.extension:partNumber",
"path": "Device.extension",
"sliceName": "partNumber",
"short": "R4B: The part number or catalog number of the device (new)",
"definition": "R4B: `Device.partNumber` (new:string)",
"comment": "Element `Device.partNumber` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.partNumber` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nAlphanumeric Maximum 20.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.partNumber|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.extension:specialization",
"path": "Device.extension",
"sliceName": "specialization",
"short": "R4B: The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication (new)",
"definition": "R4B: `Device.specialization` (new:BackboneElement)",
"comment": "Element `Device.specialization` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.specialization` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.specialization|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.extension:property",
"path": "Device.extension",
"sliceName": "property",
"short": "R4B: The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties (new)",
"definition": "R4B: `Device.property` (new:BackboneElement)",
"comment": "Element `Device.property` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.property` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.property|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.extension:parent",
"path": "Device.extension",
"sliceName": "parent",
"short": "R4B: The device that this device is attached to or is part of (new)",
"definition": "R4B: `Device.parent` (new:Reference(Device))",
"comment": "Element `Device.parent` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.parent` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.parent|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.modifierExtension",
"path": "Device.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Device.identifier",
"path": "Device.identifier",
"short": "Instance identifier",
"definition": "Unique instance identifiers assigned to a device by manufacturers other organizations or owners.",
"comment": "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.",
"alias": [
"Serial Number"
],
"min": 0,
"max": "*",
"base": {
"path": "Device.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "udi",
"map": "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."
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Device.identifier.id",
"path": "Device.identifier.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Device.identifier.extension",
"path": "Device.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Device.identifier.extension:identifier",
"path": "Device.identifier.extension",
"sliceName": "identifier",
"short": "R4B: identifier additional types",
"definition": "R4B: `Device.identifier` additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)",
"comment": "Element `Device.identifier` is mapped to FHIR STU3 element `Device.identifier` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.identifier` do not cover the following types: Identifier.\nThe mappings for `Device.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value.\nThe 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.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.identifier|0.1.0"
}
]
},
{
"id": "Device.identifier.use",
"path": "Device.identifier.use",
"short": "usual | official | temp | secondary (If known)",
"definition": "The purpose of this identifier.",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}
],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "Device.identifier.type",
"path": "Device.identifier.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}
],
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "Device.identifier.system",
"path": "Device.identifier.system",
"short": "The namespace for the identifier value",
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"id": "Device.identifier.value",
"path": "Device.identifier.value",
"short": "The value that is unique",
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/STU3/extension-rendered-value.html).",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "123456"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "Device.identifier.period",
"path": "Device.identifier.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "Device.identifier.assigner",
"path": "Device.identifier.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"id": "Device.udi",
"path": "Device.udi",
"short": "Unique Device Identifier (UDI) Barcode string",
"definition": "[Unique device identifier (UDI)](http://hl7.org/fhir/STU3/device.html#5.11.3.2.2) assigned to device label or package.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Device.udi",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id and .code"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Device.udi.id",
"path": "Device.udi.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Device.udi.extension",
"path": "Device.udi.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 2,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Device.udi.extension:name",
"path": "Device.udi.extension",
"sliceName": "name",
"short": "R4B: The name that identifies the device (new)",
"definition": "R4B: `Device.deviceName.name` (new:string)",
"comment": "Element `Device.deviceName.name` has a context of Device.udi based on following the parent source element upwards and mapping to `Device`.\nElement `Device.deviceName.name` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.deviceName.name|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.udi.extension:type",
"path": "Device.udi.extension",
"sliceName": "type",
"short": "R4B: udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other (new)",
"definition": "R4B: `Device.deviceName.type` (new:code)",
"comment": "Element `Device.deviceName.type` has a context of Device.udi based on following the parent source element upwards and mapping to `Device`.\nElement `Device.deviceName.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.deviceName.type|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.udi.modifierExtension",
"path": "Device.udi.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Device.udi.deviceIdentifier",
"path": "Device.udi.deviceIdentifier",
"short": "Mandatory fixed portion of UDI",
"definition": "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.",
"alias": [
"DI"
],
"min": 0,
"max": "1",
"base": {
"path": "Device.udi.deviceIdentifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "udi",
"map": "The device identifier (DI), a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device."
},
{
"identity": "rim",
"map": "Role.id.extension"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Device.udi.name",
"path": "Device.udi.name",
"short": "Device Name as appears on UDI label",
"definition": "Name of device as used in labeling or catalog.",
"comment": "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'.",
"alias": [
"Brand Name"
],
"min": 0,
"max": "1",
"base": {
"path": "Device.udi.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "udi",
"map": "Propietary/Trade Name of the medical Device as used in the labeling or catalog"
},
{
"identity": "rim",
"map": ".displayName"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Device.udi.jurisdiction",
"path": "Device.udi.jurisdiction",
"short": "Regional UDI authority",
"definition": "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.",
"requirements": "Allows a recipient of a UDI to know which database will contain the UDI-associated metadata.",
"min": 0,
"max": "1",
"base": {
"path": "Device.udi.jurisdiction",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": "Role.scoper"
}
]
},
{
"id": "Device.udi.carrierHRF",
"path": "Device.udi.carrierHRF",
"short": "UDI Human Readable Barcode String",
"definition": "The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.",
"comment": "If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.",
"alias": [
"Human Readable Form"
],
"min": 0,
"max": "1",
"base": {
"path": "Device.udi.carrierHRF",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "udi",
"map": "A unique device identifier (UDI) on a device label in plain text"
},
{
"identity": "rim",
"map": "Role.id.extension"
}
]
},
{
"id": "Device.udi.carrierAIDC",
"path": "Device.udi.carrierAIDC",
"short": "UDI Machine Readable Barcode String",
"definition": "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.",
"comment": "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.",
"alias": [
"Automatic Identification and Data Capture"
],
"min": 0,
"max": "1",
"base": {
"path": "Device.udi.carrierAIDC",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
}
],
"isSummary": true,
"mapping": [
{
"identity": "udi",
"map": "A unique device identifier (UDI) on a device label a form that uses automatic identification and data capture (AIDC) technology."
},
{
"identity": "rim",
"map": "Role.id.extension"
}
]
},
{
"id": "Device.udi.issuer",
"path": "Device.udi.issuer",
"short": "UDI Issuing Organization",
"definition": "Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include :\n1) GS1: \nhttp://hl7.org/fhir/NamingSystem/gs1-di, \n2) HIBCC:\nhttp://hl7.org/fhir/NamingSystem/hibcc-dI, \n3) ICCBBA for blood containers:\nhttp://hl7.org/fhir/NamingSystem/iccbba-blood-di, \n4) ICCBA for other devices:\nhttp://hl7.org/fhir/NamingSystem/iccbba-other-di.",
"alias": [
"Barcode System"
],
"min": 0,
"max": "1",
"base": {
"path": "Device.udi.issuer",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "udi",
"map": "All UDIs are to be issued under a system operated by an Jurisdiction-accredited issuing agency.\nGS1 DIs: \n http://hl7.org/fhir/NamingSystem/gs1\nHIBCC DIs:\n http://hl7.org/fhir/NamingSystem/hibcc\nICCBBA DIs for blood containers:\n http://hl7.org/fhir/NamingSystem/iccbba-blood\nICCBA DIs for other devices:\n http://hl7.org/fhir/NamingSystem/iccbba-other"
},
{
"identity": "rim",
"map": "Role.id.root"
}
]
},
{
"id": "Device.udi.entryType",
"path": "Device.udi.entryType",
"short": "barcode | rfid | manual +",
"definition": "A coded entry to indicate how the data was entered.",
"requirements": "Supports a way to distinguish hand entered from machine read data.",
"min": 0,
"max": "1",
"base": {
"path": "Device.udi.entryType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "UDIEntryType"
}
],
"strength": "required",
"description": "Codes to identify how UDI data was entered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/udi-entry-type|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "NA"
}
]
},
{
"id": "Device.status",
"path": "Device.status",
"short": "active | inactive | entered-in-error | unknown",
"definition": "Status of the Device availability.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Device.status",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRDeviceStatus"
}
],
"strength": "required",
"description": "The availability status of the device.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/device-status|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Device.type",
"path": "Device.type",
"short": "What kind of device this is",
"definition": "Code or identifier to identify a kind of device.",
"min": 0,
"max": "1",
"base": {
"path": "Device.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DeviceKind"
}
],
"strength": "example",
"description": "Codes to identify medical devices",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/device-kind|3.0.2"
}
},
"mapping": [
{
"identity": "udi",
"map": "Type description using GMDN or other code system"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Device.lotNumber",
"path": "Device.lotNumber",
"short": "Lot number of manufacture",
"definition": "Lot number assigned by the manufacturer.",
"min": 0,
"max": "1",
"base": {
"path": "Device.lotNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "udi",
"map": "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."
},
{
"identity": "rim",
"map": ".lotNumberText"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Device.manufacturer",
"path": "Device.manufacturer",
"short": "Name of device manufacturer",
"definition": "A name of the manufacturer.",
"min": 0,
"max": "1",
"base": {
"path": "Device.manufacturer",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "udi",
"map": "N/A"
},
{
"identity": "rim",
"map": ".playedRole[typeCode=MANU].scoper.name"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Device.manufactureDate",
"path": "Device.manufactureDate",
"short": "Date when the device was made",
"definition": "The date and time when the device was manufactured.",
"min": 0,
"max": "1",
"base": {
"path": "Device.manufactureDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "udi",
"map": "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”."
},
{
"identity": "rim",
"map": ".existenceTime.low"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Device.expirationDate",
"path": "Device.expirationDate",
"short": "Date and time of expiry of this device (if applicable)",
"definition": "The date and time beyond which this device is no longer valid or should not be used (if applicable).",
"min": 0,
"max": "1",
"base": {
"path": "Device.expirationDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "udi",
"map": "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”."
},
{
"identity": "rim",
"map": ".expirationTime"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Device.model",
"path": "Device.model",
"short": "Model id assigned by the manufacturer",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Device.model",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=MANU].code"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Device.version",
"path": "Device.version",
"short": "Version number (i.e. software)",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Device.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".softwareName (included as part)"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Device.version.id",
"path": "Device.version.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references)",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Device.version.extension",
"path": "Device.version.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 1,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Device.version.extension:type",
"path": "Device.version.extension",
"sliceName": "type",
"short": "R4B: The type of the device version, e.g. manufacturer, approved, internal (new)",
"definition": "R4B: `Device.version.type` (new:CodeableConcept)",
"comment": "Element `Device.version.type` has a context of Device.version based on following the parent source element upwards and mapping to `Device`.\nElement `Device.version.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.version.type|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.version.extension:component",
"path": "Device.version.extension",
"sliceName": "component",
"short": "R4B: A single component of the device version (new)",
"definition": "R4B: `Device.version.component` (new:Identifier)",
"comment": "Element `Device.version.component` has a context of Device.version based on following the parent source element upwards and mapping to `Device`.\nElement `Device.version.component` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.version.component|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.version.extension:value",
"path": "Device.version.extension",
"sliceName": "value",
"short": "R4B: The version text (new)",
"definition": "R4B: `Device.version.value` (new:string)",
"comment": "Element `Device.version.value` has a context of Device.version based on following the parent source element upwards and mapping to `Device`.\nElement `Device.version.value` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.version.value|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Device.version.value",
"path": "Device.version.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for string",
"definition": "The actual value",
"min": 0,
"max": "1",
"base": {
"path": "string.value",
"min": 0,
"max": "1"
},
"type": [
{
"_code": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:string"
}
]
}
}
],
"maxLength": 1048576
},
{
"id": "Device.patient",
"path": "Device.patient",
"short": "Patient to whom Device is affixed",
"definition": "Patient information, If the device is affixed to a person.",
"requirements": "If the device is implanted in a patient, then need to associate the device to the patient.",
"min": 0,
"max": "1",
"base": {
"path": "Device.patient",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=USED].scoper.playedRole[typeCode=PAT]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "Device.patient.id",
"path": "Device.patient.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Device.patient.extension",
"path": "Device.patient.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Device.patient.extension:patient",
"path": "Device.patient.extension",
"sliceName": "patient",
"short": "R4B: patient additional types",
"definition": "R4B: `Device.patient` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `Device.patient` is mapped to FHIR STU3 element `Device.patient` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.patient` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `Device.patient` with unmapped reference targets: Patient.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Device.patient.reference",
"path": "Device.patient.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "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.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Device.patient.identifier",
"path": "Device.patient.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "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.",
"comment": "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. \n\nWhen 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\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "Device.patient.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Device.patient.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Device.owner",
"path": "Device.owner",
"short": "Organization responsible for device",
"definition": "An organization that is responsible for the provision and ongoing maintenance of the device.",
"min": 0,
"max": "1",
"base": {
"path": "Device.owner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=OWN].scoper"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "Device.owner.id",
"path": "Device.owner.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Device.owner.extension",
"path": "Device.owner.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Device.owner.extension:owner",
"path": "Device.owner.extension",
"sliceName": "owner",
"short": "R4B: owner additional types",
"definition": "R4B: `Device.owner` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `Device.owner` is mapped to FHIR STU3 element `Device.owner` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.owner` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `Device.owner` with unmapped reference targets: Organization.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Device.owner.reference",
"path": "Device.owner.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "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.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Device.owner.identifier",
"path": "Device.owner.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "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.",
"comment": "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. \n\nWhen 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\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "Device.owner.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Device.owner.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Device.contact",
"path": "Device.contact",
"short": "Details for human/organization for support",
"definition": "Contact details for an organization or a particular human that is responsible for the device.",
"comment": "used for troubleshooting etc.",
"min": 0,
"max": "*",
"base": {
"path": "Device.contact",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "rim",
"map": ".scopedRole[typeCode=CON].player"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "Device.contact.id",
"path": "Device.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Device.contact.extension",
"path": "Device.contact.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Device.contact.extension:contact",
"path": "Device.contact.extension",
"sliceName": "contact",
"short": "R4B: contact additional types",
"definition": "R4B: `Device.contact` additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)",
"comment": "Element `Device.contact` is mapped to FHIR STU3 element `Device.contact` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.contact` do not cover the following types: ContactPoint.\nThe mappings for `Device.contact` do not cover the following types based on type expansion: period, rank, system, use, value.\nused for troubleshooting etc.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.contact|0.1.0"
}
]
},
{
"id": "Device.contact.system",
"path": "Device.contact.system",
"short": "phone | fax | email | pager | url | sms | other",
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"cpt-2"
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointSystem"
}
],
"strength": "required",
"description": "Telecommunications form for contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-system|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "XTN.3"
},
{
"identity": "rim",
"map": "./scheme"
},
{
"identity": "servd",
"map": "./ContactPointType"
}
]
},
{
"id": "Device.contact.value",
"path": "Device.contact.value",
"short": "The actual contact point details",
"definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"requirements": "Need to support legacy numbers that are not in a tightly controlled format.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XTN.1 (or XTN.12)"
},
{
"identity": "rim",
"map": "./url"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "Device.contact.use",
"path": "Device.contact.use",
"short": "home | work | temp | old | mobile - purpose of this contact point",
"definition": "Identifies the purpose for the contact point.",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointUse"
}
],
"strength": "required",
"description": "Use of contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-use|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "XTN.2 - but often indicated by field"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./ContactPointPurpose"
}
]
},
{
"id": "Device.contact.rank",
"path": "Device.contact.rank",
"short": "Specify preferred order of use (1 = highest)",
"definition": "Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.",
"comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.rank",
"min": 0,
"max": "1"
},
"type": [
{
"code": "positiveInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Device.contact.period",
"path": "Device.contact.period",
"short": "Time period when the contact point was/is in use",
"definition": "Time period when the contact point was/is in use.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./usablePeriod[type=\"IVL<TS>\"]"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "Device.location",
"path": "Device.location",
"short": "Where the resource is found",
"definition": "The place where the device can be found.",
"requirements": "Device.location can be used to track device location.",
"min": 0,
"max": "1",
"base": {
"path": "Device.location",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=LOCE].scoper"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "Device.location.id",
"path": "Device.location.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Device.location.extension",
"path": "Device.location.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Device.location.extension:location",
"path": "Device.location.extension",
"sliceName": "location",
"short": "R4B: Where the device is found additional types",
"definition": "R4B: `Device.location` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `Device.location` is mapped to FHIR STU3 element `Device.location` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.location` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `Device.location` with unmapped reference targets: Location.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Device.location.reference",
"path": "Device.location.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "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.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Device.location.identifier",
"path": "Device.location.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "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.",
"comment": "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. \n\nWhen 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\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "Device.location.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Device.location.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Device.url",
"path": "Device.url",
"short": "Network address to contact device",
"definition": "A network address on which the device may be contacted directly.",
"comment": "If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.",
"min": 0,
"max": "1",
"base": {
"path": "Device.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": ".telecom"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "Device.note",
"path": "Device.note",
"short": "Device notes and comments",
"definition": "Descriptive information, usage information or implantation information that is not captured in an existing element.",
"min": 0,
"max": "*",
"base": {
"path": "Device.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"id": "Device.note.id",
"path": "Device.note.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Device.note.extension",
"path": "Device.note.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Device.note.extension:note",
"path": "Device.note.extension",
"sliceName": "note",
"short": "R4B: note additional types",
"definition": "R4B: `Device.note` additional types (Annotation) additional types from child elements (author[x], text, time)",
"comment": "Element `Device.note` is mapped to FHIR STU3 element `Device.note` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.note` do not cover the following types: Annotation.\nThe mappings for `Device.note` do not cover the following types based on type expansion: author[x], text, time.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.note|0.1.0"
}
]
},
{
"id": "Device.note.author[x]",
"path": "Device.note.author[x]",
"short": "Individual responsible for the annotation",
"definition": "The individual responsible for making the annotation.",
"min": 0,
"max": "1",
"base": {
"path": "Annotation.author[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.participant[typeCode=AUT].role"
}
]
},
{
"id": "Device.note.time",
"path": "Device.note.time",
"short": "When the annotation was made",
"definition": "Indicates when this particular annotation was made.",
"min": 0,
"max": "1",
"base": {
"path": "Annotation.time",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.effectiveTime"
}
]
},
{
"id": "Device.note.text",
"path": "Device.note.text",
"short": "The annotation - text content",
"definition": "The text of the annotation.",
"min": 1,
"max": "1",
"base": {
"path": "Annotation.text",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.text"
}
]
},
{
"id": "Device.safety",
"path": "Device.safety",
"short": "Safety Characteristics of Device",
"definition": "Provides additional safety characteristics about a medical device. For example devices containing latex.",
"min": 0,
"max": "*",
"base": {
"path": "Device.safety",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DeviceSafety"
}
],
"strength": "example",
"description": "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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/device-safety|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "NA"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Device",
"path": "Device"
},
{
"id": "Device.meta.extension",
"path": "Device.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Device.meta.extension:meta",
"path": "Device.meta.extension",
"sliceName": "meta",
"short": "R4B: meta additional types",
"definition": "R4B: `Device.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)",
"comment": "Element `Device.meta` is mapped to FHIR STU3 element `Device.meta` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.meta` do not cover the following types: Meta.\nThe mappings for `Device.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.meta|0.1.0"
}
]
},
{
"id": "Device.text.extension",
"path": "Device.text.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Device.text.extension:text",
"path": "Device.text.extension",
"sliceName": "text",
"short": "R4B: text additional types",
"definition": "R4B: `Device.text` additional types (Narrative) additional types from child elements (div, status)",
"comment": "Element `Device.text` is mapped to FHIR STU3 element `Device.text` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.text` do not cover the following types: Narrative.\nThe mappings for `Device.text` do not cover the following types based on type expansion: div, status.\nContained 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 information is added later.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.text|0.1.0"
}
]
},
{
"id": "Device.extension",
"path": "Device.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Device.extension:definition",
"path": "Device.extension",
"sliceName": "definition",
"short": "R4B: The reference to the definition for the device (new)",
"definition": "R4B: `Device.definition` (new:Reference(DeviceDefinition))",
"comment": "Element `Device.definition` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.definition` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.definition|0.1.0"
}
]
},
{
"id": "Device.extension:statusReason",
"path": "Device.extension",
"sliceName": "statusReason",
"short": "R4B: online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off (new)",
"definition": "R4B: `Device.statusReason` (new:CodeableConcept)",
"comment": "Element `Device.statusReason` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.statusReason` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.statusReason|0.1.0"
}
]
},
{
"id": "Device.extension:distinctIdentifier",
"path": "Device.extension",
"sliceName": "distinctIdentifier",
"short": "R4B: The distinct identification string (new)",
"definition": "R4B: `Device.distinctIdentifier` (new:string)",
"comment": "Element `Device.distinctIdentifier` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.distinctIdentifier` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nFor example, this applies to devices in the United States regulated under *Code of Federal Regulation 21CFR§1271.290(c)*.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.distinctIdentifier|0.1.0"
}
]
},
{
"id": "Device.extension:serialNumber",
"path": "Device.extension",
"sliceName": "serialNumber",
"short": "R4B: Serial number assigned by the manufacturer (new)",
"definition": "R4B: `Device.serialNumber` (new:string)",
"comment": "Element `Device.serialNumber` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.serialNumber` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nAlphanumeric Maximum 20.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.serialNumber|0.1.0"
}
]
},
{
"id": "Device.extension:partNumber",
"path": "Device.extension",
"sliceName": "partNumber",
"short": "R4B: The part number or catalog number of the device (new)",
"definition": "R4B: `Device.partNumber` (new:string)",
"comment": "Element `Device.partNumber` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.partNumber` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nAlphanumeric Maximum 20.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.partNumber|0.1.0"
}
]
},
{
"id": "Device.extension:specialization",
"path": "Device.extension",
"sliceName": "specialization",
"short": "R4B: The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication (new)",
"definition": "R4B: `Device.specialization` (new:BackboneElement)",
"comment": "Element `Device.specialization` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.specialization` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.specialization|0.1.0"
}
]
},
{
"id": "Device.extension:property",
"path": "Device.extension",
"sliceName": "property",
"short": "R4B: The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties (new)",
"definition": "R4B: `Device.property` (new:BackboneElement)",
"comment": "Element `Device.property` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.property` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.property|0.1.0"
}
]
},
{
"id": "Device.extension:parent",
"path": "Device.extension",
"sliceName": "parent",
"short": "R4B: The device that this device is attached to or is part of (new)",
"definition": "R4B: `Device.parent` (new:Reference(Device))",
"comment": "Element `Device.parent` has a context of Device based on following the parent source element upwards and mapping to `Device`.\nElement `Device.parent` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.parent|0.1.0"
}
]
},
{
"id": "Device.identifier.extension",
"path": "Device.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Device.identifier.extension:identifier",
"path": "Device.identifier.extension",
"sliceName": "identifier",
"short": "R4B: identifier additional types",
"definition": "R4B: `Device.identifier` additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)",
"comment": "Element `Device.identifier` is mapped to FHIR STU3 element `Device.identifier` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.identifier` do not cover the following types: Identifier.\nThe mappings for `Device.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value.\nThe 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.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.identifier|0.1.0"
}
]
},
{
"id": "Device.udi.extension",
"path": "Device.udi.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 2,
"max": "*"
},
{
"id": "Device.udi.extension:name",
"path": "Device.udi.extension",
"sliceName": "name",
"short": "R4B: The name that identifies the device (new)",
"definition": "R4B: `Device.deviceName.name` (new:string)",
"comment": "Element `Device.deviceName.name` has a context of Device.udi based on following the parent source element upwards and mapping to `Device`.\nElement `Device.deviceName.name` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.deviceName.name|0.1.0"
}
]
},
{
"id": "Device.udi.extension:type",
"path": "Device.udi.extension",
"sliceName": "type",
"short": "R4B: udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other (new)",
"definition": "R4B: `Device.deviceName.type` (new:code)",
"comment": "Element `Device.deviceName.type` has a context of Device.udi based on following the parent source element upwards and mapping to `Device`.\nElement `Device.deviceName.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.deviceName.type|0.1.0"
}
]
},
{
"id": "Device.version.extension",
"path": "Device.version.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 1,
"max": "*"
},
{
"id": "Device.version.extension:type",
"path": "Device.version.extension",
"sliceName": "type",
"short": "R4B: The type of the device version, e.g. manufacturer, approved, internal (new)",
"definition": "R4B: `Device.version.type` (new:CodeableConcept)",
"comment": "Element `Device.version.type` has a context of Device.version based on following the parent source element upwards and mapping to `Device`.\nElement `Device.version.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.version.type|0.1.0"
}
]
},
{
"id": "Device.version.extension:component",
"path": "Device.version.extension",
"sliceName": "component",
"short": "R4B: A single component of the device version (new)",
"definition": "R4B: `Device.version.component` (new:Identifier)",
"comment": "Element `Device.version.component` has a context of Device.version based on following the parent source element upwards and mapping to `Device`.\nElement `Device.version.component` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.version.component|0.1.0"
}
]
},
{
"id": "Device.version.extension:value",
"path": "Device.version.extension",
"sliceName": "value",
"short": "R4B: The version text (new)",
"definition": "R4B: `Device.version.value` (new:string)",
"comment": "Element `Device.version.value` has a context of Device.version based on following the parent source element upwards and mapping to `Device`.\nElement `Device.version.value` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.version.value|0.1.0"
}
]
},
{
"id": "Device.patient.extension",
"path": "Device.patient.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Device.patient.extension:patient",
"path": "Device.patient.extension",
"sliceName": "patient",
"short": "R4B: patient additional types",
"definition": "R4B: `Device.patient` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `Device.patient` is mapped to FHIR STU3 element `Device.patient` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.patient` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `Device.patient` with unmapped reference targets: Patient.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Device.owner.extension",
"path": "Device.owner.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Device.owner.extension:owner",
"path": "Device.owner.extension",
"sliceName": "owner",
"short": "R4B: owner additional types",
"definition": "R4B: `Device.owner` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `Device.owner` is mapped to FHIR STU3 element `Device.owner` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.owner` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `Device.owner` with unmapped reference targets: Organization.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Device.contact.extension",
"path": "Device.contact.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Device.contact.extension:contact",
"path": "Device.contact.extension",
"sliceName": "contact",
"short": "R4B: contact additional types",
"definition": "R4B: `Device.contact` additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)",
"comment": "Element `Device.contact` is mapped to FHIR STU3 element `Device.contact` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.contact` do not cover the following types: ContactPoint.\nThe mappings for `Device.contact` do not cover the following types based on type expansion: period, rank, system, use, value.\nused for troubleshooting etc.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.contact|0.1.0"
}
]
},
{
"id": "Device.location.extension",
"path": "Device.location.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Device.location.extension:location",
"path": "Device.location.extension",
"sliceName": "location",
"short": "R4B: Where the device is found additional types",
"definition": "R4B: `Device.location` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `Device.location` is mapped to FHIR STU3 element `Device.location` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.location` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `Device.location` with unmapped reference targets: Location.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Device.note.extension",
"path": "Device.note.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Device.note.extension:note",
"path": "Device.note.extension",
"sliceName": "note",
"short": "R4B: note additional types",
"definition": "R4B: `Device.note` additional types (Annotation) additional types from child elements (author[x], text, time)",
"comment": "Element `Device.note` is mapped to FHIR STU3 element `Device.note` as `SourceIsBroaderThanTarget`.\nThe mappings for `Device.note` do not cover the following types: Annotation.\nThe mappings for `Device.note` do not cover the following types based on type expansion: author[x], text, time.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Device.note|0.1.0"
}
]
}
]
}
}