Consolidated CDA (C-CDA)
4.0.0 - STU4 United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: Social History Section

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/SocialHistorySection Version: 4.0.0
Draft as of 2025-10-02 Computable Name: SocialHistorySection
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#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. Mental/behavioral health assessments such as PHQ-9 (Patient Health Questionnaire-9) for depression screening are captured in the Mental Status section.

Templates Used

Although open templates may contain any valid CDA content, the following templates are specifically called out by this template:

Recommended Entries: SmokingStatus

Optional Entries: CaregiverCharacteristics, CharacteristicsofHomeEnvironment, CulturalandReligiousObservation, PregnancyIntentionInNextYear, PregnancyStatusObservation, SocialHistoryObservation

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 3.0.0:

  • New Content

    • Formal Views of Template Content

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

    This structure is derived from Section

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-smoking-status
    ... 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 Narrative
    .... @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
    ... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation
    .... entry:socialHistory 0..* Entry
    ..... observation 1..1 SocialHistoryObservation
    .... entry:pregnancyPregnancy 0..* Entry
    ..... observation 1..1 PregnancyStatusObservation
    .... entry:smokingStatus 0..* Entry
    ..... observation 1..1 SmokingStatus
    .... entry:caregiver 0..* Entry
    ..... observation 1..1 CaregiverCharacteristics
    .... entry:culturalReligious 0..* Entry
    ..... observation 1..1 CulturalandReligiousObservation
    .... entry:homeCharacteristics 0..* Entry
    ..... observation 1..1 CharacteristicsofHomeEnvironment
    .... entry:pregnancyIntention 0..* Entry
    ..... observation 1..1 PregnancyIntentionInNextYear

    doco Documentation for this format

    Constraints

    Id Grade Path(s) Description Expression
    should-smoking-status warning Section SHOULD contain Smoking Status entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/SmokingStatus'))
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-smoking-status
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:section 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @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
    ... @ID 0..1 xs:ID
    ... @classCode 0..1 cs Binding: ActClassRecordOrganizer (required)
    Fixed Value: DOCSECT
    ... @moodCode 0..1 cs Binding: CDAActMood (required)
    Fixed Value: EVN
    ... id 0..1 II
    ... code 1..1 CE Social history Narrative
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 29762-2
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... translation 0..* CD
    ... title 1..1 ST
    ... text 1..1 xhtml
    ... confidentialityCode 0..1 CE
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... subject 0..1 Subject
    ... author 0..* Author
    ... informant 0..* Informant
    ... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation
    .... entry:socialHistory 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 SocialHistoryObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:pregnancyPregnancy 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 PregnancyStatusObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:smokingStatus 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 SmokingStatus
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:caregiver 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CaregiverCharacteristics
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:culturalReligious 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CulturalandReligiousObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:homeCharacteristics 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CharacteristicsofHomeEnvironment
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:pregnancyIntention 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 PregnancyIntentionInNextYear
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    ... component 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Fixed Value: COMP
    .... @contextConductionInd 0..1 bl Fixed Value: true
    .... section 1..1 Section

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Section.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.templateId:section.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.classCode Base required ActClassRecordOrganizer 📦3.0.0 THO v6.5
    Section.moodCode Base required CDAActMood 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Section.entry:socialHistory.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:socialHistory.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:socialHistory.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:pregnancyPregnancy.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyPregnancy.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyPregnancy.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:smokingStatus.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:smokingStatus.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:smokingStatus.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:caregiver.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:caregiver.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:caregiver.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:culturalReligious.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:culturalReligious.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:culturalReligious.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:homeCharacteristics.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:homeCharacteristics.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:homeCharacteristics.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:pregnancyIntention.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyIntention.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyIntention.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.component.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.component.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Section.typeId, Section.entry:socialHistory.typeId, Section.entry:pregnancyPregnancy.typeId, Section.entry:smokingStatus.typeId, Section.entry:caregiver.typeId, Section.entry:culturalReligious.typeId, Section.entry:homeCharacteristics.typeId, Section.entry:pregnancyIntention.typeId, Section.component.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-smoking-status warning Section SHOULD contain Smoking Status entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/SmokingStatus'))
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-smoking-status
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:section 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @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
    ... @ID 0..1 xs:ID
    ... @classCode 0..1 cs Binding: ActClassRecordOrganizer (required)
    Fixed Value: DOCSECT
    ... @moodCode 0..1 cs Binding: CDAActMood (required)
    Fixed Value: EVN
    ... id 0..1 II
    ... code 1..1 CE Social history Narrative
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 29762-2
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... translation 0..* CD
    ... title 1..1 ST
    ... text 1..1 xhtml
    ... confidentialityCode 0..1 CE
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... subject 0..1 Subject
    ... author 0..* Author
    ... informant 0..* Informant
    ... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation
    .... entry:socialHistory 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 SocialHistoryObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:pregnancyPregnancy 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 PregnancyStatusObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:smokingStatus 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 SmokingStatus
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:caregiver 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CaregiverCharacteristics
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:culturalReligious 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CulturalandReligiousObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:homeCharacteristics 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CharacteristicsofHomeEnvironment
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:pregnancyIntention 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 PregnancyIntentionInNextYear
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    ... component 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Fixed Value: COMP
    .... @contextConductionInd 0..1 bl Fixed Value: true
    .... section 1..1 Section

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Section.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.templateId:section.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.classCode Base required ActClassRecordOrganizer 📦3.0.0 THO v6.5
    Section.moodCode Base required CDAActMood 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Section.entry:socialHistory.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:socialHistory.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:socialHistory.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:pregnancyPregnancy.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyPregnancy.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyPregnancy.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:smokingStatus.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:smokingStatus.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:smokingStatus.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:caregiver.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:caregiver.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:caregiver.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:culturalReligious.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:culturalReligious.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:culturalReligious.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:homeCharacteristics.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:homeCharacteristics.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:homeCharacteristics.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:pregnancyIntention.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyIntention.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyIntention.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.component.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.component.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Section.typeId, Section.entry:socialHistory.typeId, Section.entry:pregnancyPregnancy.typeId, Section.entry:smokingStatus.typeId, Section.entry:caregiver.typeId, Section.entry:culturalReligious.typeId, Section.entry:homeCharacteristics.typeId, Section.entry:pregnancyIntention.typeId, Section.component.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-smoking-status warning Section SHOULD contain Smoking Status entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/SmokingStatus'))

    Differential View

    This structure is derived from Section

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-smoking-status
    ... 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 Narrative
    .... @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
    ... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation
    .... entry:socialHistory 0..* Entry
    ..... observation 1..1 SocialHistoryObservation
    .... entry:pregnancyPregnancy 0..* Entry
    ..... observation 1..1 PregnancyStatusObservation
    .... entry:smokingStatus 0..* Entry
    ..... observation 1..1 SmokingStatus
    .... entry:caregiver 0..* Entry
    ..... observation 1..1 CaregiverCharacteristics
    .... entry:culturalReligious 0..* Entry
    ..... observation 1..1 CulturalandReligiousObservation
    .... entry:homeCharacteristics 0..* Entry
    ..... observation 1..1 CharacteristicsofHomeEnvironment
    .... entry:pregnancyIntention 0..* Entry
    ..... observation 1..1 PregnancyIntentionInNextYear

    doco Documentation for this format

    Constraints

    Id Grade Path(s) Description Expression
    should-smoking-status warning Section SHOULD contain Smoking Status entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/SmokingStatus'))

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-smoking-status
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:section 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @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
    ... @ID 0..1 xs:ID
    ... @classCode 0..1 cs Binding: ActClassRecordOrganizer (required)
    Fixed Value: DOCSECT
    ... @moodCode 0..1 cs Binding: CDAActMood (required)
    Fixed Value: EVN
    ... id 0..1 II
    ... code 1..1 CE Social history Narrative
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 29762-2
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... translation 0..* CD
    ... title 1..1 ST
    ... text 1..1 xhtml
    ... confidentialityCode 0..1 CE
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... subject 0..1 Subject
    ... author 0..* Author
    ... informant 0..* Informant
    ... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation
    .... entry:socialHistory 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 SocialHistoryObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:pregnancyPregnancy 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 PregnancyStatusObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:smokingStatus 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 SmokingStatus
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:caregiver 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CaregiverCharacteristics
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:culturalReligious 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CulturalandReligiousObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:homeCharacteristics 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CharacteristicsofHomeEnvironment
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:pregnancyIntention 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 PregnancyIntentionInNextYear
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    ... component 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Fixed Value: COMP
    .... @contextConductionInd 0..1 bl Fixed Value: true
    .... section 1..1 Section

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Section.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.templateId:section.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.classCode Base required ActClassRecordOrganizer 📦3.0.0 THO v6.5
    Section.moodCode Base required CDAActMood 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Section.entry:socialHistory.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:socialHistory.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:socialHistory.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:pregnancyPregnancy.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyPregnancy.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyPregnancy.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:smokingStatus.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:smokingStatus.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:smokingStatus.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:caregiver.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:caregiver.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:caregiver.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:culturalReligious.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:culturalReligious.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:culturalReligious.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:homeCharacteristics.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:homeCharacteristics.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:homeCharacteristics.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:pregnancyIntention.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyIntention.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyIntention.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.component.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.component.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Section.typeId, Section.entry:socialHistory.typeId, Section.entry:pregnancyPregnancy.typeId, Section.entry:smokingStatus.typeId, Section.entry:caregiver.typeId, Section.entry:culturalReligious.typeId, Section.entry:homeCharacteristics.typeId, Section.entry:pregnancyIntention.typeId, Section.component.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-smoking-status warning Section SHOULD contain Smoking Status entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/SmokingStatus'))

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-smoking-status
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:section 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @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
    ... @ID 0..1 xs:ID
    ... @classCode 0..1 cs Binding: ActClassRecordOrganizer (required)
    Fixed Value: DOCSECT
    ... @moodCode 0..1 cs Binding: CDAActMood (required)
    Fixed Value: EVN
    ... id 0..1 II
    ... code 1..1 CE Social history Narrative
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 29762-2
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... translation 0..* CD
    ... title 1..1 ST
    ... text 1..1 xhtml
    ... confidentialityCode 0..1 CE
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... subject 0..1 Subject
    ... author 0..* Author
    ... informant 0..* Informant
    ... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation
    .... entry:socialHistory 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 SocialHistoryObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:pregnancyPregnancy 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 PregnancyStatusObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:smokingStatus 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 SmokingStatus
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:caregiver 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CaregiverCharacteristics
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:culturalReligious 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CulturalandReligiousObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:homeCharacteristics 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CharacteristicsofHomeEnvironment
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entry:pregnancyIntention 0..* Entry
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 PregnancyIntentionInNextYear
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    ... component 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Fixed Value: COMP
    .... @contextConductionInd 0..1 bl Fixed Value: true
    .... section 1..1 Section

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Section.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.templateId:section.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.classCode Base required ActClassRecordOrganizer 📦3.0.0 THO v6.5
    Section.moodCode Base required CDAActMood 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Section.entry:socialHistory.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:socialHistory.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:socialHistory.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:pregnancyPregnancy.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyPregnancy.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyPregnancy.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:smokingStatus.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:smokingStatus.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:smokingStatus.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:caregiver.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:caregiver.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:caregiver.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:culturalReligious.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:culturalReligious.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:culturalReligious.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:homeCharacteristics.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:homeCharacteristics.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:homeCharacteristics.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.entry:pregnancyIntention.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyIntention.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.entry:pregnancyIntention.​typeCode Base required x_ActRelationshipEntry 📦3.0.0 THO v6.5
    Section.component.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Section.component.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Section.typeId, Section.entry:socialHistory.typeId, Section.entry:pregnancyPregnancy.typeId, Section.entry:smokingStatus.typeId, Section.entry:caregiver.typeId, Section.entry:culturalReligious.typeId, Section.entry:homeCharacteristics.typeId, Section.entry:pregnancyIntention.typeId, Section.component.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-smoking-status warning Section SHOULD contain Smoking Status entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/SmokingStatus'))

     

    Other representations of profile: CSV, Excel