This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). 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: R4B R4
Orders and Observations Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Device, Patient |
This is a representation of the json schema for DeviceUseStatement, 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/DeviceUseStatement", "$ref": "#/definitions/DeviceUseStatement", "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas", "definitions": { "DeviceUseStatement": { "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", "const": "DeviceUseStatement" }, "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 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" }, "identifier": { "description": "An external identifier for this statement such as an IRI.", "items": { "$ref": "Identifier.schema.json#/definitions/Identifier" }, "type": "array" }, "basedOn": { "description": "A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.", "items": { "$ref": "Reference.schema.json#/definitions/Reference" }, "type": "array" }, "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" ] }, "_status": { "description": "Extensions for status", "$ref": "Element.schema.json#/definitions/Element" }, "subject": { "description": "The patient who used the device.", "$ref": "Reference.schema.json#/definitions/Reference" }, "derivedFrom": { "description": "Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.", "items": { "$ref": "Reference.schema.json#/definitions/Reference" }, "type": "array" }, "timingTiming": { "description": "How often the device was used.", "$ref": "Timing.schema.json#/definitions/Timing" }, "timingPeriod": { "description": "How often the device was used.", "$ref": "Period.schema.json#/definitions/Period" }, "timingDateTime": { "description": "How often the device was used.", "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", "type": "string" }, "_timingDateTime": { "description": "Extensions for timingDateTime", "$ref": "Element.schema.json#/definitions/Element" }, "recordedOn": { "description": "The time at which the statement was made/recorded.", "$ref": "#/definitions/dateTime" }, "_recordedOn": { "description": "Extensions for recordedOn", "$ref": "Element.schema.json#/definitions/Element" }, "source": { "description": "Who reported the device was being used by the patient.", "$ref": "Reference.schema.json#/definitions/Reference" }, "device": { "description": "The details of the device used.", "$ref": "Reference.schema.json#/definitions/Reference" }, "reasonCode": { "description": "Reason or justification for the use of the device.", "items": { "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "type": "array" }, "reasonReference": { "description": "Indicates another resource whose existence justifies this DeviceUseStatement.", "items": { "$ref": "Reference.schema.json#/definitions/Reference" }, "type": "array" }, "bodySite": { "description": "Indicates the anotomic location on the subject\u0027s body where the device was used ( i.e. the target).", "$ref": "CodeableConcept.schema.json#/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.", "items": { "$ref": "Annotation.schema.json#/definitions/Annotation" }, "type": "array" } }, "additionalProperties": false, "required": [ "subject", "device", "resourceType" ] } } }