Search FHIR

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

FR Document Core (CDA) - version de développement local (intégration continue v0.1.0) construite par les outils de publication FHIR (HL7® FHIR® Standard). Voir le répertoire des versions publiées

Modèle logique: CDA - clinicalDocument - Descriptions détaillées

Draft à partir de 2026-08-28

Définitions pour le fr-cda-clinical-document modèle logique

Des conseils sur l'interprétation du contenu de ce tableau peuvent être trouvésici

0. ClinicalDocument
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.


Base definition for all types defined in FHIR type system.

CourtBase for all types and resources
Contrôle10..1*
Est modificateurfalse
Conteneur logiqueClinicalDocument (CDA Class)
ValidationLes instances de ce type sont validées par templateId
Format XMLDans le format XML, cette propriété a l'espace de noms (namespace) urn:hl7-org:v3.
InvariantsFRCDAPerformerRequire: performer est obligatoire et son attribut nullFlavor interdit pour l’évènement documenté principal (documentationOf.serviceEvent.performer.count() >= 1)
2. ClinicalDocument.nullFlavor
Définition

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

Contrôle0..1
BindingLes codes DOIVENT (SHALL) être pris de CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
ÉtiquetteExceptional Value Detail
4. ClinicalDocument.classCode
Contrôle0..1
BindingPour des exemples de codes, voir CDAActClass (2.0.3-sd)
(example to http://hl7.org/cda/stds/core/ValueSet/CDAActClass|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
Valeur fixeDOCCLIN
6. ClinicalDocument.moodCode
Contrôle0..1
BindingLes codes DOIVENT (SHALL) être pris de CDAActMood (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
Valeur fixeEVN
8. ClinicalDocument.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

CourtType de consentement Périmètre d’utilisation : France.
Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
10. ClinicalDocument.typeId
Définition

ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).

CourtRéférence au standard CDA R2.
Contrôle1..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())
12. ClinicalDocument.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ôle0..1
BindingLes codes DOIVENT (SHALL) être pris de CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
ÉtiquetteExceptional Value Detail
14. ClinicalDocument.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ôle0..1
Typestring(st: Character String)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
ÉtiquetteAssigning Authority Name
16. ClinicalDocument.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ôle0..1
Typeboolean(bl: Boolean)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
ÉtiquetteDisplayable
18. ClinicalDocument.typeId.root
Définition

Identifies the type as an HL7 Registered model

Contrôle1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
ÉtiquetteRoot
Valeur fixe2.16.840.1.113883.1.3
20. ClinicalDocument.typeId.extension
Définition

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

Contrôle1..1
Typestring(st: Character String)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
ÉtiquetteExtension
Valeur fixePOCD_HD000040
22. ClinicalDocument.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

CourtDéclarations de conformité.
Contrôle3..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
24. ClinicalDocument.id
Définition

Represents the unique instance identifier of a clinical document.

CourtIdentifiant unique du document.
Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
26. ClinicalDocument.sdtcCategory
Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
Format XMLDans le format XML, cette propriété a l'espace de noms (namespace) urn:hl7-org:sdtc.Dans le format XML, cette propriété a le nom réelcategory.
28. ClinicalDocument.code
Définition

The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note).

CourtType de document.
Contrôle1..1
BindingPour des exemples de codes, voir FHIRDocumentTypeCodes
(example to http://hl7.org/fhir/ValueSet/doc-typecodes|5.0.0)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
30. ClinicalDocument.title
CourtTitre du document.
Commentaires

It's commonly the case that clinical documents do not have a title, and are collectively referred to by the display name of ClinicalDocument.code (e.g. a 'consultation' or 'progress note'). Where these display names are rendered to the clinician, or where the document has a unique title, the ClinicalDocument.title component should be used.

Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
32. ClinicalDocument.sdtcStatusCode
Définition

The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.

Contrôle0..1
BindingLes codes DOIVENT (SHALL) être pris de ActStatus (3.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-ActStatus|3.0.0)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
Format XMLDans le format XML, cette propriété a l'espace de noms (namespace) urn:hl7-org:sdtc.Dans le format XML, cette propriété a le nom réelstatusCode.
34. ClinicalDocument.effectiveTime
Définition

Signifies the document creation time, when the document first came into being.

CourtDate et heure de création du document.
Commentaires

Where the CDA document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created. The time when the transform occurred is not currently represented in CDA.

Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
36. ClinicalDocument.confidentialityCode
CourtNiveau de confidentialité du document.
Commentaires

Confidentiality is a required contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.

Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
38. ClinicalDocument.languageCode
Définition

Specifies the human language of character data (whether they be in contents or attribute values).

CourtLangue principale du document.
Commentaires

Language is a contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.

Contrôle1..1
BindingLes codes DOIVENT (SHALL) être pris de AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
40. ClinicalDocument.setId
CourtIdentifiant du lot de versions du même document.
Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
42. ClinicalDocument.versionNumber
CourtNuméro de version du document.
Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
44. ClinicalDocument.copyTime
Définition

Represents the time a document is released (i.e. copied or sent to a display device) from a document management system that maintains revision control over the document. Once valued, it cannot be changed. The intent is to give the viewer of the document some notion as to how long the document has been out of the safe context of its document management system.

CourtDeprecated - use is discouraged
Contrôle0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
Exigences

Included for backwards compatibility with CDA, Release One. ClinicalDocument.copyTime has been deprecated because it is not part of the document at the time it is authenticated, but instead represents metadata about the document, applied at some variable time after authentication. Further use is discouraged.

46. ClinicalDocument.recordTarget
CourtPatient/Usager concerné par le document.
Commentaires

A clinical document typically has exactly one recordTarget participant. In the uncommon case where a clinical document (such as a group encounter note) is placed into more than one patient chart, more than one recordTarget participants can be stated.

Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RecordTarget(CDA - recordTarget)
Exigences

The recordTarget(s) of a document are stated in the header and propagate to nested content, where they cannot be overridden.

48. ClinicalDocument.author
CourtProfessionnel ou patient/usager ou système, auteur du document incluant la structure de rattachement de l'auteur.
Commentaires

In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'Medical Student Progress Note'. The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply 'Physician Progress Note' and the value of Author.functionCode is 'rounding physician'), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Contrôle1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(CDA - author)
50. ClinicalDocument.dataEnterer
CourtOpérateur de saisie.
Contrôle0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DataEnterer(CDA - dataEnterer)
Noms alternatifsTranscriptionist
52. ClinicalDocument.informant
Définition

An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.

CourtInformateur (informant), ayant fourni des informations utiles aux actes en rapport avec la production du document.
Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant(CDA - informant)
54. ClinicalDocument.custodian
Définition

Represents the organization that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian.

CourtStructure conservant le document et garantissant son cycle de vie.
Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Custodian(CDA - custodian)
Exigences

The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document, the custodian represents the steward of the original source document.

56. ClinicalDocument.informationRecipient
CourtDestinataire prévu du document.
Commentaires

The information recipient is an entity to whom a copy of a document is directed, at the time of document authorship. It is not the same as the cumulative set of persons to whom the document has subsequently been disclosed, over the life-time of the patient. Such a disclosure list would not be contained within the document, and it outside the scope of CDA.

Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient(CDA - informationRecipient)
58. ClinicalDocument.legalAuthenticator
CourtProfessionnel ou patient/usager ou système responsable du document.
Commentaires

The CDA is a standard that specifies the structure of exchanged clinical documents. In the case where a local document is transformed into a CDA document for exchange, authentication occurs on the local document, and that fact is reflected in the exchanged CDA document. A CDA document can reflect the unauthenticated, authenticated, or legally authenticated state. The unauthenticated state exists when no authentication information has been recorded (i.e., it is the absence of being either authenticated or legally authenticated).

Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator(CDA - legalAuthenticator)
Exigences

While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. A legalAuthenticator has a required legalAuthenticator.time indicating the time of authentication, and a required legalAuthenticator.signatureCode, indicating that a signature has been obtained and is on file.

60. ClinicalDocument.authenticator
Définition

Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it.

CourtProfessionnel attestant la validité du document
Commentaires

A clinical document can have zero to many authenticators. While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. An authenticator has a required authenticator.time indicating the time of authentication, and a required authenticator.signatureCode, indicating that a signature has been obtained and is on file.

Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator(CDA - authenticator)
62. ClinicalDocument.participant
Définition

Used to represent other participants not explicitly mentioned by other classes, that were somehow involved in the documented acts.

CourtParticipant, différent de l'auteur, du responsable, de l'opérateur de saisie, de l'informateur ou du destinataire.
Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1(CDA - participant)
64. ClinicalDocument.inFulfillmentOf
CourtPrescription
Commentaires

For instance, a provider orders an X-Ray. The X-Ray is performed. A radiologist reads the X-Ray and generates a report. The X-Ray order identifier is transmitted in the Order class, the performed X-Ray procedure is transmitted in the ServiceEvent class, and the ClinicalDocument.code would be valued with 'Diagnostic Imaging Report'.

Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf(CDA - inFulfillmentOf)
66. ClinicalDocument.documentationOf
CourtEvènement documenté et notamment le cadre d'exercice.
Commentaires

In some cases, the ServiceEvent is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'History and Physical Report' and the procedure being documented is a 'History and Physical' act. A ServiceEvent can further specialize the act inherent in the ClinicalDocument.code, such as where the ClinicalDocument.code is simply 'Procedure Report' and the procedure was a 'colonoscopy'. If ServiceEvent is included, it must be equivalent to or further specialize the value inherent in the ClinicalDocument.code, and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Contrôle1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf(CDA - documentationOf)
68. ClinicalDocument.relatedDocument
CourtDocument de référence (à remplacer, transformé, …).
Contrôle0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument(CDA - relatedDocument)
Exigences

A conformant CDA document can have a single relatedDocument with typeCode 'APND'; a single relatedDocument with typeCode 'RPLC'; a single relatedDocument with typeCode 'XFRM'; a combination of two relatedDocuments with typeCodes 'XFRM' and 'RPLC'; or a combination of two relatedDocuments with typeCodes 'XFRM' and 'APND'. No other combinations are allowed.

70. ClinicalDocument.authorization
CourtConsentement associé au document.
Commentaires

The type of consent (e.g. a consent to perform the related ServiceEvent, a consent for the information contained in the document to be released to a third party) is conveyed in Consent.code. Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal 'completed') and should be on file.

Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authorization(CDA - authorization)
72. ClinicalDocument.componentOf
Définition

This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note.

CourtPrise en charge du patient/usager et notamment la date et le secteur d'activité.
Commentaires

In some cases, the setting of the encounter is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'Diabetes Clinic Progress Note'. The setting of an encounter can also be transmitted in the HealthCareFacility.code attribute. If HealthCareFacility.code is sent, it should be equivalent to or further specialize the value inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply 'Clinic Progress Note' and the value of HealthCareFacility.code is 'cardiology clinic'), and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
74. ClinicalDocument.component
CourtBody of the document
Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Component

Des conseils sur l'interprétation du contenu de ce tableau peuvent être trouvésici

0. ClinicalDocument
Conteneur logiqueClinicalDocument (CDA Class)
ValidationLes instances de ce type sont validées par templateId
Format XMLDans le format XML, cette propriété a l'espace de noms (namespace) urn:hl7-org:v3.
InvariantsFRCDAPerformerRequire: performer est obligatoire et son attribut nullFlavor interdit pour l’évènement documenté principal (documentationOf.serviceEvent.performer.count() >= 1)
2. ClinicalDocument.realmCode
CourtType de consentement Périmètre d’utilisation : France.
Contrôle1..1
4. ClinicalDocument.typeId
CourtRéférence au standard CDA R2.
Contrôle1..?
6. ClinicalDocument.templateId
CourtDéclarations de conformité.
Contrôle3..?
8. ClinicalDocument.id
CourtIdentifiant unique du document.
10. ClinicalDocument.code
CourtType de document.
12. ClinicalDocument.title
CourtTitre du document.
Contrôle1..?
14. ClinicalDocument.effectiveTime
CourtDate et heure de création du document.
16. ClinicalDocument.confidentialityCode
CourtNiveau de confidentialité du document.
18. ClinicalDocument.languageCode
CourtLangue principale du document.
Contrôle1..?
20. ClinicalDocument.setId
CourtIdentifiant du lot de versions du même document.
Contrôle1..?
22. ClinicalDocument.versionNumber
CourtNuméro de version du document.
Contrôle1..?
24. ClinicalDocument.copyTime
Contrôle0..0
26. ClinicalDocument.recordTarget
CourtPatient/Usager concerné par le document.
Contrôle0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RecordTarget(CDA - recordTarget)
28. ClinicalDocument.author
CourtProfessionnel ou patient/usager ou système, auteur du document incluant la structure de rattachement de l'auteur.
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(CDA - author)
30. ClinicalDocument.dataEnterer
CourtOpérateur de saisie.
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DataEnterer(CDA - dataEnterer)
32. ClinicalDocument.informant
CourtInformateur (informant), ayant fourni des informations utiles aux actes en rapport avec la production du document.
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant(CDA - informant)
34. ClinicalDocument.custodian
CourtStructure conservant le document et garantissant son cycle de vie.
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Custodian(CDA - custodian)
36. ClinicalDocument.informationRecipient
CourtDestinataire prévu du document.
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient(CDA - informationRecipient)
38. ClinicalDocument.legalAuthenticator
CourtProfessionnel ou patient/usager ou système responsable du document.
Contrôle1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator(CDA - legalAuthenticator)
40. ClinicalDocument.authenticator
CourtProfessionnel attestant la validité du document
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator(CDA - authenticator)
42. ClinicalDocument.participant
CourtParticipant, différent de l'auteur, du responsable, de l'opérateur de saisie, de l'informateur ou du destinataire.
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1(CDA - participant)
44. ClinicalDocument.inFulfillmentOf
CourtPrescription
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf(CDA - inFulfillmentOf)
46. ClinicalDocument.documentationOf
CourtEvènement documenté et notamment le cadre d'exercice.
Contrôle1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf(CDA - documentationOf)
48. ClinicalDocument.relatedDocument
CourtDocument de référence (à remplacer, transformé, …).
Contrôle0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument(CDA - relatedDocument)
50. ClinicalDocument.authorization
CourtConsentement associé au document.
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authorization(CDA - authorization)
52. ClinicalDocument.componentOf
CourtPrise en charge du patient/usager et notamment la date et le secteur d'activité.
Contrôle1..?

Des conseils sur l'interprétation du contenu de ce tableau peuvent être trouvésici

0. ClinicalDocument
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.

CourtBase for all types and resources
Contrôle1..1
Est modificateurfalse
Conteneur logiqueClinicalDocument (CDA Class)
ValidationLes instances de ce type sont validées par templateId
Format XMLDans le format XML, cette propriété a l'espace de noms (namespace) urn:hl7-org:v3.
InvariantsFRCDAPerformerRequire: performer est obligatoire et son attribut nullFlavor interdit pour l’évènement documenté principal (documentationOf.serviceEvent.performer.count() >= 1)
2. ClinicalDocument.nullFlavor
Définition

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

Contrôle0..1
BindingLes codes DOIVENT (SHALL) être pris de CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
ÉtiquetteExceptional Value Detail
4. ClinicalDocument.classCode
Contrôle0..1
BindingPour des exemples de codes, voir CDAActClass (2.0.3-sd)
(example to http://hl7.org/cda/stds/core/ValueSet/CDAActClass|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
Valeur fixeDOCCLIN
6. ClinicalDocument.moodCode
Contrôle0..1
BindingLes codes DOIVENT (SHALL) être pris de CDAActMood (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
Valeur fixeEVN
8. ClinicalDocument.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

CourtType de consentement Périmètre d’utilisation : France.
Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
10. ClinicalDocument.typeId
Définition

ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).

CourtRéférence au standard CDA R2.
Contrôle1..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())
12. ClinicalDocument.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ôle0..1
BindingLes codes DOIVENT (SHALL) être pris de CDANullFlavor (2.0.3-sd)
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd)
Typecode(cs: Coded Simple Value)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
ÉtiquetteExceptional Value Detail
14. ClinicalDocument.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ôle0..1
Typestring(st: Character String)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
ÉtiquetteAssigning Authority Name
16. ClinicalDocument.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ôle0..1
Typeboolean(bl: Boolean)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
ÉtiquetteDisplayable
18. ClinicalDocument.typeId.root
Définition

Identifies the type as an HL7 Registered model

Contrôle1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
ÉtiquetteRoot
Valeur fixe2.16.840.1.113883.1.3
20. ClinicalDocument.typeId.extension
Définition

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

Contrôle1..1
Typestring(st: Character String)
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Format XMLDans le format XML, cette propriété est représentée comme attribut.
ÉtiquetteExtension
Valeur fixePOCD_HD000040
22. ClinicalDocument.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

CourtDéclarations de conformité.
Contrôle3..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
24. ClinicalDocument.id
Définition

Represents the unique instance identifier of a clinical document.

CourtIdentifiant unique du document.
Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
26. ClinicalDocument.sdtcCategory
Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
Format XMLDans le format XML, cette propriété a l'espace de noms (namespace) urn:hl7-org:sdtc.Dans le format XML, cette propriété a le nom réelcategory.
28. ClinicalDocument.code
Définition

The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note).

CourtType de document.
Contrôle1..1
BindingPour des exemples de codes, voir FHIRDocumentTypeCodes
(example to http://hl7.org/fhir/ValueSet/doc-typecodes|5.0.0)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
30. ClinicalDocument.title
CourtTitre du document.
Commentaires

It's commonly the case that clinical documents do not have a title, and are collectively referred to by the display name of ClinicalDocument.code (e.g. a 'consultation' or 'progress note'). Where these display names are rendered to the clinician, or where the document has a unique title, the ClinicalDocument.title component should be used.

Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
32. ClinicalDocument.sdtcStatusCode
Définition

The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.

Contrôle0..1
BindingLes codes DOIVENT (SHALL) être pris de ActStatus (3.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-ActStatus|3.0.0)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
Format XMLDans le format XML, cette propriété a l'espace de noms (namespace) urn:hl7-org:sdtc.Dans le format XML, cette propriété a le nom réelstatusCode.
34. ClinicalDocument.effectiveTime
Définition

Signifies the document creation time, when the document first came into being.

CourtDate et heure de création du document.
Commentaires

Where the CDA document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created. The time when the transform occurred is not currently represented in CDA.

Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
36. ClinicalDocument.confidentialityCode
CourtNiveau de confidentialité du document.
Commentaires

Confidentiality is a required contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.

Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
38. ClinicalDocument.languageCode
Définition

Specifies the human language of character data (whether they be in contents or attribute values).

CourtLangue principale du document.
Commentaires

Language is a contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.

Contrôle1..1
BindingLes codes DOIVENT (SHALL) être pris de AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
40. ClinicalDocument.setId
CourtIdentifiant du lot de versions du même document.
Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
42. ClinicalDocument.versionNumber
CourtNuméro de version du document.
Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
44. ClinicalDocument.copyTime
Définition

Represents the time a document is released (i.e. copied or sent to a display device) from a document management system that maintains revision control over the document. Once valued, it cannot be changed. The intent is to give the viewer of the document some notion as to how long the document has been out of the safe context of its document management system.

CourtDeprecated - use is discouraged
Contrôle0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
Exigences

Included for backwards compatibility with CDA, Release One. ClinicalDocument.copyTime has been deprecated because it is not part of the document at the time it is authenticated, but instead represents metadata about the document, applied at some variable time after authentication. Further use is discouraged.

46. ClinicalDocument.recordTarget
CourtPatient/Usager concerné par le document.
Commentaires

A clinical document typically has exactly one recordTarget participant. In the uncommon case where a clinical document (such as a group encounter note) is placed into more than one patient chart, more than one recordTarget participants can be stated.

Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RecordTarget(CDA - recordTarget)
Exigences

The recordTarget(s) of a document are stated in the header and propagate to nested content, where they cannot be overridden.

48. ClinicalDocument.author
CourtProfessionnel ou patient/usager ou système, auteur du document incluant la structure de rattachement de l'auteur.
Commentaires

In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'Medical Student Progress Note'. The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply 'Physician Progress Note' and the value of Author.functionCode is 'rounding physician'), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Contrôle1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(CDA - author)
50. ClinicalDocument.dataEnterer
CourtOpérateur de saisie.
Contrôle0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DataEnterer(CDA - dataEnterer)
Noms alternatifsTranscriptionist
52. ClinicalDocument.informant
Définition

An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.

CourtInformateur (informant), ayant fourni des informations utiles aux actes en rapport avec la production du document.
Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant(CDA - informant)
54. ClinicalDocument.custodian
Définition

Represents the organization that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian.

CourtStructure conservant le document et garantissant son cycle de vie.
Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Custodian(CDA - custodian)
Exigences

The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document, the custodian represents the steward of the original source document.

56. ClinicalDocument.informationRecipient
CourtDestinataire prévu du document.
Commentaires

The information recipient is an entity to whom a copy of a document is directed, at the time of document authorship. It is not the same as the cumulative set of persons to whom the document has subsequently been disclosed, over the life-time of the patient. Such a disclosure list would not be contained within the document, and it outside the scope of CDA.

Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient(CDA - informationRecipient)
58. ClinicalDocument.legalAuthenticator
CourtProfessionnel ou patient/usager ou système responsable du document.
Commentaires

The CDA is a standard that specifies the structure of exchanged clinical documents. In the case where a local document is transformed into a CDA document for exchange, authentication occurs on the local document, and that fact is reflected in the exchanged CDA document. A CDA document can reflect the unauthenticated, authenticated, or legally authenticated state. The unauthenticated state exists when no authentication information has been recorded (i.e., it is the absence of being either authenticated or legally authenticated).

Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator(CDA - legalAuthenticator)
Exigences

While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. A legalAuthenticator has a required legalAuthenticator.time indicating the time of authentication, and a required legalAuthenticator.signatureCode, indicating that a signature has been obtained and is on file.

60. ClinicalDocument.authenticator
Définition

Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it.

CourtProfessionnel attestant la validité du document
Commentaires

A clinical document can have zero to many authenticators. While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. An authenticator has a required authenticator.time indicating the time of authentication, and a required authenticator.signatureCode, indicating that a signature has been obtained and is on file.

Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator(CDA - authenticator)
62. ClinicalDocument.participant
Définition

Used to represent other participants not explicitly mentioned by other classes, that were somehow involved in the documented acts.

CourtParticipant, différent de l'auteur, du responsable, de l'opérateur de saisie, de l'informateur ou du destinataire.
Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1(CDA - participant)
64. ClinicalDocument.inFulfillmentOf
CourtPrescription
Commentaires

For instance, a provider orders an X-Ray. The X-Ray is performed. A radiologist reads the X-Ray and generates a report. The X-Ray order identifier is transmitted in the Order class, the performed X-Ray procedure is transmitted in the ServiceEvent class, and the ClinicalDocument.code would be valued with 'Diagnostic Imaging Report'.

Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf(CDA - inFulfillmentOf)
66. ClinicalDocument.documentationOf
CourtEvènement documenté et notamment le cadre d'exercice.
Commentaires

In some cases, the ServiceEvent is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'History and Physical Report' and the procedure being documented is a 'History and Physical' act. A ServiceEvent can further specialize the act inherent in the ClinicalDocument.code, such as where the ClinicalDocument.code is simply 'Procedure Report' and the procedure was a 'colonoscopy'. If ServiceEvent is included, it must be equivalent to or further specialize the value inherent in the ClinicalDocument.code, and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Contrôle1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf(CDA - documentationOf)
68. ClinicalDocument.relatedDocument
CourtDocument de référence (à remplacer, transformé, …).
Contrôle0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument(CDA - relatedDocument)
Exigences

A conformant CDA document can have a single relatedDocument with typeCode 'APND'; a single relatedDocument with typeCode 'RPLC'; a single relatedDocument with typeCode 'XFRM'; a combination of two relatedDocuments with typeCodes 'XFRM' and 'RPLC'; or a combination of two relatedDocuments with typeCodes 'XFRM' and 'APND'. No other combinations are allowed.

70. ClinicalDocument.authorization
CourtConsentement associé au document.
Commentaires

The type of consent (e.g. a consent to perform the related ServiceEvent, a consent for the information contained in the document to be released to a third party) is conveyed in Consent.code. Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal 'completed') and should be on file.

Contrôle0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authorization(CDA - authorization)
72. ClinicalDocument.componentOf
Définition

This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note.

CourtPrise en charge du patient/usager et notamment la date et le secteur d'activité.
Commentaires

In some cases, the setting of the encounter is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'Diabetes Clinic Progress Note'. The setting of an encounter can also be transmitted in the HealthCareFacility.code attribute. If HealthCareFacility.code is sent, it should be equivalent to or further specialize the value inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply 'Clinic Progress Note' and the value of HealthCareFacility.code is 'cardiology clinic'), and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
74. ClinicalDocument.component
CourtBody of the document
Contrôle1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Component