Current Build

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

10.8 JSON Schema for SpecimenDefinition

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 SpecimenDefinition, 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/SpecimenDefinition",
  "$ref": "#/definitions/SpecimenDefinition",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "SpecimenDefinition": {
      "description": "A kind of specimen with associated set of requirements.",
      "properties": {
        "resourceType": {
          "description": "This is a SpecimenDefinition resource",
          "const": "SpecimenDefinition"
        },
        "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": "A business identifier associated with the kind of specimen.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "typeCollected": {
          "description": "The kind of material to be collected.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "patientPreparation": {
          "description": "Preparation of the patient for specimen collection.",
          "$ref": "#/definitions/string"
        },
        "_patientPreparation": {
          "description": "Extensions for patientPreparation",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "timeAspect": {
          "description": "Time aspect of specimen collection (duration or offset).",
          "$ref": "#/definitions/string"
        },
        "_timeAspect": {
          "description": "Extensions for timeAspect",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "collection": {
          "description": "The action to be performed for collecting the specimen.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "typeTested": {
          "description": "Specimen conditioned in a container as expected by the testing laboratory.",
          "items": {
            "$ref": "#/definitions/SpecimenDefinition_TypeTested"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    },
    "SpecimenDefinition_TypeTested": {
      "description": "A kind of specimen with associated set of requirements.",
      "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"
        },
        "isDerived": {
          "description": "Primary of secondary specimen.",
          "$ref": "#/definitions/boolean"
        },
        "_isDerived": {
          "description": "Extensions for isDerived",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "type": {
          "description": "The kind of specimen conditioned for testing expected by lab.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "preference": {
          "description": "The preference for this type of conditioned specimen.",
          "enum": [
            "preferred",
            "alternate"
          ]
        },
        "_preference": {
          "description": "Extensions for preference",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "container": {
          "description": "The specimen\u0027s container.",
          "$ref": "#/definitions/SpecimenDefinition_Container"
        },
        "requirement": {
          "description": "Requirements for delivery and special handling of this kind of conditioned specimen.",
          "$ref": "#/definitions/string"
        },
        "_requirement": {
          "description": "Extensions for requirement",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "retentionTime": {
          "description": "The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.",
          "$ref": "Duration.schema.json#/definitions/Duration"
        },
        "rejectionCriterion": {
          "description": "Criterion for rejection of the specimen in its container by the laboratory.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "handling": {
          "description": "Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.",
          "items": {
            "$ref": "#/definitions/SpecimenDefinition_Handling"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    },
    "SpecimenDefinition_Container": {
      "description": "A kind of specimen with associated set of requirements.",
      "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"
        },
        "material": {
          "description": "The type of material of the container.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "type": {
          "description": "The type of container used to contain this kind of specimen.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "cap": {
          "description": "Color of container cap.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "description": {
          "description": "The textual description of the kind of container.",
          "$ref": "#/definitions/string"
        },
        "_description": {
          "description": "Extensions for description",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "capacity": {
          "description": "The capacity (volume or other measure) of this kind of container.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "minimumVolume": {
          "description": "The minimum volume to be conditioned in the container.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "additive": {
          "description": "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
          "items": {
            "$ref": "#/definitions/SpecimenDefinition_Additive"
          },
          "type": "array"
        },
        "preparation": {
          "description": "Special processing that should be applied to the container for this kind of specimen.",
          "$ref": "#/definitions/string"
        },
        "_preparation": {
          "description": "Extensions for preparation",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    },
    "SpecimenDefinition_Additive": {
      "description": "A kind of specimen with associated set of requirements.",
      "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"
        },
        "additiveCodeableConcept": {
          "description": "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "additiveReference": {
          "description": "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "additionalProperties": false
    },
    "SpecimenDefinition_Handling": {
      "description": "A kind of specimen with associated set of requirements.",
      "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"
        },
        "temperatureQualifier": {
          "description": "It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "temperatureRange": {
          "description": "The temperature interval for this set of handling instructions.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "maxDuration": {
          "description": "The maximum time interval of preservation of the specimen with these conditions.",
          "$ref": "Duration.schema.json#/definitions/Duration"
        },
        "instruction": {
          "description": "Additional textual instructions for the preservation or transport of the specimen. For instance, \u0027Protect from light exposure\u0027.",
          "$ref": "#/definitions/string"
        },
        "_instruction": {
          "description": "Extensions for instruction",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    }
  }
}