HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1 (Standard for Trial Use)
This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/odh/StructureDefinition/odh-OccupationalDataForHealth
Current and past activities for profit, wages, salary, or as a service to others.
This profile builds on Composition.
This profile was published on Fri Aug 17 00:00:00 AEST 2018 as a draft by HL7.
View the corresponding OccupationalDataForHealthModel logical model.
Summary
Mandatory: 0 element (1 nested mandatory element)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
ODH Mapping Source
This structure represents the following ODH mapping definition:
odh.OccupationalDataForHealth maps to Composition: OccupationalDataSection maps to section OccupationalDataSection.SocialHistoryObservation maps to section.entry (slice on = reference.resolve(); slice on type = profile; slice strategy = includes)
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | ODH OccupationalDataForHealth Profile | |||
 section | 1..1 | |||
   entry | Reference(ODH SocialHistoryObservation Profile) | Slice: Unordered, Open by profile:reference.resolve() | ||
 entry | 0..* | Reference(ODH PersonEmploymentStatus Profile) | PersonEmploymentStatus | |
| entry | 0..* | Reference(ODH RetirementDate Profile) | RetirementDate | |
| entry | 0..* | Reference(ODH CombatZonePeriod Profile) | CombatZonePeriod | |
| entry | 0..1 | Reference(ODH UsualWork Profile) | UsualWork | |
| entry | 0..* | Reference(ODH PastOrPresentJob Profile) | PastOrPresentJob | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | I | 0..* | ODH OccupationalDataForHealth Profile | |
 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: Common Languages (extensible) | |
| text | I | 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..1 | Identifier | Logical identifier of composition (version-independent) |
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
| type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred) |
| class | Σ | 0..1 | CodeableConcept | Categorization of Composition Binding: FHIR Document Class Codes (example) |
| subject | Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about |
| encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | Σ | 1..* | Reference(Practitioner | Device | Patient | RelatedPerson) | Who and/or what authored the composition |
| title | Σ | 1..1 | string | Human Readable name/title |
| confidentiality | ?!Σ | 0..1 | code | As defined by affinity domain Binding: ConfidentialityClassification (required) |
| attester | ΣI | 0..* | BackboneElement | Attests to accuracy of composition |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| mode | Σ | 1..* | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
| time | Σ | 0..1 | dateTime | When the composition was attested |
| party | Σ | 0..1 | Reference(Patient | Practitioner | Organization) | Who attested the composition |
| custodian | Σ | 0..1 | Reference(Organization) | Organization which maintains the composition |
| relatesTo | ΣI | 0..* | BackboneElement | Relationships to other compositions/documents |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
 target[x] | Σ | 1..1 | Identifier, Reference(Composition) | Target of the relationship |
| event | ΣI | 0..* | BackboneElement | The clinical service(s) being documented |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: ActCode (example) |
| period | Σ | 0..1 | Period | The period covered by the documentation |
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented |
| section | I | 1..1 | BackboneElement | Composition is broken into sections cmp-1: A section must at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| title | 0..1 | string | Label for section (e.g. for ToC) | |
| code | 0..1 | CodeableConcept | Classification of section (recommended) Binding: Document Section Codes (example) | |
| text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
| mode | ?!Σ | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: List Order Codes (preferred) | |
| entry | I | Reference(ODH SocialHistoryObservation Profile) | A reference to data that supports this section Slice: Unordered, Open by profile:reference.resolve() | |
| entry | I | 0..* | Reference(ODH PersonEmploymentStatus Profile) | PersonEmploymentStatus |
| entry | I | 0..* | Reference(ODH RetirementDate Profile) | RetirementDate |
| entry | I | 0..* | Reference(ODH CombatZonePeriod Profile) | CombatZonePeriod |
| entry | I | 0..1 | Reference(ODH UsualWork Profile) | UsualWork |
| entry | I | 0..* | Reference(ODH PastOrPresentJob Profile) | PastOrPresentJob |
| emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: List Empty Reasons (preferred) |
| section | I | 0..* | Unknown reference to #Composition.section Nested Section | |
| Documentation for this format | ||||
Summary
Mandatory: 0 element (1 nested mandatory element)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
ODH Mapping Source
This structure represents the following ODH mapping definition:
odh.OccupationalDataForHealth maps to Composition: OccupationalDataSection maps to section OccupationalDataSection.SocialHistoryObservation maps to section.entry (slice on = reference.resolve(); slice on type = profile; slice strategy = includes)
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | ODH OccupationalDataForHealth Profile | |||
| section | 1..1 | |||
| entry | Reference(ODH SocialHistoryObservation Profile) | Slice: Unordered, Open by profile:reference.resolve() | ||
| entry | 0..* | Reference(ODH PersonEmploymentStatus Profile) | PersonEmploymentStatus | |
| entry | 0..* | Reference(ODH RetirementDate Profile) | RetirementDate | |
| entry | 0..* | Reference(ODH CombatZonePeriod Profile) | CombatZonePeriod | |
| entry | 0..1 | Reference(ODH UsualWork Profile) | UsualWork | |
| entry | 0..* | Reference(ODH PastOrPresentJob Profile) | PastOrPresentJob | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | I | 0..* | ODH OccupationalDataForHealth Profile | |
| 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: Common Languages (extensible) | |
| text | I | 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..1 | Identifier | Logical identifier of composition (version-independent) |
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
| type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred) |
| class | Σ | 0..1 | CodeableConcept | Categorization of Composition Binding: FHIR Document Class Codes (example) |
| subject | Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about |
| encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | Σ | 1..* | Reference(Practitioner | Device | Patient | RelatedPerson) | Who and/or what authored the composition |
| title | Σ | 1..1 | string | Human Readable name/title |
| confidentiality | ?!Σ | 0..1 | code | As defined by affinity domain Binding: ConfidentialityClassification (required) |
| attester | ΣI | 0..* | BackboneElement | Attests to accuracy of composition |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| mode | Σ | 1..* | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
| time | Σ | 0..1 | dateTime | When the composition was attested |
| party | Σ | 0..1 | Reference(Patient | Practitioner | Organization) | Who attested the composition |
| custodian | Σ | 0..1 | Reference(Organization) | Organization which maintains the composition |
| relatesTo | ΣI | 0..* | BackboneElement | Relationships to other compositions/documents |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
| target[x] | Σ | 1..1 | Identifier, Reference(Composition) | Target of the relationship |
| event | ΣI | 0..* | BackboneElement | The clinical service(s) being documented |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: ActCode (example) |
| period | Σ | 0..1 | Period | The period covered by the documentation |
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented |
| section | I | 1..1 | BackboneElement | Composition is broken into sections cmp-1: A section must at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| title | 0..1 | string | Label for section (e.g. for ToC) | |
| code | 0..1 | CodeableConcept | Classification of section (recommended) Binding: Document Section Codes (example) | |
| text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
| mode | ?!Σ | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: List Order Codes (preferred) | |
| entry | I | Reference(ODH SocialHistoryObservation Profile) | A reference to data that supports this section Slice: Unordered, Open by profile:reference.resolve() | |
| entry | I | 0..* | Reference(ODH PersonEmploymentStatus Profile) | PersonEmploymentStatus |
| entry | I | 0..* | Reference(ODH RetirementDate Profile) | RetirementDate |
| entry | I | 0..* | Reference(ODH CombatZonePeriod Profile) | CombatZonePeriod |
| entry | I | 0..1 | Reference(ODH UsualWork Profile) | UsualWork |
| entry | I | 0..* | Reference(ODH PastOrPresentJob Profile) | PastOrPresentJob |
| emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: List Empty Reasons (preferred) |
| section | I | 0..* | Unknown reference to #Composition.section Nested Section | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
| Path | Name | Conformance | ValueSet |
| Composition.language | Common Languages | extensible | Common Languages |
| Composition.status | CompositionStatus | required | CompositionStatus |
| Composition.type | FHIR Document Type Codes | preferred | FHIR Document Type Codes |
| Composition.class | FHIR Document Class Codes | example | FHIR Document Class Codes |
| Composition.confidentiality | ConfidentialityClassification | required | ConfidentialityClassification |
| Composition.attester.mode | CompositionAttestationMode | required | CompositionAttestationMode |
| Composition.relatesTo.code | DocumentRelationshipType | required | DocumentRelationshipType |
| Composition.event.code | v3 Code System ActCode | example | v3 Code System ActCode |
| Composition.section.code | Document Section Codes | example | Document Section Codes |
| Composition.section.mode | ListMode | required | ListMode |
| Composition.section.orderedBy | List Order Codes | preferred | List Order Codes |
| Composition.section.emptyReason | List Empty Reasons | preferred | List Empty Reasons |
| Id | Path | Details | Requirements |
| dom-2 | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Composition | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Composition | 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-3 | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | Composition.attester | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Composition.relatesTo | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Composition.event | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Composition.section | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| cmp-1 | Composition.section | A section must at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() |
ODH Version: 0.1.0 ®© FHIR Version: 3.0.1 generated on Tue, Aug 21, 2018 16:12+1000.
| History
