HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1 (Standard for Trial Use)
This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/odh/StructureDefinition/odh-RetirementDate
A self-reported date that a person considers themselves to have ‘retired’. A person can be both retired and employed (an Employment Status); most often, a person would be retired from one job and employed in another job. A person also can have more than one retirement date; for example, a person could retire from military service, then later retire from a civilian job. Multiple retirement dates should be recorded using multiple FHIR resources. Outside of ODH, a characterization of the employment arrangement between an employer and a person (one job) has sometimes been referred to as a person's 'employment status' and might include values such as 'retired.' However, in ODH Employment Status is used to characterize a person's relationship to working (e.g., employed, unemployed) and Retirement Date is used to characterize whether or not a person self-identifies as retired. For example, a person could be 'employed' (Employment Status) and have retired from a previous job (recorded at the Person level as a Retirement Date).
This profile builds on Observation.
This profile was published on Fri Aug 17 00:00:00 AEST 2018 as a draft by HL7.
View the corresponding RetirementDateModel logical model.
Summary
Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
ODH Mapping Source
This structure represents the following ODH mapping definition:
odh.RetirementDate maps to Observation: PersonOfRecord maps to subject TopicCode maps to code Category maps to category EvaluationComponent maps to component (slice on = coding.code; slice strategy = includes) EvaluationComponent._Concept maps to component.code EvaluationComponent.Quantity maps to component.value[x] EvaluationComponent.CodeableConcept maps to component.value[x] EvaluationComponent.string maps to component.value[x] EvaluationComponent.Range maps to component.value[x] EvaluationComponent.Ratio maps to component.value[x] EvaluationComponent.Media maps to component.value[x] EvaluationComponent.time maps to component.value[x] EvaluationComponent.dateTime maps to component.value[x] EvaluationComponent.TimePeriod maps to component.value[x] EvaluationComponent.IntegerQuantity maps to component.value[x] EvaluationComponent.ExceptionValue maps to component.dataAbsentReason EvaluationComponent.Interpretation maps to component.interpretation EvaluationComponent.ReferenceRange maps to component.referenceRange ResultValue maps to value[x] RelevantTime maps to effective[x] constrain bodySite to 0..0 constrain specimen to 0..0 constrain device to 0..0
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | ODH RetirementDate Profile | |||
 category | 1..* | |||
  coding | Slice: Unordered, Open by value:code | |||
  coding | Σ | 1..1 | Coding | |
  system | Fixed Value: http://hl7.org/fhir/observation-category | |||
 code | Fixed Value: social-history | |||
| code | ||||
| coding | Slice: Unordered, Open by value:code | |||
| coding | Σ | 1..1 | Coding | Date of Retirement |
| system | Fixed Value: http://loinc.org | |||
| code | Fixed Value: 87510-4 | |||
 subject | 1..1 | Reference(US Core Patient Profile) | ||
| effective[x] | 0..0 | |||
 valueDateTime | dateTime | |||
| bodySite | 0..0 | |||
| specimen | 0..0 | |||
| device | 0..0 | |||
| component | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | ODH RetirementDate Profile obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifier for observation |
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) | Fulfills plan, proposal or order |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
| category | 1..* | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (preferred) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
| coding | Σ | 1..1 | Coding | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/observation-category |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: social-history |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
| coding | Σ | 1..1 | Coding | Date of Retirement |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 87510-4 |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(US Core Patient Profile) | Who and/or what this is about |
| context | 0..1 | Reference(Encounter | EpisodeOfCare) | Healthcare event during which this observation is made | |
| issued | Σ | 0..1 | instant | Date/Time this was made available |
| performer | Σ | 0..* | Reference(Practitioner | Organization | Patient | RelatedPerson) | Who is responsible for the observation |
| valueDateTime | ΣI | 0..1 | dateTime | Actual result |
| dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: Observation Value Absent Reason (extensible) |
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
| comment | 0..1 | string | Comments about result | |
| method | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) | |
| referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | I | 0..1 | SimpleQuantity | High Range, if relevant |
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
| age | 0..1 | Range | Applicable age range, if relevant | |
| text | 0..1 | string | Text based reference range in an observation | |
| related | ΣI | 0..* | BackboneElement | Resource related to this observation |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| type | 0..1 | code | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by Binding: ObservationRelationshipType (required) | |
| target | 1..1 | Reference(Observation | QuestionnaireResponse | Sequence) | Resource that is related to this one | |
| Documentation for this format | ||||
Summary
Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
ODH Mapping Source
This structure represents the following ODH mapping definition:
odh.RetirementDate maps to Observation: PersonOfRecord maps to subject TopicCode maps to code Category maps to category EvaluationComponent maps to component (slice on = coding.code; slice strategy = includes) EvaluationComponent._Concept maps to component.code EvaluationComponent.Quantity maps to component.value[x] EvaluationComponent.CodeableConcept maps to component.value[x] EvaluationComponent.string maps to component.value[x] EvaluationComponent.Range maps to component.value[x] EvaluationComponent.Ratio maps to component.value[x] EvaluationComponent.Media maps to component.value[x] EvaluationComponent.time maps to component.value[x] EvaluationComponent.dateTime maps to component.value[x] EvaluationComponent.TimePeriod maps to component.value[x] EvaluationComponent.IntegerQuantity maps to component.value[x] EvaluationComponent.ExceptionValue maps to component.dataAbsentReason EvaluationComponent.Interpretation maps to component.interpretation EvaluationComponent.ReferenceRange maps to component.referenceRange ResultValue maps to value[x] RelevantTime maps to effective[x] constrain bodySite to 0..0 constrain specimen to 0..0 constrain device to 0..0
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | ODH RetirementDate Profile | |||
| category | 1..* | |||
| coding | Slice: Unordered, Open by value:code | |||
| coding | Σ | 1..1 | Coding | |
| system | Fixed Value: http://hl7.org/fhir/observation-category | |||
| code | Fixed Value: social-history | |||
| code | ||||
| coding | Slice: Unordered, Open by value:code | |||
| coding | Σ | 1..1 | Coding | Date of Retirement |
| system | Fixed Value: http://loinc.org | |||
| code | Fixed Value: 87510-4 | |||
| subject | 1..1 | Reference(US Core Patient Profile) | ||
| effective[x] | 0..0 | |||
| valueDateTime | dateTime | |||
| bodySite | 0..0 | |||
| specimen | 0..0 | |||
| device | 0..0 | |||
| component | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | ODH RetirementDate Profile obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifier for observation |
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) | Fulfills plan, proposal or order |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
| category | 1..* | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (preferred) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
| coding | Σ | 1..1 | Coding | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/observation-category |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: social-history |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
| coding | Σ | 1..1 | Coding | Date of Retirement |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 87510-4 |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(US Core Patient Profile) | Who and/or what this is about |
| context | 0..1 | Reference(Encounter | EpisodeOfCare) | Healthcare event during which this observation is made | |
| issued | Σ | 0..1 | instant | Date/Time this was made available |
| performer | Σ | 0..* | Reference(Practitioner | Organization | Patient | RelatedPerson) | Who is responsible for the observation |
| valueDateTime | ΣI | 0..1 | dateTime | Actual result |
| dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: Observation Value Absent Reason (extensible) |
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
| comment | 0..1 | string | Comments about result | |
| method | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) | |
| referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | I | 0..1 | SimpleQuantity | High Range, if relevant |
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
| age | 0..1 | Range | Applicable age range, if relevant | |
| text | 0..1 | string | Text based reference range in an observation | |
| related | ΣI | 0..* | BackboneElement | Resource related to this observation |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| type | 0..1 | code | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by Binding: ObservationRelationshipType (required) | |
| target | 1..1 | Reference(Observation | QuestionnaireResponse | Sequence) | Resource that is related to this one | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
| Path | Name | Conformance | ValueSet |
| Observation.language | Common Languages | extensible | Common Languages |
| Observation.status | ObservationStatus | required | ObservationStatus |
| Observation.category | Observation Category Codes | preferred | Observation Category Codes |
| Observation.code | LOINC Codes | example | LOINC Codes |
| Observation.dataAbsentReason | Observation Value Absent Reason | extensible | Observation Value Absent Reason |
| Observation.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |
| Observation.method | Observation Methods | example | Observation Methods |
| Observation.referenceRange.type | Observation Reference Range Meaning Codes | extensible | Observation Reference Range Meaning Codes |
| Observation.referenceRange.appliesTo | Observation Reference Range Applies To Codes | example | Observation Reference Range Applies To Codes |
| Observation.related.type | ObservationRelationshipType | required | ObservationRelationshipType |
| Observation.component.code | LOINC Codes | example | LOINC Codes |
| Observation.component.dataAbsentReason | DataAbsentReason | extensible | DataAbsentReason |
| Observation.component.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |
| Observation.component.referenceRange.type | Observation Reference Range Meaning Codes | extensible | Observation Reference Range Meaning Codes |
| Observation.component.referenceRange.appliesTo | Observation Reference Range Applies To Codes | example | Observation Reference Range Applies To Codes |
| Id | Path | Details | Requirements |
| dom-2 | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Observation | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| obs-7 | Observation | If code is the same as a component code then the value element associated with the code SHALL NOT be present : value.empty() or code!=component.code | |
| obs-6 | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| ele-1 | Observation.referenceRange | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| obs-3 | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
| ele-1 | Observation.related | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
ODH Version: 0.1.0 ®© FHIR Version: 3.0.1 generated on Tue, Aug 21, 2018 16:12+1000.
| History
