ANS IG document core
0.1.0 - ci-build

ANS IG document core - version de développement local (v0.1.0) construite par les outils de publication FHIR (HL7® FHIR® Standard). Voir le répertoire des versions publiées

## Logical Model: FRCDARelatedEntity - Detailed Descriptions

Draft as of 2025-12-15

Definitions for the fr-cda-related-entity logical model.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Des conseils sur linterprétation du contenu de ce tableau peuvent être trouvésici

0. RelatedEntity
Définition | 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.
Court | Base for all types and resources
Contrôle | 10..1*
Est modificateur | false
Conteneur logique | ClinicalDocument (CDA Class)
Validation | Les instances de ce type sont validées par templateId
Format XML | Dans le format XML, cette propriété a lespace de noms (namespace) `urn:hl7-org:v3`.
2. RelatedEntity.nullFlavor
Définition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Contrôle | 0..0
Binding | Les codes DOIVENT (SHALL) être pris de CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Exceptional Value Detail
4. RelatedEntity.realmCode
Définition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Contrôle | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
6. RelatedEntity.typeId
Définition | 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.
Contrôle | 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. RelatedEntity.typeId.nullFlavor
Définition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Contrôle | 0..0
Binding | Les codes DOIVENT (SHALL) être pris de CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Exceptional Value Detail
10. RelatedEntity.typeId.assigningAuthorityName
Définition | 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.
Contrôle | 0..0
Type | string(st: Character String)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Assigning Authority Name
12. RelatedEntity.typeId.displayable
Définition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Contrôle | 0..0
Type | boolean(bl: Boolean)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Displayable
14. RelatedEntity.typeId.root
Définition | Identifies the type as an HL7 Registered model
Contrôle | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Root
Valeur fixe | `2.16.840.1.113883.1.3`
16. RelatedEntity.typeId.extension
Définition | A character string as a unique identifier within the scope of the identifier root.
Contrôle | 1..1
Type | string(st: Character String)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Extension
18. RelatedEntity.templateId
Définition | 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
Contrôle | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
20. RelatedEntity.classCode
Court | Rôle joué par la personne.
Contrôle | 1..1
Binding | Les codes DOIVENT (SHALL) être pris de Jdv Role Informateur CISIS (required to `https://smt.esante.gouv.fr/fhir/ValueSet/jdv-role-informateur-cisis` )
Type | code(cs: Coded Simple Value)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
22. RelatedEntity.code
Court | Lien de la personne avec le patient/usager.
Contrôle | 0..1
Binding | Les codes DOIVENT (SHALL) être pris de JDV_J11_RelationPatient_CISIS (required to `https://mos.esante.gouv.fr/NOS/JDV_J11-RelationPatient-CISIS/FHIR/JDV-J11-RelationPatient-CISIS` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
24. RelatedEntity.code.nullFlavor
Définition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Contrôle | 0..0
Binding | Les codes DOIVENT (SHALL) être pris de CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Exceptional Value Detail
26. RelatedEntity.code.code
Définition | 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.
Contrôle | 1..1
Type | code(cs: Coded Simple Value)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Code
28. RelatedEntity.code.codeSystem
Définition | Specifies the code system that defines the code.
Contrôle | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Code System
30. RelatedEntity.code.codeSystemName
Définition | The common name of the coding system.
Contrôle | 0..1
Type | string(st: Character String)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Code System Name
32. RelatedEntity.code.codeSystemVersion
Définition | If applicable, a version descriptor defined specifically for the given code system.
Contrôle | 0..0
Type | string(st: Character String)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Code System Version
34. RelatedEntity.code.displayName
Définition | A name or title for the code, under which the sending system shows the code value to its users.
Contrôle | 1..1
Type | string(st: Character String)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Display Name
36. RelatedEntity.code.sdtcValueSet
Définition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Contrôle | 0..0
Type | string(oid: ISO Object Identifier)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.Dans le format XML, cette propriété a lespace de noms (namespace) `urn:hl7-org:sdtc`.Dans le format XML, cette propriété a le nom réel`valueSet`.
38. RelatedEntity.code.sdtcValueSetVersion
Définition | 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.
Contrôle | 0..0
Type | string(st: Character String)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.Dans le format XML, cette propriété a lespace de noms (namespace) `urn:hl7-org:sdtc`.Dans le format XML, cette propriété a le nom réel`valueSetVersion`.
40. RelatedEntity.code.originalText
Définition | The text or phrase used as the basis for the coding.
Contrôle | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Étiquette | Original Text
42. RelatedEntity.code.qualifier
Définition | Specifies additional codes that increase the specificity of the the primary code.
Contrôle | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Étiquette | Qualifier
44. RelatedEntity.code.translation
Définition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Contrôle | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
Format XML | Le type de cette propriété est déterminé en utilisant le `xsi:type`attribute.
Étiquette | Translation
46. RelatedEntity.addr
Court | Adresse géopostale.
Contrôle | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
48. RelatedEntity.telecom
Court | Coordonnées télécom.
Contrôle | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
50. RelatedEntity.effectiveTime
Contrôle | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
52. RelatedEntity.relatedPerson
Court | Personne physique.
Contrôle | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person(CDA - assignedPerson)

Des conseils sur linterprétation du contenu de ce tableau peuvent être trouvésici

0. RelatedEntity
Conteneur logique | ClinicalDocument (CDA Class)
Validation | Les instances de ce type sont validées par templateId
Format XML | Dans le format XML, cette propriété a lespace de noms (namespace) `urn:hl7-org:v3`.
2. RelatedEntity.nullFlavor
Contrôle | 0..0
4. RelatedEntity.typeId
6. RelatedEntity.typeId.nullFlavor
Contrôle | 0..0
8. RelatedEntity.typeId.assigningAuthorityName
Contrôle | 0..0
10. RelatedEntity.typeId.displayable
Contrôle | 0..0
12. RelatedEntity.classCode
Court | Rôle joué par la personne.
Binding | Les codes DOIVENT (SHALL) être pris de Jdv Role Informateur CISIS (required to `https://smt.esante.gouv.fr/fhir/ValueSet/jdv-role-informateur-cisis` )
14. RelatedEntity.code
Court | Lien de la personne avec le patient/usager.
Binding | Les codes DOIVENT (SHALL) être pris de JDV_J11_RelationPatient_CISIS (required to `https://mos.esante.gouv.fr/NOS/JDV_J11-RelationPatient-CISIS/FHIR/JDV-J11-RelationPatient-CISIS` )
16. RelatedEntity.code.nullFlavor
Contrôle | 0..0
18. RelatedEntity.code.code
Contrôle | 1..?
20. RelatedEntity.code.codeSystem
Contrôle | 1..?
22. RelatedEntity.code.codeSystemVersion
Contrôle | 0..0
24. RelatedEntity.code.displayName
Contrôle | 1..?
26. RelatedEntity.code.sdtcValueSet
Contrôle | 0..0
28. RelatedEntity.code.sdtcValueSetVersion
Contrôle | 0..0
30. RelatedEntity.addr
Court | Adresse géopostale.
32. RelatedEntity.telecom
Court | Coordonnées télécom.
Contrôle | 1..?
34. RelatedEntity.relatedPerson
Court | Personne physique.
Contrôle | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person(CDA - assignedPerson)

Des conseils sur linterprétation du contenu de ce tableau peuvent être trouvésici

0. RelatedEntity
Définition | 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.
Court | Base for all types and resources
Contrôle | 1..1
Est modificateur | false
Conteneur logique | ClinicalDocument (CDA Class)
Validation | Les instances de ce type sont validées par templateId
Format XML | Dans le format XML, cette propriété a lespace de noms (namespace) `urn:hl7-org:v3`.
2. RelatedEntity.nullFlavor
Définition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Contrôle | 0..0
Binding | Les codes DOIVENT (SHALL) être pris de CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Exceptional Value Detail
4. RelatedEntity.realmCode
Définition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Contrôle | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
6. RelatedEntity.typeId
Définition | 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.
Contrôle | 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. RelatedEntity.typeId.nullFlavor
Définition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Contrôle | 0..0
Binding | Les codes DOIVENT (SHALL) être pris de CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Exceptional Value Detail
10. RelatedEntity.typeId.assigningAuthorityName
Définition | 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.
Contrôle | 0..0
Type | string(st: Character String)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Assigning Authority Name
12. RelatedEntity.typeId.displayable
Définition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Contrôle | 0..0
Type | boolean(bl: Boolean)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Displayable
14. RelatedEntity.typeId.root
Définition | Identifies the type as an HL7 Registered model
Contrôle | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Root
Valeur fixe | `2.16.840.1.113883.1.3`
16. RelatedEntity.typeId.extension
Définition | A character string as a unique identifier within the scope of the identifier root.
Contrôle | 1..1
Type | string(st: Character String)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Extension
18. RelatedEntity.templateId
Définition | 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
Contrôle | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
20. RelatedEntity.classCode
Court | Rôle joué par la personne.
Contrôle | 1..1
Binding | Les codes DOIVENT (SHALL) être pris de Jdv Role Informateur CISIS (required to `https://smt.esante.gouv.fr/fhir/ValueSet/jdv-role-informateur-cisis` )
Type | code(cs: Coded Simple Value)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
22. RelatedEntity.code
Court | Lien de la personne avec le patient/usager.
Contrôle | 0..1
Binding | Les codes DOIVENT (SHALL) être pris de JDV_J11_RelationPatient_CISIS (required to `https://mos.esante.gouv.fr/NOS/JDV_J11-RelationPatient-CISIS/FHIR/JDV-J11-RelationPatient-CISIS` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
24. RelatedEntity.code.nullFlavor
Définition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Contrôle | 0..0
Binding | Les codes DOIVENT (SHALL) être pris de CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Exceptional Value Detail
26. RelatedEntity.code.code
Définition | 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.
Contrôle | 1..1
Type | code(cs: Coded Simple Value)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Code
28. RelatedEntity.code.codeSystem
Définition | Specifies the code system that defines the code.
Contrôle | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Code System
30. RelatedEntity.code.codeSystemName
Définition | The common name of the coding system.
Contrôle | 0..1
Type | string(st: Character String)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Code System Name
32. RelatedEntity.code.codeSystemVersion
Définition | If applicable, a version descriptor defined specifically for the given code system.
Contrôle | 0..0
Type | string(st: Character String)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Code System Version
34. RelatedEntity.code.displayName
Définition | A name or title for the code, under which the sending system shows the code value to its users.
Contrôle | 1..1
Type | string(st: Character String)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Étiquette | Display Name
36. RelatedEntity.code.sdtcValueSet
Définition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Contrôle | 0..0
Type | string(oid: ISO Object Identifier)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.Dans le format XML, cette propriété a lespace de noms (namespace) `urn:hl7-org:sdtc`.Dans le format XML, cette propriété a le nom réel`valueSet`.
38. RelatedEntity.code.sdtcValueSetVersion
Définition | 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.
Contrôle | 0..0
Type | string(st: Character String)
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Format XML | Dans le format XML, cette propriété est représentée comme attribut.Dans le format XML, cette propriété a lespace de noms (namespace) `urn:hl7-org:sdtc`.Dans le format XML, cette propriété a le nom réel`valueSetVersion`.
40. RelatedEntity.code.originalText
Définition | The text or phrase used as the basis for the coding.
Contrôle | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Étiquette | Original Text
42. RelatedEntity.code.qualifier
Définition | Specifies additional codes that increase the specificity of the the primary code.
Contrôle | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Étiquette | Qualifier
44. RelatedEntity.code.translation
Définition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Contrôle | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
Format XML | Le type de cette propriété est déterminé en utilisant le `xsi:type`attribute.
Étiquette | Translation
46. RelatedEntity.addr
Court | Adresse géopostale.
Contrôle | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
48. RelatedEntity.telecom
Court | Coordonnées télécom.
Contrôle | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
50. RelatedEntity.effectiveTime
Contrôle | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
52. RelatedEntity.relatedPerson
Court | Personne physique.
Contrôle | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person(CDA - assignedPerson)