R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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

Patient’s or family member's work information.

Todo

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. OccupationalData DDomainResourcePatient’s or family member's work information
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..1IdentifierUnique identifier for the occupational data record
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... subject Σ0..1Reference(Patient)Who the occupational data is collected about
... date Σ1..1dateTimeOccupational Data author time
... author Σ1..*Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Occupational Data author
... employmentStatus 0..1BackboneElementEmployment status
.... code 1..1code74165-2
HistoryOfEmploymentStatus (Required)
.... effective[x] 1..1Employment status effective time
..... effectiveDateTimedateTime
..... effectivePeriodPeriod
.... value 1..1CodeableConceptEmployment status value
... retirementStatus 0..1BackboneElementRetirement status
.... code 1..1code87510-4
RetirementStatus (Required)
.... effective[x] 1..1Retirement status effective time
..... effectiveDateTimedateTime
..... effectivePeriodPeriod
.... value 1..1CodeableConceptRetirement status value
... combatZoneHazardousDuty 0..*BackboneElementCombat Zone Hazardous Duty
.... code 1..*code87511-2
HazardousDutyWork (Required)
.... effective[x] 1..1Combat Zone Hazardous Duty effective time
..... effectiveDateTimedateTime
..... effectivePeriodPeriod
.... value 1..1CodeableConceptCombat Zone Hazardous Duty value
... usualOccupation 0..1BackboneElementUsual Occupation
.... code 1..1code21843-8
UsualOccupation (Required)
.... effective[x] 1..1Usual Occupation effective time
..... effectiveDateTimedateTime
..... effectivePeriodPeriod
.... value 1..1CodeableConceptUsual Occupation value
Occupation CDC Census 2010 (Example)
.... duration 0..1BackboneElementUsual Occupation duration
..... code 1..1CodeableConceptUsual Occupation duration code
..... value 1..1PeriodUsual Occupation duration value
.... industry 0..1BackboneElementUsual Occupation industry
..... code 1..1CodeableConceptUsual Occupation industry code
..... value 1..1CodeableConceptUsual Occupation industry value
... pastOrPresentOccupation 0..1BackboneElementPast Or Present Occupation
.... code 1..1CodeableConceptPast Or Present Occupation code
.... effective[x] 1..1Past Or Present Occupation effective time
..... effectiveDateTimedateTime
..... effectivePeriodPeriod
.... value 1..1CodeableConceptPast Or Present Occupation value
Occupation CDC Census 2010 (Example)

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 {{title}}. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! »Who the occupational data is collected aboutsubject : Reference [0..1] « Patient »Occupational Data author timedate : dateTime [1..1]Occupational Data authorauthor : Reference [1..*] « Practitioner|PractitionerRole|Patient| RelatedPerson »EmploymentStatus74165-2code : code [1..1] « 74165-2 History of Employment Status (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (Strength=Required)HistoryOfEmploymentStatus! »Employment status effective timeeffective[x] : Type [1..1] « dateTime|Period »Employment status valuevalue : CodeableConcept [1..1]RetirementStatus87510-4code : code [1..1] « 87510-4 Retirement Status (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (Strength=Required)RetirementStatus! »Retirement status effective timeeffective[x] : Type [1..1] « dateTime|Period »Retirement status valuevalue : CodeableConcept [1..1]CombatZoneHazardousDuty87511-2code : code [1..*] « 87511-2 Hazardous Duty Work (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (Strength=Required)HazardousDutyWork! »Combat Zone Hazardous Duty effective timeeffective[x] : Type [1..1] « dateTime|Period »Combat Zone Hazardous Duty valuevalue : CodeableConcept [1..1]UsualOccupation21843-8code : code [1..1] « 21843-8 Usual Occupation (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (Strength=Required)UsualOccupation! »Usual Occupation effective timeeffective[x] : Type [1..1] « dateTime|Period »Usual Occupation valuevalue : CodeableConcept [1..1] « Occupation CDC Census 2010 (urn:oid:2.16.840.1.114222.4.11.7186) (Strength=Example)Occupation CDC Census 2010?? »DurationUsual Occupation duration codecode : CodeableConcept [1..1]Usual Occupation duration valuevalue : Period [1..1]IndustryUsual Occupation industry codecode : CodeableConcept [1..1]Usual Occupation industry valuevalue : CodeableConcept [1..1]PastOrPresentOccupationPast Or Present Occupation codecode : CodeableConcept [1..1]Past Or Present Occupation effective timeeffective[x] : Type [1..1] « dateTime|Period »Past Or Present Occupation valuevalue : CodeableConcept [1..1] « Occupation CDC Census 2010 (urn:oid:2.16.840.1.114222.4.11.7186) (Strength=Example)Occupation CDC Census 2010?? »Employment statusemploymentStatus[0..1]Retirement statusretirementStatus[0..1]Combat Zone Hazardous DutycombatZoneHazardousDuty[0..*]Usual Occupation durationduration[0..1]Usual Occupation industryindustry[0..1]Usual OccupationusualOccupation[0..1]Past Or Present OccupationpastOrPresentOccupation[0..1]

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 record --></identifier>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <subject><!-- 0..1 Reference(Patient) Who the occupational data is collected about --></subject>
 <date value="[dateTime]"/><!-- 1..1 Occupational Data author time -->
 <author><!-- 1..* Reference(Practitioner|PractitionerRole|Patient|RelatedPerson) Occupational Data author --></author>
 <employmentStatus>  <!-- 0..1 Employment status -->
  <code value="[code]"/><!-- 1..1 74165-2 -->
  <effective[x]><!-- 1..1 dateTime|Period Employment status effective time --></effective[x]>
  <value><!-- 1..1 CodeableConcept Employment status value --></value>
 </employmentStatus>
 <retirementStatus>  <!-- 0..1 Retirement status -->
  <code value="[code]"/><!-- 1..1 87510-4 -->
  <effective[x]><!-- 1..1 dateTime|Period Retirement status effective time --></effective[x]>
  <value><!-- 1..1 CodeableConcept Retirement status value --></value>
 </retirementStatus>
 <combatZoneHazardousDuty>  <!-- 0..* Combat Zone Hazardous Duty -->
  <code value="[code]"/><!-- 1..* 87511-2 -->
  <effective[x]><!-- 1..1 dateTime|Period Combat Zone Hazardous Duty effective time --></effective[x]>
  <value><!-- 1..1 CodeableConcept Combat Zone Hazardous Duty value --></value>
 </combatZoneHazardousDuty>
 <usualOccupation>  <!-- 0..1 Usual Occupation -->
  <code value="[code]"/><!-- 1..1 21843-8 -->
  <effective[x]><!-- 1..1 dateTime|Period Usual Occupation effective time --></effective[x]>
  <value><!-- 1..1 CodeableConcept Usual Occupation value --></value>
  <duration>  <!-- 0..1 Usual Occupation duration -->
   <code><!-- 1..1 CodeableConcept Usual Occupation duration code --></code>
   <value><!-- 1..1 Period Usual Occupation duration value --></value>
  </duration>
  <industry>  <!-- 0..1 Usual Occupation industry -->
   <code><!-- 1..1 CodeableConcept Usual Occupation industry code --></code>
   <value><!-- 1..1 CodeableConcept Usual Occupation industry value --></value>
  </industry>
 </usualOccupation>
 <pastOrPresentOccupation>  <!-- 0..1 Past Or Present Occupation -->
  <code><!-- 1..1 CodeableConcept Past Or Present Occupation code --></code>
  <effective[x]><!-- 1..1 dateTime|Period Past Or Present Occupation effective time --></effective[x]>
  <value><!-- 1..1 CodeableConcept Past Or Present Occupation value --></value>
 </pastOrPresentOccupation>
</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 record
  "status" : "<code>", // R!  draft | active | retired | unknown
  "subject" : { Reference(Patient) }, // Who the occupational data is collected about
  "date" : "<dateTime>", // R!  Occupational Data author time
  "author" : [{ Reference(Practitioner|PractitionerRole|Patient|RelatedPerson) }], // R!  Occupational Data author
  "employmentStatus" : { // Employment status
    "code" : "<code>", // R!  74165-2
    // effective[x]: Employment status effective time. One of these 2:
    "effectiveDateTime" : "<dateTime>",
    "effectivePeriod" : { Period },
    "value" : { CodeableConcept } // R!  Employment status value
  },
  "retirementStatus" : { // Retirement status
    "code" : "<code>", // R!  87510-4
    // effective[x]: Retirement status effective time. One of these 2:
    "effectiveDateTime" : "<dateTime>",
    "effectivePeriod" : { Period },
    "value" : { CodeableConcept } // R!  Retirement status value
  },
  "combatZoneHazardousDuty" : [{ // Combat Zone Hazardous Duty
    "code" : ["<code>"], // R!  87511-2
    // effective[x]: Combat Zone Hazardous Duty effective time. One of these 2:
    "effectiveDateTime" : "<dateTime>",
    "effectivePeriod" : { Period },
    "value" : { CodeableConcept } // R!  Combat Zone Hazardous Duty value
  }],
  "usualOccupation" : { // Usual Occupation
    "code" : "<code>", // R!  21843-8
    // effective[x]: Usual Occupation effective time. One of these 2:
    "effectiveDateTime" : "<dateTime>",
    "effectivePeriod" : { Period },
    "value" : { CodeableConcept }, // R!  Usual Occupation value
    "duration" : { // Usual Occupation duration
      "code" : { CodeableConcept }, // R!  Usual Occupation duration code
      "value" : { Period } // R!  Usual Occupation duration value
    },
    "industry" : { // Usual Occupation industry
      "code" : { CodeableConcept }, // R!  Usual Occupation industry code
      "value" : { CodeableConcept } // R!  Usual Occupation industry value
    }
  },
  "pastOrPresentOccupation" : { // Past Or Present Occupation
    "code" : { CodeableConcept }, // R!  Past Or Present Occupation code
    // effective[x]: Past Or Present Occupation effective time. One of these 2:
    "effectiveDateTime" : "<dateTime>",
    "effectivePeriod" : { Period },
    "value" : { CodeableConcept } // R!  Past Or Present Occupation value
  }
}

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 record
  fhir:OccupationalData.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:OccupationalData.subject [ Reference(Patient) ]; # 0..1 Who the occupational data is collected about
  fhir:OccupationalData.date [ dateTime ]; # 1..1 Occupational Data author time
  fhir:OccupationalData.author [ Reference(Practitioner|PractitionerRole|Patient|RelatedPerson) ], ... ; # 1..* Occupational Data author
  fhir:OccupationalData.employmentStatus [ # 0..1 Employment status
    fhir:OccupationalData.employmentStatus.code [ code ]; # 1..1 74165-2
    # OccupationalData.employmentStatus.effective[x] : 1..1 Employment status effective time. One of these 2
      fhir:OccupationalData.employmentStatus.effectiveDateTime [ dateTime ]
      fhir:OccupationalData.employmentStatus.effectivePeriod [ Period ]
    fhir:OccupationalData.employmentStatus.value [ CodeableConcept ]; # 1..1 Employment status value
  ];
  fhir:OccupationalData.retirementStatus [ # 0..1 Retirement status
    fhir:OccupationalData.retirementStatus.code [ code ]; # 1..1 87510-4
    # OccupationalData.retirementStatus.effective[x] : 1..1 Retirement status effective time. One of these 2
      fhir:OccupationalData.retirementStatus.effectiveDateTime [ dateTime ]
      fhir:OccupationalData.retirementStatus.effectivePeriod [ Period ]
    fhir:OccupationalData.retirementStatus.value [ CodeableConcept ]; # 1..1 Retirement status value
  ];
  fhir:OccupationalData.combatZoneHazardousDuty [ # 0..* Combat Zone Hazardous Duty
    fhir:OccupationalData.combatZoneHazardousDuty.code [ code ], ... ; # 1..* 87511-2
    # OccupationalData.combatZoneHazardousDuty.effective[x] : 1..1 Combat Zone Hazardous Duty effective time. One of these 2
      fhir:OccupationalData.combatZoneHazardousDuty.effectiveDateTime [ dateTime ]
      fhir:OccupationalData.combatZoneHazardousDuty.effectivePeriod [ Period ]
    fhir:OccupationalData.combatZoneHazardousDuty.value [ CodeableConcept ]; # 1..1 Combat Zone Hazardous Duty value
  ], ...;
  fhir:OccupationalData.usualOccupation [ # 0..1 Usual Occupation
    fhir:OccupationalData.usualOccupation.code [ code ]; # 1..1 21843-8
    # OccupationalData.usualOccupation.effective[x] : 1..1 Usual Occupation effective time. One of these 2
      fhir:OccupationalData.usualOccupation.effectiveDateTime [ dateTime ]
      fhir:OccupationalData.usualOccupation.effectivePeriod [ Period ]
    fhir:OccupationalData.usualOccupation.value [ CodeableConcept ]; # 1..1 Usual Occupation value
    fhir:OccupationalData.usualOccupation.duration [ # 0..1 Usual Occupation duration
      fhir:OccupationalData.usualOccupation.duration.code [ CodeableConcept ]; # 1..1 Usual Occupation duration code
      fhir:OccupationalData.usualOccupation.duration.value [ Period ]; # 1..1 Usual Occupation duration value
    ];
    fhir:OccupationalData.usualOccupation.industry [ # 0..1 Usual Occupation industry
      fhir:OccupationalData.usualOccupation.industry.code [ CodeableConcept ]; # 1..1 Usual Occupation industry code
      fhir:OccupationalData.usualOccupation.industry.value [ CodeableConcept ]; # 1..1 Usual Occupation industry value
    ];
  ];
  fhir:OccupationalData.pastOrPresentOccupation [ # 0..1 Past Or Present Occupation
    fhir:OccupationalData.pastOrPresentOccupation.code [ CodeableConcept ]; # 1..1 Past Or Present Occupation code
    # OccupationalData.pastOrPresentOccupation.effective[x] : 1..1 Past Or Present Occupation effective time. One of these 2
      fhir:OccupationalData.pastOrPresentOccupation.effectiveDateTime [ dateTime ]
      fhir:OccupationalData.pastOrPresentOccupation.effectivePeriod [ Period ]
    fhir:OccupationalData.pastOrPresentOccupation.value [ CodeableConcept ]; # 1..1 Past Or Present Occupation value
  ];
]

Changes since DSTU2

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
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..1IdentifierUnique identifier for the occupational data record
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... subject Σ0..1Reference(Patient)Who the occupational data is collected about
... date Σ1..1dateTimeOccupational Data author time
... author Σ1..*Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Occupational Data author
... employmentStatus 0..1BackboneElementEmployment status
.... code 1..1code74165-2
HistoryOfEmploymentStatus (Required)
.... effective[x] 1..1Employment status effective time
..... effectiveDateTimedateTime
..... effectivePeriodPeriod
.... value 1..1CodeableConceptEmployment status value
... retirementStatus 0..1BackboneElementRetirement status
.... code 1..1code87510-4
RetirementStatus (Required)
.... effective[x] 1..1Retirement status effective time
..... effectiveDateTimedateTime
..... effectivePeriodPeriod
.... value 1..1CodeableConceptRetirement status value
... combatZoneHazardousDuty 0..*BackboneElementCombat Zone Hazardous Duty
.... code 1..*code87511-2
HazardousDutyWork (Required)
.... effective[x] 1..1Combat Zone Hazardous Duty effective time
..... effectiveDateTimedateTime
..... effectivePeriodPeriod
.... value 1..1CodeableConceptCombat Zone Hazardous Duty value
... usualOccupation 0..1BackboneElementUsual Occupation
.... code 1..1code21843-8
UsualOccupation (Required)
.... effective[x] 1..1Usual Occupation effective time
..... effectiveDateTimedateTime
..... effectivePeriodPeriod
.... value 1..1CodeableConceptUsual Occupation value
Occupation CDC Census 2010 (Example)
.... duration 0..1BackboneElementUsual Occupation duration
..... code 1..1CodeableConceptUsual Occupation duration code
..... value 1..1PeriodUsual Occupation duration value
.... industry 0..1BackboneElementUsual Occupation industry
..... code 1..1CodeableConceptUsual Occupation industry code
..... value 1..1CodeableConceptUsual Occupation industry value
... pastOrPresentOccupation 0..1BackboneElementPast Or Present Occupation
.... code 1..1CodeableConceptPast Or Present Occupation code
.... effective[x] 1..1Past Or Present Occupation effective time
..... effectiveDateTimedateTime
..... effectivePeriodPeriod
.... value 1..1CodeableConceptPast Or Present Occupation value
Occupation CDC Census 2010 (Example)

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 {{title}}. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! »Who the occupational data is collected aboutsubject : Reference [0..1] « Patient »Occupational Data author timedate : dateTime [1..1]Occupational Data authorauthor : Reference [1..*] « Practitioner|PractitionerRole|Patient| RelatedPerson »EmploymentStatus74165-2code : code [1..1] « 74165-2 History of Employment Status (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (Strength=Required)HistoryOfEmploymentStatus! »Employment status effective timeeffective[x] : Type [1..1] « dateTime|Period »Employment status valuevalue : CodeableConcept [1..1]RetirementStatus87510-4code : code [1..1] « 87510-4 Retirement Status (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (Strength=Required)RetirementStatus! »Retirement status effective timeeffective[x] : Type [1..1] « dateTime|Period »Retirement status valuevalue : CodeableConcept [1..1]CombatZoneHazardousDuty87511-2code : code [1..*] « 87511-2 Hazardous Duty Work (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (Strength=Required)HazardousDutyWork! »Combat Zone Hazardous Duty effective timeeffective[x] : Type [1..1] « dateTime|Period »Combat Zone Hazardous Duty valuevalue : CodeableConcept [1..1]UsualOccupation21843-8code : code [1..1] « 21843-8 Usual Occupation (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (Strength=Required)UsualOccupation! »Usual Occupation effective timeeffective[x] : Type [1..1] « dateTime|Period »Usual Occupation valuevalue : CodeableConcept [1..1] « Occupation CDC Census 2010 (urn:oid:2.16.840.1.114222.4.11.7186) (Strength=Example)Occupation CDC Census 2010?? »DurationUsual Occupation duration codecode : CodeableConcept [1..1]Usual Occupation duration valuevalue : Period [1..1]IndustryUsual Occupation industry codecode : CodeableConcept [1..1]Usual Occupation industry valuevalue : CodeableConcept [1..1]PastOrPresentOccupationPast Or Present Occupation codecode : CodeableConcept [1..1]Past Or Present Occupation effective timeeffective[x] : Type [1..1] « dateTime|Period »Past Or Present Occupation valuevalue : CodeableConcept [1..1] « Occupation CDC Census 2010 (urn:oid:2.16.840.1.114222.4.11.7186) (Strength=Example)Occupation CDC Census 2010?? »Employment statusemploymentStatus[0..1]Retirement statusretirementStatus[0..1]Combat Zone Hazardous DutycombatZoneHazardousDuty[0..*]Usual Occupation durationduration[0..1]Usual Occupation industryindustry[0..1]Usual OccupationusualOccupation[0..1]Past Or Present OccupationpastOrPresentOccupation[0..1]

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 record --></identifier>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <subject><!-- 0..1 Reference(Patient) Who the occupational data is collected about --></subject>
 <date value="[dateTime]"/><!-- 1..1 Occupational Data author time -->
 <author><!-- 1..* Reference(Practitioner|PractitionerRole|Patient|RelatedPerson) Occupational Data author --></author>
 <employmentStatus>  <!-- 0..1 Employment status -->
  <code value="[code]"/><!-- 1..1 74165-2 -->
  <effective[x]><!-- 1..1 dateTime|Period Employment status effective time --></effective[x]>
  <value><!-- 1..1 CodeableConcept Employment status value --></value>
 </employmentStatus>
 <retirementStatus>  <!-- 0..1 Retirement status -->
  <code value="[code]"/><!-- 1..1 87510-4 -->
  <effective[x]><!-- 1..1 dateTime|Period Retirement status effective time --></effective[x]>
  <value><!-- 1..1 CodeableConcept Retirement status value --></value>
 </retirementStatus>
 <combatZoneHazardousDuty>  <!-- 0..* Combat Zone Hazardous Duty -->
  <code value="[code]"/><!-- 1..* 87511-2 -->
  <effective[x]><!-- 1..1 dateTime|Period Combat Zone Hazardous Duty effective time --></effective[x]>
  <value><!-- 1..1 CodeableConcept Combat Zone Hazardous Duty value --></value>
 </combatZoneHazardousDuty>
 <usualOccupation>  <!-- 0..1 Usual Occupation -->
  <code value="[code]"/><!-- 1..1 21843-8 -->
  <effective[x]><!-- 1..1 dateTime|Period Usual Occupation effective time --></effective[x]>
  <value><!-- 1..1 CodeableConcept Usual Occupation value --></value>
  <duration>  <!-- 0..1 Usual Occupation duration -->
   <code><!-- 1..1 CodeableConcept Usual Occupation duration code --></code>
   <value><!-- 1..1 Period Usual Occupation duration value --></value>
  </duration>
  <industry>  <!-- 0..1 Usual Occupation industry -->
   <code><!-- 1..1 CodeableConcept Usual Occupation industry code --></code>
   <value><!-- 1..1 CodeableConcept Usual Occupation industry value --></value>
  </industry>
 </usualOccupation>
 <pastOrPresentOccupation>  <!-- 0..1 Past Or Present Occupation -->
  <code><!-- 1..1 CodeableConcept Past Or Present Occupation code --></code>
  <effective[x]><!-- 1..1 dateTime|Period Past Or Present Occupation effective time --></effective[x]>
  <value><!-- 1..1 CodeableConcept Past Or Present Occupation value --></value>
 </pastOrPresentOccupation>
</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 record
  "status" : "<code>", // R!  draft | active | retired | unknown
  "subject" : { Reference(Patient) }, // Who the occupational data is collected about
  "date" : "<dateTime>", // R!  Occupational Data author time
  "author" : [{ Reference(Practitioner|PractitionerRole|Patient|RelatedPerson) }], // R!  Occupational Data author
  "employmentStatus" : { // Employment status
    "code" : "<code>", // R!  74165-2
    // effective[x]: Employment status effective time. One of these 2:
    "effectiveDateTime" : "<dateTime>",
    "effectivePeriod" : { Period },
    "value" : { CodeableConcept } // R!  Employment status value
  },
  "retirementStatus" : { // Retirement status
    "code" : "<code>", // R!  87510-4
    // effective[x]: Retirement status effective time. One of these 2:
    "effectiveDateTime" : "<dateTime>",
    "effectivePeriod" : { Period },
    "value" : { CodeableConcept } // R!  Retirement status value
  },
  "combatZoneHazardousDuty" : [{ // Combat Zone Hazardous Duty
    "code" : ["<code>"], // R!  87511-2
    // effective[x]: Combat Zone Hazardous Duty effective time. One of these 2:
    "effectiveDateTime" : "<dateTime>",
    "effectivePeriod" : { Period },
    "value" : { CodeableConcept } // R!  Combat Zone Hazardous Duty value
  }],
  "usualOccupation" : { // Usual Occupation
    "code" : "<code>", // R!  21843-8
    // effective[x]: Usual Occupation effective time. One of these 2:
    "effectiveDateTime" : "<dateTime>",
    "effectivePeriod" : { Period },
    "value" : { CodeableConcept }, // R!  Usual Occupation value
    "duration" : { // Usual Occupation duration
      "code" : { CodeableConcept }, // R!  Usual Occupation duration code
      "value" : { Period } // R!  Usual Occupation duration value
    },
    "industry" : { // Usual Occupation industry
      "code" : { CodeableConcept }, // R!  Usual Occupation industry code
      "value" : { CodeableConcept } // R!  Usual Occupation industry value
    }
  },
  "pastOrPresentOccupation" : { // Past Or Present Occupation
    "code" : { CodeableConcept }, // R!  Past Or Present Occupation code
    // effective[x]: Past Or Present Occupation effective time. One of these 2:
    "effectiveDateTime" : "<dateTime>",
    "effectivePeriod" : { Period },
    "value" : { CodeableConcept } // R!  Past Or Present Occupation value
  }
}

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 record
  fhir:OccupationalData.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:OccupationalData.subject [ Reference(Patient) ]; # 0..1 Who the occupational data is collected about
  fhir:OccupationalData.date [ dateTime ]; # 1..1 Occupational Data author time
  fhir:OccupationalData.author [ Reference(Practitioner|PractitionerRole|Patient|RelatedPerson) ], ... ; # 1..* Occupational Data author
  fhir:OccupationalData.employmentStatus [ # 0..1 Employment status
    fhir:OccupationalData.employmentStatus.code [ code ]; # 1..1 74165-2
    # OccupationalData.employmentStatus.effective[x] : 1..1 Employment status effective time. One of these 2
      fhir:OccupationalData.employmentStatus.effectiveDateTime [ dateTime ]
      fhir:OccupationalData.employmentStatus.effectivePeriod [ Period ]
    fhir:OccupationalData.employmentStatus.value [ CodeableConcept ]; # 1..1 Employment status value
  ];
  fhir:OccupationalData.retirementStatus [ # 0..1 Retirement status
    fhir:OccupationalData.retirementStatus.code [ code ]; # 1..1 87510-4
    # OccupationalData.retirementStatus.effective[x] : 1..1 Retirement status effective time. One of these 2
      fhir:OccupationalData.retirementStatus.effectiveDateTime [ dateTime ]
      fhir:OccupationalData.retirementStatus.effectivePeriod [ Period ]
    fhir:OccupationalData.retirementStatus.value [ CodeableConcept ]; # 1..1 Retirement status value
  ];
  fhir:OccupationalData.combatZoneHazardousDuty [ # 0..* Combat Zone Hazardous Duty
    fhir:OccupationalData.combatZoneHazardousDuty.code [ code ], ... ; # 1..* 87511-2
    # OccupationalData.combatZoneHazardousDuty.effective[x] : 1..1 Combat Zone Hazardous Duty effective time. One of these 2
      fhir:OccupationalData.combatZoneHazardousDuty.effectiveDateTime [ dateTime ]
      fhir:OccupationalData.combatZoneHazardousDuty.effectivePeriod [ Period ]
    fhir:OccupationalData.combatZoneHazardousDuty.value [ CodeableConcept ]; # 1..1 Combat Zone Hazardous Duty value
  ], ...;
  fhir:OccupationalData.usualOccupation [ # 0..1 Usual Occupation
    fhir:OccupationalData.usualOccupation.code [ code ]; # 1..1 21843-8
    # OccupationalData.usualOccupation.effective[x] : 1..1 Usual Occupation effective time. One of these 2
      fhir:OccupationalData.usualOccupation.effectiveDateTime [ dateTime ]
      fhir:OccupationalData.usualOccupation.effectivePeriod [ Period ]
    fhir:OccupationalData.usualOccupation.value [ CodeableConcept ]; # 1..1 Usual Occupation value
    fhir:OccupationalData.usualOccupation.duration [ # 0..1 Usual Occupation duration
      fhir:OccupationalData.usualOccupation.duration.code [ CodeableConcept ]; # 1..1 Usual Occupation duration code
      fhir:OccupationalData.usualOccupation.duration.value [ Period ]; # 1..1 Usual Occupation duration value
    ];
    fhir:OccupationalData.usualOccupation.industry [ # 0..1 Usual Occupation industry
      fhir:OccupationalData.usualOccupation.industry.code [ CodeableConcept ]; # 1..1 Usual Occupation industry code
      fhir:OccupationalData.usualOccupation.industry.value [ CodeableConcept ]; # 1..1 Usual Occupation industry value
    ];
  ];
  fhir:OccupationalData.pastOrPresentOccupation [ # 0..1 Past Or Present Occupation
    fhir:OccupationalData.pastOrPresentOccupation.code [ CodeableConcept ]; # 1..1 Past Or Present Occupation code
    # OccupationalData.pastOrPresentOccupation.effective[x] : 1..1 Past Or Present Occupation effective time. One of these 2
      fhir:OccupationalData.pastOrPresentOccupation.effectiveDateTime [ dateTime ]
      fhir:OccupationalData.pastOrPresentOccupation.effectivePeriod [ Period ]
    fhir:OccupationalData.pastOrPresentOccupation.value [ CodeableConcept ]; # 1..1 Past Or Present Occupation value
  ];
]

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

PathDefinitionTypeReference
OccupationalData.status The lifecycle status of a Value Set or Concept Map.RequiredPublicationStatus
OccupationalData.employmentStatus.code 74165-2 History of Employment Status (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1)RequiredHistoryOfEmploymentStatus
OccupationalData.employmentStatus.value Employment Status urn:oid:2.16.840.1.114222.4.11.7129 DYNAMICUnknownNo details provided yet
OccupationalData.retirementStatus.code 87510-4 Retirement Status (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1)RequiredRetirementStatus
OccupationalData.retirementStatus.value Yes No Unknown (YNU) (urn:oid:2.16.840.1.114222.4.11.888)UnknownNo details provided yet
OccupationalData.combatZoneHazardousDuty.code 87511-2 Hazardous Duty Work (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1)RequiredHazardousDutyWork
OccupationalData.combatZoneHazardousDuty.value Hazardous Duty Work ValueUnknownNo details provided yet
OccupationalData.usualOccupation.code 21843-8 Usual Occupation (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1)RequiredUsualOccupation
OccupationalData.usualOccupation.value
OccupationalData.pastOrPresentOccupation.value
Occupation CDC Census 2010 (urn:oid:2.16.840.1.114222.4.11.7186)ExampleOccupation CDC Census 2010
OccupationalData.usualOccupation.duration.code 74163-7 Usual Occupation Duration (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1)UnknownNo details provided yet
OccupationalData.usualOccupation.industry.code 21844-6 Usual Industry (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1)UnknownNo details provided yet
OccupationalData.usualOccupation.industry.value Industry CDC Census 2010 (urn:oid:2.16.840.1.114222.4.11.7187)UnknownNo details provided yet
OccupationalData.pastOrPresentOccupation.code 11341-5 History of Occupation (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1)UnknownNo details provided yet

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

NameTypeDescriptionExpressionIn Common
subjectreferenceWho the occupational data is collected aboutOccupationalData.subject
(Patient)