FHIR IG analytics| Package | ans.cda.fr.document-core |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-fr-cda-clinical-document.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/ansforge/interop-IG-cda-document-core/StructureDefinition-fr-cda-clinical-document.html |
| URL | https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-clinical-document |
| Version | 0.1.0 |
| Status | draft |
| Date | 2026-07-16T15:39:52+00:00 |
| Name | FRCDAClinicalDocument |
| Title | CDA - clinicalDocument |
| Realm | fr |
| Description | L'élément de l'en-tête CDA 'ClinicalDocument' est l’élément racine d’un document médical. |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument |
| Kind | logical |
No resources found
| StructureDefinition | ||
| au.digitalhealth.cda.schema#current | Authenticator | Authenticator (CDA Class) |
| au.digitalhealth.cda.schema#current | Author | Author (CDA Class) |
| au.digitalhealth.cda.schema#current | Authorization | Authorization (CDA Class) |
| au.digitalhealth.cda.schema#current | ClinicalDocument | ClinicalDocument (CDA Class) |
| au.digitalhealth.cda.schema#current | Custodian | Custodian (CDA Class) |
| au.digitalhealth.cda.schema#current | DataEnterer | DataEnterer (CDA Class) |
| au.digitalhealth.cda.schema#current | DocumentationOf | DocumentationOf (CDA Class) |
| au.digitalhealth.cda.schema#current | InFulfillmentOf | InFulfillmentOf (CDA Class) |
| au.digitalhealth.cda.schema#current | Informant | Informant (CDA Class) |
| au.digitalhealth.cda.schema#current | InformationRecipient | InformationRecipient (CDA Class) |
| au.digitalhealth.cda.schema#current | LegalAuthenticator | LegalAuthenticator (CDA Class) |
| au.digitalhealth.cda.schema#current | Participant1 | Participant1 (CDA Class) |
| au.digitalhealth.cda.schema#current | RecordTarget | RecordTarget (CDA Class) |
| au.digitalhealth.cda.schema#current | RelatedDocument | RelatedDocument (CDA Class) |
| ans.cda.fr.document-core#current | fr-cda-authenticator | CDA - authenticator |
| ans.cda.fr.document-core#current | fr-cda-author | CDA - author |
| ans.cda.fr.document-core#current | fr-cda-authorization | CDA - authorization |
| ans.cda.fr.document-core#current | fr-cda-custodian | CDA - custodian |
| ans.cda.fr.document-core#current | fr-cda-data-enterer | CDA - dataEnterer |
| ans.cda.fr.document-core#current | fr-cda-documentation-of | CDA - documentationOf |
| ans.cda.fr.document-core#current | fr-cda-inFulfillment-of | CDA - inFulfillmentOf |
| ans.cda.fr.document-core#current | fr-cda-informant | CDA - informant |
| ans.cda.fr.document-core#current | fr-cda-information-recipient | CDA - informationRecipient |
| ans.cda.fr.document-core#current | fr-cda-legal-authenticator | CDA - legalAuthenticator |
| ans.cda.fr.document-core#current | fr-cda-participant-entete | CDA - participant |
| ans.cda.fr.document-core#current | fr-cda-record-target | CDA - recordTarget |
| ans.cda.fr.document-core#current | fr-cda-related-document | CDA - relatedDocument |
Note: links and images are rebased to the (stated) source
French
Narratif généré : DéfinitionStructure fr-cda-clinical-document
| Nom | Drapeaux | Card. | Type | Description et contraintes |
|---|---|---|---|---|
  ClinicalDocument | C | 1..1 | ClinicalDocument(2.0.3-sd) | Espace de noms (namespace) XML: urn:hl7-org:v3 Base for all types and resources Les instances de ce type sont validées par templateId Conteneur logique: ClinicalDocument (CDA Class) |
 realmCode | 1..1 | CS | Type de consentement Périmètre d’utilisation : France. | |
| typeId | 1..1 | II | Référence au standard CDA R2. | |
| templateId | 3..* | II | Déclarations de conformité. | |
| id | 1..1 | II | Identifiant unique du document. | |
| code | 1..1 | CE | Type de document. | |
| title | 1..1 | ST | Titre du document. | |
| effectiveTime | 1..1 | TS | Date et heure de création du document. | |
| confidentialityCode | 1..1 | CE | Niveau de confidentialité du document. | |
| languageCode | 1..1 | CS | Langue principale du document. | |
| setId | 1..1 | II | Identifiant du lot de versions du même document. | |
| versionNumber | 1..1 | INT | Numéro de version du document. | |
| copyTime | 0..0 | Deprecated - use is discouraged | ||
 recordTarget | 1..1 | FRCDARecordTarget(0.1.0) | Patient/Usager concerné par le document. | |
| author | 1..* | FRCDAAuthor(0.1.0) | Professionnel ou patient/usager ou système, auteur du document incluant la structure de rattachement de l'auteur. | |
| dataEnterer | 0..1 | FRCDADataEnterer(0.1.0) | Opérateur de saisie. | |
| informant | 0..* | FRCDAInformant(0.1.0) | Informateur (informant), ayant fourni des informations utiles aux actes en rapport avec la production du document. | |
| custodian | 1..1 | FRCDACustodian(0.1.0) | Structure conservant le document et garantissant son cycle de vie. | |
| informationRecipient | 0..* | FRCDAInformationRecipient(0.1.0) | Destinataire prévu du document. | |
| legalAuthenticator | 1..1 | FRCDALegalAuthenticator(0.1.0) | Professionnel ou patient/usager ou système responsable du document. | |
| authenticator | 0..* | FRCDAAuthenticator(0.1.0) | Professionnel attestant la validité du document | |
| participant | 0..* | FRCDAParticipantEntete(0.1.0) | Participant, différent de l'auteur, du responsable, de l'opérateur de saisie, de l'informateur ou du destinataire. | |
| inFulfillmentOf | 0..* | FRCDAInFulfillmentOf(0.1.0) | Prescription | |
| documentationOf | 1..* | FRCDADocumentationOf(0.1.0) | Evènement documenté et notamment le cadre d'exercice. | |
| relatedDocument | 0..1 | FRCDARelatedDocument(0.1.0) | Document de référence (à remplacer, transformé, …). | |
| authorization | 0..* | FRCDAAuthorization(0.1.0) | Consentement associé au document. | |
 componentOf | 1..1 | ComponentOf | Prise en charge du patient/usager et notamment la date et le secteur d'activité. | |
| Documentation pour ce format | ||||
English
Generated Narrative: StructureDefinition fr-cda-clinical-document
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ClinicalDocument | C | 1..1 | ClinicalDocument(2.0.3-sd) | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) |
| realmCode | 1..1 | CS | Type de consentement Périmètre d’utilisation : France. | |
| typeId | 1..1 | II | Référence au standard CDA R2. | |
| templateId | 3..* | II | Déclarations de conformité. | |
| id | 1..1 | II | Identifiant unique du document. | |
| code | 1..1 | CE | Type de document. | |
| title | 1..1 | ST | Titre du document. | |
| effectiveTime | 1..1 | TS | Date et heure de création du document. | |
| confidentialityCode | 1..1 | CE | Niveau de confidentialité du document. | |
| languageCode | 1..1 | CS | Langue principale du document. | |
| setId | 1..1 | II | Identifiant du lot de versions du même document. | |
| versionNumber | 1..1 | INT | Numéro de version du document. | |
| copyTime | 0..0 | Deprecated - use is discouraged | ||
| recordTarget | 1..1 | FRCDARecordTarget(0.1.0) | Patient/Usager concerné par le document. | |
| author | 1..* | FRCDAAuthor(0.1.0) | Professionnel ou patient/usager ou système, auteur du document incluant la structure de rattachement de l'auteur. | |
| dataEnterer | 0..1 | FRCDADataEnterer(0.1.0) | Opérateur de saisie. | |
| informant | 0..* | FRCDAInformant(0.1.0) | Informateur (informant), ayant fourni des informations utiles aux actes en rapport avec la production du document. | |
| custodian | 1..1 | FRCDACustodian(0.1.0) | Structure conservant le document et garantissant son cycle de vie. | |
| informationRecipient | 0..* | FRCDAInformationRecipient(0.1.0) | Destinataire prévu du document. | |
| legalAuthenticator | 1..1 | FRCDALegalAuthenticator(0.1.0) | Professionnel ou patient/usager ou système responsable du document. | |
| authenticator | 0..* | FRCDAAuthenticator(0.1.0) | Professionnel attestant la validité du document | |
| participant | 0..* | FRCDAParticipantEntete(0.1.0) | Participant, différent de l'auteur, du responsable, de l'opérateur de saisie, de l'informateur ou du destinataire. | |
| inFulfillmentOf | 0..* | FRCDAInFulfillmentOf(0.1.0) | Prescription | |
| documentationOf | 1..* | FRCDADocumentationOf(0.1.0) | Evènement documenté et notamment le cadre d'exercice. | |
| relatedDocument | 0..1 | FRCDARelatedDocument(0.1.0) | Document de référence (à remplacer, transformé, …). | |
| authorization | 0..* | FRCDAAuthorization(0.1.0) | Consentement associé au document. | |
| componentOf | 1..1 | ComponentOf | Prise en charge du patient/usager et notamment la date et le secteur d'activité. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "fr-cda-clinical-document",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "not-applicable"
}
]
}
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:v3"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "ClinicalDocument"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueCode": "cda"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
],
"url": "https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-clinical-document",
"version": "0.1.0",
"name": "FRCDAClinicalDocument",
"title": "CDA - clinicalDocument",
"status": "draft",
"date": "2026-07-16T15:39:52+00:00",
"publisher": "Agence du Numérique en Santé (ANS) - 2-10 Rue d'Oradour-sur-Glane, 75015 Paris",
"contact": [
{
"name": "Agence du Numérique en Santé (ANS) - 2-10 Rue d'Oradour-sur-Glane, 75015 Paris",
"telecom": [
{
"system": "url",
"value": "https://esante.gouv.fr"
}
]
}
],
"description": "L'élément de l'en-tête CDA 'ClinicalDocument' est l’élément racine d’un document médical.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "FR",
"display": "France (la)"
}
]
}
],
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument|2.0.3-sd",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "2.0.3-sd"
}
],
"element": [
{
"id": "ClinicalDocument",
"path": "ClinicalDocument",
"short": "Base for all types and resources",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "FRCDAPerformerRequire",
"severity": "error",
"human": "performer est obligatoire et son attribut nullFlavor interdit pour l’évènement documenté principal",
"expression": "documentationOf.serviceEvent.performer.count() >= 1",
"source": "https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-clinical-document|0.1.0"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ClinicalDocument.nullFlavor",
"path": "ClinicalDocument.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd"
}
},
{
"id": "ClinicalDocument.classCode",
"path": "ClinicalDocument.classCode",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "ClinicalDocument.classCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"fixedCode": "DOCCLIN",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClass|2.0.3-sd"
}
},
{
"id": "ClinicalDocument.moodCode",
"path": "ClinicalDocument.moodCode",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "ClinicalDocument.moodCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"fixedCode": "EVN",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActMood|2.0.3-sd"
}
},
{
"id": "ClinicalDocument.realmCode",
"path": "ClinicalDocument.realmCode",
"short": "Type de consentement Périmètre d’utilisation : France.",
"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",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "ClinicalDocument.typeId",
"path": "ClinicalDocument.typeId",
"short": "Référence au standard CDA R2.",
"definition": "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).",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument|2.0.3-sd"
}
]
},
{
"id": "ClinicalDocument.typeId.nullFlavor",
"path": "ClinicalDocument.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd"
}
},
{
"id": "ClinicalDocument.typeId.assigningAuthorityName",
"path": "ClinicalDocument.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple|2.0.3-sd"
]
}
]
},
{
"id": "ClinicalDocument.typeId.displayable",
"path": "ClinicalDocument.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple|2.0.3-sd"
]
}
]
},
{
"id": "ClinicalDocument.typeId.root",
"path": "ClinicalDocument.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid|2.0.3-sd"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "ClinicalDocument.typeId.extension",
"path": "ClinicalDocument.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple|2.0.3-sd"
]
}
],
"fixedString": "POCD_HD000040"
},
{
"id": "ClinicalDocument.templateId",
"path": "ClinicalDocument.templateId",
"short": "Déclarations de conformité.",
"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",
"min": 3,
"max": "*",
"base": {
"path": "ClinicalDocument.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "ClinicalDocument.id",
"path": "ClinicalDocument.id",
"short": "Identifiant unique du document.",
"definition": "Represents the unique instance identifier of a clinical document.",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "ClinicalDocument.sdtcCategory",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "category"
}
],
"path": "ClinicalDocument.sdtcCategory",
"min": 0,
"max": "*",
"base": {
"path": "ClinicalDocument.sdtcCategory",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id": "ClinicalDocument.code",
"path": "ClinicalDocument.code",
"short": "Type de document.",
"definition": "The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note).",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/doc-typecodes|4.0.1"
}
},
{
"id": "ClinicalDocument.title",
"path": "ClinicalDocument.title",
"short": "Titre du document.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.title",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id": "ClinicalDocument.sdtcStatusCode",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "statusCode"
}
],
"path": "ClinicalDocument.sdtcStatusCode",
"definition": "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.",
"min": 0,
"max": "1",
"base": {
"path": "ClinicalDocument.sdtcStatusCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActStatus|3.0.0"
}
},
{
"id": "ClinicalDocument.effectiveTime",
"path": "ClinicalDocument.effectiveTime",
"short": "Date et heure de création du document.",
"definition": "Signifies the document creation time, when the document first came into being.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.effectiveTime",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
}
]
},
{
"id": "ClinicalDocument.confidentialityCode",
"path": "ClinicalDocument.confidentialityCode",
"short": "Niveau de confidentialité du document.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.confidentialityCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id": "ClinicalDocument.languageCode",
"path": "ClinicalDocument.languageCode",
"short": "Langue principale du document.",
"definition": "Specifies the human language of character data (whether they be in contents or attribute values).",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.languageCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|4.0.1"
}
},
{
"id": "ClinicalDocument.setId",
"path": "ClinicalDocument.setId",
"short": "Identifiant du lot de versions du même document.",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.setId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "ClinicalDocument.versionNumber",
"path": "ClinicalDocument.versionNumber",
"short": "Numéro de version du document.",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.versionNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/INT"
}
]
},
{
"id": "ClinicalDocument.copyTime",
"path": "ClinicalDocument.copyTime",
"short": "Deprecated - use is discouraged",
"definition": "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.",
"requirements": "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.",
"min": 0,
"max": "0",
"base": {
"path": "ClinicalDocument.copyTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
}
]
},
{
"id": "ClinicalDocument.recordTarget",
"path": "ClinicalDocument.recordTarget",
"short": "Patient/Usager concerné par le document.",
"comment": "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.",
"requirements": "The recordTarget(s) of a document are stated in the header and propagate to nested content, where they cannot be overridden.",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.recordTarget",
"min": 1,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-record-target|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.author",
"path": "ClinicalDocument.author",
"short": "Professionnel ou patient/usager ou système, auteur du document incluant la structure de rattachement de l'auteur.",
"comment": "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.",
"min": 1,
"max": "*",
"base": {
"path": "ClinicalDocument.author",
"min": 1,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Author",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-author|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.dataEnterer",
"path": "ClinicalDocument.dataEnterer",
"short": "Opérateur de saisie.",
"alias": [
"Transcriptionist"
],
"min": 0,
"max": "1",
"base": {
"path": "ClinicalDocument.dataEnterer",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-data-enterer|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.informant",
"path": "ClinicalDocument.informant",
"short": "Informateur (informant), ayant fourni des informations utiles aux actes en rapport avec la production du document.",
"definition": "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.",
"min": 0,
"max": "*",
"base": {
"path": "ClinicalDocument.informant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-informant|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.custodian",
"path": "ClinicalDocument.custodian",
"short": "Structure conservant le document et garantissant son cycle de vie.",
"definition": "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.",
"requirements": "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.",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.custodian",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Custodian",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-custodian|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.informationRecipient",
"path": "ClinicalDocument.informationRecipient",
"short": "Destinataire prévu du document.",
"comment": "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.",
"min": 0,
"max": "*",
"base": {
"path": "ClinicalDocument.informationRecipient",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-information-recipient|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.legalAuthenticator",
"path": "ClinicalDocument.legalAuthenticator",
"short": "Professionnel ou patient/usager ou système responsable du document.",
"comment": "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).",
"requirements": "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.",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.legalAuthenticator",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-legal-authenticator|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.authenticator",
"path": "ClinicalDocument.authenticator",
"short": "Professionnel attestant la validité du document",
"definition": "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.",
"comment": "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.",
"min": 0,
"max": "*",
"base": {
"path": "ClinicalDocument.authenticator",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Authenticator",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-authenticator|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.participant",
"path": "ClinicalDocument.participant",
"short": "Participant, différent de l'auteur, du responsable, de l'opérateur de saisie, de l'informateur ou du destinataire.",
"definition": "Used to represent other participants not explicitly mentioned by other classes, that were somehow involved in the documented acts.",
"min": 0,
"max": "*",
"base": {
"path": "ClinicalDocument.participant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant1",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-participant-entete|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.inFulfillmentOf",
"path": "ClinicalDocument.inFulfillmentOf",
"short": "Prescription",
"comment": "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'.",
"min": 0,
"max": "*",
"base": {
"path": "ClinicalDocument.inFulfillmentOf",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-inFulfillment-of|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.documentationOf",
"path": "ClinicalDocument.documentationOf",
"short": "Evènement documenté et notamment le cadre d'exercice.",
"comment": "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.",
"min": 1,
"max": "*",
"base": {
"path": "ClinicalDocument.documentationOf",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-documentation-of|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.relatedDocument",
"path": "ClinicalDocument.relatedDocument",
"short": "Document de référence (à remplacer, transformé, …).",
"requirements": "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.",
"min": 0,
"max": "1",
"base": {
"path": "ClinicalDocument.relatedDocument",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-related-document|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.authorization",
"path": "ClinicalDocument.authorization",
"short": "Consentement associé au document.",
"comment": "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.",
"min": 0,
"max": "*",
"base": {
"path": "ClinicalDocument.authorization",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Authorization",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-authorization|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.componentOf",
"path": "ClinicalDocument.componentOf",
"short": "Prise en charge du patient/usager et notamment la date et le secteur d'activité.",
"definition": "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.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.componentOf",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ComponentOf"
}
]
},
{
"id": "ClinicalDocument.component",
"path": "ClinicalDocument.component",
"short": "Body of the document",
"min": 1,
"max": "1",
"base": {
"path": "ClinicalDocument.component",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Component"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ClinicalDocument",
"path": "ClinicalDocument",
"constraint": [
{
"key": "FRCDAPerformerRequire",
"severity": "error",
"human": "performer est obligatoire et son attribut nullFlavor interdit pour l’évènement documenté principal",
"expression": "documentationOf.serviceEvent.performer.count() >= 1",
"source": "https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-clinical-document|0.1.0"
}
]
},
{
"id": "ClinicalDocument.realmCode",
"path": "ClinicalDocument.realmCode",
"short": "Type de consentement Périmètre d’utilisation : France.",
"min": 1,
"max": "1"
},
{
"id": "ClinicalDocument.typeId",
"path": "ClinicalDocument.typeId",
"short": "Référence au standard CDA R2.",
"min": 1
},
{
"id": "ClinicalDocument.templateId",
"path": "ClinicalDocument.templateId",
"short": "Déclarations de conformité.",
"min": 3
},
{
"id": "ClinicalDocument.id",
"path": "ClinicalDocument.id",
"short": "Identifiant unique du document."
},
{
"id": "ClinicalDocument.code",
"path": "ClinicalDocument.code",
"short": "Type de document."
},
{
"id": "ClinicalDocument.title",
"path": "ClinicalDocument.title",
"short": "Titre du document.",
"min": 1
},
{
"id": "ClinicalDocument.effectiveTime",
"path": "ClinicalDocument.effectiveTime",
"short": "Date et heure de création du document."
},
{
"id": "ClinicalDocument.confidentialityCode",
"path": "ClinicalDocument.confidentialityCode",
"short": "Niveau de confidentialité du document."
},
{
"id": "ClinicalDocument.languageCode",
"path": "ClinicalDocument.languageCode",
"short": "Langue principale du document.",
"min": 1
},
{
"id": "ClinicalDocument.setId",
"path": "ClinicalDocument.setId",
"short": "Identifiant du lot de versions du même document.",
"min": 1
},
{
"id": "ClinicalDocument.versionNumber",
"path": "ClinicalDocument.versionNumber",
"short": "Numéro de version du document.",
"min": 1
},
{
"id": "ClinicalDocument.copyTime",
"path": "ClinicalDocument.copyTime",
"max": "0"
},
{
"id": "ClinicalDocument.recordTarget",
"path": "ClinicalDocument.recordTarget",
"short": "Patient/Usager concerné par le document.",
"max": "1",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-record-target|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.author",
"path": "ClinicalDocument.author",
"short": "Professionnel ou patient/usager ou système, auteur du document incluant la structure de rattachement de l'auteur.",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Author",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-author|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.dataEnterer",
"path": "ClinicalDocument.dataEnterer",
"short": "Opérateur de saisie.",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-data-enterer|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.informant",
"path": "ClinicalDocument.informant",
"short": "Informateur (informant), ayant fourni des informations utiles aux actes en rapport avec la production du document.",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-informant|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.custodian",
"path": "ClinicalDocument.custodian",
"short": "Structure conservant le document et garantissant son cycle de vie.",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Custodian",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-custodian|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.informationRecipient",
"path": "ClinicalDocument.informationRecipient",
"short": "Destinataire prévu du document.",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-information-recipient|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.legalAuthenticator",
"path": "ClinicalDocument.legalAuthenticator",
"short": "Professionnel ou patient/usager ou système responsable du document.",
"min": 1,
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-legal-authenticator|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.authenticator",
"path": "ClinicalDocument.authenticator",
"short": "Professionnel attestant la validité du document",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Authenticator",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-authenticator|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.participant",
"path": "ClinicalDocument.participant",
"short": "Participant, différent de l'auteur, du responsable, de l'opérateur de saisie, de l'informateur ou du destinataire.",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant1",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-participant-entete|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.inFulfillmentOf",
"path": "ClinicalDocument.inFulfillmentOf",
"short": "Prescription",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-inFulfillment-of|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.documentationOf",
"path": "ClinicalDocument.documentationOf",
"short": "Evènement documenté et notamment le cadre d'exercice.",
"min": 1,
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-documentation-of|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.relatedDocument",
"path": "ClinicalDocument.relatedDocument",
"short": "Document de référence (à remplacer, transformé, …).",
"max": "1",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-related-document|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.authorization",
"path": "ClinicalDocument.authorization",
"short": "Consentement associé au document.",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Authorization",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-authorization|0.1.0"
]
}
]
},
{
"id": "ClinicalDocument.componentOf",
"path": "ClinicalDocument.componentOf",
"short": "Prise en charge du patient/usager et notamment la date et le secteur d'activité.",
"min": 1
}
]
}
}