This page is part of the CDA: Clinical Document Architecture (v2.0.1-sd: CDA 2.0 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Active as of 2024-12-18 |
Definitions for the EncompassingEncounter logical model.
Guidance on how to interpret the contents of this table can be found here
0. EncompassingEncounter | |
Control | 1..1 |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. EncompassingEncounter.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAActClass (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ENC |
4. EncompassingEncounter.moodCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAActMood (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | EVN |
6. EncompassingEncounter.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
8. EncompassingEncounter.code | |
Control | 0..1 |
Binding | For example codes, see ActEncounterCode (example to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
10. EncompassingEncounter.effectiveTime | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
12. EncompassingEncounter.sdtcAdmissionReferralSourceCode | |
Definition | This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameadmissionReferralSourceCode . |
14. EncompassingEncounter.dischargeDispositionCode | |
Control | 0..1 |
Binding | For example codes, see USEncounterDischargeDisposition (example to http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
16. EncompassingEncounter.responsibleParty | |
Definition | The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
18. EncompassingEncounter.responsibleParty.typeCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAParticipationType (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | RESP |
20. EncompassingEncounter.responsibleParty.assignedEntity | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity |
22. EncompassingEncounter.encounterParticipant | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant |
24. EncompassingEncounter.location | |
Definition | The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. The entity playing the role of HealthCareFacility is a place (Place class). The entity scoping the HealthCareFacility role is an organization (Organization class). The setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow. When the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
26. EncompassingEncounter.location.typeCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ParticipationTargetLocation (required to http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | LOC |
28. EncompassingEncounter.location.healthCareFacility | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility |
Guidance on how to interpret the contents of this table can be found here
0. EncompassingEncounter | |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system. |
Short | Base for all types and resources |
Control | 10..1* |
Is Modifier | false |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. EncompassingEncounter.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
4. EncompassingEncounter.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
6. EncompassingEncounter.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists() ) |
8. EncompassingEncounter.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
10. EncompassingEncounter.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
12. EncompassingEncounter.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
14. EncompassingEncounter.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
16. EncompassingEncounter.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
18. 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/cda/stds/core/StructureDefinition/II |
20. EncompassingEncounter.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAActClass (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ENC |
22. EncompassingEncounter.moodCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAActMood (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | EVN |
24. EncompassingEncounter.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
26. EncompassingEncounter.code | |
Control | 0..1 |
Binding | For example codes, see ActEncounterCode (example to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
28. EncompassingEncounter.effectiveTime | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
30. EncompassingEncounter.sdtcAdmissionReferralSourceCode | |
Definition | This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameadmissionReferralSourceCode . |
32. EncompassingEncounter.dischargeDispositionCode | |
Control | 0..1 |
Binding | For example codes, see USEncounterDischargeDisposition (example to http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
34. EncompassingEncounter.responsibleParty | |
Definition | The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
36. EncompassingEncounter.responsibleParty.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
38. EncompassingEncounter.responsibleParty.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
40. EncompassingEncounter.responsibleParty.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists() ) |
42. EncompassingEncounter.responsibleParty.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
44. EncompassingEncounter.responsibleParty.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
46. EncompassingEncounter.responsibleParty.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
48. EncompassingEncounter.responsibleParty.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
50. EncompassingEncounter.responsibleParty.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
52. EncompassingEncounter.responsibleParty.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/cda/stds/core/StructureDefinition/II |
54. EncompassingEncounter.responsibleParty.typeCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAParticipationType (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | RESP |
56. EncompassingEncounter.responsibleParty.assignedEntity | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity |
58. EncompassingEncounter.encounterParticipant | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant |
60. EncompassingEncounter.location | |
Definition | The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. The entity playing the role of HealthCareFacility is a place (Place class). The entity scoping the HealthCareFacility role is an organization (Organization class). The setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow. When the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
62. EncompassingEncounter.location.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
64. EncompassingEncounter.location.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
66. EncompassingEncounter.location.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists() ) |
68. EncompassingEncounter.location.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
70. EncompassingEncounter.location.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
72. EncompassingEncounter.location.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
74. EncompassingEncounter.location.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
76. EncompassingEncounter.location.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
78. EncompassingEncounter.location.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/cda/stds/core/StructureDefinition/II |
80. EncompassingEncounter.location.typeCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ParticipationTargetLocation (required to http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | LOC |
82. EncompassingEncounter.location.healthCareFacility | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility |
Guidance on how to interpret the contents of this table can be found here
0. EncompassingEncounter | |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
Short | Base for all types and resources |
Control | 1..1 |
Is Modifier | false |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. EncompassingEncounter.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
4. EncompassingEncounter.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
6. EncompassingEncounter.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists() ) |
8. EncompassingEncounter.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
10. EncompassingEncounter.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
12. EncompassingEncounter.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
14. EncompassingEncounter.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
16. EncompassingEncounter.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
18. 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/cda/stds/core/StructureDefinition/II |
20. EncompassingEncounter.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAActClass (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ENC |
22. EncompassingEncounter.moodCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAActMood (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | EVN |
24. EncompassingEncounter.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
26. EncompassingEncounter.code | |
Control | 0..1 |
Binding | For example codes, see ActEncounterCode (example to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
28. EncompassingEncounter.effectiveTime | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
30. EncompassingEncounter.sdtcAdmissionReferralSourceCode | |
Definition | This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameadmissionReferralSourceCode . |
32. EncompassingEncounter.dischargeDispositionCode | |
Control | 0..1 |
Binding | For example codes, see USEncounterDischargeDisposition (example to http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
34. EncompassingEncounter.responsibleParty | |
Definition | The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
36. EncompassingEncounter.responsibleParty.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
38. EncompassingEncounter.responsibleParty.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
40. EncompassingEncounter.responsibleParty.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists() ) |
42. EncompassingEncounter.responsibleParty.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
44. EncompassingEncounter.responsibleParty.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
46. EncompassingEncounter.responsibleParty.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
48. EncompassingEncounter.responsibleParty.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
50. EncompassingEncounter.responsibleParty.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
52. EncompassingEncounter.responsibleParty.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/cda/stds/core/StructureDefinition/II |
54. EncompassingEncounter.responsibleParty.typeCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAParticipationType (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | RESP |
56. EncompassingEncounter.responsibleParty.assignedEntity | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity |
58. EncompassingEncounter.encounterParticipant | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant |
60. EncompassingEncounter.location | |
Definition | The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. The entity playing the role of HealthCareFacility is a place (Place class). The entity scoping the HealthCareFacility role is an organization (Organization class). The setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow. When the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
62. EncompassingEncounter.location.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
64. EncompassingEncounter.location.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
66. EncompassingEncounter.location.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists() ) |
68. EncompassingEncounter.location.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
70. EncompassingEncounter.location.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
72. EncompassingEncounter.location.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
74. EncompassingEncounter.location.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
76. EncompassingEncounter.location.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
78. EncompassingEncounter.location.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/cda/stds/core/StructureDefinition/II |
80. EncompassingEncounter.location.typeCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ParticipationTargetLocation (required to http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | LOC |
82. EncompassingEncounter.location.healthCareFacility | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility |