This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
This is a representation of the json schema for UserSession, 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/UserSession", "$ref": "#/definitions/UserSession", "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas", "definitions": { "UserSession": { "description": "Information about a user\u0027s current session.", "properties": { "resourceType": { "description": "This is a UserSession resource", "const": "UserSession" }, "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.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "identifier": { "description": "Allows a service to provide a unique, business identifier for the session.", "$ref": "Identifier.schema.json#/definitions/Identifier" }, "user": { "description": "A practitioner, patient, device, or related person engaged in the session.", "$ref": "Reference.schema.json#/definitions/Reference" }, "status": { "description": "Status of the session.", "$ref": "#/definitions/UserSession_Status" }, "workstation": { "description": "Location that identifies the physical place at which the user\u0027s session is occurring. For the purposes of context synchronization, this is intended to represent the user\u0027s workstation.", "$ref": "Identifier.schema.json#/definitions/Identifier" }, "focus": { "description": "The current focus of the user\u0027s session. Common values are a reference to a Patient, Encounter, ImagingStudy, etc.", "items": { "$ref": "Reference.schema.json#/definitions/Reference" }, "type": "array" }, "created": { "description": "Indicates the timestamp when the user session was first created.", "$ref": "#/definitions/instant" }, "_created": { "description": "Extensions for created", "$ref": "Element.schema.json#/definitions/Element" }, "expires": { "description": "Indicates the timestamp when the user session will expire (i.e. no longer be valid).", "$ref": "#/definitions/instant" }, "_expires": { "description": "Extensions for expires", "$ref": "Element.schema.json#/definitions/Element" }, "context": { "description": "Provides additional information associated with the context.", "items": { "$ref": "#/definitions/UserSession_Context" }, "type": "array" } }, "additionalProperties": false, "required": [ "user", "resourceType" ] }, "UserSession_Status": { "description": "Information about a user\u0027s current session.", "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.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "code": { "description": "The current status of the user session.", "enum": [ "activating", "active", "suspended", "closing", "closed" ] }, "_code": { "description": "Extensions for code", "$ref": "Element.schema.json#/definitions/Element" }, "source": { "description": "The source of the status code.", "enum": [ "user", "system" ] }, "_source": { "description": "Extensions for source", "$ref": "Element.schema.json#/definitions/Element" } }, "additionalProperties": false }, "UserSession_Context": { "description": "Information about a user\u0027s current session.", "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.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "type": { "description": "Indicates which type of context is being provided.", "$ref": "#/definitions/string" }, "_type": { "description": "Extensions for type", "$ref": "Element.schema.json#/definitions/Element" }, "valueCodeableConcept": { "description": "Provides the context value.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "valueQuantity": { "description": "Provides the context value.", "$ref": "Quantity.schema.json#/definitions/Quantity" } }, "additionalProperties": false } } }