Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
XML representation of the EncompassingEncounter logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="EncompassingEncounter"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<p>This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note.</p>
<p>In some cases, the setting of the encounter is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is "Diabetes Clinic Progress Note". The setting of an encounter can also be transmitted in the HealthCareFacility.code attribute. If HealthCareFacility.code is sent, it should be equivalent to or further specialize the value inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply "Clinic Progress Note" and the value of HealthCareFacility.code is "cardiology clinic"), and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.</p>
<p>EncompassingEncounter.dischargeDispositionCode can be used to depict the disposition of the patient at the time of hospital discharge (e.g., discharged to home, expired, against medical advice, etc.).</p>
</div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:v3"/>
</extension>
<url
value="http://hl7.org/fhir/cda/StructureDefinition/EncompassingEncounter"/>
<version value="2.1.0-draft1"/>
<name value="CDAR2.EncompassingEncounter"/>
<title value="EncompassingEncounter (CDA Class)"/>
<status value="active"/>
<experimental value="false"/>
<date value="2023-01-16T16:39:50+11:00"/>
<publisher value="Health Level 7"/>
<contact>
<name value="HL7 International - Cross-Group Projects"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/cgp"/>
</telecom>
<telecom>
<system value="email"/>
<value value="cgp@lists.HL7.org"/>
</telecom>
</contact>
<description
value="This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note.
In some cases, the setting of the encounter is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is "Diabetes Clinic Progress Note". The setting of an encounter can also be transmitted in the HealthCareFacility.code attribute. If HealthCareFacility.code is sent, it should be equivalent to or further specialize the value inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply "Clinic Progress Note" and the value of HealthCareFacility.code is "cardiology clinic"), and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.
EncompassingEncounter.dischargeDispositionCode can be used to depict the disposition of the patient at the time of hospital discharge (e.g., discharged to home, expired, against medical advice, etc.)."/>
<fhirVersion value="5.0.0-snapshot3"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type value="EncompassingEncounter"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
<derivation value="specialization"/>
<snapshot>
<element id="EncompassingEncounter">
<path value="EncompassingEncounter"/>
<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="EncompassingEncounter.classCode">
<path value="EncompassingEncounter.classCode"/>
<representation value="xmlAttr"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="EncompassingEncounter.classCode"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<defaultValueCode value="ENC"/>
<fixedCode value="ENC"/>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActClass"/>
</binding>
</element>
<element id="EncompassingEncounter.moodCode">
<path value="EncompassingEncounter.moodCode"/>
<representation value="xmlAttr"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="EncompassingEncounter.moodCode"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<defaultValueCode value="EVN"/>
<fixedCode value="EVN"/>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActMood"/>
</binding>
</element>
<element id="EncompassingEncounter.templateId">
<path value="EncompassingEncounter.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="EncompassingEncounter.templateId"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
</type>
</element>
<element id="EncompassingEncounter.id">
<path value="EncompassingEncounter.id"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="EncompassingEncounter.id"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
</type>
</element>
<element id="EncompassingEncounter.code">
<path value="EncompassingEncounter.code"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EncompassingEncounter.code"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
</type>
<binding>
<strength value="extensible"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"/>
</binding>
</element>
<element id="EncompassingEncounter.effectiveTime">
<path value="EncompassingEncounter.effectiveTime"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="EncompassingEncounter.effectiveTime"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"/>
</type>
</element>
<element id="EncompassingEncounter.sdtcAdmissionReferralSourceCode">
<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">
<valueString value="admissionReferralSourceCode"/>
</extension>
<path value="EncompassingEncounter.sdtcAdmissionReferralSourceCode"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EncompassingEncounter.sdtcAdmissionReferralSourceCode"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
</type>
</element>
<element id="EncompassingEncounter.dischargeDispositionCode">
<path value="EncompassingEncounter.dischargeDispositionCode"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EncompassingEncounter.dischargeDispositionCode"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
</type>
<binding>
<strength value="extensible"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition"/>
</binding>
</element>
<element id="EncompassingEncounter.responsibleParty">
<path value="EncompassingEncounter.responsibleParty"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EncompassingEncounter.responsibleParty"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Element"/>
</type>
<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>
</element>
<element id="EncompassingEncounter.responsibleParty.id">
<path value="EncompassingEncounter.responsibleParty.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="EncompassingEncounter.responsibleParty.extension">
<path value="EncompassingEncounter.responsibleParty.extension"/>
<slicing>
<discriminator>
<type value="value"/>
<path value="url"/>
</discriminator>
<description value="Extensions are always sliced by (at least) url"/>
<rules value="open"/>
</slicing>
<short value="Additional content defined by implementations"/>
<definition
value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
<comment
value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<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>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="EncompassingEncounter.responsibleParty.typeCode">
<path value="EncompassingEncounter.responsibleParty.typeCode"/>
<representation value="xmlAttr"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="EncompassingEncounter.responsibleParty.typeCode"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<defaultValueCode value="RESP"/>
<fixedCode value="RESP"/>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-ParticipationType"/>
</binding>
</element>
<element id="EncompassingEncounter.responsibleParty.assignedEntity">
<path value="EncompassingEncounter.responsibleParty.assignedEntity"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="EncompassingEncounter.responsibleParty.assignedEntity"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code
value="http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"/>
</type>
</element>
<element id="EncompassingEncounter.encounterParticipant">
<path value="EncompassingEncounter.encounterParticipant"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="EncompassingEncounter.encounterParticipant"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant"/>
</type>
</element>
<element id="EncompassingEncounter.location">
<path value="EncompassingEncounter.location"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EncompassingEncounter.location"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Element"/>
</type>
<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>
</element>
<element id="EncompassingEncounter.location.id">
<path value="EncompassingEncounter.location.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="EncompassingEncounter.location.extension">
<path value="EncompassingEncounter.location.extension"/>
<slicing>
<discriminator>
<type value="value"/>
<path value="url"/>
</discriminator>
<description value="Extensions are always sliced by (at least) url"/>
<rules value="open"/>
</slicing>
<short value="Additional content defined by implementations"/>
<definition
value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
<comment
value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<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>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="EncompassingEncounter.location.typeCode">
<path value="EncompassingEncounter.location.typeCode"/>
<representation value="xmlAttr"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="EncompassingEncounter.location.typeCode"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<defaultValueCode value="LOC"/>
<fixedCode value="LOC"/>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation"/>
</binding>
</element>
<element id="EncompassingEncounter.location.healthCareFacility">
<path value="EncompassingEncounter.location.healthCareFacility"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="EncompassingEncounter.location.healthCareFacility"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code
value="http://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility"/>
</type>
</element>
</snapshot>
<differential>
<element id="EncompassingEncounter">
<path value="EncompassingEncounter"/>
<min value="1"/>
<max value="1"/>
</element>
<element id="EncompassingEncounter.classCode">
<path value="EncompassingEncounter.classCode"/>
<representation value="xmlAttr"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
<defaultValueCode value="ENC"/>
<fixedCode value="ENC"/>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActClass"/>
</binding>
</element>
<element id="EncompassingEncounter.moodCode">
<path value="EncompassingEncounter.moodCode"/>
<representation value="xmlAttr"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
<defaultValueCode value="EVN"/>
<fixedCode value="EVN"/>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActMood"/>
</binding>
</element>
<element id="EncompassingEncounter.templateId">
<path value="EncompassingEncounter.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/fhir/cda/StructureDefinition/II"/>
</type>
</element>
<element id="EncompassingEncounter.id">
<path value="EncompassingEncounter.id"/>
<min value="0"/>
<max value="*"/>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
</type>
</element>
<element id="EncompassingEncounter.code">
<path value="EncompassingEncounter.code"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
</type>
<binding>
<strength value="extensible"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"/>
</binding>
</element>
<element id="EncompassingEncounter.effectiveTime">
<path value="EncompassingEncounter.effectiveTime"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"/>
</type>
</element>
<element id="EncompassingEncounter.sdtcAdmissionReferralSourceCode">
<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">
<valueString value="admissionReferralSourceCode"/>
</extension>
<path value="EncompassingEncounter.sdtcAdmissionReferralSourceCode"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
</type>
</element>
<element id="EncompassingEncounter.dischargeDispositionCode">
<path value="EncompassingEncounter.dischargeDispositionCode"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
</type>
<binding>
<strength value="extensible"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition"/>
</binding>
</element>
<element id="EncompassingEncounter.responsibleParty">
<path value="EncompassingEncounter.responsibleParty"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Element"/>
</type>
</element>
<element id="EncompassingEncounter.responsibleParty.typeCode">
<path value="EncompassingEncounter.responsibleParty.typeCode"/>
<representation value="xmlAttr"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
<defaultValueCode value="RESP"/>
<fixedCode value="RESP"/>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-ParticipationType"/>
</binding>
</element>
<element id="EncompassingEncounter.responsibleParty.assignedEntity">
<path value="EncompassingEncounter.responsibleParty.assignedEntity"/>
<min value="1"/>
<max value="1"/>
<type>
<code
value="http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"/>
</type>
</element>
<element id="EncompassingEncounter.encounterParticipant">
<path value="EncompassingEncounter.encounterParticipant"/>
<min value="0"/>
<max value="*"/>
<type>
<code
value="http://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant"/>
</type>
</element>
<element id="EncompassingEncounter.location">
<path value="EncompassingEncounter.location"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Element"/>
</type>
</element>
<element id="EncompassingEncounter.location.typeCode">
<path value="EncompassingEncounter.location.typeCode"/>
<representation value="xmlAttr"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
<defaultValueCode value="LOC"/>
<fixedCode value="LOC"/>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation"/>
</binding>
</element>
<element id="EncompassingEncounter.location.healthCareFacility">
<path value="EncompassingEncounter.location.healthCareFacility"/>
<min value="1"/>
<max value="1"/>
<type>
<code
value="http://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility"/>
</type>
</element>
</differential>
</StructureDefinition>
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change