Clinical Document Architecture
2.0.1 - active
Clinical Document Architecture
2.0.1 - active
Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). 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
| Active as of 2023-10-03 |
XML representation of the Encounter logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Encounter"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<p>A derivative of the RIM PatientEncounter class, used to represent related encounters, such as follow-up visits or referenced past encounters.</p>
<p>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.</p>
</div>
</text>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
<valueBoolean>
<extension
url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
<valueCode value="not-applicable"/>
</extension>
</valueBoolean>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:v3"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
<valueUri value="encounter"/>
</extension>
<url value="http://hl7.org/cda/stds/core/StructureDefinition/Encounter"/>
<version value="2.0.1"/>
<name value="CDAR2.Encounter"/>
<title value="Encounter (CDA Class)"/>
<status value="active"/>
<experimental value="false"/>
<date value="2023-10-03T20:44:04+00:00"/>
<publisher value="Health Level 7"/>
<contact>
<name value="HL7 International - Structured Documents"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/structdoc"/>
</telecom>
<telecom>
<system value="email"/>
<value value="structdog@lists.HL7.org"/>
</telecom>
</contact>
<description
value="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."/>
<fhirVersion value="5.0.0"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type value="http://hl7.org/cda/stds/core/StructureDefinition/Encounter"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
<derivation value="specialization"/>
<snapshot>
<element id="Encounter">
<path value="Encounter"/>
<short value="Base for all types and resources"/>
<definition
value="Base definition for all types defined in FHIR type system."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Encounter.classCode">
<path value="Encounter.classCode"/>
<representation value="xmlAttr"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Encounter.classCode"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="ENC"/>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActClass"/>
</binding>
</element>
<element id="Encounter.moodCode">
<path value="Encounter.moodCode"/>
<representation value="xmlAttr"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Encounter.moodCode"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
</element>
<element id="Encounter.realmCode">
<path value="Encounter.realmCode"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Encounter.realmCode"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
</type>
</element>
<element id="Encounter.typeId">
<path value="Encounter.typeId"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Encounter.typeId"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
</type>
</element>
<element id="Encounter.templateId">
<path value="Encounter.templateId"/>
<definition
value="When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Encounter.templateId"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
</type>
</element>
<element id="Encounter.id">
<path value="Encounter.id"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Encounter.id"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
</type>
</element>
<element id="Encounter.code">
<path value="Encounter.code"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Encounter.code"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CD"/>
</type>
<binding>
<strength value="extensible"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"/>
</binding>
</element>
<element id="Encounter.text">
<path value="Encounter.text"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Encounter.text"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ED"/>
</type>
</element>
<element id="Encounter.statusCode">
<path value="Encounter.statusCode"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Encounter.statusCode"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActStatus"/>
</binding>
</element>
<element id="Encounter.effectiveTime">
<path value="Encounter.effectiveTime"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Encounter.effectiveTime"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"/>
</type>
</element>
<element id="Encounter.sdtcDischargeDispositionCode">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
<valueUri value="dischargeDispositionCode"/>
</extension>
<path value="Encounter.sdtcDischargeDispositionCode"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Encounter.sdtcDischargeDispositionCode"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CE"/>
</type>
</element>
<element id="Encounter.priorityCode">
<path value="Encounter.priorityCode"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Encounter.priorityCode"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CE"/>
</type>
<binding>
<strength value="extensible"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActPriority"/>
</binding>
</element>
<element id="Encounter.subject">
<path value="Encounter.subject"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Encounter.subject"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Subject"/>
</type>
</element>
<element id="Encounter.specimen">
<path value="Encounter.specimen"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Encounter.specimen"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Specimen"/>
</type>
</element>
<element id="Encounter.performer">
<path value="Encounter.performer"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Encounter.performer"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Performer2"/>
</type>
</element>
<element id="Encounter.author">
<path value="Encounter.author"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Encounter.author"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Author"/>
</type>
</element>
<element id="Encounter.informant">
<path value="Encounter.informant"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Encounter.informant"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Informant"/>
</type>
</element>
<element id="Encounter.participant">
<path value="Encounter.participant"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Encounter.participant"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Participant2"/>
</type>
</element>
<element id="Encounter.entryRelationship">
<path value="Encounter.entryRelationship"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Encounter.entryRelationship"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"/>
</type>
</element>
<element id="Encounter.reference">
<path value="Encounter.reference"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Encounter.reference"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Reference"/>
</type>
</element>
<element id="Encounter.precondition">
<path value="Encounter.precondition"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Encounter.precondition"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Precondition"/>
</type>
</element>
</snapshot>
<differential>
<element id="Encounter">
<path value="Encounter"/>
<min value="1"/>
<max value="1"/>
</element>
<element id="Encounter.classCode">
<path value="Encounter.classCode"/>
<representation value="xmlAttr"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="ENC"/>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActClass"/>
</binding>
</element>
<element id="Encounter.moodCode">
<path value="Encounter.moodCode"/>
<representation value="xmlAttr"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
</element>
<element id="Encounter.realmCode">
<path value="Encounter.realmCode"/>
<min value="0"/>
<max value="*"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
</type>
</element>
<element id="Encounter.typeId">
<path value="Encounter.typeId"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
</type>
</element>
<element id="Encounter.templateId">
<path value="Encounter.templateId"/>
<definition
value="When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"/>
<min value="0"/>
<max value="*"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
</type>
</element>
<element id="Encounter.id">
<path value="Encounter.id"/>
<min value="0"/>
<max value="*"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
</type>
</element>
<element id="Encounter.code">
<path value="Encounter.code"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CD"/>
</type>
<binding>
<strength value="extensible"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"/>
</binding>
</element>
<element id="Encounter.text">
<path value="Encounter.text"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ED"/>
</type>
</element>
<element id="Encounter.statusCode">
<path value="Encounter.statusCode"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActStatus"/>
</binding>
</element>
<element id="Encounter.effectiveTime">
<path value="Encounter.effectiveTime"/>
<min value="0"/>
<max value="1"/>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"/>
</type>
</element>
<element id="Encounter.sdtcDischargeDispositionCode">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
<valueUri value="dischargeDispositionCode"/>
</extension>
<path value="Encounter.sdtcDischargeDispositionCode"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CE"/>
</type>
</element>
<element id="Encounter.priorityCode">
<path value="Encounter.priorityCode"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CE"/>
</type>
<binding>
<strength value="extensible"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActPriority"/>
</binding>
</element>
<element id="Encounter.subject">
<path value="Encounter.subject"/>
<min value="0"/>
<max value="1"/>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Subject"/>
</type>
</element>
<element id="Encounter.specimen">
<path value="Encounter.specimen"/>
<min value="0"/>
<max value="*"/>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Specimen"/>
</type>
</element>
<element id="Encounter.performer">
<path value="Encounter.performer"/>
<min value="0"/>
<max value="*"/>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Performer2"/>
</type>
</element>
<element id="Encounter.author">
<path value="Encounter.author"/>
<min value="0"/>
<max value="*"/>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Author"/>
</type>
</element>
<element id="Encounter.informant">
<path value="Encounter.informant"/>
<min value="0"/>
<max value="*"/>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Informant"/>
</type>
</element>
<element id="Encounter.participant">
<path value="Encounter.participant"/>
<min value="0"/>
<max value="*"/>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Participant2"/>
</type>
</element>
<element id="Encounter.entryRelationship">
<path value="Encounter.entryRelationship"/>
<min value="0"/>
<max value="*"/>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"/>
</type>
</element>
<element id="Encounter.reference">
<path value="Encounter.reference"/>
<min value="0"/>
<max value="*"/>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Reference"/>
</type>
</element>
<element id="Encounter.precondition">
<path value="Encounter.precondition"/>
<min value="0"/>
<max value="*"/>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Precondition"/>
</type>
</element>
</differential>
</StructureDefinition>
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.1 based on FHIR 5.0.0. Generated 2023-10-03
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change