Current Build

8.16 JSON Schema for DeviceComponent

Health Care Devices Work GroupMaturity Level: N/ABallot Status: Informative Compartments: Not linked to any defined compartments

This is a representation of the json schema for DeviceComponent, 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/DeviceComponent",
  "$ref": "#/definitions/DeviceComponent",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "DeviceComponent": {
      "description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.",
      "properties": {
        "resourceType": {
          "description": "This is a DeviceComponent resource",
          "const": "DeviceComponent"
        },
        "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, and nor can they have their own independent transaction scope.",
          "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. 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"
        },
        "type": {
          "description": "The component type as defined in the object-oriented or metric nomenclature partition.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "lastSystemChange": {
          "description": "The timestamp for the most recent system change which includes device configuration or setting change.",
          "$ref": "#/definitions/instant"
        },
        "_lastSystemChange": {
          "description": "Extensions for lastSystemChange",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "source": {
          "description": "The link to the source Device that contains administrative device information such as manufacture, serial number, etc.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "parent": {
          "description": "The link to the parent resource. For example: Channel is linked to its VMD parent.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "operationalStatus": {
          "description": "The current operational status of the device. For example: On, Off, Standby, etc.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "parameterGroup": {
          "description": "The parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "measurementPrinciple": {
          "description": "The physical principle of the measurement. For example: thermal, chemical, acoustical, etc.",
          "enum": [
            "other",
            "chemical",
            "electrical",
            "impedance",
            "nuclear",
            "optical",
            "thermal",
            "biological",
            "mechanical",
            "acoustical",
            "manual"
          ]
        },
        "_measurementPrinciple": {
          "description": "Extensions for measurementPrinciple",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "productionSpecification": {
          "description": "The production specification such as component revision, serial number, etc.",
          "items": {
            "$ref": "#/definitions/DeviceComponent_ProductionSpecification"
          },
          "type": "array"
        },
        "languageCode": {
          "description": "The language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "property": {
          "description": "Other device properties expressed as a `type` which identifies the property and a value(s) either as a quantity or a code.",
          "items": {
            "$ref": "#/definitions/DeviceComponent_Property"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "type",
        "resourceType"
      ]
    },
    "DeviceComponent_ProductionSpecification": {
      "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"
        },
        "specType": {
          "description": "The specification type, such as, serial number, part number, hardware revision, software revision, etc.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "componentId": {
          "description": "The internal component unique identification. This is a provision for manufacture specific standard components using a private OID. 11073-10101 has a partition for private OID semantic that the manufacturer can make use of.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "productionSpec": {
          "description": "The printable string defining the component.",
          "$ref": "#/definitions/string"
        },
        "_productionSpec": {
          "description": "Extensions for productionSpec",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    },
    "DeviceComponent_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": "The code for the device property identifying the property being reported such as \u0027time capability\u0027.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "valueQuantity": {
          "description": "The property value when the property being reported is a quantity such as the resolution of a real time clock.",
          "items": {
            "$ref": "Quantity.schema.json#/definitions/Quantity"
          },
          "type": "array"
        },
        "valueCode": {
          "description": "The property value when the property being reported is a code, such as the code indicating that the device supports a real time clock using absolute time.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "type"
      ]
    }
  }
}