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 |
Definitions for the EncompassingEncounter logical model.
Guidance on how to interpret the contents of this table can be found here.
| 1. EncompassingEncounter | |
| Control | 1..1 |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. EncompassingEncounter.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ENC |
| Fixed Value | ENC |
| 3. EncompassingEncounter.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 4. EncompassingEncounter.templateId | |
| Definition | 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 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 5. EncompassingEncounter.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 6. EncompassingEncounter.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 7. EncompassingEncounter.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| 8. EncompassingEncounter.sdtcAdmissionReferralSourceCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name admissionReferralSourceCode. |
| 9. EncompassingEncounter.dischargeDispositionCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from USEncounterDischargeDisposition; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 10. EncompassingEncounter.responsibleParty | |
| Control | 0..1 |
| Type | Element |
| 11. EncompassingEncounter.responsibleParty.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | RESP |
| Fixed Value | RESP |
| 12. EncompassingEncounter.responsibleParty.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 13. EncompassingEncounter.encounterParticipant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant |
| 14. EncompassingEncounter.location | |
| Control | 0..1 |
| Type | Element |
| 15. EncompassingEncounter.location.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetLocation |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | LOC |
| Fixed Value | LOC |
| 16. EncompassingEncounter.location.healthCareFacility | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility |
Guidance on how to interpret the contents of this table can be found here.
| 1. EncompassingEncounter | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 10..1* |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 2. EncompassingEncounter.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ENC |
| Fixed Value | ENC |
| 3. EncompassingEncounter.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 4. EncompassingEncounter.templateId | |
| Definition | 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 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 5. EncompassingEncounter.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 6. EncompassingEncounter.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 7. EncompassingEncounter.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| 8. EncompassingEncounter.sdtcAdmissionReferralSourceCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name admissionReferralSourceCode. |
| 9. EncompassingEncounter.dischargeDispositionCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from USEncounterDischargeDisposition; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 10. EncompassingEncounter.responsibleParty | |
| Control | 0..1 |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 11. EncompassingEncounter.responsibleParty.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | RESP |
| Fixed Value | RESP |
| 12. EncompassingEncounter.responsibleParty.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 13. EncompassingEncounter.encounterParticipant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant |
| 14. EncompassingEncounter.location | |
| Control | 0..1 |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 15. EncompassingEncounter.location.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetLocation |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | LOC |
| Fixed Value | LOC |
| 16. EncompassingEncounter.location.healthCareFacility | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility |
Guidance on how to interpret the contents of this table can be found here.
| 1. EncompassingEncounter | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. EncompassingEncounter.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ENC |
| Fixed Value | ENC |
| 3. EncompassingEncounter.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 4. EncompassingEncounter.templateId | |
| Definition | 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 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 5. EncompassingEncounter.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 6. EncompassingEncounter.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 7. EncompassingEncounter.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| 8. EncompassingEncounter.sdtcAdmissionReferralSourceCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name admissionReferralSourceCode. |
| 9. EncompassingEncounter.dischargeDispositionCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from USEncounterDischargeDisposition; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 10. EncompassingEncounter.responsibleParty | |
| Control | 0..1 |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 11. EncompassingEncounter.responsibleParty.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 12. EncompassingEncounter.responsibleParty.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on EncompassingEncounter.responsibleParty.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 13. EncompassingEncounter.responsibleParty.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | RESP |
| Fixed Value | RESP |
| 14. EncompassingEncounter.responsibleParty.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 15. EncompassingEncounter.encounterParticipant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant |
| 16. EncompassingEncounter.location | |
| Control | 0..1 |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 17. EncompassingEncounter.location.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 18. EncompassingEncounter.location.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on EncompassingEncounter.location.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 19. EncompassingEncounter.location.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetLocation |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | LOC |
| Fixed Value | LOC |
| 20. EncompassingEncounter.location.healthCareFacility | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility |
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