Release 5 Ballot
AdministrationThis page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Orders and Observations Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
This is a representation of the json schema for DeviceDefinition, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/DeviceDefinition",
"$ref": "#/definitions/DeviceDefinition",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"DeviceDefinition": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"resourceType": {
"description": "This is a DeviceDefinition resource",
"const": "DeviceDefinition"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can 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.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"description": {
"description": "Additional information to describe the device.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"identifier": {
"description": "Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. The identifier is typically valued if the udiDeviceIdentifier, partNumber or modelNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"udiDeviceIdentifier": {
"description": "Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.",
"items": {
"$ref": "#/definitions/DeviceDefinition_UdiDeviceIdentifier"
},
"type": "array"
},
"regulatoryIdentifier": {
"description": "Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device models sharing the same intended purpose, risk class and essential design and manufacturing characteristics. One example is the Basic UDI-DI in Europe.",
"items": {
"$ref": "#/definitions/DeviceDefinition_RegulatoryIdentifier"
},
"type": "array"
},
"partNumber": {
"description": "The part number or catalog number of the device.",
"$ref": "#/definitions/string"
},
"_partNumber": {
"description": "Extensions for partNumber",
"$ref": "Element.schema.json#/definitions/Element"
},
"manufacturer": {
"description": "A name of the manufacturer or legal representative e.g. labeler. Whether this is the actual manufacturer or the labeler or responsible depends on implementation and jurisdiction.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"deviceName": {
"description": "The name or names of the device as given by the manufacturer.",
"items": {
"$ref": "#/definitions/DeviceDefinition_DeviceName"
},
"type": "array"
},
"modelNumber": {
"description": "The model number for the device for example as defined by the manufacturer or labeler, or other agency.",
"$ref": "#/definitions/string"
},
"_modelNumber": {
"description": "Extensions for modelNumber",
"$ref": "Element.schema.json#/definitions/Element"
},
"classification": {
"description": "What kind of device or device system this is.",
"items": {
"$ref": "#/definitions/DeviceDefinition_Classification"
},
"type": "array"
},
"specialization": {
"description": "The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.",
"items": {
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"type": "array"
},
"hasPart": {
"description": "A device that is part (for example a component) of the present device.",
"items": {
"$ref": "#/definitions/DeviceDefinition_HasPart"
},
"type": "array"
},
"packaging": {
"description": "Information about the packaging of the device, i.e. how the device is packaged.",
"items": {
"$ref": "#/definitions/DeviceDefinition_Packaging"
},
"type": "array"
},
"version": {
"description": "The version of the device or software.",
"items": {
"$ref": "#/definitions/DeviceDefinition_Version"
},
"type": "array"
},
"safety": {
"description": "Safety characteristics of the device.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"shelfLifeStorage": {
"description": "Shelf Life and storage information.",
"items": {
"$ref": "ProductShelfLife.schema.json#/definitions/ProductShelfLife"
},
"type": "array"
},
"languageCode": {
"description": "Language code for the human-readable text strings produced by the device (all supported).",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"property": {
"description": "The potential, valid configuration settings of a device, e.g., regulation status, time properties.",
"items": {
"$ref": "#/definitions/DeviceDefinition_Property"
},
"type": "array"
},
"owner": {
"description": "An organization that is responsible for the provision and ongoing maintenance of the device.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"contact": {
"description": "Contact details for an organization or a particular human that is responsible for the device.",
"items": {
"$ref": "ContactPoint.schema.json#/definitions/ContactPoint"
},
"type": "array"
},
"link": {
"description": "An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device.",
"items": {
"$ref": "#/definitions/DeviceDefinition_Link"
},
"type": "array"
},
"note": {
"description": "Descriptive information, usage information or implantation information that is not captured in an existing element.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
},
"parentDevice": {
"description": "The parent device it can be part of.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"material": {
"description": "A substance used to create the material(s) of which the device is made.",
"items": {
"$ref": "#/definitions/DeviceDefinition_Material"
},
"type": "array"
},
"productionIdentifierInUDI": {
"description": "Indicates the production identifier(s) that are expected to appear in the UDI carrier on the device label.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_productionIdentifierInUDI": {
"description": "Extensions for productionIdentifierInUDI",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"guideline": {
"description": "Information aimed at providing directions for the usage of this model of device.",
"$ref": "#/definitions/DeviceDefinition_Guideline"
},
"correctiveAction": {
"description": "Tracking of latest field safety corrective action.",
"$ref": "#/definitions/DeviceDefinition_CorrectiveAction"
},
"chargeItem": {
"description": "Billing code or reference associated with the device.",
"items": {
"$ref": "#/definitions/DeviceDefinition_ChargeItem"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"DeviceDefinition_UdiDeviceIdentifier": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"deviceIdentifier": {
"description": "The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier.",
"$ref": "#/definitions/string"
},
"_deviceIdentifier": {
"description": "Extensions for deviceIdentifier",
"$ref": "Element.schema.json#/definitions/Element"
},
"issuer": {
"description": "The organization that assigns the identifier algorithm.",
"$ref": "#/definitions/uri"
},
"_issuer": {
"description": "Extensions for issuer",
"$ref": "Element.schema.json#/definitions/Element"
},
"jurisdiction": {
"description": "The jurisdiction to which the deviceIdentifier applies.",
"$ref": "#/definitions/uri"
},
"_jurisdiction": {
"description": "Extensions for jurisdiction",
"$ref": "Element.schema.json#/definitions/Element"
},
"marketDistribution": {
"description": "Indicates where and when the device is available on the market.",
"items": {
"$ref": "#/definitions/DeviceDefinition_MarketDistribution"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"DeviceDefinition_MarketDistribution": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"marketPeriod": {
"description": "Begin and end dates for the commercial distribution of the device.",
"$ref": "Period.schema.json#/definitions/Period"
},
"subJurisdiction": {
"description": "National state or territory to which the marketDistribution recers, typically where the device is commercialized.",
"$ref": "#/definitions/uri"
},
"_subJurisdiction": {
"description": "Extensions for subJurisdiction",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"marketPeriod"
]
},
"DeviceDefinition_RegulatoryIdentifier": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The type of identifier itself.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"deviceIdentifier": {
"description": "The identifier itself.",
"$ref": "#/definitions/string"
},
"_deviceIdentifier": {
"description": "Extensions for deviceIdentifier",
"$ref": "Element.schema.json#/definitions/Element"
},
"issuer": {
"description": "The organization that issued this identifier.",
"$ref": "#/definitions/uri"
},
"_issuer": {
"description": "Extensions for issuer",
"$ref": "Element.schema.json#/definitions/Element"
},
"jurisdiction": {
"description": "The jurisdiction to which the deviceIdentifier applies.",
"$ref": "#/definitions/uri"
},
"_jurisdiction": {
"description": "Extensions for jurisdiction",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"DeviceDefinition_DeviceName": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "A human-friendly name that is used to refer to the device - depending on the type, it can be the brand name, the common name or alias, or other.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "The type of deviceName.\nRegisteredName | UserFriendlyName | PatientReportedName.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"DeviceDefinition_Classification": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "A classification or risk class of the device model.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"justification": {
"description": "Further information qualifying this classification of the device model.",
"items": {
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"type"
]
},
"DeviceDefinition_HasPart": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"reference": {
"description": "Reference to the device that is part of the current device.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"count": {
"description": "Number of instances of the component device in the current device.",
"$ref": "#/definitions/integer"
},
"_count": {
"description": "Extensions for count",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"reference"
]
},
"DeviceDefinition_Packaging": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "The business identifier of the packaged medication.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": {
"description": "A code that defines the specific type of packaging.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"count": {
"description": "The number of items contained in the package (devices or sub-packages).",
"$ref": "#/definitions/integer"
},
"_count": {
"description": "Extensions for count",
"$ref": "Element.schema.json#/definitions/Element"
},
"distributor": {
"description": "An organization that distributes the packaged device.",
"items": {
"$ref": "#/definitions/DeviceDefinition_Distributor"
},
"type": "array"
},
"udiDeviceIdentifier": {
"description": "Unique Device Identifier (UDI) Barcode string on the packaging.",
"items": {
"$ref": "#/definitions/DeviceDefinition_UdiDeviceIdentifier"
},
"type": "array"
},
"packaging": {
"description": "Allows packages within packages.",
"items": {
"$ref": "#/definitions/DeviceDefinition_Packaging"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"DeviceDefinition_Distributor": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "Distributor\u0027s human-readable name.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"organizationReference": {
"description": "Distributor as an Organization resource.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"DeviceDefinition_Version": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The type of the device version, e.g. manufacturer, approved, internal.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"component": {
"description": "The hardware or software module of the device to which the version applies.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"value": {
"description": "The version text.",
"$ref": "#/definitions/string"
},
"_value": {
"description": "Extensions for value",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"DeviceDefinition_Property": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Code that specifies the property.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueQuantity": {
"description": "Property value - the data type depends on the property type.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"valueCodeableConcept": {
"description": "Property value - the data type depends on the property type.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueString": {
"description": "Property value - the data type depends on the property type.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueBoolean": {
"description": "Property value - the data type depends on the property type.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueInteger": {
"description": "Property value - the data type depends on the property type.",
"pattern": "^-?([0]|([1-9][0-9]*))$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueRange": {
"description": "Property value - the data type depends on the property type.",
"$ref": "Range.schema.json#/definitions/Range"
},
"valueAttachment": {
"description": "Property value - the data type depends on the property type.",
"$ref": "Attachment.schema.json#/definitions/Attachment"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"type"
]
},
"DeviceDefinition_Link": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"relation": {
"description": "The type indicates the relationship of the related device to the device instance.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"relatedDevice": {
"description": "A reference to the linked device.",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"relatedDevice",
"relation"
]
},
"DeviceDefinition_Material": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"substance": {
"description": "A substance that the device contains, may contain, or is made of - for example latex - to be used to determine patient compatibility. This is not intended to represent the composition of the device, only the clinically relevant materials.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"alternate": {
"description": "Indicates an alternative material of the device.",
"$ref": "#/definitions/boolean"
},
"_alternate": {
"description": "Extensions for alternate",
"$ref": "Element.schema.json#/definitions/Element"
},
"allergenicIndicator": {
"description": "Whether the substance is a known or suspected allergen.",
"$ref": "#/definitions/boolean"
},
"_allergenicIndicator": {
"description": "Extensions for allergenicIndicator",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"substance"
]
},
"DeviceDefinition_Guideline": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"useContext": {
"description": "The circumstances that form the setting for using the device.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"usageInstruction": {
"description": "Detailed written and visual directions for the user on how to use the device.",
"$ref": "#/definitions/markdown"
},
"_usageInstruction": {
"description": "Extensions for usageInstruction",
"$ref": "Element.schema.json#/definitions/Element"
},
"relatedArtifact": {
"description": "A source of information or reference for this guideline.",
"items": {
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"type": "array"
},
"indication": {
"description": "A clinical condition for which the device was designed to be used.",
"items": {
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"type": "array"
},
"contraindication": {
"description": "A specific situation when a device should not be used because it may cause harm.",
"items": {
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"type": "array"
},
"warning": {
"description": "Specific hazard alert information that a user needs to know before using the device.",
"items": {
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"type": "array"
},
"intendedUse": {
"description": "A description of the general purpose or medical use of the device or its function.",
"$ref": "#/definitions/string"
},
"_intendedUse": {
"description": "Extensions for intendedUse",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"DeviceDefinition_CorrectiveAction": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"recall": {
"description": "Whether the last corrective action known for this device was a recall.",
"$ref": "#/definitions/boolean"
},
"_recall": {
"description": "Extensions for recall",
"$ref": "Element.schema.json#/definitions/Element"
},
"scope": {
"description": "The scope of the corrective action - whether the action targeted all units of a given device model, or only a specific set of batches identified by lot numbers, or individually identified devices identified by the serial name.",
"$ref": "#/definitions/code"
},
"_scope": {
"description": "Extensions for scope",
"$ref": "Element.schema.json#/definitions/Element"
},
"period": {
"description": "Start and end dates of the corrective action.",
"$ref": "Period.schema.json#/definitions/Period"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"period"
]
},
"DeviceDefinition_ChargeItem": {
"description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"chargeItemCode": {
"description": "The code or reference for the charge item.",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"count": {
"description": "Coefficient applicable to the billing code.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"effectivePeriod": {
"description": "A specific time period in which this charge item applies.",
"$ref": "Period.schema.json#/definitions/Period"
},
"useContext": {
"description": "The context to which this charge item applies.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"chargeItemCode",
"count"
]
}
}
}
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Sat, Sep 10, 2022 05:02+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change