R4 Ballot #1 (Mixed Normative/Trial use)
AdministrationThis 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 
| Public Health and Emergency Response Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Patient |
This is a representation of the json schema for OccupationalData, 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/OccupationalData",
"$ref": "#/definitions/OccupationalData",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"OccupationalData": {
"description": "A person\u0027s work information, structured to facilitate individual, population, and public health use; not intended to support billing.",
"properties": {
"resourceType": {
"description": "This is a OccupationalData resource",
"const": "OccupationalData"
},
"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": "Business identifier assigned to the occupational data record.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"status": {
"description": "The status of this ODH. Enables tracking the life-cycle of the content.",
"enum": [
"draft",
"active",
"retired",
"unknown"
]
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"subject": {
"description": "The occupational data record is about this person (e.g., the patient, a parent of a minor child).",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"date": {
"description": "The date of creation or updating of the occupational data record.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"recorder": {
"description": "The person who created or last updated the occupational data record.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"informant": {
"description": "The person who provided the subject\u0027s health-related occupational data.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"employmentStatus": {
"description": "A person\u0027s current economic relationship to a job. Employment status refers to whether a person is currently working for compensation, is unemployed (i.e., searching for work for compensation), or is not in the labor force (e.g. disabled, homemaker, chooses not to work, etc.). Employment status is not the same as classification of work.",
"items": {
"$ref": "#/definitions/OccupationalData_EmploymentStatus"
},
"type": "array"
},
"retirementDate": {
"description": "A person\u0027s self-identified retirement date. A person may retire multiple times.",
"items": {
"$ref": "#/definitions/dateTime"
},
"type": "array"
},
"_retirementDate": {
"description": "Extensions for retirementDate",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"combatZonePeriod": {
"description": "The start and end dates for the period of time a person\u0027s work is or was in a combat zone. In addition to military personnel, civilians also may work or have worked in a combat zone.",
"items": {
"$ref": "Period.schema.json#/definitions/Period"
},
"type": "array"
},
"usualWork": {
"description": "The type of work a person has held for the longest amount of time during his or her life, regardless of the occupation currently held and regardless of whether or not it has been held for a continuous time.",
"$ref": "#/definitions/OccupationalData_UsualWork"
},
"pastOrPresentJob": {
"description": "The type of work done by a person during a current or past job. A job is defined by the sum of all the data related to the occupation. A change in occupation, supervisory level, industry, employer, or employer location is considered a new job.",
"items": {
"$ref": "#/definitions/OccupationalData_PastOrPresentJob"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"resourceType"
]
},
"OccupationalData_EmploymentStatus": {
"description": "A person\u0027s work information, structured to facilitate individual, population, and public health use; not intended to support billing.",
"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": "A code that represents a person\u0027s current economic relationship to a job.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"effective": {
"description": "The start and end dates for a person\u0027s current economic relationship to a job.",
"$ref": "Period.schema.json#/definitions/Period"
}
},
"additionalProperties": false,
"required": [
"effective",
"code"
]
},
"OccupationalData_UsualWork": {
"description": "A person\u0027s work information, structured to facilitate individual, population, and public health use; not intended to support billing.",
"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"
},
"occupation": {
"description": "A code that represents the type of work a person has held for the longest amount of time during his or her life.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"industry": {
"description": "A code that represents the type of business a person has worked in for the longest total time while in the usual occupation.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"start": {
"description": "The date when a person first started working in their usual occupation.",
"$ref": "#/definitions/dateTime"
},
"_start": {
"description": "Extensions for start",
"$ref": "Element.schema.json#/definitions/Element"
},
"duration": {
"description": "Total of all periods of time a person has spent in the usual occupation, not including intermittent period(s) where the person was not working in that occupation.",
"$ref": "Duration.schema.json#/definitions/Duration"
}
},
"additionalProperties": false,
"required": [
"occupation",
"industry"
]
},
"OccupationalData_PastOrPresentJob": {
"description": "A person\u0027s work information, structured to facilitate individual, population, and public health use; not intended to support billing.",
"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"
},
"occupation": {
"description": "A code that represents the type of work done by a person at one job.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"industry": {
"description": "A code that represents the type of business associated with a person\u0027s Past or Present Job; i.e., for one job. A change in industry indicates a change in job.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"effective": {
"description": "The start and end dates for one job. A change in occupation, supervisory level, industry, employer, or employer location is considered a new job.",
"$ref": "Period.schema.json#/definitions/Period"
},
"employer": {
"description": "The party, be it an individual or an organization, responsible for providing compensation to a person performing work, or in the case of unpaid work, the party responsible for engaging the person in a position. For military occupations, this refers to the name of the person\u0027s military home base; the person\u0027s Branch of Service is recorded as industry. A change in employer or employer location indicates a change in job.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"workClassification": {
"description": "The classification of a person\u0027s job (one job) as defined by compensation and sector (e.g. paid, unpaid, self-employed, government, etc.). This is different from employment status: a person who is a volunteer (work classification) may have chosen not to be in the labor force (employment status).",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"supervisoryLevel": {
"description": "Reflects the amount of supervisory or management responsibilities of a person at one job. For military jobs, pay grade is used as a proxy because it can be interpreted across branches of service. A change in supervisory level is considered a new job.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"jobDuty": {
"description": "A regular action performed at a single job.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_jobDuty": {
"description": "Extensions for jobDuty",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"occupationalHazard": {
"description": "A hazard that is specific to a person\u0027s work or work environment for a single job and with which the person might come in contact. A hazard is a source of potential harm to an individual\u0027s physical or mental health (e.g., biological, chemical, physical, psychological, radiological).",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_occupationalHazard": {
"description": "Extensions for occupationalHazard",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"workSchedule": {
"description": "Describes a person\u0027s typical arrangement of working hours for one job.",
"$ref": "#/definitions/OccupationalData_WorkSchedule"
}
},
"additionalProperties": false,
"required": [
"occupation",
"industry"
]
},
"OccupationalData_WorkSchedule": {
"description": "A person\u0027s work information, structured to facilitate individual, population, and public health use; not intended to support billing.",
"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": "A code that represents a person\u0027s typical arrangement of working hours for one job.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"weeklyWorkDays": {
"description": "The typical number of days worked in a week by a person at one job.",
"$ref": "#/definitions/decimal"
},
"_weeklyWorkDays": {
"description": "Extensions for weeklyWorkDays",
"$ref": "Element.schema.json#/definitions/Element"
},
"dailyWorkHours": {
"description": "The number of hours worked in a day or shift at one job by a person. For those working a split shift (divided into two parts that are separated by an interval longer than a normal rest period), it is the total of both periods of time in a shift.",
"$ref": "#/definitions/decimal"
},
"_dailyWorkHours": {
"description": "Extensions for dailyWorkHours",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false,
"required": [
"code"
]
}
}
}
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:17+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change