Search FHIR

FR Document Core (CDA)
0.1.0 - ci-build France (la) flag

FR Document Core (CDA) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: CDA - encompassingEncounter - Detailed Descriptions

Draft as of 2026-08-28

Definitions for the fr-cda-encompassing-encounter logical model

Guidance on how to interpret the contents of this table can be foundhere

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.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn 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.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional 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

Control0..*
Typehttp://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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-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.

Control0..0
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional 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.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning 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).

Control0..0
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
14. EncompassingEncounter.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.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.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
20. EncompassingEncounter.classCode
Control0..1
BindingThe codes SHALL be taken from CDAActClass (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueENC
22. EncompassingEncounter.moodCode
Control0..1
BindingThe codes SHALL be taken from CDAActMood (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
24. EncompassingEncounter.id
ShortIdentifiant de la prise en charge
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
26. EncompassingEncounter.code
ShortType de prise en charge
Control0..1
BindingThe codes SHALL be taken from JDV_J142_TypeRencontre_CISIS (20210326120000)
(required to https://mos.esante.gouv.fr/NOS/JDV_J142-TypeRencontre-CISIS/FHIR/JDV-J142-TypeRencontre-CISIS|20210326120000)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
28. EncompassingEncounter.code.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..0
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
30. EncompassingEncounter.code.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode
32. EncompassingEncounter.code.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System
34. EncompassingEncounter.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Name
36. EncompassingEncounter.code.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Version
38. EncompassingEncounter.code.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplay Name
40. EncompassingEncounter.code.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..0
Typestring(oid: ISO Object Identifier)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
42. EncompassingEncounter.code.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
44. EncompassingEncounter.code.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
46. EncompassingEncounter.code.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
48. EncompassingEncounter.code.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
50. EncompassingEncounter.effectiveTime
ShortDate de début et de fin de la prise en charge
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
52. EncompassingEncounter.sdtcAdmissionReferralSourceCode
Definition

This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter.

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameadmissionReferralSourceCode.
54. EncompassingEncounter.dischargeDispositionCode
ShortType sortie
Control0..1
BindingFor example codes, see USEncounterDischargeDisposition (5.0.0)
(example to http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition|5.0.0)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
56. 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.

ShortResponsable de la prise en charge
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
58. EncompassingEncounter.responsibleParty.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..0
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
60. 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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
62. 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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
64. 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.

Control0..0
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
66. 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.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
68. 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).

Control0..0
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
70. EncompassingEncounter.responsibleParty.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
72. EncompassingEncounter.responsibleParty.typeId.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
74. 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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
76. EncompassingEncounter.responsibleParty.typeCode
Control0..1
BindingThe codes SHALL be taken from CDAParticipationType (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueRESP
78. EncompassingEncounter.responsibleParty.assignedEntity
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
80. EncompassingEncounter.encounterParticipant
ShortPersonne impliquée dans la prise en charge
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant(CDA - encounterParticipant)
82. 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.

ShortLieu de la prise en charge
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
84. EncompassingEncounter.location.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..0
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
86. 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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
88. 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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
90. 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.

Control0..0
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
92. 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.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
94. 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).

Control0..0
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
96. EncompassingEncounter.location.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
98. EncompassingEncounter.location.typeId.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
100. 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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
102. EncompassingEncounter.location.typeCode
Control0..0
BindingThe codes SHALL be taken from ParticipationTargetLocation (3.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation|3.0.0)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueLOC
104. EncompassingEncounter.location.healthCareFacility
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility(CDA - healthCareFacility)

Guidance on how to interpret the contents of this table can be foundhere

0. EncompassingEncounter
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. EncompassingEncounter.typeId
4. EncompassingEncounter.typeId.nullFlavor
Control0..0
6. EncompassingEncounter.typeId.assigningAuthorityName
Control0..0
8. EncompassingEncounter.typeId.displayable
Control0..0
10. EncompassingEncounter.id
ShortIdentifiant de la prise en charge
12. EncompassingEncounter.code
ShortType de prise en charge
BindingThe codes SHALL be taken from JDV_J142_TypeRencontre_CISIS (20210326120000)
(required to https://mos.esante.gouv.fr/NOS/JDV_J142-TypeRencontre-CISIS/FHIR/JDV-J142-TypeRencontre-CISIS|20210326120000)
14. EncompassingEncounter.code.nullFlavor
Control0..0
16. EncompassingEncounter.code.codeSystem
Control1..?
18. EncompassingEncounter.code.codeSystemVersion
Control0..0
20. EncompassingEncounter.code.displayName
Control1..?
22. EncompassingEncounter.code.sdtcValueSet
Control0..0
24. EncompassingEncounter.code.sdtcValueSetVersion
Control0..0
26. EncompassingEncounter.effectiveTime
ShortDate de début et de fin de la prise en charge
28. EncompassingEncounter.sdtcAdmissionReferralSourceCode
Control0..0
30. EncompassingEncounter.dischargeDispositionCode
ShortType sortie
32. EncompassingEncounter.responsibleParty
ShortResponsable de la prise en charge
34. EncompassingEncounter.responsibleParty.nullFlavor
Control0..0
36. EncompassingEncounter.responsibleParty.typeId
38. EncompassingEncounter.responsibleParty.typeId.nullFlavor
Control0..0
40. EncompassingEncounter.responsibleParty.typeId.assigningAuthorityName
Control0..0
42. EncompassingEncounter.responsibleParty.typeId.displayable
Control0..0
44. EncompassingEncounter.encounterParticipant
ShortPersonne impliquée dans la prise en charge
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant(CDA - encounterParticipant)
46. EncompassingEncounter.location
ShortLieu de la prise en charge
Control1..?
48. EncompassingEncounter.location.nullFlavor
Control0..0
50. EncompassingEncounter.location.typeId
52. EncompassingEncounter.location.typeId.nullFlavor
Control0..0
54. EncompassingEncounter.location.typeId.assigningAuthorityName
Control0..0
56. EncompassingEncounter.location.typeId.displayable
Control0..0
58. EncompassingEncounter.location.typeCode
Control0..0
60. EncompassingEncounter.location.healthCareFacility
Typehttp://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility(CDA - healthCareFacility)

Guidance on how to interpret the contents of this table can be foundhere

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.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn 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.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional 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

Control0..*
Typehttp://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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-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.

Control0..0
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional 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.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning 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).

Control0..0
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
14. EncompassingEncounter.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.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.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
20. EncompassingEncounter.classCode
Control0..1
BindingThe codes SHALL be taken from CDAActClass (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueENC
22. EncompassingEncounter.moodCode
Control0..1
BindingThe codes SHALL be taken from CDAActMood (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
24. EncompassingEncounter.id
ShortIdentifiant de la prise en charge
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
26. EncompassingEncounter.code
ShortType de prise en charge
Control0..1
BindingThe codes SHALL be taken from JDV_J142_TypeRencontre_CISIS (20210326120000)
(required to https://mos.esante.gouv.fr/NOS/JDV_J142-TypeRencontre-CISIS/FHIR/JDV-J142-TypeRencontre-CISIS|20210326120000)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
28. EncompassingEncounter.code.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..0
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
30. EncompassingEncounter.code.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode
32. EncompassingEncounter.code.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System
34. EncompassingEncounter.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Name
36. EncompassingEncounter.code.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Version
38. EncompassingEncounter.code.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplay Name
40. EncompassingEncounter.code.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..0
Typestring(oid: ISO Object Identifier)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
42. EncompassingEncounter.code.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
44. EncompassingEncounter.code.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
46. EncompassingEncounter.code.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
48. EncompassingEncounter.code.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
50. EncompassingEncounter.effectiveTime
ShortDate de début et de fin de la prise en charge
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
52. EncompassingEncounter.sdtcAdmissionReferralSourceCode
Definition

This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter.

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameadmissionReferralSourceCode.
54. EncompassingEncounter.dischargeDispositionCode
ShortType sortie
Control0..1
BindingFor example codes, see USEncounterDischargeDisposition (5.0.0)
(example to http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition|5.0.0)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
56. 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.

ShortResponsable de la prise en charge
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
58. EncompassingEncounter.responsibleParty.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..0
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
60. 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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
62. 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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
64. 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.

Control0..0
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
66. 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.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
68. 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).

Control0..0
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
70. EncompassingEncounter.responsibleParty.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
72. EncompassingEncounter.responsibleParty.typeId.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
74. 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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
76. EncompassingEncounter.responsibleParty.typeCode
Control0..1
BindingThe codes SHALL be taken from CDAParticipationType (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueRESP
78. EncompassingEncounter.responsibleParty.assignedEntity
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
80. EncompassingEncounter.encounterParticipant
ShortPersonne impliquée dans la prise en charge
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant(CDA - encounterParticipant)
82. 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.

ShortLieu de la prise en charge
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
84. EncompassingEncounter.location.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..0
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
86. 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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
88. 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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
90. 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.

Control0..0
BindingThe codes SHALL be taken from CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
92. 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.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
94. 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).

Control0..0
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
96. EncompassingEncounter.location.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
98. EncompassingEncounter.location.typeId.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
100. 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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
102. EncompassingEncounter.location.typeCode
Control0..0
BindingThe codes SHALL be taken from ParticipationTargetLocation (3.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation|3.0.0)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueLOC
104. EncompassingEncounter.location.healthCareFacility
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility(CDA - healthCareFacility)