Vital Records Common Library (VRCL) STU2-ballot
2.0.0-ballot - ballot United States of America flag

This page is part of the Vital Records Common Profile Library (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Observation - Usual Work

Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Observation-usual-work-vr Version: 2.0.0-ballot
Draft as of 2023-12-16 Computable Name: ObservationUsualWorkVitalRecords

Used to send text-string industry and occupation information from Jurisdictions to NCHS, and coded versions from NCHS to Jurisdictions.

Implementors are free to use the coded fields with the defined valuesets for inter-jurisdictional exchange, but coded values are not expected for vital records submissions.

Note that the coded industry and occupation fields are bound to PHINVADs-hosted value sets.

For NCHS provided coded values the specific vocabulary used will depend on the death year.

IJE Mapping

Natality
Use Case # Description IJE Name Field Type Value Set/Comments
Natality 282 Occupation of Mother MOM_OC_T value.text,
extension[roleVitalRecords].value='MTH'
string(40)
Natality 284 Occupation of Father DAD_OC_T value.text,
extension[roleVitalRecords].value='FTH'
string(40)
Natality 286 Industry of Mother MOM_IN_T component [odh-UsualIndustry].value.text,
extension[roleVitalRecords].value='MTH'
string(40)
Natality 288 Industry of Father DAD_IN_T component [odh-UsualIndustry].value.text,
extension[roleVitalRecords].value='FTH'
string(40)

Fetal Death
Use Case # Description IJE Name Field Type Value Set/Comments
Fetal Death 269 Occupation of Mother MOM_OC_T value.text,
extension[roleVitalRecords].value='MTH'
string(40)
Fetal Death 271 Occupation of Father DAD_OC_T value.text,
extension[roleVitalRecords].value='FTH'
string(40)
Fetal Death 273 Industry of Mother MOM_IN_T component [odh-UsualIndustry].value.text,
extension[roleVitalRecords].value='MTH'
string(40)
Fetal Death 275 Industry of Father DAD_IN_T component [odh-UsualIndustry].value.text,
extension[roleVitalRecords].value='FTH'
string(40)

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from UsualWork

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*UsualWorkUsual Work
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... roleVitalRecords 0..1CodeableConceptVital Records Role (father,mother if present)
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr
Binding: ValueSet - Role Vital Records (required): Father, Mother

... subject 1..1Reference(Patient - Vital Records)The subject of an observation
... value[x]:valueCodeableConcept 0..1CodeableConceptExpress the usual occupation using a coded value. If no coded value is available, use text. If the usual occupation is not available, explain using dataAbsentReason.
.... coding:occupationCDCCensus2018 0..1CodingOccupation Code
.... text 0..1stringOccupation - Literal
... component:odh-UsualIndustry 1..1BackboneElementUsualIndustry: The industry (type of business) in which the subject has worked for the longest duration while in the usual occupation. Express the usual industry using a coded value. If no coded value is available, use text. If the usual industry is not available, explain using dataAbsentReason.
.... value[x]
..... coding:industryCDCCensus2018 0..1CodingIndustry Code
..... text 0..1stringIndustry - Literal

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*UsualWorkUsual Work
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... roleVitalRecords 0..1CodeableConceptVital Records Role (father,mother if present)
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr
Binding: ValueSet - Role Vital Records (required): Father, Mother


... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 0..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_social-history Σ1..1CodingSocial History
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: social-history
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_21843-8 Σ1..1CodingHistory of Usual Occupation
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 21843-8
... subject Σ1..1Reference(Patient - Vital Records)The subject of an observation
... focus Σ0..*Reference(Related Person - Parent Vital Records)What the observation is about, when it is not about the subject of record
... Slices for effective[x] Σ0..1Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
.... effective[x]:effectivePeriod Σ0..1PeriodThe period.start asserts when the usual occupation began. NOTE: If the period.start element is missing, the start of the usual occupation is not known. The period.end asserts when the usual occupation ended. If usual occupation is current, period.end should be omitted.
... Slices for value[x] ΣC0..1Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
.... value[x]:valueCodeableConcept ΣC0..1CodeableConceptExpress the usual occupation using a coded value. If no coded value is available, use text. If the usual occupation is not available, explain using dataAbsentReason.
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
...... coding:occupationCDCCensus2010 Σ0..1CodingOccupation CDC Census 2010
Binding: Occupation CDC Census 2010 (required): Occupation CDC Census 2010


...... coding:occupationONETSOCDetailODH Σ0..1CodingOccupation ONETSOC Detail (ODH)
Binding: Occupation ONETSOC Detail (ODH) (required): Occupation ONETSOC Detail (ODH)


...... coding:occupationCDCCensus2018 Σ0..1CodingOccupation Code
Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018


..... text Σ0..1stringOccupation - Literal
... Slices for component Σ1..*BackboneElementComponent results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... component:odh-UsualIndustry Σ1..1BackboneElementUsualIndustry: The industry (type of business) in which the subject has worked for the longest duration while in the usual occupation. Express the usual industry using a coded value. If no coded value is available, use text. If the usual industry is not available, explain using dataAbsentReason.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptHistory of Usual industry
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 21844-6
.... component:odh-UsualOccupationDuration Σ0..1BackboneElementUsualOccupationDuration: The total of all periods of time (in years) the subject has spent in their Usual Occupation, not including intermittent period(s) when they were not working in that occupation (type of work).
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptUsual occupation duration
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 74163-7

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes (a valid code from LOINC)
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010requiredPHVS_Occupation_CDC_Census2010
Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODHrequiredPHVS_Occupation_ONETSOC_Detail_ODH
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018requiredPHVS_Occupation_CDC_Census2018
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component:odh-UsualIndustry.codeexamplePattern: LOINC code 21844-6
Observation.component:odh-UsualOccupationDuration.codeexamplePattern: LOINC code 74163-7
Observation.component:odh-UsualOccupationDuration.referenceRange.appliesToextensibleObservationReferenceRangeAppliesToCodes
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*UsualWorkUsual Work
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... roleVitalRecords 0..1CodeableConceptVital Records Role (father,mother if present)
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr
Binding: ValueSet - Role Vital Records (required): Father, Mother


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(ServiceRequest)The plan, proposal or order that is fulfilled in whole or in part by this observation
... partOf Σ0..*Reference(Procedure)The larger procedure that this particular observation is a component or step
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 0..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_social-history Σ1..1CodingSocial History
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: social-history
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_21843-8 Σ1..1CodingHistory of Usual Occupation
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 21843-8
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject Σ1..1Reference(Patient - Vital Records)The subject of an observation
... focus Σ0..*Reference(Related Person - Parent Vital Records)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... Slices for effective[x] Σ0..1Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
.... effective[x]:effectivePeriod Σ0..1PeriodThe period.start asserts when the usual occupation began. NOTE: If the period.start element is missing, the start of the usual occupation is not known. The period.end asserts when the usual occupation ended. If usual occupation is current, period.end should be omitted.
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson)Who is responsible for the observation
... Slices for value[x] ΣC0..1Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
.... value[x]:valueCodeableConcept ΣC0..1CodeableConceptExpress the usual occupation using a coded value. If no coded value is available, use text. If the usual occupation is not available, explain using dataAbsentReason.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
...... coding:occupationCDCCensus2010 Σ0..1CodingOccupation CDC Census 2010
Binding: Occupation CDC Census 2010 (required): Occupation CDC Census 2010


...... coding:occupationONETSOCDetailODH Σ0..1CodingOccupation ONETSOC Detail (ODH)
Binding: Occupation ONETSOC Detail (ODH) (required): Occupation ONETSOC Detail (ODH)


...... coding:occupationCDCCensus2018 Σ0..1CodingOccupation Code
Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018


..... text Σ0..1stringOccupation - Literal
... dataAbsentReason C0..1CodeableConceptThe reason that there is no value available for the Occupation.
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... note 0..*AnnotationComments about the observation
... derivedFrom Σ0..*Reference(DocumentReference | Media | QuestionnaireResponse | Observation)Related measurements the observation is made from
... Slices for component Σ1..*BackboneElementComponent results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ0..1Actual component result
...... valueQuantityQuantity
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result
.... component:odh-UsualIndustry Σ1..1BackboneElementUsualIndustry: The industry (type of business) in which the subject has worked for the longest duration while in the usual occupation. Express the usual industry using a coded value. If no coded value is available, use text. If the usual industry is not available, explain using dataAbsentReason.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptHistory of Usual industry
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 21844-6
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1CodeableConceptExpress the Industry using a coded value. If no coded value is available, use text. If the Industry is not available, explain using dataAbsentReason.
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
....... coding:industryCDCCensus2010 Σ0..1CodingIndustry CDC Census 2010
Binding: Industry CDC Census 2010 (required): Industry CDC Census 2010


....... coding:industryONETSOCDetailODH Σ0..1CodingIndustry NAICS Detail (ODH)
Binding: Industry NAICS Detail (ODH) (required): Industry NAICS Detail (ODH)


....... coding:industryCDCCensus2018 Σ0..1CodingIndustry Code
Binding: Industry CDC Census 2018 (required): Industry CDC Census 2018


...... text Σ0..1stringIndustry - Literal
..... dataAbsentReason C0..1CodeableConceptThe reason that there is no value available for the Industry.
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... component:odh-UsualOccupationDuration Σ0..1BackboneElementUsualOccupationDuration: The total of all periods of time (in years) the subject has spent in their Usual Occupation, not including intermittent period(s) when they were not working in that occupation (type of work).
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptUsual occupation duration
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 74163-7
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1QuantityActual component result
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ0..1decimalNumerical value (with implicit precision)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ0..1stringUnit representation
...... system ΣC0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code Σ0..1codeCoded form of the unit
Fixed Value: a
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes (a valid code from LOINC)
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010requiredPHVS_Occupation_CDC_Census2010
Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODHrequiredPHVS_Occupation_ONETSOC_Detail_ODH
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018requiredPHVS_Occupation_CDC_Census2018
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.referenceRange.typeextensibleObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToextensibleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes
Observation.component:odh-UsualIndustry.codeexamplePattern: LOINC code 21844-6
Observation.component:odh-UsualIndustry.value[x].coding:industryCDCCensus2010requiredPHVS_Industry_CDC_Census2010
Observation.component:odh-UsualIndustry.value[x].coding:industryONETSOCDetailODHrequiredPHVS_Industry_NAICS_Detail _ODH
Observation.component:odh-UsualIndustry.value[x].coding:industryCDCCensus2018requiredPHVS_Industry_CDC_Census2018
Observation.component:odh-UsualIndustry.dataAbsentReasonextensibleDataAbsentReason
Observation.component:odh-UsualIndustry.referenceRange.typeextensibleObservationReferenceRangeMeaningCodes
Observation.component:odh-UsualIndustry.referenceRange.appliesToextensibleObservationReferenceRangeAppliesToCodes
Observation.component:odh-UsualOccupationDuration.codeexamplePattern: LOINC code 74163-7
Observation.component:odh-UsualOccupationDuration.value[x].comparatorrequiredQuantityComparator
Observation.component:odh-UsualOccupationDuration.dataAbsentReasonextensibleDataAbsentReason
Observation.component:odh-UsualOccupationDuration.referenceRange.typeextensibleObservationReferenceRangeMeaningCodes
Observation.component:odh-UsualOccupationDuration.referenceRange.appliesToextensibleObservationReferenceRangeAppliesToCodes

Differential View

This structure is derived from UsualWork

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*UsualWorkUsual Work
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... roleVitalRecords 0..1CodeableConceptVital Records Role (father,mother if present)
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr
Binding: ValueSet - Role Vital Records (required): Father, Mother

... subject 1..1Reference(Patient - Vital Records)The subject of an observation
... value[x]:valueCodeableConcept 0..1CodeableConceptExpress the usual occupation using a coded value. If no coded value is available, use text. If the usual occupation is not available, explain using dataAbsentReason.
.... coding:occupationCDCCensus2018 0..1CodingOccupation Code
.... text 0..1stringOccupation - Literal
... component:odh-UsualIndustry 1..1BackboneElementUsualIndustry: The industry (type of business) in which the subject has worked for the longest duration while in the usual occupation. Express the usual industry using a coded value. If no coded value is available, use text. If the usual industry is not available, explain using dataAbsentReason.
.... value[x]
..... coding:industryCDCCensus2018 0..1CodingIndustry Code
..... text 0..1stringIndustry - Literal

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*UsualWorkUsual Work
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... roleVitalRecords 0..1CodeableConceptVital Records Role (father,mother if present)
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr
Binding: ValueSet - Role Vital Records (required): Father, Mother


... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 0..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_social-history Σ1..1CodingSocial History
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: social-history
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_21843-8 Σ1..1CodingHistory of Usual Occupation
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 21843-8
... subject Σ1..1Reference(Patient - Vital Records)The subject of an observation
... focus Σ0..*Reference(Related Person - Parent Vital Records)What the observation is about, when it is not about the subject of record
... Slices for effective[x] Σ0..1Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
.... effective[x]:effectivePeriod Σ0..1PeriodThe period.start asserts when the usual occupation began. NOTE: If the period.start element is missing, the start of the usual occupation is not known. The period.end asserts when the usual occupation ended. If usual occupation is current, period.end should be omitted.
... Slices for value[x] ΣC0..1Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
.... value[x]:valueCodeableConcept ΣC0..1CodeableConceptExpress the usual occupation using a coded value. If no coded value is available, use text. If the usual occupation is not available, explain using dataAbsentReason.
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
...... coding:occupationCDCCensus2010 Σ0..1CodingOccupation CDC Census 2010
Binding: Occupation CDC Census 2010 (required): Occupation CDC Census 2010


...... coding:occupationONETSOCDetailODH Σ0..1CodingOccupation ONETSOC Detail (ODH)
Binding: Occupation ONETSOC Detail (ODH) (required): Occupation ONETSOC Detail (ODH)


...... coding:occupationCDCCensus2018 Σ0..1CodingOccupation Code
Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018


..... text Σ0..1stringOccupation - Literal
... Slices for component Σ1..*BackboneElementComponent results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... component:odh-UsualIndustry Σ1..1BackboneElementUsualIndustry: The industry (type of business) in which the subject has worked for the longest duration while in the usual occupation. Express the usual industry using a coded value. If no coded value is available, use text. If the usual industry is not available, explain using dataAbsentReason.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptHistory of Usual industry
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 21844-6
.... component:odh-UsualOccupationDuration Σ0..1BackboneElementUsualOccupationDuration: The total of all periods of time (in years) the subject has spent in their Usual Occupation, not including intermittent period(s) when they were not working in that occupation (type of work).
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptUsual occupation duration
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 74163-7

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes (a valid code from LOINC)
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010requiredPHVS_Occupation_CDC_Census2010
Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODHrequiredPHVS_Occupation_ONETSOC_Detail_ODH
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018requiredPHVS_Occupation_CDC_Census2018
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component:odh-UsualIndustry.codeexamplePattern: LOINC code 21844-6
Observation.component:odh-UsualOccupationDuration.codeexamplePattern: LOINC code 74163-7
Observation.component:odh-UsualOccupationDuration.referenceRange.appliesToextensibleObservationReferenceRangeAppliesToCodes

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*UsualWorkUsual Work
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... roleVitalRecords 0..1CodeableConceptVital Records Role (father,mother if present)
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr
Binding: ValueSet - Role Vital Records (required): Father, Mother


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(ServiceRequest)The plan, proposal or order that is fulfilled in whole or in part by this observation
... partOf Σ0..*Reference(Procedure)The larger procedure that this particular observation is a component or step
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 0..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_social-history Σ1..1CodingSocial History
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: social-history
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_21843-8 Σ1..1CodingHistory of Usual Occupation
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 21843-8
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject Σ1..1Reference(Patient - Vital Records)The subject of an observation
... focus Σ0..*Reference(Related Person - Parent Vital Records)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... Slices for effective[x] Σ0..1Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
.... effective[x]:effectivePeriod Σ0..1PeriodThe period.start asserts when the usual occupation began. NOTE: If the period.start element is missing, the start of the usual occupation is not known. The period.end asserts when the usual occupation ended. If usual occupation is current, period.end should be omitted.
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson)Who is responsible for the observation
... Slices for value[x] ΣC0..1Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
.... value[x]:valueCodeableConcept ΣC0..1CodeableConceptExpress the usual occupation using a coded value. If no coded value is available, use text. If the usual occupation is not available, explain using dataAbsentReason.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
...... coding:occupationCDCCensus2010 Σ0..1CodingOccupation CDC Census 2010
Binding: Occupation CDC Census 2010 (required): Occupation CDC Census 2010


...... coding:occupationONETSOCDetailODH Σ0..1CodingOccupation ONETSOC Detail (ODH)
Binding: Occupation ONETSOC Detail (ODH) (required): Occupation ONETSOC Detail (ODH)


...... coding:occupationCDCCensus2018 Σ0..1CodingOccupation Code
Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018


..... text Σ0..1stringOccupation - Literal
... dataAbsentReason C0..1CodeableConceptThe reason that there is no value available for the Occupation.
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... note 0..*AnnotationComments about the observation
... derivedFrom Σ0..*Reference(DocumentReference | Media | QuestionnaireResponse | Observation)Related measurements the observation is made from
... Slices for component Σ1..*BackboneElementComponent results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ0..1Actual component result
...... valueQuantityQuantity
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result
.... component:odh-UsualIndustry Σ1..1BackboneElementUsualIndustry: The industry (type of business) in which the subject has worked for the longest duration while in the usual occupation. Express the usual industry using a coded value. If no coded value is available, use text. If the usual industry is not available, explain using dataAbsentReason.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptHistory of Usual industry
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 21844-6
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1CodeableConceptExpress the Industry using a coded value. If no coded value is available, use text. If the Industry is not available, explain using dataAbsentReason.
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
....... coding:industryCDCCensus2010 Σ0..1CodingIndustry CDC Census 2010
Binding: Industry CDC Census 2010 (required): Industry CDC Census 2010


....... coding:industryONETSOCDetailODH Σ0..1CodingIndustry NAICS Detail (ODH)
Binding: Industry NAICS Detail (ODH) (required): Industry NAICS Detail (ODH)


....... coding:industryCDCCensus2018 Σ0..1CodingIndustry Code
Binding: Industry CDC Census 2018 (required): Industry CDC Census 2018


...... text Σ0..1stringIndustry - Literal
..... dataAbsentReason C0..1CodeableConceptThe reason that there is no value available for the Industry.
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... component:odh-UsualOccupationDuration Σ0..1BackboneElementUsualOccupationDuration: The total of all periods of time (in years) the subject has spent in their Usual Occupation, not including intermittent period(s) when they were not working in that occupation (type of work).
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptUsual occupation duration
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 74163-7
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1QuantityActual component result
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ0..1decimalNumerical value (with implicit precision)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ0..1stringUnit representation
...... system ΣC0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code Σ0..1codeCoded form of the unit
Fixed Value: a
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes (a valid code from LOINC)
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010requiredPHVS_Occupation_CDC_Census2010
Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODHrequiredPHVS_Occupation_ONETSOC_Detail_ODH
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018requiredPHVS_Occupation_CDC_Census2018
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.referenceRange.typeextensibleObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToextensibleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes
Observation.component:odh-UsualIndustry.codeexamplePattern: LOINC code 21844-6
Observation.component:odh-UsualIndustry.value[x].coding:industryCDCCensus2010requiredPHVS_Industry_CDC_Census2010
Observation.component:odh-UsualIndustry.value[x].coding:industryONETSOCDetailODHrequiredPHVS_Industry_NAICS_Detail _ODH
Observation.component:odh-UsualIndustry.value[x].coding:industryCDCCensus2018requiredPHVS_Industry_CDC_Census2018
Observation.component:odh-UsualIndustry.dataAbsentReasonextensibleDataAbsentReason
Observation.component:odh-UsualIndustry.referenceRange.typeextensibleObservationReferenceRangeMeaningCodes
Observation.component:odh-UsualIndustry.referenceRange.appliesToextensibleObservationReferenceRangeAppliesToCodes
Observation.component:odh-UsualOccupationDuration.codeexamplePattern: LOINC code 74163-7
Observation.component:odh-UsualOccupationDuration.value[x].comparatorrequiredQuantityComparator
Observation.component:odh-UsualOccupationDuration.dataAbsentReasonextensibleDataAbsentReason
Observation.component:odh-UsualOccupationDuration.referenceRange.typeextensibleObservationReferenceRangeMeaningCodes
Observation.component:odh-UsualOccupationDuration.referenceRange.appliesToextensibleObservationReferenceRangeAppliesToCodes

 

Other representations of profile: CSV, Excel, Schematron