Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Encounters Section - entries required

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.2.22.1 Version: 2.1.0-draft1
Active as of 2023-01-16 Computable Name: EncountersSectionentriesrequired
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.2.22.1:2015-08-01

This section lists and describes any healthcare encounters pertinent to the patient’s current health status or historical health history. An encounter is an interaction, regardless of the setting, between a patient and a practitioner who is vested with primary responsibility for diagnosing, evaluating, or treating the patient’s condition. It may include visits, appointments, as well as non-face-to-face interactions. It is also a contact between a patient and a practitioner who has primary responsibility (exercising independent judgment) for assessing and treating the patient at a given contact. This section may contain all encounters for the time period being summarized, but should include notable encounters.

Usage:

Formal Views of Profile Content

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

This structure is derived from EncountersSectionentriesoptional

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1EncountersSectionentriesoptionalBase for all types and resources
... nullFlavor 0..1codeRequired Pattern: NI
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:secondary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.22.1
..... extension 1..1stringRequired Pattern: 2015-08-01
... code 1..1CE
.... code 1..1stringRequired Pattern: 46240-8
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
... text 1..1xhtml
... Slices for entry 0..*ElementIf section/@nullFlavor is not present:
Slice: Unordered, Open by value:encounter
.... entry:encounter 1..*Element
..... encounter 1..1EncounterActivityBase for all types and resources

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1EncountersSectionentriesoptionalBase for all types and resources
... nullFlavor 0..1codeBinding: NullFlavor (required)
Required Pattern: NI
... classCode 1..1codeBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.22
..... extension 1..1stringRequired Pattern: 2015-08-01
.... templateId:secondary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.22.1
..... extension 1..1stringRequired Pattern: 2015-08-01
... code 1..1CEBinding: DocumentSectionType (extensible)
.... code 1..1stringRequired Pattern: 46240-8
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
... title 1..1ED
... text S1..1xhtml
... Slices for entry C0..*ElementIf section/@nullFlavor is not present:
Slice: Unordered, Open by value:encounter
.... entry:encounter C1..*Element
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... encounter 1..1EncounterActivityBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Section.nullFlavorrequiredPattern: NI
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.codeextensibleDocumentSectionType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
only-one-statementerrorSection.entry, Section.entry:encounterSHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act.
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1EncountersSectionentriesoptionalBase for all types and resources
... ID 0..1string
... nullFlavor 0..1codeBinding: NullFlavor (required)
Required Pattern: NI
... classCode 1..1codeBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.22
..... extension 1..1stringRequired Pattern: 2015-08-01
.... templateId:secondary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.22.1
..... extension 1..1stringRequired Pattern: 2015-08-01
... id 0..1II
... code 1..1CEBinding: DocumentSectionType (extensible)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: 46240-8
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... title 1..1ED
... text S1..1xhtml
... confidentialityCode 0..1CE
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... author 0..*Author
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... Slices for entry C0..*ElementIf section/@nullFlavor is not present:
Slice: Unordered, Open by value:encounter
.... entry:encounter C1..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... encounter 1..1EncounterActivityBase for all types and resources
... component 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeFixed Value: COMP
.... contextConductionInd 1..1boolean
.... section 1..1Section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Section.nullFlavorrequiredPattern: NI
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.templateId:primary.nullFlavorrequiredNullFlavor
Section.templateId:secondary.nullFlavorrequiredNullFlavor
Section.codeextensibleDocumentSectionType
Section.code.nullFlavorrequiredNullFlavor
Section.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Section.subject.typeCoderequiredFixed Value: SBJ
Section.subject.contextControlCoderequiredFixed Value: OP
Section.subject.awarenessCodeextensibleTargetAwareness
Section.informant.typeCoderequiredFixed Value: INF
Section.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
only-one-statementerrorSection.entry, Section.entry:encounterSHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act.
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

This structure is derived from EncountersSectionentriesoptional

Summary

Mandatory: 10 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Section.templateId is sliced based on the values of value:root, value:extension
  • The element Section.entry is sliced based on the value of value:encounter

Differential View

This structure is derived from EncountersSectionentriesoptional

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1EncountersSectionentriesoptionalBase for all types and resources
... nullFlavor 0..1codeRequired Pattern: NI
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:secondary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.22.1
..... extension 1..1stringRequired Pattern: 2015-08-01
... code 1..1CE
.... code 1..1stringRequired Pattern: 46240-8
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
... text 1..1xhtml
... Slices for entry 0..*ElementIf section/@nullFlavor is not present:
Slice: Unordered, Open by value:encounter
.... entry:encounter 1..*Element
..... encounter 1..1EncounterActivityBase for all types and resources

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1EncountersSectionentriesoptionalBase for all types and resources
... nullFlavor 0..1codeBinding: NullFlavor (required)
Required Pattern: NI
... classCode 1..1codeBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.22
..... extension 1..1stringRequired Pattern: 2015-08-01
.... templateId:secondary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.22.1
..... extension 1..1stringRequired Pattern: 2015-08-01
... code 1..1CEBinding: DocumentSectionType (extensible)
.... code 1..1stringRequired Pattern: 46240-8
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
... title 1..1ED
... text S1..1xhtml
... Slices for entry C0..*ElementIf section/@nullFlavor is not present:
Slice: Unordered, Open by value:encounter
.... entry:encounter C1..*Element
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... encounter 1..1EncounterActivityBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Section.nullFlavorrequiredPattern: NI
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.codeextensibleDocumentSectionType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
only-one-statementerrorSection.entry, Section.entry:encounterSHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act.
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1EncountersSectionentriesoptionalBase for all types and resources
... ID 0..1string
... nullFlavor 0..1codeBinding: NullFlavor (required)
Required Pattern: NI
... classCode 1..1codeBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.22
..... extension 1..1stringRequired Pattern: 2015-08-01
.... templateId:secondary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.22.1
..... extension 1..1stringRequired Pattern: 2015-08-01
... id 0..1II
... code 1..1CEBinding: DocumentSectionType (extensible)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: 46240-8
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... title 1..1ED
... text S1..1xhtml
... confidentialityCode 0..1CE
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... author 0..*Author
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... Slices for entry C0..*ElementIf section/@nullFlavor is not present:
Slice: Unordered, Open by value:encounter
.... entry:encounter C1..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... encounter 1..1EncounterActivityBase for all types and resources
... component 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeFixed Value: COMP
.... contextConductionInd 1..1boolean
.... section 1..1Section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Section.nullFlavorrequiredPattern: NI
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.templateId:primary.nullFlavorrequiredNullFlavor
Section.templateId:secondary.nullFlavorrequiredNullFlavor
Section.codeextensibleDocumentSectionType
Section.code.nullFlavorrequiredNullFlavor
Section.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Section.subject.typeCoderequiredFixed Value: SBJ
Section.subject.contextControlCoderequiredFixed Value: OP
Section.subject.awarenessCodeextensibleTargetAwareness
Section.informant.typeCoderequiredFixed Value: INF
Section.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
only-one-statementerrorSection.entry, Section.entry:encounterSHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act.
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

This structure is derived from EncountersSectionentriesoptional

Summary

Mandatory: 10 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Section.templateId is sliced based on the values of value:root, value:extension
  • The element Section.entry is sliced based on the value of value:encounter

 

​Other representations of profile: CSV, Excel, Schematron