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

RetirementDateModel

Definitions for odh-RetirementDate-model.

odh-RetirementDate-model
Definition

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).

Control0..*
odh-RetirementDate-model.personOfRecord
Definition

The person this entry belongs to.

Control1..1
TypeReference(PersonModel)
odh-RetirementDate-model.recorded
Definition

The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.

Control0..0
Typehttp://hl7.org/fhir/us/odh/StructureDefinition/cimi-core-Attribution-model
odh-RetirementDate-model.signed
Definition

Provenance information specific to the signing of the clinical statement.

Control0..0
Typehttp://hl7.org/fhir/us/odh/StructureDefinition/cimi-core-Attribution-model
odh-RetirementDate-model.additionalText
Definition

A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information.

Control0..0
Typestring
odh-RetirementDate-model.contextCode
Definition

Code representing the sense in which the statement is interpreted, for example, the degree of presence in a PresenceStatement.

Control0..0
TypeCoding
odh-RetirementDate-model.contextCode.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
odh-RetirementDate-model.contextCode.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

odh-RetirementDate-model.contextCode.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://snomed.info/sct
odh-RetirementDate-model.contextCode.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

odh-RetirementDate-model.contextCode.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

Fixed Value424975005
odh-RetirementDate-model.contextCode.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

odh-RetirementDate-model.contextCode.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

odh-RetirementDate-model.statementTopic
Definition

Compositional and reusable grouping of clinical statement attributes that make up the clinical focus of a statement.

StatementTopic class attributes are aligned with SNOMED CT Concept Model attributes when such an overlap exists. Note that this class does not include contextual attributes such as the nature of the action (ordered, proposed, planned, etc...), the nature of the patient state being described (e.g., present, suspected present, absent), and the attribution of this information (the who, when, where, how, why of the information recorded).

Control0..0
Typehttp://hl7.org/fhir/us/odh/StructureDefinition/cimi-topic-StatementTopic-model
odh-RetirementDate-model.encounter
Definition

A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

Control0..0
Typehttp://hl7.org/fhir/us/odh/StructureDefinition/cimi-encounter-Encounter-model
odh-RetirementDate-model.interpretation
Definition

A clinical interpretation of a finding (applies to both assertions and observation).

Control0..0
BindingThe codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable
TypeCoding
odh-RetirementDate-model.relevantTime
Definition

The time or time period that the finding addresses. The clinically relevant time is not necessarily when the information is gathered or when a test is carried out, but for example, when a specimen was collected, or the time period referred to by the question. Use a TimePeriod for a measurement or specimen collection continued over a significant period of time (e.g. 24 hour Urine Sodium).

Control0..0
TypeChoice of: dateTime, http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-TimePeriod-model
odh-RetirementDate-model.findingMethod
Definition

The technique used to create the finding, for example, the specific imaging technical, lab test code, or assessment vehicle.

Control0..0
BindingThe codes SHOULD be taken from FindingMethodVS
TypeCoding
odh-RetirementDate-model.media
Definition

A file that contains audio, video, image, or similar content.

Control0..0
Typehttp://hl7.org/fhir/us/odh/StructureDefinition/cimi-datatypes-Media-model
odh-RetirementDate-model.topicCode
Definition

The concept representing the finding or action that is the topic of the statement.

For action topics, the TopicCode represents the action being described. For findings, the TopicCode represents the 'question' or property being investigated. For evaluation result findings, the TopicCode contains a concept for an observable entity, such as systolic blood pressure. For assertion findings, the TopicCode contains a code representing the condition, allergy, or other item being asserted. In all cases, the TopicCode describes the topic of the action or the finding.

Control1..1
TypeCoding
odh-RetirementDate-model.topicCode.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
odh-RetirementDate-model.topicCode.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

odh-RetirementDate-model.topicCode.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://loinc.org
odh-RetirementDate-model.topicCode.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

odh-RetirementDate-model.topicCode.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

Fixed Value87510-4
odh-RetirementDate-model.topicCode.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

odh-RetirementDate-model.topicCode.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

odh-RetirementDate-model.resultValue
Definition

The finding itself, such as the blood pressure value recorded.

Control0..1
TypedateTime
odh-RetirementDate-model.exceptionValue
Definition

Reason that a value associated with a test or other finding is missing.

Control0..0
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable
TypeCoding
odh-RetirementDate-model.deltaFlag
Definition

Indicator of significant change (delta) from the last or previous measurement.

Control0..0
BindingThe codes SHALL be taken from DeltaFlagVS
TypeCoding
odh-RetirementDate-model.category
Definition

The type, kind, or class of this item.

Control1..*
TypeCoding
odh-RetirementDate-model.category.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
odh-RetirementDate-model.category.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

odh-RetirementDate-model.category.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://hl7.org/fhir/observation-category
odh-RetirementDate-model.category.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

odh-RetirementDate-model.category.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

Fixed Valuesocial-history
odh-RetirementDate-model.category.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

odh-RetirementDate-model.category.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

odh-RetirementDate-model.anatomicalLocation
Definition

A location or structure in the body, including tissues, regions, cavities, and spaces; for example, right elbow, or left ventricle of the heart.

Control0..0
Typehttp://hl7.org/fhir/us/odh/StructureDefinition/cimi-element-AnatomicalLocation-model
odh-RetirementDate-model.device
Definition

A specific durable physical device used in diagnosis or treatment. The value is the coding for a type of device, for example, a CPAP machine. The same device might be used on multiple patients.

Control0..0
Typehttp://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Device-model
odh-RetirementDate-model.specimen
Definition

A specimen is a substance, physical object, or collection of objects, that the laboratory considers a single discrete, uniquely identified unit that is the subject of one or more steps in the laboratory workflow. A specimen may include multiple physical pieces as long as they are considered a single unit within the laboratory workflow. A specimen results from one to many specimen collection procedures, and may be contained in multiple specimen containers. Specimen may have one or more processing activities.

Control0..0
Typehttp://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Specimen-model
odh-RetirementDate-model.precondition
Definition

A description of the conditions or context of an observation, for example, under sedation, fasting or post-exercise. Body position and body site are also qualifiers, but handled separately. A qualifier cannot modify the measurement type; for example, a fasting blood sugar is still a blood sugar.

Control0..0
TypeChoice of: Coding, Reference(ObservationModel)
odh-RetirementDate-model.referenceRange
Definition

The usual or acceptable range for a test result.

Control0..0
Typehttp://hl7.org/fhir/us/odh/StructureDefinition/cimi-statement-ReferenceRange-model
odh-RetirementDate-model.evaluationComponent
Definition

A simplified, non-separable evaluation consisting of a finding code (represented by the Concept), value (or exception value), reference range, and interpretation. The subject of the evaluation component is the same as in the parent evaluation.

Control0..0
Typehttp://hl7.org/fhir/us/odh/StructureDefinition/cimi-statement-EvaluationComponent-model
odh-RetirementDate-model.panelMembers
Definition

PanelMembers represent the elements of a group of a related but independent evaluations. Examples are the measurements that compose a complete blood count (CBC), or the elements of a pathology report. Each member is an independent evaluation, but the grouping reflects a composite lab order, shared specimen, or a single report author. Typically the Category and Reason are not given for individual findings that are part of the panel, but rather given at the level of the panel itself.

Control0..0
Typehttp://hl7.org/fhir/us/odh/StructureDefinition/cimi-statement-PanelMembers-model
odh-RetirementDate-model.focalSubjectModifier
Definition

The focus of the observation, if someone other than the person of record (subject), identified only by the relationship to the PersonOfRecord.

Control0..0
BindingThe codes SHALL be taken from PatientRelationshipType; other codes may be used where these codes are not suitable
TypeCoding