This page is part of the Occupational Data for Health (ODH) FHIR IG (v1.3.0: STU 1.3 on FHIR R4) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/odh/StructureDefinition/odh-UsualWork | Version: 1.3.0 | |||
Active as of 2020-01-04 | Computable Name: UsualWork | |||
Copyright/Legal: ©2020+ HL7 International Public Health Work Group. Package hl7.fhir.us.odh#1.0.0 based on FHIR 4.0.1. Generated 2020-01-08. Links: Home | QA Report | Search | Version History external | CC0 external | Propose a change external |
A Usual Occupation Observation is a clinical statement about the type of work (paid or unpaid) done by a person for the longest amount of time during his or her life, not including voluntary work. It includes a set of self-reported, related components about the work a person performed for the longest amount of time during his or her life, regardless of the person’s current job and regardless of whether or not the person performed this work for a continuous time. It also can be used in a minor’s record for the Usual Work of people who share a home with the person (see optional related subject). Usual Work supports recognition of new and known chronic conditions which evolve over many years and may become evident after the person is no longer performing that type of work, e.g., some respiratory conditions and cancers. These data also are used by public health entities and medical researchers to investigate the relationship between conditions and exposures at work and illnesses, causes of death, or cancer.
Observations are a key aspect of healthcare. This resource is used to capture those that do not require more sophisticated mechanisms.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Usual Work | |
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 | |
category | 0..1 | CodeableConcept | Classification of type of observation | |
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) | |
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(US Core Patient Profile) | The subject of an observation | |
focus | 0..* | Reference(RelatedPerson) | What the observation is about, when it is not about the subject of record | |
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. | |
performer | 0..* | Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson) | Who is responsible for the observation | |
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. | |
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 CDC Census 2018 Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018 | |
text | 0..1 | string | Use the narrative description if there is no coded value available for the usual occupation. | |
dataAbsentReason | 0..1 | CodeableConcept | The reason that there is no value available for the Occupation. | |
interpretation | 0..0 | |||
bodySite | 0..0 | |||
method | 0..0 | |||
specimen | 0..0 | |||
device | 0..0 | |||
referenceRange | 0..0 | |||
hasMember | 0..0 | |||
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: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. | |
code | 1..1 | CodeableConcept | History of Usual industry 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 | |
valueCodeableConcept | 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. | |
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 CDC Census 2018 Binding: Industry CDC Census 2018 (required): Industry CDC Census 2018 | |
text | 0..1 | string | Use the narrative description if there is no coded value available for the usual industry. | |
dataAbsentReason | 0..1 | CodeableConcept | The reason that there is no value available for the Industry. | |
interpretation | 0..0 | |||
referenceRange | 0..0 | |||
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). | |
code | 1..1 | CodeableConcept | Usual occupation duration 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 | |
valueQuantity | 0..1 | Quantity | Actual component result | |
system | 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 | |
interpretation | 0..0 | |||
referenceRange | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet |
Observation.valueCodeableConcept.coding:occupationCDCCensus2010 | required | PHVS_Occupation_CDC_Census2010 |
Observation.valueCodeableConcept.coding:occupationONETSOCDetailODH | required | PHVS_Occupation_ONETSOC_Detail_ODH |
Observation.valueCodeableConcept.coding:occupationCDCCensus2018 | required | PHVS_Occupation_CDC_Census2018 |
Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Observation.component:odh-UsualIndustry.valueCodeableConcept.coding:industryCDCCensus2010 | required | PHVS_Industry_CDC_Census2010 |
Observation.component:odh-UsualIndustry.valueCodeableConcept.coding:industryONETSOCDetailODH | required | PHVS_Industry_NAICS_Detail _ODH |
Observation.component:odh-UsualIndustry.valueCodeableConcept.coding:industryCDCCensus2018 | required | PHVS_Industry_CDC_Census2018 |
Observation.component:odh-UsualIndustry.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
Observation.component:odh-UsualIndustry.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Observation.component:odh-UsualOccupationDuration.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
Observation.component:odh-UsualOccupationDuration.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Usual Work |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
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. | |
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(US Core Patient Profile) | The subject of an observation |
focus | Σ | 0..* | Reference(RelatedPerson) | 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. |
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, Open 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 CDC Census 2018 Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018 |
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. |
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 | |||
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 | |
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). |
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 |
Observation.status | required | ObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.code | example | LOINCCodes (a valid code from LOINC) |
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010 | required | PHVS_Occupation_CDC_Census2010 |
Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODH | required | PHVS_Occupation_ONETSOC_Detail_ODH |
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018 | required | PHVS_Occupation_CDC_Census2018 |
Observation.dataAbsentReason | extensible | DataAbsentReason |
Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
Observation.component:odh-UsualIndustry.code | example | Pattern: LOINC code 21844-6 |
Observation.component:odh-UsualIndustry.dataAbsentReason | extensible | DataAbsentReason |
Observation.component:odh-UsualIndustry.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
Observation.component:odh-UsualIndustry.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Observation.component:odh-UsualOccupationDuration.code | example | Pattern: LOINC code 74163-7 |
Observation.component:odh-UsualOccupationDuration.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
Observation.component:odh-UsualOccupationDuration.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Usual Work | ||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
basedOn | Σ | 0..* | Reference(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(US Core Patient Profile) | The subject of an observation | ||||
focus | Σ | 0..* | Reference(RelatedPerson) | 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, Open 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 CDC Census 2018 Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018 | ||||
text | Σ | 0..1 | string | Use the narrative description if there is no coded value available for the usual occupation. | ||||
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 CDC Census 2018 Binding: Industry CDC Census 2018 (required): Industry CDC Census 2018 | ||||
text | Σ | 0..1 | string | Use the narrative description if there is no coded value available for the usual industry. | ||||
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 | ||||
Observation.language | preferred | CommonLanguages
| ||||
Observation.status | required | ObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.code | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010 | required | PHVS_Occupation_CDC_Census2010 | ||||
Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODH | required | PHVS_Occupation_ONETSOC_Detail_ODH | ||||
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018 | required | PHVS_Occupation_CDC_Census2018 | ||||
Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes | ||||
Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:odh-UsualIndustry.code | example | Pattern: LOINC code 21844-6 | ||||
Observation.component:odh-UsualIndustry.value[x].coding:industryCDCCensus2010 | required | PHVS_Industry_CDC_Census2010 | ||||
Observation.component:odh-UsualIndustry.value[x].coding:industryONETSOCDetailODH | required | PHVS_Industry_NAICS_Detail _ODH | ||||
Observation.component:odh-UsualIndustry.value[x].coding:industryCDCCensus2018 | required | PHVS_Industry_CDC_Census2018 | ||||
Observation.component:odh-UsualIndustry.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:odh-UsualIndustry.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes | ||||
Observation.component:odh-UsualIndustry.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes | ||||
Observation.component:odh-UsualOccupationDuration.code | example | Pattern: LOINC code 74163-7 | ||||
Observation.component:odh-UsualOccupationDuration.value[x].comparator | required | QuantityComparator | ||||
Observation.component:odh-UsualOccupationDuration.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:odh-UsualOccupationDuration.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes | ||||
Observation.component:odh-UsualOccupationDuration.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Observation
Summary
Mandatory: 7 elements (4 nested mandatory elements)
Fixed Value: 6 elements
Prohibited: 11 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Usual Work | |
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 | |
category | 0..1 | CodeableConcept | Classification of type of observation | |
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) | |
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(US Core Patient Profile) | The subject of an observation | |
focus | 0..* | Reference(RelatedPerson) | What the observation is about, when it is not about the subject of record | |
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. | |
performer | 0..* | Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson) | Who is responsible for the observation | |
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. | |
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 CDC Census 2018 Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018 | |
text | 0..1 | string | Use the narrative description if there is no coded value available for the usual occupation. | |
dataAbsentReason | 0..1 | CodeableConcept | The reason that there is no value available for the Occupation. | |
interpretation | 0..0 | |||
bodySite | 0..0 | |||
method | 0..0 | |||
specimen | 0..0 | |||
device | 0..0 | |||
referenceRange | 0..0 | |||
hasMember | 0..0 | |||
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: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. | |
code | 1..1 | CodeableConcept | History of Usual industry 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 | |
valueCodeableConcept | 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. | |
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 CDC Census 2018 Binding: Industry CDC Census 2018 (required): Industry CDC Census 2018 | |
text | 0..1 | string | Use the narrative description if there is no coded value available for the usual industry. | |
dataAbsentReason | 0..1 | CodeableConcept | The reason that there is no value available for the Industry. | |
interpretation | 0..0 | |||
referenceRange | 0..0 | |||
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). | |
code | 1..1 | CodeableConcept | Usual occupation duration 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 | |
valueQuantity | 0..1 | Quantity | Actual component result | |
system | 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 | |
interpretation | 0..0 | |||
referenceRange | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet |
Observation.valueCodeableConcept.coding:occupationCDCCensus2010 | required | PHVS_Occupation_CDC_Census2010 |
Observation.valueCodeableConcept.coding:occupationONETSOCDetailODH | required | PHVS_Occupation_ONETSOC_Detail_ODH |
Observation.valueCodeableConcept.coding:occupationCDCCensus2018 | required | PHVS_Occupation_CDC_Census2018 |
Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Observation.component:odh-UsualIndustry.valueCodeableConcept.coding:industryCDCCensus2010 | required | PHVS_Industry_CDC_Census2010 |
Observation.component:odh-UsualIndustry.valueCodeableConcept.coding:industryONETSOCDetailODH | required | PHVS_Industry_NAICS_Detail _ODH |
Observation.component:odh-UsualIndustry.valueCodeableConcept.coding:industryCDCCensus2018 | required | PHVS_Industry_CDC_Census2018 |
Observation.component:odh-UsualIndustry.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
Observation.component:odh-UsualIndustry.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Observation.component:odh-UsualOccupationDuration.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
Observation.component:odh-UsualOccupationDuration.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Usual Work |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
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. | |
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(US Core Patient Profile) | The subject of an observation |
focus | Σ | 0..* | Reference(RelatedPerson) | 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. |
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, Open 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 CDC Census 2018 Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018 |
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. |
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 | |||
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 | |
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). |
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 |
Observation.status | required | ObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.code | example | LOINCCodes (a valid code from LOINC) |
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010 | required | PHVS_Occupation_CDC_Census2010 |
Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODH | required | PHVS_Occupation_ONETSOC_Detail_ODH |
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018 | required | PHVS_Occupation_CDC_Census2018 |
Observation.dataAbsentReason | extensible | DataAbsentReason |
Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
Observation.component:odh-UsualIndustry.code | example | Pattern: LOINC code 21844-6 |
Observation.component:odh-UsualIndustry.dataAbsentReason | extensible | DataAbsentReason |
Observation.component:odh-UsualIndustry.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
Observation.component:odh-UsualIndustry.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Observation.component:odh-UsualOccupationDuration.code | example | Pattern: LOINC code 74163-7 |
Observation.component:odh-UsualOccupationDuration.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
Observation.component:odh-UsualOccupationDuration.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Usual Work | ||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
basedOn | Σ | 0..* | Reference(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(US Core Patient Profile) | The subject of an observation | ||||
focus | Σ | 0..* | Reference(RelatedPerson) | 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, Open 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 CDC Census 2018 Binding: Occupation CDC Census 2018 (required): Occupation CDC Census 2018 | ||||
text | Σ | 0..1 | string | Use the narrative description if there is no coded value available for the usual occupation. | ||||
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 CDC Census 2018 Binding: Industry CDC Census 2018 (required): Industry CDC Census 2018 | ||||
text | Σ | 0..1 | string | Use the narrative description if there is no coded value available for the usual industry. | ||||
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 | ||||
Observation.language | preferred | CommonLanguages
| ||||
Observation.status | required | ObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.code | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010 | required | PHVS_Occupation_CDC_Census2010 | ||||
Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODH | required | PHVS_Occupation_ONETSOC_Detail_ODH | ||||
Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018 | required | PHVS_Occupation_CDC_Census2018 | ||||
Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes | ||||
Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:odh-UsualIndustry.code | example | Pattern: LOINC code 21844-6 | ||||
Observation.component:odh-UsualIndustry.value[x].coding:industryCDCCensus2010 | required | PHVS_Industry_CDC_Census2010 | ||||
Observation.component:odh-UsualIndustry.value[x].coding:industryONETSOCDetailODH | required | PHVS_Industry_NAICS_Detail _ODH | ||||
Observation.component:odh-UsualIndustry.value[x].coding:industryCDCCensus2018 | required | PHVS_Industry_CDC_Census2018 | ||||
Observation.component:odh-UsualIndustry.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:odh-UsualIndustry.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes | ||||
Observation.component:odh-UsualIndustry.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes | ||||
Observation.component:odh-UsualOccupationDuration.code | example | Pattern: LOINC code 74163-7 | ||||
Observation.component:odh-UsualOccupationDuration.value[x].comparator | required | QuantityComparator | ||||
Observation.component:odh-UsualOccupationDuration.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:odh-UsualOccupationDuration.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes | ||||
Observation.component:odh-UsualOccupationDuration.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Observation
Summary
Mandatory: 7 elements (4 nested mandatory elements)
Fixed Value: 6 elements
Prohibited: 11 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron