R4 Ballot #1 (Mixed Normative/Trial use)

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

8.31 Resource OccupationalData - Content

Public Health and Emergency Response Work GroupMaturity Level: 0 Draft Compartments: Patient

A person's work information, structured to facilitate individual, population, and public health use; not intended to support billing.

8.31.1 Scope and Usage

Note that this content is preliminary and has not yet undergone proper review by the appropriate Workgroups.

The OccupationalData (i.e. Occupational Data for Health, ODH) FHIR resource covers information about a patient's work or a patient's family member's work. ODH is designed for the social history section of a medical record, to facilitate clinical care in most, if not all disciplines and delivery environments. ODH also can be used to support public health reporting, population health activities, clinical decision support, and similar value-based care. ODH is not designed to support billing activities. The scope of the work information includes:

  • Subject (patient or related person)
  • Employment Status
  • Retirement Date(s)
  • Combat Zone Period
  • Usual Work, which includes:
    • Usual Occupation
    • Usual Industry
    • Start Date
    • Duration
  • Past or Present Job, which includes:
    • Past or Present Occupation
    • Past or Present Industry
    • Work Classification
    • Work Schedule, with:
      • Weekly Work Days
      • Daily Work Hours
    • Job Duty
    • Occupational Hazards
    • Employer Details (e.g., name, address)

This resource is expected to be implemented by clinical systems of all settings. Since a likely mechanism for collecting work information would be by patient data entry, the resource may be implemented by Personal Health Record systems. Systems supporting quality metrics and population health may also implement this resource.

Example Scenarios

  • Diabetes management affected by rotating shift
  • Population prevention and testing activities due to potential for increased substance exposure or take-home exposure (e.g. lead) associated with occupation (e.g. house painter)
  • Stress factors associated with retirement status
  • Long shifts with safety sensitive work
  • Recognition of asthma related to the workplace environment
  • Recognition of cancer related to exposure to an occupational hazard during a previous job

8.31.2 Boundaries and Relationships

This resource is expected to be referenced within FHIR profiles to incorporate patient's work information. Such profiles may include those related to:

  • Quality measures
  • Public health reporting (e.g. vital records, cancer, case reporting)
  • Encounter summaries

This resource refers to the following other resources:

  • The Observation Resource for the actual observations
  • The RelatedPerson Resource for work or occupations related to the patient's family
  • The Organization Resource for Employer name and address information
  • The Author extension for documentation of the person that recorded the patient's work information

8.31.3 Background and Context

The majority of adults in the U.S. spend more than half their waking hours at work. Therefore health and work are inextricably inter-related. For example, the management of chronic conditions requires taking the patient's work environment into consideration. Furthermore, the recognition of new conditions related to previously unknown workplace hazards has often come from astute clinicians, which requires knowledge of the patient's work setting. ONC has indicated recognition of the value of work information for health care.

8.31.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. OccupationalData DDomainResourcePatient's or family member's work information (ODH)
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..1IdentifierUnique identifier for the occupational data (ODH) record
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... subject Σ0..1Reference(Patient | RelatedPerson)Who the occupational data (ODH) is collected about
... date 0..1dateTimeOccupational Data (ODH) recording time
... recorder 0..*Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Occupational Data (ODH) recorder
... informant 0..*Reference(Patient | RelatedPerson)Occupational Data (ODH) informant
... employmentStatus Σ0..*BackboneElementEmployment status
.... code Σ1..1CodeableConceptEmployment status code
Employment Status (ODH) (Example)
.... effective Σ1..1PeriodEmployment status effective time period
... retirementDate Σ0..*dateTimeRetirement date
... combatZonePeriod Σ0..*PeriodCombat Zone Work period
... usualWork Σ0..1BackboneElementUsual Work
.... occupation Σ1..1CodeableConceptUsual Work occupation
Occupation CDC Census 2010 (Example)
.... industry Σ1..1CodeableConceptUsual Work industry
Industry CDC Census 2010 (Example)
.... start Σ0..1dateTimeUsual Work start time
.... duration Σ0..1DurationUsual Work duration
... pastOrPresentJob Σ0..*BackboneElementPast or Present Job
.... occupation Σ1..1CodeableConceptPast or Present Job occupation
Occupation CDC Census 2010 (Example)
.... industry Σ1..1CodeableConceptPast or Present Job industry
Industry CDC Census 2010 (Example)
.... effective Σ0..1PeriodPast or Present Job effective time period
.... employer Σ0..1Reference(Organization)Past or Present Job employer
.... workClassification Σ0..1CodeableConceptPast or Present Job work classification
Work Classification (ODH) (Example)
.... supervisoryLevel Σ0..1CodeableConceptPast or Present Job supervisory level
Supervisory Level (ODH) (US) (Example)
.... jobDuty Σ0..*stringPast or Present Job job duty
.... occupationalHazard Σ0..*stringPast or Present Job occupational hazard
.... workSchedule Σ0..1BackboneElementPast or Present Job work schedule
..... code Σ1..1CodeableConceptPast or Present Job work schedule code
Work Schedule (ODH) (Example)
..... weeklyWorkDays Σ0..1decimalPast or Present Job work schedule weekly work days
..... dailyWorkHours Σ0..1decimalPast or Present Job work schedule daily work hours

doco Documentation for this format

UML Diagram (Legend)

OccupationalData (DomainResource)Business identifier assigned to the occupational data recordidentifier : Identifier [0..1]The status of this ODH. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »The occupational data record is about this person (e.g., the patient, a parent of a minor child)subject : Reference [0..1] « Patient|RelatedPerson »The date of creation or updating of the occupational data recorddate : dateTime [0..1]The person who created or last updated the occupational data recordrecorder : Reference [0..*] « Practitioner|PractitionerRole|Patient| RelatedPerson »The person who provided the subject's health-related occupational datainformant : Reference [0..*] « Patient|RelatedPerson »A person's self-identified retirement date. A person may retire multiple timesretirementDate : dateTime [0..*]The start and end dates for the period of time a person's work is or was in a combat zone. In addition to military personnel, civilians also may work or have worked in a combat zonecombatZonePeriod : Period [0..*]EmploymentStatusA code that represents a person's current economic relationship to a jobcode : CodeableConcept [1..1] « A value set consisting of codes pertaining to a person’s 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. (Strength=Example)Employment Status (ODH)?? »The start and end dates for a person's current economic relationship to a jobeffective : Period [1..1]UsualWorkA code that represents the type of work a person has held for the longest amount of time during his or her lifeoccupation : CodeableConcept [1..1] « A value set consisting of all codes from the 2010 Occupation coding system used by CDC (NIOSH & NCHS) for coding a person's type of work. Occupation describes a set of activities or tasks that an individual is paid to perform or, if unpaid, define the person’s contribution to a household/family business/community. This code system includes 2010 U.S. Census Bureau occupation codes with modifications made by CDC for unpaid workers and military occupations. The 2010 Census occupation categories are based on the 2010 BLS Standard Occupational Classification (SOC) system. The PH_Industry_CDC_Census2010 code system should be used in conjunction with this occupation code system when coding both industry and occupation. (Strength=Example)Occupation CDC Census 2010?? »A code that represents the type of business a person has worked in for the longest total time while in the usual occupationindustry : CodeableConcept [1..1] « A value set consisting of all codes from the 2010 Industry coding system used by CDC (NIOSH & NCHS) for coding the type of business in which a person works. Industry describes an economic or business sector comprised of businesses or enterprises concerned with the output of a specified category of products or services (e.g., the construction industry or the agriculture industry). This industry code system includes 2007 U.S. Census Bureau industry codes and additional codes developed by CDC for unpaid workers. The 2010 Census industry categories are based on the 2007 North American Industry Classification System (NAICS). The PH_Occupation_CDC_Census2010 code system should be used in conjunction with this industry code system when coding both industry and occupation. (Strength=Example)Industry CDC Census 2010?? »The date when a person first started working in their usual occupationstart : dateTime [0..1]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 occupationduration : Duration [0..1]PastOrPresentJobA code that represents the type of work done by a person at one joboccupation : CodeableConcept [1..1] « A value set consisting of all codes from the 2010 Occupation coding system used by CDC (NIOSH & NCHS) for coding a person's type of work. Occupation describes a set of activities or tasks that an individual is paid to perform or, if unpaid, define the person’s contribution to a household/family business/community. This code system includes 2010 U.S. Census Bureau occupation codes with modifications made by CDC for unpaid workers and military occupations. The 2010 Census occupation categories are based on the 2010 BLS Standard Occupational Classification (SOC) system. The PH_Industry_CDC_Census2010 code system should be used in conjunction with this occupation code system when coding both industry and occupation. (Strength=Example)Occupation CDC Census 2010?? »A code that represents the type of business associated with a person's Past or Present Job; i.e., for one job. A change in industry indicates a change in jobindustry : CodeableConcept [1..1] « A value set consisting of all codes from the 2010 Industry coding system used by CDC (NIOSH & NCHS) for coding the type of business in which a person works. Industry describes an economic or business sector comprised of businesses or enterprises concerned with the output of a specified category of products or services (e.g., the construction industry or the agriculture industry). This industry code system includes 2007 U.S. Census Bureau industry codes and additional codes developed by CDC for unpaid workers. The 2010 Census industry categories are based on the 2007 North American Industry Classification System (NAICS). The PH_Occupation_CDC_Census2010 code system should be used in conjunction with this industry code system when coding both industry and occupation. (Strength=Example)Industry CDC Census 2010?? »The start and end dates for one job. A change in occupation, supervisory level, industry, employer, or employer location is considered a new jobeffective : Period [0..1]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's military home base; the person's Branch of Service is recorded as industry. A change in employer or employer location indicates a change in jobemployer : Reference [0..1] « Organization »The classification of a person's 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)workClassification : CodeableConcept [0..1] « A value set consisting of codes pertaining to the classification of a person's 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). (Strength=Example)Work Classification (ODH)?? »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 jobsupervisoryLevel : CodeableConcept [0..1] « A value set consisting of codes which reflect 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. This set of codes reflects US usage - other jurisdictions will have different needs. (Strength=Example)Supervisory Level (ODH) (US)?? »A regular action performed at a single jobjobDuty : string [0..*]A hazard that is specific to a person's 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's physical or mental health (e.g., biological, chemical, physical, psychological, radiological)occupationalHazard : string [0..*]WorkScheduleA code that represents a person's typical arrangement of working hours for one jobcode : CodeableConcept [1..1] « A value set consisting of codes which describe a person's typical arrangement of working hours for one job. (Strength=Example)Work Schedule (ODH)?? »The typical number of days worked in a week by a person at one jobweeklyWorkDays : decimal [0..1]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 shiftdailyWorkHours : decimal [0..1]A person's 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 workemploymentStatus[0..*]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 timeusualWork[0..1]Describes a person's typical arrangement of working hours for one jobworkSchedule[0..1]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 jobpastOrPresentJob[0..*]

XML Template

<OccupationalData xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Unique identifier for the occupational data (ODH) record --></identifier>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <subject><!-- 0..1 Reference(Patient|RelatedPerson) Who the occupational data (ODH) is collected about --></subject>
 <date value="[dateTime]"/><!-- 0..1 Occupational Data (ODH) recording time -->
 <recorder><!-- 0..* Reference(Practitioner|PractitionerRole|Patient|
   RelatedPerson) Occupational Data (ODH) recorder --></recorder>
 <informant><!-- 0..* Reference(Patient|RelatedPerson) Occupational Data (ODH) informant --></informant>
 <employmentStatus>  <!-- 0..* Employment status -->
  <code><!-- 1..1 CodeableConcept Employment status code --></code>
  <effective><!-- 1..1 Period Employment status effective time period --></effective>
 </employmentStatus>
 <retirementDate value="[dateTime]"/><!-- 0..* Retirement date -->
 <combatZonePeriod><!-- 0..* Period Combat Zone Work period --></combatZonePeriod>
 <usualWork>  <!-- 0..1 Usual Work -->
  <occupation><!-- 1..1 CodeableConcept Usual Work occupation --></occupation>
  <industry><!-- 1..1 CodeableConcept Usual Work industry --></industry>
  <start value="[dateTime]"/><!-- 0..1 Usual Work start time -->
  <duration><!-- 0..1 Duration Usual Work duration --></duration>
 </usualWork>
 <pastOrPresentJob>  <!-- 0..* Past or Present Job -->
  <occupation><!-- 1..1 CodeableConcept Past or Present Job occupation --></occupation>
  <industry><!-- 1..1 CodeableConcept Past or Present Job industry --></industry>
  <effective><!-- 0..1 Period Past or Present Job effective time period --></effective>
  <employer><!-- 0..1 Reference(Organization) Past or Present Job employer --></employer>
  <workClassification><!-- 0..1 CodeableConcept Past or Present Job work classification --></workClassification>
  <supervisoryLevel><!-- 0..1 CodeableConcept Past or Present Job supervisory level --></supervisoryLevel>
  <jobDuty value="[string]"/><!-- 0..* Past or Present Job job duty -->
  <occupationalHazard value="[string]"/><!-- 0..* Past or Present Job occupational hazard -->
  <workSchedule>  <!-- 0..1 Past or Present Job work schedule -->
   <code><!-- 1..1 CodeableConcept Past or Present Job work schedule code --></code>
   <weeklyWorkDays value="[decimal]"/><!-- 0..1 Past or Present Job work schedule weekly work days -->
   <dailyWorkHours value="[decimal]"/><!-- 0..1 Past or Present Job work schedule daily work hours -->
  </workSchedule>
 </pastOrPresentJob>
</OccupationalData>

JSON Template

{doco
  "resourceType" : "OccupationalData",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Unique identifier for the occupational data (ODH) record
  "status" : "<code>", // R!  draft | active | retired | unknown
  "subject" : { Reference(Patient|RelatedPerson) }, // Who the occupational data (ODH) is collected about
  "date" : "<dateTime>", // Occupational Data (ODH) recording time
  "recorder" : [{ Reference(Practitioner|PractitionerRole|Patient|
   RelatedPerson) }], // Occupational Data (ODH) recorder
  "informant" : [{ Reference(Patient|RelatedPerson) }], // Occupational Data (ODH) informant
  "employmentStatus" : [{ // Employment status
    "code" : { CodeableConcept }, // R!  Employment status code
    "effective" : { Period } // R!  Employment status effective time period
  }],
  "retirementDate" : ["<dateTime>"], // Retirement date
  "combatZonePeriod" : [{ Period }], // Combat Zone Work period
  "usualWork" : { // Usual Work
    "occupation" : { CodeableConcept }, // R!  Usual Work occupation
    "industry" : { CodeableConcept }, // R!  Usual Work industry
    "start" : "<dateTime>", // Usual Work start time
    "duration" : { Duration } // Usual Work duration
  },
  "pastOrPresentJob" : [{ // Past or Present Job
    "occupation" : { CodeableConcept }, // R!  Past or Present Job occupation
    "industry" : { CodeableConcept }, // R!  Past or Present Job industry
    "effective" : { Period }, // Past or Present Job effective time period
    "employer" : { Reference(Organization) }, // Past or Present Job employer
    "workClassification" : { CodeableConcept }, // Past or Present Job work classification
    "supervisoryLevel" : { CodeableConcept }, // Past or Present Job supervisory level
    "jobDuty" : ["<string>"], // Past or Present Job job duty
    "occupationalHazard" : ["<string>"], // Past or Present Job occupational hazard
    "workSchedule" : { // Past or Present Job work schedule
      "code" : { CodeableConcept }, // R!  Past or Present Job work schedule code
      "weeklyWorkDays" : <decimal>, // Past or Present Job work schedule weekly work days
      "dailyWorkHours" : <decimal> // Past or Present Job work schedule daily work hours
    }
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:OccupationalData;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:OccupationalData.identifier [ Identifier ]; # 0..1 Unique identifier for the occupational data (ODH) record
  fhir:OccupationalData.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:OccupationalData.subject [ Reference(Patient|RelatedPerson) ]; # 0..1 Who the occupational data (ODH) is collected about
  fhir:OccupationalData.date [ dateTime ]; # 0..1 Occupational Data (ODH) recording time
  fhir:OccupationalData.recorder [ Reference(Practitioner|PractitionerRole|Patient|RelatedPerson) ], ... ; # 0..* Occupational Data (ODH) recorder
  fhir:OccupationalData.informant [ Reference(Patient|RelatedPerson) ], ... ; # 0..* Occupational Data (ODH) informant
  fhir:OccupationalData.employmentStatus [ # 0..* Employment status
    fhir:OccupationalData.employmentStatus.code [ CodeableConcept ]; # 1..1 Employment status code
    fhir:OccupationalData.employmentStatus.effective [ Period ]; # 1..1 Employment status effective time period
  ], ...;
  fhir:OccupationalData.retirementDate [ dateTime ], ... ; # 0..* Retirement date
  fhir:OccupationalData.combatZonePeriod [ Period ], ... ; # 0..* Combat Zone Work period
  fhir:OccupationalData.usualWork [ # 0..1 Usual Work
    fhir:OccupationalData.usualWork.occupation [ CodeableConcept ]; # 1..1 Usual Work occupation
    fhir:OccupationalData.usualWork.industry [ CodeableConcept ]; # 1..1 Usual Work industry
    fhir:OccupationalData.usualWork.start [ dateTime ]; # 0..1 Usual Work start time
    fhir:OccupationalData.usualWork.duration [ Duration ]; # 0..1 Usual Work duration
  ];
  fhir:OccupationalData.pastOrPresentJob [ # 0..* Past or Present Job
    fhir:OccupationalData.pastOrPresentJob.occupation [ CodeableConcept ]; # 1..1 Past or Present Job occupation
    fhir:OccupationalData.pastOrPresentJob.industry [ CodeableConcept ]; # 1..1 Past or Present Job industry
    fhir:OccupationalData.pastOrPresentJob.effective [ Period ]; # 0..1 Past or Present Job effective time period
    fhir:OccupationalData.pastOrPresentJob.employer [ Reference(Organization) ]; # 0..1 Past or Present Job employer
    fhir:OccupationalData.pastOrPresentJob.workClassification [ CodeableConcept ]; # 0..1 Past or Present Job work classification
    fhir:OccupationalData.pastOrPresentJob.supervisoryLevel [ CodeableConcept ]; # 0..1 Past or Present Job supervisory level
    fhir:OccupationalData.pastOrPresentJob.jobDuty [ string ], ... ; # 0..* Past or Present Job job duty
    fhir:OccupationalData.pastOrPresentJob.occupationalHazard [ string ], ... ; # 0..* Past or Present Job occupational hazard
    fhir:OccupationalData.pastOrPresentJob.workSchedule [ # 0..1 Past or Present Job work schedule
      fhir:OccupationalData.pastOrPresentJob.workSchedule.code [ CodeableConcept ]; # 1..1 Past or Present Job work schedule code
      fhir:OccupationalData.pastOrPresentJob.workSchedule.weeklyWorkDays [ decimal ]; # 0..1 Past or Present Job work schedule weekly work days
      fhir:OccupationalData.pastOrPresentJob.workSchedule.dailyWorkHours [ decimal ]; # 0..1 Past or Present Job work schedule daily work hours
    ];
  ], ...;
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. OccupationalData DDomainResourcePatient's or family member's work information (ODH)
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..1IdentifierUnique identifier for the occupational data (ODH) record
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... subject Σ0..1Reference(Patient | RelatedPerson)Who the occupational data (ODH) is collected about
... date 0..1dateTimeOccupational Data (ODH) recording time
... recorder 0..*Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Occupational Data (ODH) recorder
... informant 0..*Reference(Patient | RelatedPerson)Occupational Data (ODH) informant
... employmentStatus Σ0..*BackboneElementEmployment status
.... code Σ1..1CodeableConceptEmployment status code
Employment Status (ODH) (Example)
.... effective Σ1..1PeriodEmployment status effective time period
... retirementDate Σ0..*dateTimeRetirement date
... combatZonePeriod Σ0..*PeriodCombat Zone Work period
... usualWork Σ0..1BackboneElementUsual Work
.... occupation Σ1..1CodeableConceptUsual Work occupation
Occupation CDC Census 2010 (Example)
.... industry Σ1..1CodeableConceptUsual Work industry
Industry CDC Census 2010 (Example)
.... start Σ0..1dateTimeUsual Work start time
.... duration Σ0..1DurationUsual Work duration
... pastOrPresentJob Σ0..*BackboneElementPast or Present Job
.... occupation Σ1..1CodeableConceptPast or Present Job occupation
Occupation CDC Census 2010 (Example)
.... industry Σ1..1CodeableConceptPast or Present Job industry
Industry CDC Census 2010 (Example)
.... effective Σ0..1PeriodPast or Present Job effective time period
.... employer Σ0..1Reference(Organization)Past or Present Job employer
.... workClassification Σ0..1CodeableConceptPast or Present Job work classification
Work Classification (ODH) (Example)
.... supervisoryLevel Σ0..1CodeableConceptPast or Present Job supervisory level
Supervisory Level (ODH) (US) (Example)
.... jobDuty Σ0..*stringPast or Present Job job duty
.... occupationalHazard Σ0..*stringPast or Present Job occupational hazard
.... workSchedule Σ0..1BackboneElementPast or Present Job work schedule
..... code Σ1..1CodeableConceptPast or Present Job work schedule code
Work Schedule (ODH) (Example)
..... weeklyWorkDays Σ0..1decimalPast or Present Job work schedule weekly work days
..... dailyWorkHours Σ0..1decimalPast or Present Job work schedule daily work hours

doco Documentation for this format

UML Diagram (Legend)

OccupationalData (DomainResource)Business identifier assigned to the occupational data recordidentifier : Identifier [0..1]The status of this ODH. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »The occupational data record is about this person (e.g., the patient, a parent of a minor child)subject : Reference [0..1] « Patient|RelatedPerson »The date of creation or updating of the occupational data recorddate : dateTime [0..1]The person who created or last updated the occupational data recordrecorder : Reference [0..*] « Practitioner|PractitionerRole|Patient| RelatedPerson »The person who provided the subject's health-related occupational datainformant : Reference [0..*] « Patient|RelatedPerson »A person's self-identified retirement date. A person may retire multiple timesretirementDate : dateTime [0..*]The start and end dates for the period of time a person's work is or was in a combat zone. In addition to military personnel, civilians also may work or have worked in a combat zonecombatZonePeriod : Period [0..*]EmploymentStatusA code that represents a person's current economic relationship to a jobcode : CodeableConcept [1..1] « A value set consisting of codes pertaining to a person’s 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. (Strength=Example)Employment Status (ODH)?? »The start and end dates for a person's current economic relationship to a jobeffective : Period [1..1]UsualWorkA code that represents the type of work a person has held for the longest amount of time during his or her lifeoccupation : CodeableConcept [1..1] « A value set consisting of all codes from the 2010 Occupation coding system used by CDC (NIOSH & NCHS) for coding a person's type of work. Occupation describes a set of activities or tasks that an individual is paid to perform or, if unpaid, define the person’s contribution to a household/family business/community. This code system includes 2010 U.S. Census Bureau occupation codes with modifications made by CDC for unpaid workers and military occupations. The 2010 Census occupation categories are based on the 2010 BLS Standard Occupational Classification (SOC) system. The PH_Industry_CDC_Census2010 code system should be used in conjunction with this occupation code system when coding both industry and occupation. (Strength=Example)Occupation CDC Census 2010?? »A code that represents the type of business a person has worked in for the longest total time while in the usual occupationindustry : CodeableConcept [1..1] « A value set consisting of all codes from the 2010 Industry coding system used by CDC (NIOSH & NCHS) for coding the type of business in which a person works. Industry describes an economic or business sector comprised of businesses or enterprises concerned with the output of a specified category of products or services (e.g., the construction industry or the agriculture industry). This industry code system includes 2007 U.S. Census Bureau industry codes and additional codes developed by CDC for unpaid workers. The 2010 Census industry categories are based on the 2007 North American Industry Classification System (NAICS). The PH_Occupation_CDC_Census2010 code system should be used in conjunction with this industry code system when coding both industry and occupation. (Strength=Example)Industry CDC Census 2010?? »The date when a person first started working in their usual occupationstart : dateTime [0..1]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 occupationduration : Duration [0..1]PastOrPresentJobA code that represents the type of work done by a person at one joboccupation : CodeableConcept [1..1] « A value set consisting of all codes from the 2010 Occupation coding system used by CDC (NIOSH & NCHS) for coding a person's type of work. Occupation describes a set of activities or tasks that an individual is paid to perform or, if unpaid, define the person’s contribution to a household/family business/community. This code system includes 2010 U.S. Census Bureau occupation codes with modifications made by CDC for unpaid workers and military occupations. The 2010 Census occupation categories are based on the 2010 BLS Standard Occupational Classification (SOC) system. The PH_Industry_CDC_Census2010 code system should be used in conjunction with this occupation code system when coding both industry and occupation. (Strength=Example)Occupation CDC Census 2010?? »A code that represents the type of business associated with a person's Past or Present Job; i.e., for one job. A change in industry indicates a change in jobindustry : CodeableConcept [1..1] « A value set consisting of all codes from the 2010 Industry coding system used by CDC (NIOSH & NCHS) for coding the type of business in which a person works. Industry describes an economic or business sector comprised of businesses or enterprises concerned with the output of a specified category of products or services (e.g., the construction industry or the agriculture industry). This industry code system includes 2007 U.S. Census Bureau industry codes and additional codes developed by CDC for unpaid workers. The 2010 Census industry categories are based on the 2007 North American Industry Classification System (NAICS). The PH_Occupation_CDC_Census2010 code system should be used in conjunction with this industry code system when coding both industry and occupation. (Strength=Example)Industry CDC Census 2010?? »The start and end dates for one job. A change in occupation, supervisory level, industry, employer, or employer location is considered a new jobeffective : Period [0..1]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's military home base; the person's Branch of Service is recorded as industry. A change in employer or employer location indicates a change in jobemployer : Reference [0..1] « Organization »The classification of a person's 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)workClassification : CodeableConcept [0..1] « A value set consisting of codes pertaining to the classification of a person's 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). (Strength=Example)Work Classification (ODH)?? »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 jobsupervisoryLevel : CodeableConcept [0..1] « A value set consisting of codes which reflect 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. This set of codes reflects US usage - other jurisdictions will have different needs. (Strength=Example)Supervisory Level (ODH) (US)?? »A regular action performed at a single jobjobDuty : string [0..*]A hazard that is specific to a person's 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's physical or mental health (e.g., biological, chemical, physical, psychological, radiological)occupationalHazard : string [0..*]WorkScheduleA code that represents a person's typical arrangement of working hours for one jobcode : CodeableConcept [1..1] « A value set consisting of codes which describe a person's typical arrangement of working hours for one job. (Strength=Example)Work Schedule (ODH)?? »The typical number of days worked in a week by a person at one jobweeklyWorkDays : decimal [0..1]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 shiftdailyWorkHours : decimal [0..1]A person's 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 workemploymentStatus[0..*]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 timeusualWork[0..1]Describes a person's typical arrangement of working hours for one jobworkSchedule[0..1]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 jobpastOrPresentJob[0..*]

XML Template

<OccupationalData xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Unique identifier for the occupational data (ODH) record --></identifier>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <subject><!-- 0..1 Reference(Patient|RelatedPerson) Who the occupational data (ODH) is collected about --></subject>
 <date value="[dateTime]"/><!-- 0..1 Occupational Data (ODH) recording time -->
 <recorder><!-- 0..* Reference(Practitioner|PractitionerRole|Patient|
   RelatedPerson) Occupational Data (ODH) recorder --></recorder>
 <informant><!-- 0..* Reference(Patient|RelatedPerson) Occupational Data (ODH) informant --></informant>
 <employmentStatus>  <!-- 0..* Employment status -->
  <code><!-- 1..1 CodeableConcept Employment status code --></code>
  <effective><!-- 1..1 Period Employment status effective time period --></effective>
 </employmentStatus>
 <retirementDate value="[dateTime]"/><!-- 0..* Retirement date -->
 <combatZonePeriod><!-- 0..* Period Combat Zone Work period --></combatZonePeriod>
 <usualWork>  <!-- 0..1 Usual Work -->
  <occupation><!-- 1..1 CodeableConcept Usual Work occupation --></occupation>
  <industry><!-- 1..1 CodeableConcept Usual Work industry --></industry>
  <start value="[dateTime]"/><!-- 0..1 Usual Work start time -->
  <duration><!-- 0..1 Duration Usual Work duration --></duration>
 </usualWork>
 <pastOrPresentJob>  <!-- 0..* Past or Present Job -->
  <occupation><!-- 1..1 CodeableConcept Past or Present Job occupation --></occupation>
  <industry><!-- 1..1 CodeableConcept Past or Present Job industry --></industry>
  <effective><!-- 0..1 Period Past or Present Job effective time period --></effective>
  <employer><!-- 0..1 Reference(Organization) Past or Present Job employer --></employer>
  <workClassification><!-- 0..1 CodeableConcept Past or Present Job work classification --></workClassification>
  <supervisoryLevel><!-- 0..1 CodeableConcept Past or Present Job supervisory level --></supervisoryLevel>
  <jobDuty value="[string]"/><!-- 0..* Past or Present Job job duty -->
  <occupationalHazard value="[string]"/><!-- 0..* Past or Present Job occupational hazard -->
  <workSchedule>  <!-- 0..1 Past or Present Job work schedule -->
   <code><!-- 1..1 CodeableConcept Past or Present Job work schedule code --></code>
   <weeklyWorkDays value="[decimal]"/><!-- 0..1 Past or Present Job work schedule weekly work days -->
   <dailyWorkHours value="[decimal]"/><!-- 0..1 Past or Present Job work schedule daily work hours -->
  </workSchedule>
 </pastOrPresentJob>
</OccupationalData>

JSON Template

{doco
  "resourceType" : "OccupationalData",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Unique identifier for the occupational data (ODH) record
  "status" : "<code>", // R!  draft | active | retired | unknown
  "subject" : { Reference(Patient|RelatedPerson) }, // Who the occupational data (ODH) is collected about
  "date" : "<dateTime>", // Occupational Data (ODH) recording time
  "recorder" : [{ Reference(Practitioner|PractitionerRole|Patient|
   RelatedPerson) }], // Occupational Data (ODH) recorder
  "informant" : [{ Reference(Patient|RelatedPerson) }], // Occupational Data (ODH) informant
  "employmentStatus" : [{ // Employment status
    "code" : { CodeableConcept }, // R!  Employment status code
    "effective" : { Period } // R!  Employment status effective time period
  }],
  "retirementDate" : ["<dateTime>"], // Retirement date
  "combatZonePeriod" : [{ Period }], // Combat Zone Work period
  "usualWork" : { // Usual Work
    "occupation" : { CodeableConcept }, // R!  Usual Work occupation
    "industry" : { CodeableConcept }, // R!  Usual Work industry
    "start" : "<dateTime>", // Usual Work start time
    "duration" : { Duration } // Usual Work duration
  },
  "pastOrPresentJob" : [{ // Past or Present Job
    "occupation" : { CodeableConcept }, // R!  Past or Present Job occupation
    "industry" : { CodeableConcept }, // R!  Past or Present Job industry
    "effective" : { Period }, // Past or Present Job effective time period
    "employer" : { Reference(Organization) }, // Past or Present Job employer
    "workClassification" : { CodeableConcept }, // Past or Present Job work classification
    "supervisoryLevel" : { CodeableConcept }, // Past or Present Job supervisory level
    "jobDuty" : ["<string>"], // Past or Present Job job duty
    "occupationalHazard" : ["<string>"], // Past or Present Job occupational hazard
    "workSchedule" : { // Past or Present Job work schedule
      "code" : { CodeableConcept }, // R!  Past or Present Job work schedule code
      "weeklyWorkDays" : <decimal>, // Past or Present Job work schedule weekly work days
      "dailyWorkHours" : <decimal> // Past or Present Job work schedule daily work hours
    }
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:OccupationalData;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:OccupationalData.identifier [ Identifier ]; # 0..1 Unique identifier for the occupational data (ODH) record
  fhir:OccupationalData.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:OccupationalData.subject [ Reference(Patient|RelatedPerson) ]; # 0..1 Who the occupational data (ODH) is collected about
  fhir:OccupationalData.date [ dateTime ]; # 0..1 Occupational Data (ODH) recording time
  fhir:OccupationalData.recorder [ Reference(Practitioner|PractitionerRole|Patient|RelatedPerson) ], ... ; # 0..* Occupational Data (ODH) recorder
  fhir:OccupationalData.informant [ Reference(Patient|RelatedPerson) ], ... ; # 0..* Occupational Data (ODH) informant
  fhir:OccupationalData.employmentStatus [ # 0..* Employment status
    fhir:OccupationalData.employmentStatus.code [ CodeableConcept ]; # 1..1 Employment status code
    fhir:OccupationalData.employmentStatus.effective [ Period ]; # 1..1 Employment status effective time period
  ], ...;
  fhir:OccupationalData.retirementDate [ dateTime ], ... ; # 0..* Retirement date
  fhir:OccupationalData.combatZonePeriod [ Period ], ... ; # 0..* Combat Zone Work period
  fhir:OccupationalData.usualWork [ # 0..1 Usual Work
    fhir:OccupationalData.usualWork.occupation [ CodeableConcept ]; # 1..1 Usual Work occupation
    fhir:OccupationalData.usualWork.industry [ CodeableConcept ]; # 1..1 Usual Work industry
    fhir:OccupationalData.usualWork.start [ dateTime ]; # 0..1 Usual Work start time
    fhir:OccupationalData.usualWork.duration [ Duration ]; # 0..1 Usual Work duration
  ];
  fhir:OccupationalData.pastOrPresentJob [ # 0..* Past or Present Job
    fhir:OccupationalData.pastOrPresentJob.occupation [ CodeableConcept ]; # 1..1 Past or Present Job occupation
    fhir:OccupationalData.pastOrPresentJob.industry [ CodeableConcept ]; # 1..1 Past or Present Job industry
    fhir:OccupationalData.pastOrPresentJob.effective [ Period ]; # 0..1 Past or Present Job effective time period
    fhir:OccupationalData.pastOrPresentJob.employer [ Reference(Organization) ]; # 0..1 Past or Present Job employer
    fhir:OccupationalData.pastOrPresentJob.workClassification [ CodeableConcept ]; # 0..1 Past or Present Job work classification
    fhir:OccupationalData.pastOrPresentJob.supervisoryLevel [ CodeableConcept ]; # 0..1 Past or Present Job supervisory level
    fhir:OccupationalData.pastOrPresentJob.jobDuty [ string ], ... ; # 0..* Past or Present Job job duty
    fhir:OccupationalData.pastOrPresentJob.occupationalHazard [ string ], ... ; # 0..* Past or Present Job occupational hazard
    fhir:OccupationalData.pastOrPresentJob.workSchedule [ # 0..1 Past or Present Job work schedule
      fhir:OccupationalData.pastOrPresentJob.workSchedule.code [ CodeableConcept ]; # 1..1 Past or Present Job work schedule code
      fhir:OccupationalData.pastOrPresentJob.workSchedule.weeklyWorkDays [ decimal ]; # 0..1 Past or Present Job work schedule weekly work days
      fhir:OccupationalData.pastOrPresentJob.workSchedule.dailyWorkHours [ decimal ]; # 0..1 Past or Present Job work schedule daily work hours
    ];
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

8.31.4.1 Terminology Bindings

PathDefinitionTypeReference
OccupationalData.status The lifecycle status of an artifact.RequiredPublicationStatus
OccupationalData.employmentStatus.code A value set consisting of codes pertaining to a person’s 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.ExampleEmployment Status (ODH)
OccupationalData.usualWork.occupation
OccupationalData.pastOrPresentJob.occupation 		A value set consisting of all codes from the 2010 Occupation coding system used by CDC (NIOSH & NCHS) for coding a person's type of work. Occupation describes a set of activities or tasks that an individual is paid to perform or, if unpaid, define the person’s contribution to a household/family business/community. This code system includes 2010 U.S. Census Bureau occupation codes with modifications made by CDC for unpaid workers and military occupations. The 2010 Census occupation categories are based on the 2010 BLS Standard Occupational Classification (SOC) system. The PH_Industry_CDC_Census2010 code system should be used in conjunction with this occupation code system when coding both industry and occupation.ExampleOccupation CDC Census 2010
OccupationalData.usualWork.industry
OccupationalData.pastOrPresentJob.industry 		A value set consisting of all codes from the 2010 Industry coding system used by CDC (NIOSH & NCHS) for coding the type of business in which a person works. Industry describes an economic or business sector comprised of businesses or enterprises concerned with the output of a specified category of products or services (e.g., the construction industry or the agriculture industry). This industry code system includes 2007 U.S. Census Bureau industry codes and additional codes developed by CDC for unpaid workers. The 2010 Census industry categories are based on the 2007 North American Industry Classification System (NAICS). The PH_Occupation_CDC_Census2010 code system should be used in conjunction with this industry code system when coding both industry and occupation.ExampleIndustry CDC Census 2010
OccupationalData.pastOrPresentJob.workClassification A value set consisting of codes pertaining to the classification of a person's 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).ExampleWork Classification (ODH)
OccupationalData.pastOrPresentJob.supervisoryLevel A value set consisting of codes which reflect 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. This set of codes reflects US usage - other jurisdictions will have different needs.ExampleSupervisory Level (ODH) (US)
OccupationalData.pastOrPresentJob.workSchedule.code A value set consisting of codes which describe a person's typical arrangement of working hours for one job.ExampleWork Schedule (ODH)

8.31.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
datedateObtained date/time. If the obtained element is a period, a date that falls in the periodOccupationalData.date
identifiertokenA business identifier for a particular occupational data recordOccupationalData.identifier
informantreferenceThe person who provided the subject's health-related occupational data.OccupationalData.informant
(Patient, RelatedPerson)
recorderreferenceThe person who recorded or updated the occupational data recordOccupationalData.recorder
(Practitioner, Patient, PractitionerRole, RelatedPerson)
statustokenThe status of the occupational data recordOccupationalData.status
subjectreferenceThe subject that the occupational data record is aboutOccupationalData.subject
(Patient, RelatedPerson)