This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/SocialHistorySection | Version: 3.0.0-ballot | |||
Draft as of 2023-12-21 | Computable Name: SocialHistorySection | |||
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.2.17:2015-08-01 |
This section contains social history data that influence a patient’s physical, psychological or emotional health (e.g., smoking status, pregnancy). Demographic data, such as marital status, race, ethnicity, and religious affiliation, is captured in the header.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Section
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Section | C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-smoking-status: SHOULD contain Smoking Status - Meaningful Use |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:section | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.17 | |
@extension | 1..1 | st | Required Pattern: 2015-08-01 | |
code | 1..1 | CE | Social History | |
@code | 1..1 | cs | Required Pattern: 29762-2 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
title | 1..1 | ST | ||
text | 1..1 | xhtml | ||
Slices for entry | 0..* | Entry | Slice: Unordered, Open by profile:observation | |
entry:socialHistory | 0..* | Entry | ||
observation | 1..1 | SocialHistoryObservation | Base for all types and resources | |
entry:pregnancyPregnancy | 0..* | Entry | ||
observation | 1..1 | PregnancyObservation | Base for all types and resources | |
entry:smokingStatus | 0..* | Entry | ||
observation | 1..1 | SmokingStatusMeaningfulUse | Base for all types and resources | |
entry:tobaccoUse | 0..* | Entry | ||
observation | 1..1 | TobaccoUse | Base for all types and resources | |
entry:caregiver | 0..* | Entry | ||
observation | 1..1 | CaregiverCharacteristics | Base for all types and resources | |
entry:culteralReligious | 0..* | Entry | ||
observation | 1..1 | CulturalandReligiousObservation | Base for all types and resources | |
entry:homeCharacteristics | 0..* | Entry | ||
observation | 1..1 | CharacteristicsofHomeEnvironment | Base for all types and resources | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
should-smoking-status | warning | Section | SHOULD contain Smoking Status - Meaningful Use : entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/SmokingStatusMeaningfulUse')) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Section | C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-smoking-status: SHOULD contain Smoking Status - Meaningful Use |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:section | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.17 | |
@extension | 1..1 | st | Required Pattern: 2015-08-01 | |
code | 1..1 | CE | Social History Binding: DocumentSectionType (example) | |
@code | 1..1 | cs | Required Pattern: 29762-2 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
title | 1..1 | ST | ||
text | 1..1 | xhtml | ||
Slices for entry | 0..* | Entry | Slice: Unordered, Open by profile:observation | |
entry:socialHistory | 0..* | Entry | ||
observation | C | 1..1 | SocialHistoryObservation | Base for all types and resources |
entry:pregnancyPregnancy | 0..* | Entry | ||
observation | C | 1..1 | PregnancyObservation | Base for all types and resources |
entry:smokingStatus | 0..* | Entry | ||
observation | C | 1..1 | SmokingStatusMeaningfulUse | Base for all types and resources |
entry:tobaccoUse | 0..* | Entry | ||
observation | C | 1..1 | TobaccoUse | Base for all types and resources |
entry:caregiver | 0..* | Entry | ||
observation | C | 1..1 | CaregiverCharacteristics | Base for all types and resources |
entry:culteralReligious | 0..* | Entry | ||
observation | C | 1..1 | CulturalandReligiousObservation | Base for all types and resources |
entry:homeCharacteristics | 0..* | Entry | ||
observation | C | 1..1 | CharacteristicsofHomeEnvironment | Base for all types and resources |
Documentation for this format |
Path | Conformance | ValueSet |
Section.code | example | DocumentSectionType |
Id | Grade | Path(s) | Details | Requirements |
4515-8555 | error | Section.entry:socialHistory.observation | If Observation/value is a physical quantity (xsi:type="PQ"): This value SHALL contain exactly one [1..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC. Note: Base CDA requires that all @unit values SHALL be drawn from UCUM. : | |
should-author | warning | Section.entry:smokingStatus.observation, Section.entry:tobaccoUse.observation | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Section.entry:pregnancyPregnancy.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-sh-author | warning | Section.entry:socialHistory.observation | SHOULD contain author : author.exists() | |
should-smoking-status | warning | Section | SHOULD contain Smoking Status - Meaningful Use : entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/SmokingStatusMeaningfulUse')) | |
should-text-ref-value | warning | Section.entry:socialHistory.observation, Section.entry:pregnancyPregnancy.observation, Section.entry:smokingStatus.observation, Section.entry:tobaccoUse.observation, Section.entry:caregiver.observation, Section.entry:culteralReligious.observation, Section.entry:homeCharacteristics.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
should-value | warning | Section.entry:socialHistory.observation | SHOULD contain value : value.exists() |
Path | Conformance | ValueSet / Code |
Section.nullFlavor | required | CDANullFlavor |
Section.typeId.nullFlavor | required | CDANullFlavor |
Section.templateId:section.nullFlavor | required | CDANullFlavor |
Section.classCode | required | Fixed Value: DOCSECT |
Section.moodCode | required | Fixed Value: EVN |
Section.code | example | DocumentSectionType |
Section.code.nullFlavor | required | CDANullFlavor |
Section.languageCode | required | AllLanguages |
Section.entry:socialHistory.nullFlavor | required | CDANullFlavor |
Section.entry:socialHistory.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:socialHistory.typeCode | required | XActRelationshipEntry |
Section.entry:pregnancyPregnancy.nullFlavor | required | CDANullFlavor |
Section.entry:pregnancyPregnancy.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:pregnancyPregnancy.typeCode | required | XActRelationshipEntry |
Section.entry:smokingStatus.nullFlavor | required | CDANullFlavor |
Section.entry:smokingStatus.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:smokingStatus.typeCode | required | XActRelationshipEntry |
Section.entry:tobaccoUse.nullFlavor | required | CDANullFlavor |
Section.entry:tobaccoUse.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:tobaccoUse.typeCode | required | XActRelationshipEntry |
Section.entry:caregiver.nullFlavor | required | CDANullFlavor |
Section.entry:caregiver.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:caregiver.typeCode | required | XActRelationshipEntry |
Section.entry:culteralReligious.nullFlavor | required | CDANullFlavor |
Section.entry:culteralReligious.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:culteralReligious.typeCode | required | XActRelationshipEntry |
Section.entry:homeCharacteristics.nullFlavor | required | CDANullFlavor |
Section.entry:homeCharacteristics.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:homeCharacteristics.typeCode | required | XActRelationshipEntry |
Section.component.nullFlavor | required | CDANullFlavor |
Section.component.typeId.nullFlavor | required | CDANullFlavor |
Id | Grade | Path(s) | Details | Requirements |
4515-8555 | error | Section.entry:socialHistory.observation | If Observation/value is a physical quantity (xsi:type="PQ"): This value SHALL contain exactly one [1..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC. Note: Base CDA requires that all @unit values SHALL be drawn from UCUM. : | |
should-author | warning | Section.entry:smokingStatus.observation, Section.entry:tobaccoUse.observation | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Section.entry:pregnancyPregnancy.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-sh-author | warning | Section.entry:socialHistory.observation | SHOULD contain author : author.exists() | |
should-smoking-status | warning | Section | SHOULD contain Smoking Status - Meaningful Use : entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/SmokingStatusMeaningfulUse')) | |
should-text-ref-value | warning | Section.entry:socialHistory.observation, Section.entry:pregnancyPregnancy.observation, Section.entry:smokingStatus.observation, Section.entry:tobaccoUse.observation, Section.entry:caregiver.observation, Section.entry:culteralReligious.observation, Section.entry:homeCharacteristics.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
should-value | warning | Section.entry:socialHistory.observation | SHOULD contain value : value.exists() |
This structure is derived from Section
Summary
Mandatory: 9 elements (7 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Section
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Section | C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-smoking-status: SHOULD contain Smoking Status - Meaningful Use |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:section | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.17 | |
@extension | 1..1 | st | Required Pattern: 2015-08-01 | |
code | 1..1 | CE | Social History | |
@code | 1..1 | cs | Required Pattern: 29762-2 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
title | 1..1 | ST | ||
text | 1..1 | xhtml | ||
Slices for entry | 0..* | Entry | Slice: Unordered, Open by profile:observation | |
entry:socialHistory | 0..* | Entry | ||
observation | 1..1 | SocialHistoryObservation | Base for all types and resources | |
entry:pregnancyPregnancy | 0..* | Entry | ||
observation | 1..1 | PregnancyObservation | Base for all types and resources | |
entry:smokingStatus | 0..* | Entry | ||
observation | 1..1 | SmokingStatusMeaningfulUse | Base for all types and resources | |
entry:tobaccoUse | 0..* | Entry | ||
observation | 1..1 | TobaccoUse | Base for all types and resources | |
entry:caregiver | 0..* | Entry | ||
observation | 1..1 | CaregiverCharacteristics | Base for all types and resources | |
entry:culteralReligious | 0..* | Entry | ||
observation | 1..1 | CulturalandReligiousObservation | Base for all types and resources | |
entry:homeCharacteristics | 0..* | Entry | ||
observation | 1..1 | CharacteristicsofHomeEnvironment | Base for all types and resources | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
should-smoking-status | warning | Section | SHOULD contain Smoking Status - Meaningful Use : entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/SmokingStatusMeaningfulUse')) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Section | C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-smoking-status: SHOULD contain Smoking Status - Meaningful Use |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:section | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.17 | |
@extension | 1..1 | st | Required Pattern: 2015-08-01 | |
code | 1..1 | CE | Social History Binding: DocumentSectionType (example) | |
@code | 1..1 | cs | Required Pattern: 29762-2 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
title | 1..1 | ST | ||
text | 1..1 | xhtml | ||
Slices for entry | 0..* | Entry | Slice: Unordered, Open by profile:observation | |
entry:socialHistory | 0..* | Entry | ||
observation | C | 1..1 | SocialHistoryObservation | Base for all types and resources |
entry:pregnancyPregnancy | 0..* | Entry | ||
observation | C | 1..1 | PregnancyObservation | Base for all types and resources |
entry:smokingStatus | 0..* | Entry | ||
observation | C | 1..1 | SmokingStatusMeaningfulUse | Base for all types and resources |
entry:tobaccoUse | 0..* | Entry | ||
observation | C | 1..1 | TobaccoUse | Base for all types and resources |
entry:caregiver | 0..* | Entry | ||
observation | C | 1..1 | CaregiverCharacteristics | Base for all types and resources |
entry:culteralReligious | 0..* | Entry | ||
observation | C | 1..1 | CulturalandReligiousObservation | Base for all types and resources |
entry:homeCharacteristics | 0..* | Entry | ||
observation | C | 1..1 | CharacteristicsofHomeEnvironment | Base for all types and resources |
Documentation for this format |
Path | Conformance | ValueSet |
Section.code | example | DocumentSectionType |
Id | Grade | Path(s) | Details | Requirements |
4515-8555 | error | Section.entry:socialHistory.observation | If Observation/value is a physical quantity (xsi:type="PQ"): This value SHALL contain exactly one [1..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC. Note: Base CDA requires that all @unit values SHALL be drawn from UCUM. : | |
should-author | warning | Section.entry:smokingStatus.observation, Section.entry:tobaccoUse.observation | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Section.entry:pregnancyPregnancy.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-sh-author | warning | Section.entry:socialHistory.observation | SHOULD contain author : author.exists() | |
should-smoking-status | warning | Section | SHOULD contain Smoking Status - Meaningful Use : entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/SmokingStatusMeaningfulUse')) | |
should-text-ref-value | warning | Section.entry:socialHistory.observation, Section.entry:pregnancyPregnancy.observation, Section.entry:smokingStatus.observation, Section.entry:tobaccoUse.observation, Section.entry:caregiver.observation, Section.entry:culteralReligious.observation, Section.entry:homeCharacteristics.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
should-value | warning | Section.entry:socialHistory.observation | SHOULD contain value : value.exists() |
Snapshot View
Path | Conformance | ValueSet / Code |
Section.nullFlavor | required | CDANullFlavor |
Section.typeId.nullFlavor | required | CDANullFlavor |
Section.templateId:section.nullFlavor | required | CDANullFlavor |
Section.classCode | required | Fixed Value: DOCSECT |
Section.moodCode | required | Fixed Value: EVN |
Section.code | example | DocumentSectionType |
Section.code.nullFlavor | required | CDANullFlavor |
Section.languageCode | required | AllLanguages |
Section.entry:socialHistory.nullFlavor | required | CDANullFlavor |
Section.entry:socialHistory.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:socialHistory.typeCode | required | XActRelationshipEntry |
Section.entry:pregnancyPregnancy.nullFlavor | required | CDANullFlavor |
Section.entry:pregnancyPregnancy.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:pregnancyPregnancy.typeCode | required | XActRelationshipEntry |
Section.entry:smokingStatus.nullFlavor | required | CDANullFlavor |
Section.entry:smokingStatus.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:smokingStatus.typeCode | required | XActRelationshipEntry |
Section.entry:tobaccoUse.nullFlavor | required | CDANullFlavor |
Section.entry:tobaccoUse.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:tobaccoUse.typeCode | required | XActRelationshipEntry |
Section.entry:caregiver.nullFlavor | required | CDANullFlavor |
Section.entry:caregiver.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:caregiver.typeCode | required | XActRelationshipEntry |
Section.entry:culteralReligious.nullFlavor | required | CDANullFlavor |
Section.entry:culteralReligious.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:culteralReligious.typeCode | required | XActRelationshipEntry |
Section.entry:homeCharacteristics.nullFlavor | required | CDANullFlavor |
Section.entry:homeCharacteristics.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:homeCharacteristics.typeCode | required | XActRelationshipEntry |
Section.component.nullFlavor | required | CDANullFlavor |
Section.component.typeId.nullFlavor | required | CDANullFlavor |
Id | Grade | Path(s) | Details | Requirements |
4515-8555 | error | Section.entry:socialHistory.observation | If Observation/value is a physical quantity (xsi:type="PQ"): This value SHALL contain exactly one [1..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC. Note: Base CDA requires that all @unit values SHALL be drawn from UCUM. : | |
should-author | warning | Section.entry:smokingStatus.observation, Section.entry:tobaccoUse.observation | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Section.entry:pregnancyPregnancy.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-sh-author | warning | Section.entry:socialHistory.observation | SHOULD contain author : author.exists() | |
should-smoking-status | warning | Section | SHOULD contain Smoking Status - Meaningful Use : entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/SmokingStatusMeaningfulUse')) | |
should-text-ref-value | warning | Section.entry:socialHistory.observation, Section.entry:pregnancyPregnancy.observation, Section.entry:smokingStatus.observation, Section.entry:tobaccoUse.observation, Section.entry:caregiver.observation, Section.entry:culteralReligious.observation, Section.entry:homeCharacteristics.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
should-value | warning | Section.entry:socialHistory.observation | SHOULD contain value : value.exists() |
This structure is derived from Section
Summary
Mandatory: 9 elements (7 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: