HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1.0 (Standard for Trial Use)
This page is part of the Occupational Data for Health (ODH) FHIR IG (v1.0.0: STU 1) based on FHIR R4. 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
Information about a person's work and volunteer positions to support patient care, population health and public health activities.. The profile is based on FHIR Composition that contains a single section, OccupationalDataSection.
This profile builds on Composition.
This profile was published on Sat Jan 04 00:00:00 UTC 2020 as a draft by HL7 International Public Health Work Group.
Summary
Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Mapping Source
This structure represents the following mapping definition:
odh.OccupationalDataForHealth maps to Composition: Language maps to language ImplicitRules maps to implicitRules Metadata.VersionId maps to meta.versionId Metadata.SourceSystem maps to meta.source Metadata.Profile maps to meta.profile Metadata.LastUpdated maps to meta.lastUpdated Metadata.SecurityLabel maps to meta.security Metadata.Tag maps to meta.tag Narrative maps to text Identifier maps to identifier Status maps to status Type maps to type Category maps to category FocalSubject maps to subject CareContext maps to encounter StatementDateTime maps to date Author maps to author Title maps to title ConfidentialityCode maps to confidentiality Attestation.AttestationMode maps to attester.mode Attestation.CreationDateTime maps to attester.time Attestation.Attester maps to attester.party ManagingOrganization maps to custodian RelatedDocument.Relationship maps to relatesTo.code RelatedDocument.TargetDocument maps to relatesTo.target[x] EventContext.Code maps to event.code EventContext.TimePeriod maps to event.period EventContext.SupportingInformation maps to event.detail OccupationalDataSection maps to section (slice on = code.coding.code; slice strategy = includes) OccupationalDataSection.Title maps to section.title OccupationalDataSection.Code maps to section.code OccupationalDataSection.Author maps to section.author OccupationalDataSection.FocalSubject maps to section.focus OccupationalDataSection.Narrative maps to section.text OccupationalDataSection.Type maps to section.mode OccupationalDataSection.SortOrder maps to section.orderedBy // terrible FHIR name! OccupationalDataSection.Resource maps to section.entry (slice on = reference.resolve(); slice on type = profile; slice strategy = includes) OccupationalDataSection.EmptyReason maps to section.emptyReason OccupationalDataSection.Section maps to section.section
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | Composition | Occupational Data For Health | ||
  type | ||||
   coding | 1..* | (Slice Definition) | Slice: Unordered, Open by value:code | |
   coding:Fixed_74166-0 | Σ | 1..1 | Coding | Occupational summary note |
 system | 1..1 | Fixed Value: http://loinc.org | ||
 code | 1..1 | Fixed Value: 74166-0 | ||
| category | 0..1 | |||
| subject | 1..1 | |||
 author | Reference(Practitioner | Practitioner Role | Device | US Core Patient Profile | RelatedPerson | Organization) | |||
| attester | ||||
| party | Reference(US Core Patient Profile | Practitioner | RelatedPerson | Organization | Practitioner Role) | |||
| relatesTo | ||||
 target[x] | ||||
 targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| section | 1..1 | Section in the OccupationalDataForHealth composition, containing the person's occupational data, past and present | ||
| author | Reference(Practitioner | Practitioner Role | Device | US Core Patient Profile | RelatedPerson | Organization) | |||
| entry | (Slice Definition) | 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..1 | Reference(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 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | I | 0..* | Composition | Occupational Data For Health |
 id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..1 | Identifier | Version-independent identifier for the Composition |
| status | ?!ΣI | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
| type | ΣI | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:Fixed_74166-0 | Σ | 1..1 | Coding | Occupational summary note |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 74166-0 |
| display | ΣI | 0..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| category | ΣI | 0..1 | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example) |
| subject | ΣI | 1..1 | Reference(Resource) | Who and/or what the composition is about |
| encounter | ΣI | 0..1 | Reference(Encounter) | Context of the Composition |
| date | ΣI | 1..1 | dateTime | Composition editing time |
| author | ΣI | 1..* | Reference(Practitioner | Practitioner Role | Device | US Core Patient Profile | RelatedPerson | Organization) | Who and/or what authored the composition |
| title | ΣI | 1..1 | string | Human Readable name/title |
| confidentiality | ΣI | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required) |
| attester | I | 0..* | BackboneElement | Attests to accuracy of composition |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| mode | I | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
| time | I | 0..1 | dateTime | When the composition was attested |
| party | I | 0..1 | Reference(US Core Patient Profile | Practitioner | RelatedPerson | Organization | Practitioner Role) | Who attested the composition |
| custodian | ΣI | 0..1 | Reference(Organization) | Organization which maintains the composition |
| relatesTo | I | 0..* | BackboneElement | Relationships to other compositions/documents |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | I | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
| target[x] | I | 1..1 | Target of the relationship | |
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| event | ΣI | 0..* | BackboneElement | The clinical service(s) being documented |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | ΣI | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example) |
| period | ΣI | 0..1 | Period | The period covered by the documentation |
| detail | ΣI | 0..* | Reference(Resource) | The event(s) being documented |
| section | I | 1..1 | BackboneElement | Section 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..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | I | 0..1 | string | Label for section (e.g. for ToC) |
| code | I | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example) |
| author | I | 0..* | Reference(Practitioner | Practitioner Role | Device | US Core Patient Profile | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
| entry | I | 0..* | (Slice Definition) | A reference to data that supports this section Slice: Unordered, Open by profile:reference.resolve() |
| entry:odh-EmploymentStatus | I | 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 | I | 0..* | Reference(Retirement Date) | RetirementDate: A self-reported date that a person considers themselves to have ‘retired’ |
| entry:odh-CombatZonePeriod | I | 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 | I | 0..1 | Reference(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 | I | 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 |
| emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred) |
| section | I | 0..* | BackboneElement | Nested Section |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | I | 0..1 | string | Label for section (e.g. for ToC) |
| code | I | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example) |
| author | I | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
| entry | I | 0..* | Reference(Resource) | A reference to data that supports this section |
| emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred) |
| section | I | 0..* | Unknown reference to #Composition.section Nested Section | |
| Documentation for this format | ||||
Summary
Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Mapping Source
This structure represents the following mapping definition:
odh.OccupationalDataForHealth maps to Composition: Language maps to language ImplicitRules maps to implicitRules Metadata.VersionId maps to meta.versionId Metadata.SourceSystem maps to meta.source Metadata.Profile maps to meta.profile Metadata.LastUpdated maps to meta.lastUpdated Metadata.SecurityLabel maps to meta.security Metadata.Tag maps to meta.tag Narrative maps to text Identifier maps to identifier Status maps to status Type maps to type Category maps to category FocalSubject maps to subject CareContext maps to encounter StatementDateTime maps to date Author maps to author Title maps to title ConfidentialityCode maps to confidentiality Attestation.AttestationMode maps to attester.mode Attestation.CreationDateTime maps to attester.time Attestation.Attester maps to attester.party ManagingOrganization maps to custodian RelatedDocument.Relationship maps to relatesTo.code RelatedDocument.TargetDocument maps to relatesTo.target[x] EventContext.Code maps to event.code EventContext.TimePeriod maps to event.period EventContext.SupportingInformation maps to event.detail OccupationalDataSection maps to section (slice on = code.coding.code; slice strategy = includes) OccupationalDataSection.Title maps to section.title OccupationalDataSection.Code maps to section.code OccupationalDataSection.Author maps to section.author OccupationalDataSection.FocalSubject maps to section.focus OccupationalDataSection.Narrative maps to section.text OccupationalDataSection.Type maps to section.mode OccupationalDataSection.SortOrder maps to section.orderedBy // terrible FHIR name! OccupationalDataSection.Resource maps to section.entry (slice on = reference.resolve(); slice on type = profile; slice strategy = includes) OccupationalDataSection.EmptyReason maps to section.emptyReason OccupationalDataSection.Section maps to section.section
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | Composition | Occupational Data For Health | ||
| type | ||||
| coding | 1..* | (Slice Definition) | Slice: Unordered, Open by value:code | |
| coding:Fixed_74166-0 | Σ | 1..1 | Coding | Occupational summary note |
| system | 1..1 | Fixed Value: http://loinc.org | ||
| code | 1..1 | Fixed Value: 74166-0 | ||
| category | 0..1 | |||
| subject | 1..1 | |||
| author | Reference(Practitioner | Practitioner Role | Device | US Core Patient Profile | RelatedPerson | Organization) | |||
| attester | ||||
| party | Reference(US Core Patient Profile | Practitioner | RelatedPerson | Organization | Practitioner Role) | |||
| relatesTo | ||||
| target[x] | ||||
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| section | 1..1 | Section in the OccupationalDataForHealth composition, containing the person's occupational data, past and present | ||
| author | Reference(Practitioner | Practitioner Role | Device | US Core Patient Profile | RelatedPerson | Organization) | |||
| entry | (Slice Definition) | 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..1 | Reference(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 | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | I | 0..* | Composition | Occupational Data For Health |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..1 | Identifier | Version-independent identifier for the Composition |
| status | ?!ΣI | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
| type | ΣI | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:Fixed_74166-0 | Σ | 1..1 | Coding | Occupational summary note |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 74166-0 |
| display | ΣI | 0..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| category | ΣI | 0..1 | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example) |
| subject | ΣI | 1..1 | Reference(Resource) | Who and/or what the composition is about |
| encounter | ΣI | 0..1 | Reference(Encounter) | Context of the Composition |
| date | ΣI | 1..1 | dateTime | Composition editing time |
| author | ΣI | 1..* | Reference(Practitioner | Practitioner Role | Device | US Core Patient Profile | RelatedPerson | Organization) | Who and/or what authored the composition |
| title | ΣI | 1..1 | string | Human Readable name/title |
| confidentiality | ΣI | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required) |
| attester | I | 0..* | BackboneElement | Attests to accuracy of composition |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| mode | I | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
| time | I | 0..1 | dateTime | When the composition was attested |
| party | I | 0..1 | Reference(US Core Patient Profile | Practitioner | RelatedPerson | Organization | Practitioner Role) | Who attested the composition |
| custodian | ΣI | 0..1 | Reference(Organization) | Organization which maintains the composition |
| relatesTo | I | 0..* | BackboneElement | Relationships to other compositions/documents |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | I | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
| target[x] | I | 1..1 | Target of the relationship | |
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| event | ΣI | 0..* | BackboneElement | The clinical service(s) being documented |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | ΣI | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example) |
| period | ΣI | 0..1 | Period | The period covered by the documentation |
| detail | ΣI | 0..* | Reference(Resource) | The event(s) being documented |
| section | I | 1..1 | BackboneElement | Section 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..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | I | 0..1 | string | Label for section (e.g. for ToC) |
| code | I | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example) |
| author | I | 0..* | Reference(Practitioner | Practitioner Role | Device | US Core Patient Profile | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
| entry | I | 0..* | (Slice Definition) | A reference to data that supports this section Slice: Unordered, Open by profile:reference.resolve() |
| entry:odh-EmploymentStatus | I | 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 | I | 0..* | Reference(Retirement Date) | RetirementDate: A self-reported date that a person considers themselves to have ‘retired’ |
| entry:odh-CombatZonePeriod | I | 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 | I | 0..1 | Reference(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 | I | 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 |
| emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred) |
| section | I | 0..* | BackboneElement | Nested Section |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | I | 0..1 | string | Label for section (e.g. for ToC) |
| code | I | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example) |
| author | I | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
| entry | I | 0..* | Reference(Resource) | A reference to data that supports this section |
| emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred) |
| section | I | 0..* | Unknown reference to #Composition.section Nested Section | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
| Path | Conformance | ValueSet |
| Composition.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | FHIRDocumentTypeCodes |
| Composition.category | example | DocumentClassValueSet |
| Composition.confidentiality | required | v3.ConfidentialityClassification |
| Composition.attester.mode | required | CompositionAttestationMode |
| Composition.relatesTo.code | required | DocumentRelationshipType |
| Composition.event.code | example | v3.ActCode |
| Composition.section.code | example | DocumentSectionCodes |
| Composition.section.mode | required | ListMode |
| Composition.section.orderedBy | preferred | ListOrderCodes |
| Composition.section.emptyReason | preferred | ListEmptyReasons |
| Composition.section.section.code | example | DocumentSectionCodes |
| Composition.section.section.mode | required | ListMode |
| Composition.section.section.orderedBy | preferred | ListOrderCodes |
| Composition.section.section.emptyReason | preferred | ListEmptyReasons |
| 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-3 | Composition | 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 | 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-5 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Composition.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.type.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.type.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.type.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.type.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.type.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.type.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.type.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.type.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.type.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.confidentiality | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.attester | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.attester.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.attester.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.attester.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.attester.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.attester.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.attester.time | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.attester.party | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.custodian | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.relatesTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.relatesTo.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.relatesTo.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.relatesTo.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.relatesTo.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.relatesTo.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.relatesTo.target[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.event | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.event.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.event.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.event.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.event.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.event.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.event.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.event.detail | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| cmp-1 | Composition.section | A section must contain 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() | |
| ele-1 | Composition.section | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.section.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.section.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.section.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.section.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.focus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.orderedBy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.emptyReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.section | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.section.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.section.section.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.section.section.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.section.section.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.section.section.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.section.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.section.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.section.focus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.section.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.section.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.section.orderedBy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.section.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.section.emptyReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.section.section | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
©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
|
|
Propose a change