Vital Records Common Library (VRCL) STU2-ballot
2.0.0 - trial-use
Vital Records Common Library (VRCL) STU2-ballot
2.0.0 - trial-use
Vital Records Common Library (VRCL) STU2-ballot, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/vr-common-library/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Observation-usual-work-vr | Version: 2.0.0 | |||
| Active as of 2024-03-21 | 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.
| 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) |
| 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) |
| Use Case | # | Description | IJE Name | Field | Type | Value Set/Comments |
|---|---|---|---|---|---|---|
| Mortality | 84 | Occupation -- Literal | OCCUP | value.text | string(40) | - |
| Mortality | 86 | Industry -- Literal | INDUST | component [odh-UsualIndustry ].value.text | string(40) | - |
| Mortality | 94 | Occupation -- 4 digit Code | OCCUPC4 | valueCodeableConcept.coding[occupationCDCCensus2018] | codeable | PHVS_Occupation_CDC_Census2018VS |
| Mortality | 95 | Industry -- 4 digit Code | INDUSTC4 | component[odh-UsualIndustry].valueCodeableConcept.coding[industryCDCCensus2018] | codeable | PHVS_Industry_CDC_Census2018VS |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from UsualWork
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | UsualWork | Usual Work | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  roleVitalRecords | 0..1 | CodeableConcept | Vital Records Role (father,mother if present) URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr Binding: Role Vital Records (extensible): Vital Records Role | |
   value[x] | 1..1 | CodeableConcept | Parent (MTH | FTH) | |
 subject | 1..1 | Reference(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 | |
| value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Express 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..1 | Coding | Occupation Code | |
| text | 0..1 | string | Occupation - Literal | |
 component:odh-UsualIndustry | 1..1 | BackboneElement | UsualIndustry: 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..1 | Coding | Industry Code | |
 text | 0..1 | string | Industry - Literal | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | UsualWork | Usual Work obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| roleVitalRecords | 0..1 | CodeableConcept | Vital Records Role (father,mother if present) URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr Binding: Role Vital Records (extensible): Vital Records Role | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr" | |
 value[x] | 1..1 | CodeableConcept | Parent (MTH | FTH) Binding: Role Vital Records (extensible): Vital Records Role | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| category | 0..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
 Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
 coding:Fixed_social-history | Σ | 1..1 | Coding | Social History |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:Fixed_21843-8 | Σ | 1..1 | Coding | History of Usual Occupation |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 21843-8 |
| subject | Σ | 1..1 | Reference(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..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
 effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| effectiveTiming | Timing | |||
| effectiveInstant | instant | |||
 effective[x]:effectivePeriod | Σ | 0..1 | Period | The 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] | ΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |
| valueQuantity | Quantity | |||
| valueCodeableConcept | CodeableConcept | |||
| valueString | string | |||
| valueBoolean | boolean | |||
| valueInteger | integer | |||
| valueRange | Range | |||
| valueRatio | Ratio | |||
| valueSampledData | SampledData | |||
| valueTime | time | |||
| valueDateTime | dateTime | |||
| valuePeriod | Period | |||
| value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Express 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..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
 coding:occupationCDCCensus2010 | Σ | 0..1 | Coding | Occupation CDC Census 2010 Binding: Occupation CDC Census 2010 (required): Occupation CDC Census 2010 |
| coding:occupationONETSOCDetailODH | Σ | 0..1 | Coding | Occupation ONETSOC Detail (ODH) Binding: Occupation ONETSOC Detail (ODH) (required): Occupation ONETSOC Detail (ODH) |
| coding:occupationCDCCensus2018 | Σ | 0..1 | Coding | Occupation Code Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018 |
| text | Σ | 0..1 | string | Occupation - Literal |
| Slices for component | Σ | 1..* | BackboneElement | Component results Slice: Unordered, Open by value:code |
 component:All Slices | Content/Rules for all slices | |||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| component:odh-UsualIndustry | Σ | 1..1 | BackboneElement | UsualIndustry: 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..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | History of Usual industry Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 21844-6 | |
| component:odh-UsualOccupationDuration | Σ | 0..1 | BackboneElement | UsualOccupationDuration: 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..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Usual occupation duration Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 74163-7 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.extension:roleVitalRecords.value[x] | extensible | ValueSetRoleVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vrfrom this IG | |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010 | required | PHVS_Occupation_CDC_Census2010http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7186 | |
| Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODH | required | PHVS_Occupation_ONETSOC_Detail_ODHhttp://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7901 | |
| Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018 | required | PHVS_Occupation_CDC_Census2018http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.8065 | |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:odh-UsualIndustry.code | example | Pattern: LOINC code 21844-6http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:odh-UsualOccupationDuration.code | example | Pattern: LOINC code 74163-7http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:odh-UsualOccupationDuration.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | UsualWork | Usual Work obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| roleVitalRecords | 0..1 | CodeableConcept | Vital Records Role (father,mother if present) URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr Binding: Role Vital Records (extensible): Vital Records Role | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr" | |||||
| value[x] | 1..1 | CodeableConcept | Parent (MTH | FTH) Binding: Role Vital Records (extensible): Vital Records Role | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business 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..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category | 0..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | ||||
| coding:Fixed_social-history | Σ | 1..1 | Coding | Social History | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..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: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | ||||
| coding:Fixed_21843-8 | Σ | 1..1 | Coding | History of Usual Occupation | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 21843-8 | ||||
| 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(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..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| Slices for effective[x] | Σ | 0..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| effectiveTiming | Timing | |||||||
| effectiveInstant | instant | |||||||
| effective[x]:effectivePeriod | Σ | 0..1 | Period | The 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..1 | instant | Date/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] | ΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Express 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
| coding:occupationCDCCensus2010 | Σ | 0..1 | Coding | Occupation CDC Census 2010 Binding: Occupation CDC Census 2010 (required): Occupation CDC Census 2010 | ||||
| coding:occupationONETSOCDetailODH | Σ | 0..1 | Coding | Occupation ONETSOC Detail (ODH) Binding: Occupation ONETSOC Detail (ODH) (required): Occupation ONETSOC Detail (ODH) | ||||
| coding:occupationCDCCensus2018 | Σ | 0..1 | Coding | Occupation Code Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018 | ||||
| text | Σ | 0..1 | string | Occupation - Literal | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | The 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..* | Annotation | Comments about the observation | |||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | Media | QuestionnaireResponse | Observation) | Related measurements the observation is made from | ||||
| Slices for component | Σ | 1..* | BackboneElement | Component results Slice: Unordered, Open by value:code | ||||
| component:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
 value[x] | Σ | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, 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..1 | BackboneElement | UsualIndustry: 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | History of Usual industry Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 21844-6 | |||||
| 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 | |||||
| value[x] | Σ | 0..1 | CodeableConcept | Express 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
| coding:industryCDCCensus2010 | Σ | 0..1 | Coding | Industry CDC Census 2010 Binding: Industry CDC Census 2010 (required): Industry CDC Census 2010 | ||||
| coding:industryONETSOCDetailODH | Σ | 0..1 | Coding | Industry NAICS Detail (ODH) Binding: Industry NAICS Detail (ODH) (required): Industry NAICS Detail (ODH) | ||||
| coding:industryCDCCensus2018 | Σ | 0..1 | Coding | Industry Code Binding: Industry CDC Census 2018 (required): Industry CDC Census 2018 | ||||
| text | Σ | 0..1 | string | Industry - Literal | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | The 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..1 | BackboneElement | UsualOccupationDuration: 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Usual occupation duration Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 74163-7 | |||||
| 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 | |||||
| value[x] | Σ | 0..1 | Quantity | Actual component result | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit | Σ | 0..1 | string | Unit representation | ||||
| system | ΣC | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
| code | Σ | 0..1 | code | Coded form of the unit Fixed Value: a | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Observation.extension:roleVitalRecords.value[x] | extensible | ValueSetRoleVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vrfrom this IG | ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010 | required | PHVS_Occupation_CDC_Census2010http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7186 | ||||
| Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODH | required | PHVS_Occupation_ONETSOC_Detail_ODHhttp://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7901 | ||||
| Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018 | required | PHVS_Occupation_CDC_Census2018http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.8065 | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:odh-UsualIndustry.code | example | Pattern: LOINC code 21844-6http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component:odh-UsualIndustry.value[x].coding:industryCDCCensus2010 | required | PHVS_Industry_CDC_Census2010http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7187 | ||||
| Observation.component:odh-UsualIndustry.value[x].coding:industryONETSOCDetailODH | required | PHVS_Industry_NAICS_Detail _ODHhttp://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7900 | ||||
| Observation.component:odh-UsualIndustry.value[x].coding:industryCDCCensus2018 | required | PHVS_Industry_CDC_Census2018http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.8066 | ||||
| Observation.component:odh-UsualIndustry.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:odh-UsualIndustry.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.component:odh-UsualIndustry.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component:odh-UsualOccupationDuration.code | example | Pattern: LOINC code 74163-7http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component:odh-UsualOccupationDuration.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| Observation.component:odh-UsualOccupationDuration.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:odh-UsualOccupationDuration.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.component:odh-UsualOccupationDuration.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard |
This structure is derived from UsualWork
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from UsualWork
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | UsualWork | Usual Work | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| roleVitalRecords | 0..1 | CodeableConcept | Vital Records Role (father,mother if present) URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr Binding: Role Vital Records (extensible): Vital Records Role | |
| value[x] | 1..1 | CodeableConcept | Parent (MTH | FTH) | |
| subject | 1..1 | Reference(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 | |
| value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Express 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..1 | Coding | Occupation Code | |
| text | 0..1 | string | Occupation - Literal | |
| component:odh-UsualIndustry | 1..1 | BackboneElement | UsualIndustry: 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..1 | Coding | Industry Code | |
| text | 0..1 | string | Industry - Literal | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | UsualWork | Usual Work obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| roleVitalRecords | 0..1 | CodeableConcept | Vital Records Role (father,mother if present) URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr Binding: Role Vital Records (extensible): Vital Records Role | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr" | |
| value[x] | 1..1 | CodeableConcept | Parent (MTH | FTH) Binding: Role Vital Records (extensible): Vital Records Role | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| category | 0..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:Fixed_social-history | Σ | 1..1 | Coding | Social History |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:Fixed_21843-8 | Σ | 1..1 | Coding | History of Usual Occupation |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 21843-8 |
| subject | Σ | 1..1 | Reference(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..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| effectiveTiming | Timing | |||
| effectiveInstant | instant | |||
| effective[x]:effectivePeriod | Σ | 0..1 | Period | The 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] | ΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |
| valueQuantity | Quantity | |||
| valueCodeableConcept | CodeableConcept | |||
| valueString | string | |||
| valueBoolean | boolean | |||
| valueInteger | integer | |||
| valueRange | Range | |||
| valueRatio | Ratio | |||
| valueSampledData | SampledData | |||
| valueTime | time | |||
| valueDateTime | dateTime | |||
| valuePeriod | Period | |||
| value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Express 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..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
| coding:occupationCDCCensus2010 | Σ | 0..1 | Coding | Occupation CDC Census 2010 Binding: Occupation CDC Census 2010 (required): Occupation CDC Census 2010 |
| coding:occupationONETSOCDetailODH | Σ | 0..1 | Coding | Occupation ONETSOC Detail (ODH) Binding: Occupation ONETSOC Detail (ODH) (required): Occupation ONETSOC Detail (ODH) |
| coding:occupationCDCCensus2018 | Σ | 0..1 | Coding | Occupation Code Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018 |
| text | Σ | 0..1 | string | Occupation - Literal |
| Slices for component | Σ | 1..* | BackboneElement | Component results Slice: Unordered, Open by value:code |
| component:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| component:odh-UsualIndustry | Σ | 1..1 | BackboneElement | UsualIndustry: 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..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | History of Usual industry Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 21844-6 | |
| component:odh-UsualOccupationDuration | Σ | 0..1 | BackboneElement | UsualOccupationDuration: 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..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Usual occupation duration Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 74163-7 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.extension:roleVitalRecords.value[x] | extensible | ValueSetRoleVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vrfrom this IG | |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010 | required | PHVS_Occupation_CDC_Census2010http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7186 | |
| Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODH | required | PHVS_Occupation_ONETSOC_Detail_ODHhttp://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7901 | |
| Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018 | required | PHVS_Occupation_CDC_Census2018http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.8065 | |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:odh-UsualIndustry.code | example | Pattern: LOINC code 21844-6http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:odh-UsualOccupationDuration.code | example | Pattern: LOINC code 74163-7http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:odh-UsualOccupationDuration.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | UsualWork | Usual Work obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| roleVitalRecords | 0..1 | CodeableConcept | Vital Records Role (father,mother if present) URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr Binding: Role Vital Records (extensible): Vital Records Role | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-role-vr" | |||||
| value[x] | 1..1 | CodeableConcept | Parent (MTH | FTH) Binding: Role Vital Records (extensible): Vital Records Role | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business 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..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category | 0..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | ||||
| coding:Fixed_social-history | Σ | 1..1 | Coding | Social History | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..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: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | ||||
| coding:Fixed_21843-8 | Σ | 1..1 | Coding | History of Usual Occupation | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 21843-8 | ||||
| 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(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..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| Slices for effective[x] | Σ | 0..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| effectiveTiming | Timing | |||||||
| effectiveInstant | instant | |||||||
| effective[x]:effectivePeriod | Σ | 0..1 | Period | The 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..1 | instant | Date/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] | ΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Express 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
| coding:occupationCDCCensus2010 | Σ | 0..1 | Coding | Occupation CDC Census 2010 Binding: Occupation CDC Census 2010 (required): Occupation CDC Census 2010 | ||||
| coding:occupationONETSOCDetailODH | Σ | 0..1 | Coding | Occupation ONETSOC Detail (ODH) Binding: Occupation ONETSOC Detail (ODH) (required): Occupation ONETSOC Detail (ODH) | ||||
| coding:occupationCDCCensus2018 | Σ | 0..1 | Coding | Occupation Code Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018 | ||||
| text | Σ | 0..1 | string | Occupation - Literal | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | The 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..* | Annotation | Comments about the observation | |||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | Media | QuestionnaireResponse | Observation) | Related measurements the observation is made from | ||||
| Slices for component | Σ | 1..* | BackboneElement | Component results Slice: Unordered, Open by value:code | ||||
| component:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, 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..1 | BackboneElement | UsualIndustry: 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | History of Usual industry Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 21844-6 | |||||
| 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 | |||||
| value[x] | Σ | 0..1 | CodeableConcept | Express 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
| coding:industryCDCCensus2010 | Σ | 0..1 | Coding | Industry CDC Census 2010 Binding: Industry CDC Census 2010 (required): Industry CDC Census 2010 | ||||
| coding:industryONETSOCDetailODH | Σ | 0..1 | Coding | Industry NAICS Detail (ODH) Binding: Industry NAICS Detail (ODH) (required): Industry NAICS Detail (ODH) | ||||
| coding:industryCDCCensus2018 | Σ | 0..1 | Coding | Industry Code Binding: Industry CDC Census 2018 (required): Industry CDC Census 2018 | ||||
| text | Σ | 0..1 | string | Industry - Literal | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | The 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..1 | BackboneElement | UsualOccupationDuration: 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Usual occupation duration Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 74163-7 | |||||
| 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 | |||||
| value[x] | Σ | 0..1 | Quantity | Actual component result | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit | Σ | 0..1 | string | Unit representation | ||||
| system | ΣC | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
| code | Σ | 0..1 | code | Coded form of the unit Fixed Value: a | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Observation.extension:roleVitalRecords.value[x] | extensible | ValueSetRoleVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vrfrom this IG | ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010 | required | PHVS_Occupation_CDC_Census2010http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7186 | ||||
| Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODH | required | PHVS_Occupation_ONETSOC_Detail_ODHhttp://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7901 | ||||
| Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018 | required | PHVS_Occupation_CDC_Census2018http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.8065 | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:odh-UsualIndustry.code | example | Pattern: LOINC code 21844-6http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component:odh-UsualIndustry.value[x].coding:industryCDCCensus2010 | required | PHVS_Industry_CDC_Census2010http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7187 | ||||
| Observation.component:odh-UsualIndustry.value[x].coding:industryONETSOCDetailODH | required | PHVS_Industry_NAICS_Detail _ODHhttp://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7900 | ||||
| Observation.component:odh-UsualIndustry.value[x].coding:industryCDCCensus2018 | required | PHVS_Industry_CDC_Census2018http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.8066 | ||||
| Observation.component:odh-UsualIndustry.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:odh-UsualIndustry.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.component:odh-UsualIndustry.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component:odh-UsualOccupationDuration.code | example | Pattern: LOINC code 74163-7http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component:odh-UsualOccupationDuration.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| Observation.component:odh-UsualOccupationDuration.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:odh-UsualOccupationDuration.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.component:odh-UsualOccupationDuration.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard |
This structure is derived from UsualWork
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Public Health. Package hl7.fhir.us.vr-common-library#2.0.0 based on FHIR 4.0.1. Generated 2024-03-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change