Clinical Document Architecture V2.0.1
2.1.0 - CI Build

Clinical Document Architecture V2.0.1, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: Encounter (CDA Class)

Defining URL:http://hl7.org/fhir/cda/StructureDefinition/Encounter
Version:2.1.0
Name:CDAR2.Encounter
Title:Encounter (CDA Class)
Status:Active as of 2020-11-19T18:06:12+00:00
Definition:

A derivative of the RIM PatientEncounter class, used to represent related encounters, such as follow-up visits or referenced past encounters. NOTE: The EncompassingEncounter class in the CDA Header (see Header Relationships (§ 4.2.3 )) represents the setting of the clinical encounter during which the documented act occurred. The Encounter class in the CDA Body is used to represent other related encounters.

Publisher:Health Level 7
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/cda/StructureDefinition/Encounter

Formal Views of Profile Content

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

This structure is derived from Base

Summary

Mandatory: 0 element (19 nested mandatory elements)
Fixed Value: 9 elements

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: ENC
... moodCode 1..1code
... templateId 0..*II
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL_TS
.... modeCode 0..1CEBinding: ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Element
.... typeCode 1..1codeBinding: ParticipationType (required)
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... time 0..1IVL_TS
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship I0..*Elementenc-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... observation 0..1Observation
..... regionOfInterest 0..1RegionOfInterest
..... observationMedia 0..1ObservationMedia
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
..... procedure 0..1Procedure
..... encounter 0..1Encounter
..... organizer 0..1Organizer
..... act 0..1Act
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Element
.... typeCode 1..1codeBinding: ActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: ENC
... moodCode 1..1code
... templateId 0..*II
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL_TS
.... modeCode 0..1CEBinding: ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Element
.... typeCode 1..1codeBinding: ParticipationType (required)
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... time 0..1IVL_TS
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship I0..*Elementenc-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... observation 0..1Observation
..... regionOfInterest 0..1RegionOfInterest
..... observationMedia 0..1ObservationMedia
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
..... procedure 0..1Procedure
..... encounter 0..1Encounter
..... organizer 0..1Organizer
..... act 0..1Act
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Element
.... typeCode 1..1codeBinding: ActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element (19 nested mandatory elements)
Fixed Value: 9 elements

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: ENC
... moodCode 1..1code
... templateId 0..*II
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL_TS
.... modeCode 0..1CEBinding: ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Element
.... typeCode 1..1codeBinding: ParticipationType (required)
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... time 0..1IVL_TS
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship I0..*Elementenc-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... observation 0..1Observation
..... regionOfInterest 0..1RegionOfInterest
..... observationMedia 0..1ObservationMedia
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
..... procedure 0..1Procedure
..... encounter 0..1Encounter
..... organizer 0..1Organizer
..... act 0..1Act
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Element
.... typeCode 1..1codeBinding: ActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: ENC
... moodCode 1..1code
... templateId 0..*II
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL_TS
.... modeCode 0..1CEBinding: ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Element
.... typeCode 1..1codeBinding: ParticipationType (required)
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... time 0..1IVL_TS
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship I0..*Elementenc-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... observation 0..1Observation
..... regionOfInterest 0..1RegionOfInterest
..... observationMedia 0..1ObservationMedia
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
..... procedure 0..1Procedure
..... encounter 0..1Encounter
..... organizer 0..1Organizer
..... act 0..1Act
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Element
.... typeCode 1..1codeBinding: ActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Encounter.classCoderequiredFixed Value: ENC
Encounter.codeextensibleActEncounterCode
Encounter.statusCoderequiredActStatus
Encounter.priorityCodeextensibleActPriority
Encounter.subject.typeCoderequiredFixed Value: SBJ
Encounter.subject.contextControlCoderequiredFixed Value: OP
Encounter.subject.awarenessCodeextensibleTargetAwareness
Encounter.specimen.typeCoderequiredFixed Value: SPC
Encounter.performer.typeCoderequiredFixed Value: PRF
Encounter.performer.modeCodeextensibleParticipationMode
Encounter.informant.typeCoderequiredFixed Value: INF
Encounter.informant.contextControlCoderequiredFixed Value: OP
Encounter.participant.typeCoderequiredParticipationType
Encounter.participant.contextControlCoderequiredFixed Value: OP
Encounter.participant.awarenessCodeextensibleTargetAwareness
Encounter.precondition.typeCoderequiredFixed Value: PRCN

Constraints

IdPathDetailsRequirements
enc-er-1Encounter.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1