Current Build

Переводит команда Health Samurai . Приглашаем поучаствовать в русификации стандарта FHIR: GitHub , Email.

8.15 JSON Schema for DeviceDefinition

Orders and Observations Work GroupMaturity Level: N/ABallot 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": "Метаданные ресурса. Это такая информация, которая поддерживается инфраструктурой. Изменения этой информации не всегда можно ассоциировать с версионными изменениями ресурса.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "Ссылка на свод правил, которым следовали при создании этого ресурса и которые необходимо понимать при обработке этого содержимого. 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": "Основной язык, на котором написан ресурс.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "Человекочитаемая описательная часть, содержащая краткое изложение ресурса, которая может использоваться для представления содержимого ресурса человеку. От описательной части не требуется кодировать все структурированные данные, но она должна содержать достаточно сведений, чтобы простое её прочтение человеком было \"клинически безопасным\". Определения ресурсов могут описывать, какое содержимое должно быть представлено в описательной части для обеспечения клинической безопасной.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "Эти ресурсы не обладают независимым существованием вне ресурса, который их содержит - их нельзя идентифицировать независимо, и они не могут иметь своей собственной независимой транзакционной области действия.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "Может использоваться для представления дополнительной информации, не являющейся частью базового определения ресурса. Чтобы сделать использование расширений надежным и управляемым, существует строгий набор управления применительно к определению и использованию расширений. Хотя каждому реализатору разрешается определять расширения, имеется набор требований, которые должны выполняться в рамках определения расширения.",
          "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. 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"
        },
        "identifier": {
          "description": "Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.",
          "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"
        },
        "manufacturerString": {
          "description": "A name of the manufacturer.",
          "pattern": "^[ \\r\\n\\t\\S]+$",
          "type": "string"
        },
        "_manufacturerString": {
          "description": "Extensions for manufacturerString",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "manufacturerReference": {
          "description": "A name of the manufacturer.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "deviceName": {
          "description": "A name given to the device to identify it.",
          "items": {
            "$ref": "#/definitions/DeviceDefinition_DeviceName"
          },
          "type": "array"
        },
        "modelNumber": {
          "description": "The model number for the device.",
          "$ref": "#/definitions/string"
        },
        "_modelNumber": {
          "description": "Extensions for modelNumber",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "type": {
          "description": "What kind of device or device system this is.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "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": "#/definitions/DeviceDefinition_Specialization"
          },
          "type": "array"
        },
        "version": {
          "description": "The available versions of the device, e.g., software versions.",
          "items": {
            "$ref": "#/definitions/string"
          },
          "type": "array"
        },
        "_version": {
          "description": "Extensions for version",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "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"
        },
        "physicalCharacteristics": {
          "description": "Dimensions, color etc.",
          "$ref": "ProdCharacteristic.schema.json#/definitions/ProdCharacteristic"
        },
        "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"
        },
        "capability": {
          "description": "Device capabilities.",
          "items": {
            "$ref": "#/definitions/DeviceDefinition_Capability"
          },
          "type": "array"
        },
        "property": {
          "description": "The actual configuration settings of a device as it actually operates, 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"
        },
        "url": {
          "description": "A network address on which the device may be contacted directly.",
          "$ref": "#/definitions/uri"
        },
        "_url": {
          "description": "Extensions for url",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "onlineInformation": {
          "description": "Access to on-line information about the device.",
          "$ref": "#/definitions/uri"
        },
        "_onlineInformation": {
          "description": "Extensions for onlineInformation",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "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"
        },
        "quantity": {
          "description": "The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "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"
        }
      },
      "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. 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 jurisdication porvided 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"
        }
      },
      "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. 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": "The name of the device.",
          "$ref": "#/definitions/string"
        },
        "_name": {
          "description": "Extensions for name",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "type": {
          "description": "The type of deviceName.\nUDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.",
          "enum": [
            "udi-label-name",
            "user-friendly-name",
            "patient-reported-name",
            "manufacturer-name",
            "model-name",
            "other"
          ]
        },
        "_type": {
          "description": "Extensions for type",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    },
    "DeviceDefinition_Specialization": {
      "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. 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"
        },
        "systemType": {
          "description": "The standard that is used to operate and communicate.",
          "$ref": "#/definitions/string"
        },
        "_systemType": {
          "description": "Extensions for systemType",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "version": {
          "description": "The version of the standard that is used to operate and communicate.",
          "$ref": "#/definitions/string"
        },
        "_version": {
          "description": "Extensions for version",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    },
    "DeviceDefinition_Capability": {
      "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. 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": "Type of capability.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "description": {
          "description": "Description of capability.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "type"
      ]
    },
    "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. 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 DeviceDefinitionPropetyCode (Extensible).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "valueQuantity": {
          "description": "Property value as a quantity.",
          "items": {
            "$ref": "Quantity.schema.json#/definitions/Quantity"
          },
          "type": "array"
        },
        "valueCode": {
          "description": "Property value as a code, e.g., NTP4 (synced to NTP).",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "type"
      ]
    },
    "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. 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": "The substance.",
          "$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"
        }
      },
      "additionalProperties": false,
      "required": [
        "substance"
      ]
    }
  }
}