FHIR IG analytics| Package | ans.cda.fr.document-core |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-fr-cda-related-document.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/ansforge/interop-IG-cda-document-core/StructureDefinition-fr-cda-related-document.html |
| URL | https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-related-document |
| Version | 0.1.0 |
| Status | draft |
| Date | 2026-07-16T15:39:52+00:00 |
| Name | FRCDARelatedDocument |
| Title | CDA - relatedDocument |
| Realm | fr |
| Description | L'élément de l'en-tête du CDA relatedDocument permet de référencer un document existant (à remplacer ou transformé). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument |
| Kind | logical |
| StructureDefinition | ||
| ans.cda.fr.document-core#current | fr-cda-clinical-document | CDA - clinicalDocument |
| StructureDefinition | ||
| au.digitalhealth.cda.schema#current | ParentDocument | ParentDocument (CDA Class) |
| au.digitalhealth.cda.schema#current | RelatedDocument | RelatedDocument (CDA Class) |
| ans.cda.fr.document-core#current | fr-cda-parent-document | CDA - parentDocument |
Note: links and images are rebased to the (stated) source
French
Narratif généré : DéfinitionStructure fr-cda-related-document
| Nom | Drapeaux | Card. | Type | Description et contraintes |
|---|---|---|---|---|
  RelatedDocument | RelatedDocument(2.0.3-sd) | Espace de noms (namespace) XML: urn:hl7-org:v3 Les instances de ce type sont validées par templateId Conteneur logique: ClinicalDocument (CDA Class) | ||
 typeId | ||||
 @nullFlavor | 0..0 | |||
| @assigningAuthorityName | 0..0 | |||
 @displayable | 0..0 | |||
| @typeCode | 1..1 | cs(2.0.3-sd) | le typeCode prend la valeur : - 'RPLC' pour remplacement, seul le remplacement au sens annulation et remplacement du document référencé par la version courante du document est autorisé. - 'XFRM' pour transformation, la relation est portée par le document CDA transformé (et pas par le document de référence). | |
 parentDocument | 1..1 | FRCDAParentDocument(0.1.0) | Document de référence. | |
| Documentation pour ce format | ||||
English
Generated Narrative: StructureDefinition fr-cda-related-document
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedDocument | RelatedDocument(2.0.3-sd) | XML Namespace: urn:hl7-org:v3 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | ||
| typeId | ||||
| @nullFlavor | 0..0 | |||
| @assigningAuthorityName | 0..0 | |||
| @displayable | 0..0 | |||
| @typeCode | 1..1 | cs(2.0.3-sd) | le typeCode prend la valeur : - 'RPLC' pour remplacement, seul le remplacement au sens annulation et remplacement du document référencé par la version courante du document est autorisé. - 'XFRM' pour transformation, la relation est portée par le document CDA transformé (et pas par le document de référence). | |
| parentDocument | 1..1 | FRCDAParentDocument(0.1.0) | Document de référence. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "fr-cda-related-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": "relatedDocument"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueCode": "cda"
}
],
"url": "https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-related-document",
"version": "0.1.0",
"name": "FRCDARelatedDocument",
"title": "CDA - relatedDocument",
"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 du CDA relatedDocument permet de référencer un document existant (à remplacer ou transformé).",
"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/RelatedDocument",
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument|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": "RelatedDocument",
"path": "RelatedDocument",
"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": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "RelatedDocument.nullFlavor",
"path": "RelatedDocument.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": "RelatedDocument.realmCode",
"path": "RelatedDocument.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "RelatedDocument.typeId",
"path": "RelatedDocument.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.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/InfrastructureRoot|2.0.3-sd"
}
]
},
{
"id": "RelatedDocument.typeId.nullFlavor",
"path": "RelatedDocument.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": "0",
"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": "RelatedDocument.typeId.assigningAuthorityName",
"path": "RelatedDocument.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": "0",
"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": "RelatedDocument.typeId.displayable",
"path": "RelatedDocument.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": "0",
"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": "RelatedDocument.typeId.root",
"path": "RelatedDocument.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": "RelatedDocument.typeId.extension",
"path": "RelatedDocument.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"
]
}
]
},
{
"id": "RelatedDocument.templateId",
"path": "RelatedDocument.templateId",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "RelatedDocument.typeCode",
"path": "RelatedDocument.typeCode",
"representation": [
"xmlAttr"
],
"short": "le typeCode prend la valeur :\n- 'RPLC' pour remplacement, seul le remplacement au sens annulation et remplacement du document référencé par la version courante du document est autorisé.\n- 'XFRM' pour transformation, la relation est portée par le document CDA transformé (et pas par le document de référence).",
"min": 1,
"max": "1",
"base": {
"path": "RelatedDocument.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xActRelationshipDocument|3.0.0"
}
},
{
"id": "RelatedDocument.parentDocument",
"path": "RelatedDocument.parentDocument",
"short": "Document de référence.",
"min": 1,
"max": "1",
"base": {
"path": "RelatedDocument.parentDocument",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ParentDocument",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-parent-document|0.1.0"
]
}
]
}
]
},
"differential": {
"element": [
{
"id": "RelatedDocument.typeId.nullFlavor",
"path": "RelatedDocument.typeId.nullFlavor",
"max": "0"
},
{
"id": "RelatedDocument.typeId.assigningAuthorityName",
"path": "RelatedDocument.typeId.assigningAuthorityName",
"max": "0"
},
{
"id": "RelatedDocument.typeId.displayable",
"path": "RelatedDocument.typeId.displayable",
"max": "0"
},
{
"id": "RelatedDocument.typeCode",
"path": "RelatedDocument.typeCode",
"short": "le typeCode prend la valeur :\n- 'RPLC' pour remplacement, seul le remplacement au sens annulation et remplacement du document référencé par la version courante du document est autorisé.\n- 'XFRM' pour transformation, la relation est portée par le document CDA transformé (et pas par le document de référence)."
},
{
"id": "RelatedDocument.parentDocument",
"path": "RelatedDocument.parentDocument",
"short": "Document de référence.",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ParentDocument",
"profile": [
"https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-parent-document|0.1.0"
]
}
]
}
]
}
}