fhir-schemas/fhir.schema.json/DeviceUseStatement.schema.json

Schemas for Fast Healthcare Interoperability Resources.

{
  "schema": "http://json-schema.org/draft-04/schema#",
  "$id": "http://hl7.org/fhir/json-schema/DeviceUseStatement",
  "$ref": "#/definitions/DeviceUseStatement",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "DeviceUseStatement": {
      "allOf": [
        {
          "$ref": "DomainResource#/definitions/DomainResource"
        },
        {
          "description": "A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.",
          "properties": {
            "resourceType": {
              "description": "This is a DeviceUseStatement resource",
              "type": "string",
              "enum": [
                "DeviceUseStatement"
              ]
            },
            "identifier": {
              "description": "An external identifier for this statement such as an IRI.",
              "type": "array",
              "items": {
                "$ref": "http://hl7.org/fhir/json-schema/Identifier#/definitions/Identifier"
              }
            },
            "status": {
              "description": "A code representing the patient or other source\u0027s judgment about the state of the device used that this statement is about.  Generally this will be active or completed.",
              "enum": [
                "active",
                "completed",
                "entered-in-error",
                "intended",
                "stopped",
                "on-hold"
              ],
              "type": "string"
            },
            "_status": {
              "description": "Extensions for status",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "subject": {
              "description": "The patient who used the device.",
              "$ref": "http://hl7.org/fhir/json-schema/Reference#/definitions/Reference"
            },
            "whenUsed": {
              "description": "The time period over which the device was used.",
              "$ref": "http://hl7.org/fhir/json-schema/Period#/definitions/Period"
            },
            "timingTiming": {
              "description": "How often the device was used.",
              "$ref": "http://hl7.org/fhir/json-schema/Timing#/definitions/Timing"
            },
            "timingPeriod": {
              "description": "How often the device was used.",
              "$ref": "http://hl7.org/fhir/json-schema/Period#/definitions/Period"
            },
            "timingDateTime": {
              "description": "How often the device was used.",
              "pattern": "-?[0-9]{4}(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
              "type": "string"
            },
            "_timingDateTime": {
              "description": "Extensions for timingDateTime",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "recordedOn": {
              "description": "The time at which the statement was made/recorded.",
              "type": "string",
              "pattern": "-?[0-9]{4}(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?"
            },
            "_recordedOn": {
              "description": "Extensions for recordedOn",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "source": {
              "description": "Who reported the device was being used by the patient.",
              "$ref": "http://hl7.org/fhir/json-schema/Reference#/definitions/Reference"
            },
            "device": {
              "description": "The details of the device used.",
              "$ref": "http://hl7.org/fhir/json-schema/Reference#/definitions/Reference"
            },
            "indication": {
              "description": "Reason or justification for the use of the device.",
              "type": "array",
              "items": {
                "$ref": "http://hl7.org/fhir/json-schema/CodeableConcept#/definitions/CodeableConcept"
              }
            },
            "bodySite": {
              "description": "Indicates the site on the subject\u0027s body where the device was used ( i.e. the target site).",
              "$ref": "http://hl7.org/fhir/json-schema/CodeableConcept#/definitions/CodeableConcept"
            },
            "note": {
              "description": "Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.",
              "type": "array",
              "items": {
                "$ref": "http://hl7.org/fhir/json-schema/Annotation#/definitions/Annotation"
              }
            }
          },
          "required": [
            "subject",
            "device",
            "resourceType"
          ]
        }
      ]
    }
  }
}