IHE FHIR Profile: Occupational Data for Health (ODH) - International
1.0.0-comment - ballot International flag

This page is part of the IHE FHIR Profile: Occupational Data for Health (ODH) - International (v1.0.0-comment: Publication Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Occupational Data For Health

Official URL: https://profiles.ihe.net/PCC/ODH/StructureDefinition/odh-OccupationalDataForHealth Version: 1.0.0-comment
Draft as of 2024-03-08 Computable Name: OccupationalDataForHealth

This Composition covers information about a patient’s work, including some voluntary work, or a patient’s household members’ work. ODH is designed for the social history section of a medical record, to facilitate clinical care in multiple disciplines and delivery environments. ODH can be used for clinical decision support, population health activities and value-based care, and public health reporting.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionOccupational Data For Health
... type 1..1CodeableConceptKind of composition (LOINC if possible)
.... Slices for coding 1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_74166-0 Σ1..1CodingOccupational summary note
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1codeSymbol in syntax defined by the system
Fixed Value: 74166-0
... category 0..1CodeableConceptCategorization of Composition
... subject 1..1Reference(Resource)Who and/or what the composition is about
... attester 0..*BackboneElementAttests to accuracy of composition
.... party 0..1Reference(Patient | Practitioner | RelatedPerson | Organization | PractitionerRole)Who attested the composition
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... section 1..1BackboneElementSection in the OccupationalDataForHealth composition, containing the person's occupational data, past and present
.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... Slices for entry 0..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:reference.resolve()
..... entry:odh-EmploymentStatus 0..*Reference(Employment Status)EmploymentStatus: The self-reported current and/or historical status about a person's economic relationship to work (e.g. having one or more jobs), including start and end dates
..... entry:odh-RetirementDate 0..*Reference(Retirement Date)RetirementDate: A self-reported date that a person considers themselves to have 'retired'
..... entry:odh-CombatZonePeriod 0..*Reference(Combat Zone Period)CombatZonePeriod: Self-reported date range(s) when a person worked in what is considered a combat zone; sometimes called a hazardous duty work
..... entry:odh-UsualWork 0..1Reference(Usual Work)UsualWork: Related data elements about the work a person reports having 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
..... entry:odh-PastOrPresentJob 0..*Reference(Past Or Present Job)PastOrPresentJob: Related data elements for a current or previous job, as reported by the person, i.e., a work situation or position held for a specified time period

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionOccupational Data For Health
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_74166-0 Σ1..1CodingOccupational summary note
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 74166-0
... category Σ0..1CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ1..1Reference(Resource)Who and/or what the composition is about
... date Σ1..1dateTimeComposition editing time
... author Σ1..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
... attester 0..*BackboneElementAttests to accuracy of composition
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.

.... party 0..1Reference(Patient | Practitioner | RelatedPerson | Organization | PractitionerRole)Who attested the composition
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... section C1..1BackboneElementSection in the OccupationalDataForHealth composition, containing the person's occupational data, past and present
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... Slices for entry C0..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:reference.resolve()
..... entry:odh-EmploymentStatus C0..*Reference(Employment Status)EmploymentStatus: The self-reported current and/or historical status about a person's economic relationship to work (e.g. having one or more jobs), including start and end dates
..... entry:odh-RetirementDate C0..*Reference(Retirement Date)RetirementDate: A self-reported date that a person considers themselves to have 'retired'
..... entry:odh-CombatZonePeriod C0..*Reference(Combat Zone Period)CombatZonePeriod: Self-reported date range(s) when a person worked in what is considered a combat zone; sometimes called a hazardous duty work
..... entry:odh-UsualWork C0..1Reference(Usual Work)UsualWork: Related data elements about the work a person reports having 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
..... entry:odh-PastOrPresentJob C0..*Reference(Past Or Present Job)PastOrPresentJob: Related data elements for a current or previous job, as reported by the person, i.e., a work situation or position held for a specified time period

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionOccupational Data For Health
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierVersion-independent identifier for the Composition
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_74166-0 Σ1..1CodingOccupational summary note
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 74166-0
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... category Σ0..1CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ1..1Reference(Resource)Who and/or what the composition is about
... encounter Σ0..1Reference(Encounter)Context of the Composition
... date Σ1..1dateTimeComposition editing time
... author Σ1..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
... confidentiality Σ0..1codeAs defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.

... attester 0..*BackboneElementAttests to accuracy of composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.

.... time 0..1dateTimeWhen the composition was attested
.... party 0..1Reference(Patient | Practitioner | RelatedPerson | Organization | PractitionerRole)Who attested the composition
... custodian Σ0..1Reference(Organization)Organization which maintains the composition
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... event Σ0..*BackboneElementThe clinical service(s) being documented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... section C1..1BackboneElementSection in the OccupationalDataForHealth composition, containing the person's occupational data, past and present
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
.... text C0..1NarrativeText summary of the section, for human interpretation
.... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

.... Slices for entry C0..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:reference.resolve()
..... entry:odh-EmploymentStatus C0..*Reference(Employment Status)EmploymentStatus: The self-reported current and/or historical status about a person's economic relationship to work (e.g. having one or more jobs), including start and end dates
..... entry:odh-RetirementDate C0..*Reference(Retirement Date)RetirementDate: A self-reported date that a person considers themselves to have 'retired'
..... entry:odh-CombatZonePeriod C0..*Reference(Combat Zone Period)CombatZonePeriod: Self-reported date range(s) when a person worked in what is considered a combat zone; sometimes called a hazardous duty work
..... entry:odh-UsualWork C0..1Reference(Usual Work)UsualWork: Related data elements about the work a person reports having 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
..... entry:odh-PastOrPresentJob C0..*Reference(Past Or Present Job)PastOrPresentJob: Related data elements for a current or previous job, as reported by the person, i.e., a work situation or position held for a specified time period
.... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section C0..*See section (Composition)Nested Section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.confidentialityrequiredv3.ConfidentialityClassification
http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Composition

Summary

Mandatory: 6 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Composition.type.coding is sliced based on the value of value:code
  • The element Composition.section.entry is sliced based on the value of profile:reference.resolve()

Differential View

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionOccupational Data For Health
... type 1..1CodeableConceptKind of composition (LOINC if possible)
.... Slices for coding 1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_74166-0 Σ1..1CodingOccupational summary note
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1codeSymbol in syntax defined by the system
Fixed Value: 74166-0
... category 0..1CodeableConceptCategorization of Composition
... subject 1..1Reference(Resource)Who and/or what the composition is about
... attester 0..*BackboneElementAttests to accuracy of composition
.... party 0..1Reference(Patient | Practitioner | RelatedPerson | Organization | PractitionerRole)Who attested the composition
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... section 1..1BackboneElementSection in the OccupationalDataForHealth composition, containing the person's occupational data, past and present
.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... Slices for entry 0..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:reference.resolve()
..... entry:odh-EmploymentStatus 0..*Reference(Employment Status)EmploymentStatus: The self-reported current and/or historical status about a person's economic relationship to work (e.g. having one or more jobs), including start and end dates
..... entry:odh-RetirementDate 0..*Reference(Retirement Date)RetirementDate: A self-reported date that a person considers themselves to have 'retired'
..... entry:odh-CombatZonePeriod 0..*Reference(Combat Zone Period)CombatZonePeriod: Self-reported date range(s) when a person worked in what is considered a combat zone; sometimes called a hazardous duty work
..... entry:odh-UsualWork 0..1Reference(Usual Work)UsualWork: Related data elements about the work a person reports having 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
..... entry:odh-PastOrPresentJob 0..*Reference(Past Or Present Job)PastOrPresentJob: Related data elements for a current or previous job, as reported by the person, i.e., a work situation or position held for a specified time period

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionOccupational Data For Health
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_74166-0 Σ1..1CodingOccupational summary note
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 74166-0
... category Σ0..1CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ1..1Reference(Resource)Who and/or what the composition is about
... date Σ1..1dateTimeComposition editing time
... author Σ1..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
... attester 0..*BackboneElementAttests to accuracy of composition
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.

.... party 0..1Reference(Patient | Practitioner | RelatedPerson | Organization | PractitionerRole)Who attested the composition
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... section C1..1BackboneElementSection in the OccupationalDataForHealth composition, containing the person's occupational data, past and present
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... Slices for entry C0..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:reference.resolve()
..... entry:odh-EmploymentStatus C0..*Reference(Employment Status)EmploymentStatus: The self-reported current and/or historical status about a person's economic relationship to work (e.g. having one or more jobs), including start and end dates
..... entry:odh-RetirementDate C0..*Reference(Retirement Date)RetirementDate: A self-reported date that a person considers themselves to have 'retired'
..... entry:odh-CombatZonePeriod C0..*Reference(Combat Zone Period)CombatZonePeriod: Self-reported date range(s) when a person worked in what is considered a combat zone; sometimes called a hazardous duty work
..... entry:odh-UsualWork C0..1Reference(Usual Work)UsualWork: Related data elements about the work a person reports having 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
..... entry:odh-PastOrPresentJob C0..*Reference(Past Or Present Job)PastOrPresentJob: Related data elements for a current or previous job, as reported by the person, i.e., a work situation or position held for a specified time period

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionOccupational Data For Health
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierVersion-independent identifier for the Composition
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_74166-0 Σ1..1CodingOccupational summary note
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 74166-0
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... category Σ0..1CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ1..1Reference(Resource)Who and/or what the composition is about
... encounter Σ0..1Reference(Encounter)Context of the Composition
... date Σ1..1dateTimeComposition editing time
... author Σ1..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
... confidentiality Σ0..1codeAs defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.

... attester 0..*BackboneElementAttests to accuracy of composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.

.... time 0..1dateTimeWhen the composition was attested
.... party 0..1Reference(Patient | Practitioner | RelatedPerson | Organization | PractitionerRole)Who attested the composition
... custodian Σ0..1Reference(Organization)Organization which maintains the composition
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... event Σ0..*BackboneElementThe clinical service(s) being documented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... section C1..1BackboneElementSection in the OccupationalDataForHealth composition, containing the person's occupational data, past and present
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
.... text C0..1NarrativeText summary of the section, for human interpretation
.... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

.... Slices for entry C0..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:reference.resolve()
..... entry:odh-EmploymentStatus C0..*Reference(Employment Status)EmploymentStatus: The self-reported current and/or historical status about a person's economic relationship to work (e.g. having one or more jobs), including start and end dates
..... entry:odh-RetirementDate C0..*Reference(Retirement Date)RetirementDate: A self-reported date that a person considers themselves to have 'retired'
..... entry:odh-CombatZonePeriod C0..*Reference(Combat Zone Period)CombatZonePeriod: Self-reported date range(s) when a person worked in what is considered a combat zone; sometimes called a hazardous duty work
..... entry:odh-UsualWork C0..1Reference(Usual Work)UsualWork: Related data elements about the work a person reports having 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
..... entry:odh-PastOrPresentJob C0..*Reference(Past Or Present Job)PastOrPresentJob: Related data elements for a current or previous job, as reported by the person, i.e., a work situation or position held for a specified time period
.... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section C0..*See section (Composition)Nested Section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.confidentialityrequiredv3.ConfidentialityClassification
http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Composition

Summary

Mandatory: 6 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Composition.type.coding is sliced based on the value of value:code
  • The element Composition.section.entry is sliced based on the value of profile:reference.resolve()

 

Other representations of profile: CSV, Excel, Schematron