Search FHIR

Partage de Documents de Santé en mobilité (PDSm)
3.1.0 - trial-use France flag

Partage de Documents de Santé en mobilité (PDSm) - Local Development build (v3.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PDSm Comprehensive DocumentReference

Official URL: https://interop.esante.gouv.fr/ig/fhir/pdsm/StructureDefinition/pdsm-comprehensive-document-reference Version: 3.1.0
Active as of 2025-10-22 Computable Name: PDSm_ComprehensiveDocumentReference

Profil contenant les métadonnées du document ainsi que le lien vers la ressource Binary contenant le document dérivé de la ressource DocumentReference et du profil IHE MHD v4.0.1 "ComprehensiveDocumentReference"

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NomDrapeauxCard.TypeDescription et contraintes    Filter: Filtersdoco
.. DocumentReference C 0..* ComprehensiveDocumentReference A reference to a document
Constraints: iti-mhd-repl
... meta Σ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Numéro de version de la fiche d’un document attribué par le système cible. La valeur de la métadonnée version est égale à 1 pour la première version de la fiche. Cet élément est requis lorsque le flux envoyé correspond à une mise à jour des données d’une fiche.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained S 1..* Resource Ressource contenue. Dans le cadre de ce profil, il est obligatoire qu'il y ait au moins une ressource contenue : la•les ressource•s référencée•s dans les attributs author et authenticator
.... extension:isArchived S 0..1 boolean Extension définie pour distinguer les fiches archivées des actives.
URL: https://interop.esante.gouv.fr/ig/fhir/pdsm/StructureDefinition/pdsm-ext-is-archived
... masterIdentifier S 1..1 UniqueIdIdentifier Représente l’identifiant unique global affecté au document par son créateur. Il est utilisable comme référence externe dans d’autres documents.
... Slices pour identifier SΣ 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
... type SΣC 1..1 CodeableConcept Représente le type du document.
Binding: JDV_J07_XdsTypeCode_CISIS (preferred)
Constraints: constr-bind-type
... category SΣC 1..1 CodeableConcept Représente la classe du document (compte rendu, imagerie médicale, traitement, certificat,...).
Binding: JDV_J06_XdsClassCode_CISIS (preferred)
Constraints: constr-bind-category
... subject SΣ 1..1 Reference(FR Core Patient Profile) Référence vers le patient concerné par le document. Cette même ressource est référencée depuis context.sourcePatientInfo.
... date SΣ 0..1 instant Représente la date de création de la ressource DocumentReference dans FHIR
... author SΣ 1..* Reference(AS PractitionerRole Profile | Device | FR Core Patient Profile) {c} Personnes physiques ou morales et/ou les dispositifs auteurs d'un document.
... authenticator S 1..1 Reference(AS PractitionerRole Profile | AS Organization Profile) {c} Cet attribut représente l’acteur validant le document et prenant la responsabilité du contenu médical de celui-ci. Il peut s’agir de l’auteur du document si celui-ci est une personne et s’il endosse la responsabilité du contenu médical de ses documents. Si l’auteur est un dispositif, cet attribut doit représenter la personne responsable de l’action effectuée par le dispositif. Pour les documents d’expression personnelle du patient, cet attribut fait référence au patient.
... relatesTo SΣC 0..* BackboneElement Relation avec d'autres fiches
Constraints: constr-cdr-rempl, constr-bind-relatesTo
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Représente le type d'association entre deux fiches.
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target ΣC 1..1 Reference(DocumentReference) Représente l'identifiant d'une association entre deux fiches.
Constraints: constr-bind-relatesToTarget
... description SΣ 0..1 string Commentaire associé au document.
... securityLabel SΣC 1..* CodeableConcept Contient les informations définissant le niveau de confidentialité d'un document.
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Constraints: constr-bind-securityLabel
... content SΣ 1..1 BackboneElement Document référencé.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Exemple General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Pour tous les documents produits par les systèmes initiateurs français, le code est "fr-FR'.
Binding: CommonLanguages (preferred): A human language.
Bindings AdditionnelsBut
AllLanguages Binding Max

Exemple General: en-AU
..... url ΣC 1..1 url Représente la référence vers une ressource Binary où se trouvent les données du document référencé
Constraints: constr-bind-attachmenturl
Exemple General: http://www.acme.com/logo-small.png
..... size Σ 1..1 unsignedInt Représente la taille du document.
..... hash Σ 1..1 base64Binary Représente le résultat de hachage du document (SHA 1).
..... title Σ 1..1 string Label to display in place of the data
Exemple General: Official Corporate Logo
..... creation SΣ 1..1 dateTime Représente la date et l’heure de création du document
.... format SΣC 1..1 Coding Format technique détaillé du document.
Binding: JDV_J10_XdsFormatCode_CISIS (preferred)
Constraints: constr-bind-format
... context SΣ 1..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... event C 0..* CodeableConcept Représente les actes et les pathologies en rapport avec le document.
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
Constraints: constr-bind-context-event
.... period SΣ 1..1 Period Time of service that is being documented
..... start ΣC 1..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType SC 1..1 CodeableConcept Secteur d'activité lié à la prise en charge de la personne, en lien avec le document produit.
Binding: JDV_J02_XdsHealthcareFacilityTypeCode_CISIS (preferred)
Constraints: constr-bind-ProducteurDoc
.... practiceSetting SC 1..1 CodeableConcept Cadre d’exercice de l’acte qui a engendré la création du document.
Binding: JDV_J04_XdsPracticeSettingCode_CISIS (preferred)
Constraints: constr-bind-ProducteurDoc
.... sourcePatientInfo S 1..1 Reference(FR Core Patient Profile) {c} Référence vers la ressource Patient titulaire du dossier.
.... Slices pour related S 0..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by pattern:type
..... related:referenceIdList 0..* Reference(Resource) Données d’un « identifiant de référence » (referenceIdList)
...... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ coding Σ 0..* Coding Code defined by a terminology system
......... system Σ 0..1 uri Identity of the terminology system
Required Pattern: urn:ietf:rfc:3986
......... code SΣ 0..1 code [CXi.5] Identifier Type Code : urn:ihe:iti:xds:2016:studyInstanceUID | urn:ihe:iti:xds:2013:order | urn:ihe:iti:xds:2013:accession
....... system SΣ 0..1 uri [CXi.4.2] Assigning Authority (ce champs n'est pas présent systématiquement, il ne l'est dans le cas de studyInstanceUID notamment).
Exemple General: http://www.acme.com/identifiers/patient
....... value SΣ 1..1 string [CXi.1] Accession number
Exemple General: 123456

doco Documentation for this format

Terminology Bindings

Path Statut Usage ValueSet Version Source
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.0 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred JDV_J07_XdsTypeCode_CISIS 📦20250623120000 Terminologies de Santé v1.2
DocumentReference.category Base preferred JDV_J06_XdsClassCode_CISIS 📦20230922120000 Terminologies de Santé v1.2
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred JDV_J10_XdsFormatCode_CISIS 📦20240726120000 Terminologies de Santé v1.2
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v6.5
DocumentReference.context.​facilityType Base preferred JDV_J02_XdsHealthcareFacilityTypeCode_CISIS 📦20250523120000 Terminologies de Santé v1.2
DocumentReference.context.​practiceSetting Base preferred JDV_J04_XdsPracticeSettingCode_CISIS 📦20240927120000 Terminologies de Santé v1.2
DocumentReference.context.​related:referenceIdList.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.context.​related:referenceIdList.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
constr-bind-ProducteurDoc error DocumentReference.context.facilityType, DocumentReference.context.practiceSetting Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A00-ProducteurDocNonPS, OID : 1.2.250.1.213.1.1.4.6 (lorsque l’auteur du document est un patient ou un équipement sous sa responsabilité) - TRE_R02-SecteurActivite, OID : 1.2.250.1.71.4.2.4 (lorsque l’auteur du document est un professionnel ou un équipement sous sa responsabilité) Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J61-HealthcareFacilityTypeCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J02-XdsHealthcareFacilityTypeCode-CISIS peut être utilisé.
constr-bind-attachmenturl error DocumentReference.content.attachment.url Dans le cas de l’ajout de document, l’url fait référence à la ressource Binary (« Binary/[id] »). Dans le cas de la recherche, il s’agit de l’URL permettant d’accéder au document
constr-bind-category error DocumentReference.category Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A03-ClasseDocument-CISIS, OID : 1.2.250.1.213.1.1.4.1 - TRE_A10-NomenclatureURN, OID : URN Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J57-ClassCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J06-XdsClassCode-CISIS peut être utilisé.
constr-bind-context-event error DocumentReference.context.event Nomenclatures utilisées : 1) CCAM pour les actes médicaux (OID="1.2.250.1.213.2.5"); 2) CIM-10 pour les diagnostics de pathologie (OID="2.16.840.1.113883.6.3"), 3) TRE_A00-ProducteurDocNonPS pour les documents d'expression personnelle du patient, 4) autre
constr-bind-format error DocumentReference.content.format Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A06-FormatCodeComplementaire, OID : 1.2.250.1.213.1.1.4.2.282 - TRE_A11-IheFormatCode, OID : 1.3.6.1.4.1.19376.1.2.3 - TRE_A09-DICOMuidRegistry, OID : 1.2.840.10008.2.6.1 - TRE_A10-NomenclatureURN, OID : URN Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J60-FormatCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J10-XdsFormatCode-CISIS peut être utilisé.
constr-bind-relatesTo error DocumentReference.relatesTo Cardinalité contrainte à [1..1] lorsque le flux envoyé correspond au remplacement d’un document.
constr-bind-relatesToTarget error DocumentReference.relatesTo.target Référence contrainte au profil PDSm_ComprehensiveDocumentReference
constr-bind-securityLabel error DocumentReference.securityLabel Les codes pour cet élément doivent provenir du ValueSet spécifié par le standard. Lorsqu’aucun code ne correspond au concept recherché, un code provenant de la terminologie de référence TRE_A07-StatusVisibiliteDocument, OID : 1.2.250.1.213.1.1.4.13 peut être utilisé.
constr-bind-type error DocumentReference.type Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : TRE_A05-TypeDocComplementaireCISIS, OID : 1.2.250.1.213.1.1.4.12 LOINC, OID : 2.16.840.1.113883.6.1 TRE_A12-NomenclatureASTM, OID : ASTM Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J66-TypeCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J07-XdsTypeCode-CISIS peut être utilisé.
constr-cdr-rempl error DocumentReference.relatesTo Elément requis lorsque le flux envoyé correspond au remplacement d'un document
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
iti-mhd-repl error DocumentReference a DocumetReference replacements needs to relate to a superseded DocumentReference relatesTo.empty() or (relatesTo.code='replaces' implies relatesTo.target.exists())

This structure is derived from ComprehensiveDocumentReference

NomDrapeauxCard.TypeDescription et contraintes    Filter: Filtersdoco
.. DocumentReference 0..* ComprehensiveDocumentReference A reference to a document
... meta
.... versionId S 0..1 id Numéro de version de la fiche d’un document attribué par le système cible. La valeur de la métadonnée version est égale à 1 pour la première version de la fiche. Cet élément est requis lorsque le flux envoyé correspond à une mise à jour des données d’une fiche.
... contained S 1..* Resource Ressource contenue. Dans le cadre de ce profil, il est obligatoire qu'il y ait au moins une ressource contenue : la•les ressource•s référencée•s dans les attributs author et authenticator
... Slices pour extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isArchived S 0..1 boolean Extension définie pour distinguer les fiches archivées des actives.
URL: https://interop.esante.gouv.fr/ig/fhir/pdsm/StructureDefinition/pdsm-ext-is-archived
... identifier 0..* Identifier Other identifiers for the document
... status S 1..1 code current | superseded | entered-in-error
... type C 1..1 CodeableConcept Représente le type du document.
Binding: JDV_J07_XdsTypeCode_CISIS (preferred)
Constraints: constr-bind-type
... category C 1..1 CodeableConcept Représente la classe du document (compte rendu, imagerie médicale, traitement, certificat,...).
Binding: JDV_J06_XdsClassCode_CISIS (preferred)
Constraints: constr-bind-category
... subject 1..1 Reference(FR Core Patient Profile) Référence vers le patient concerné par le document. Cette même ressource est référencée depuis context.sourcePatientInfo.
... date 0..1 instant Représente la date de création de la ressource DocumentReference dans FHIR
... author 1..* Reference(AS PractitionerRole Profile | Device | FR Core Patient Profile) {c} Personnes physiques ou morales et/ou les dispositifs auteurs d'un document.
... authenticator S 1..1 Reference(AS PractitionerRole Profile | AS Organization Profile) {c} Cet attribut représente l’acteur validant le document et prenant la responsabilité du contenu médical de celui-ci. Il peut s’agir de l’auteur du document si celui-ci est une personne et s’il endosse la responsabilité du contenu médical de ses documents. Si l’auteur est un dispositif, cet attribut doit représenter la personne responsable de l’action effectuée par le dispositif. Pour les documents d’expression personnelle du patient, cet attribut fait référence au patient.
... relatesTo C 0..* BackboneElement Relation avec d'autres fiches
Constraints: constr-cdr-rempl, constr-bind-relatesTo
.... code 1..1 code Représente le type d'association entre deux fiches.
.... target C 1..1 Reference(DocumentReference) Représente l'identifiant d'une association entre deux fiches.
Constraints: constr-bind-relatesToTarget
... description S 0..1 string Commentaire associé au document.
... securityLabel C 1..* CodeableConcept Contient les informations définissant le niveau de confidentialité d'un document.
Constraints: constr-bind-securityLabel
... content S 1..1 BackboneElement Document référencé.
.... attachment
..... language 1..1 code Pour tous les documents produits par les systèmes initiateurs français, le code est "fr-FR'.
..... url C 1..1 url Représente la référence vers une ressource Binary où se trouvent les données du document référencé
Constraints: constr-bind-attachmenturl
..... size 1..1 unsignedInt Représente la taille du document.
..... hash 1..1 base64Binary Représente le résultat de hachage du document (SHA 1).
..... title 1..1 string Label to display in place of the data
..... creation 1..1 dateTime Représente la date et l’heure de création du document
.... format C 1..1 Coding Format technique détaillé du document.
Binding: JDV_J10_XdsFormatCode_CISIS (preferred)
Constraints: constr-bind-format
... context S 1..1 BackboneElement Clinical context of document
.... event C 0..* CodeableConcept Représente les actes et les pathologies en rapport avec le document.
Constraints: constr-bind-context-event
.... period 1..1 Period Time of service that is being documented
..... start 1..1 dateTime Starting time with inclusive boundary
..... end 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType C 1..1 CodeableConcept Secteur d'activité lié à la prise en charge de la personne, en lien avec le document produit.
Binding: JDV_J02_XdsHealthcareFacilityTypeCode_CISIS (preferred)
Constraints: constr-bind-ProducteurDoc
.... practiceSetting C 1..1 CodeableConcept Cadre d’exercice de l’acte qui a engendré la création du document.
Binding: JDV_J04_XdsPracticeSettingCode_CISIS (preferred)
Constraints: constr-bind-ProducteurDoc
.... sourcePatientInfo 1..1 Reference(FR Core Patient Profile) {c} Référence vers la ressource Patient titulaire du dossier.
.... Slices pour related S 0..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by pattern:type
..... related:referenceIdList 0..* Reference(Resource) Données d’un « identifiant de référence » (referenceIdList)
...... identifier S 0..1 Identifier Logical reference, when literal reference is not known
....... type
........ coding
......... system 0..1 uri Identity of the terminology system
Required Pattern: urn:ietf:rfc:3986
......... code S 0..1 code [CXi.5] Identifier Type Code : urn:ihe:iti:xds:2016:studyInstanceUID | urn:ihe:iti:xds:2013:order | urn:ihe:iti:xds:2013:accession
....... system S 0..1 uri [CXi.4.2] Assigning Authority (ce champs n'est pas présent systématiquement, il ne l'est dans le cas de studyInstanceUID notamment).
....... value S 1..1 string [CXi.1] Accession number

doco Documentation for this format

Terminology Bindings (Differential)

Path Statut Usage ValueSet Version Source
DocumentReference.type Base preferred JDV_J07_XdsTypeCode_CISIS 📦20250623120000 Terminologies de Santé v1.2
DocumentReference.category Base preferred JDV_J06_XdsClassCode_CISIS 📦20230922120000 Terminologies de Santé v1.2
DocumentReference.content.​format Base preferred JDV_J10_XdsFormatCode_CISIS 📦20240726120000 Terminologies de Santé v1.2
DocumentReference.context.​facilityType Base preferred JDV_J02_XdsHealthcareFacilityTypeCode_CISIS 📦20250523120000 Terminologies de Santé v1.2
DocumentReference.context.​practiceSetting Base preferred JDV_J04_XdsPracticeSettingCode_CISIS 📦20240927120000 Terminologies de Santé v1.2

Constraints

Id Grade Path(s) Description Expression
constr-bind-ProducteurDoc error DocumentReference.context.facilityType, DocumentReference.context.practiceSetting Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A00-ProducteurDocNonPS, OID : 1.2.250.1.213.1.1.4.6 (lorsque l’auteur du document est un patient ou un équipement sous sa responsabilité) - TRE_R02-SecteurActivite, OID : 1.2.250.1.71.4.2.4 (lorsque l’auteur du document est un professionnel ou un équipement sous sa responsabilité) Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J61-HealthcareFacilityTypeCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J02-XdsHealthcareFacilityTypeCode-CISIS peut être utilisé.
constr-bind-attachmenturl error DocumentReference.content.attachment.url Dans le cas de l’ajout de document, l’url fait référence à la ressource Binary (« Binary/[id] »). Dans le cas de la recherche, il s’agit de l’URL permettant d’accéder au document
constr-bind-category error DocumentReference.category Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A03-ClasseDocument-CISIS, OID : 1.2.250.1.213.1.1.4.1 - TRE_A10-NomenclatureURN, OID : URN Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J57-ClassCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J06-XdsClassCode-CISIS peut être utilisé.
constr-bind-context-event error DocumentReference.context.event Nomenclatures utilisées : 1) CCAM pour les actes médicaux (OID="1.2.250.1.213.2.5"); 2) CIM-10 pour les diagnostics de pathologie (OID="2.16.840.1.113883.6.3"), 3) TRE_A00-ProducteurDocNonPS pour les documents d'expression personnelle du patient, 4) autre
constr-bind-format error DocumentReference.content.format Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A06-FormatCodeComplementaire, OID : 1.2.250.1.213.1.1.4.2.282 - TRE_A11-IheFormatCode, OID : 1.3.6.1.4.1.19376.1.2.3 - TRE_A09-DICOMuidRegistry, OID : 1.2.840.10008.2.6.1 - TRE_A10-NomenclatureURN, OID : URN Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J60-FormatCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J10-XdsFormatCode-CISIS peut être utilisé.
constr-bind-relatesTo error DocumentReference.relatesTo Cardinalité contrainte à [1..1] lorsque le flux envoyé correspond au remplacement d’un document.
constr-bind-relatesToTarget error DocumentReference.relatesTo.target Référence contrainte au profil PDSm_ComprehensiveDocumentReference
constr-bind-securityLabel error DocumentReference.securityLabel Les codes pour cet élément doivent provenir du ValueSet spécifié par le standard. Lorsqu’aucun code ne correspond au concept recherché, un code provenant de la terminologie de référence TRE_A07-StatusVisibiliteDocument, OID : 1.2.250.1.213.1.1.4.13 peut être utilisé.
constr-bind-type error DocumentReference.type Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : TRE_A05-TypeDocComplementaireCISIS, OID : 1.2.250.1.213.1.1.4.12 LOINC, OID : 2.16.840.1.113883.6.1 TRE_A12-NomenclatureASTM, OID : ASTM Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J66-TypeCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J07-XdsTypeCode-CISIS peut être utilisé.
constr-cdr-rempl error DocumentReference.relatesTo Elément requis lorsque le flux envoyé correspond au remplacement d'un document
NomDrapeauxCard.TypeDescription et contraintes    Filter: Filtersdoco
.. DocumentReference C 0..* ComprehensiveDocumentReference A reference to a document
Constraints: iti-mhd-repl
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Numéro de version de la fiche d’un document attribué par le système cible. La valeur de la métadonnée version est égale à 1 pour la première version de la fiche. Cet élément est requis lorsque le flux envoyé correspond à une mise à jour des données d’une fiche.
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained S 1..* Resource Ressource contenue. Dans le cadre de ce profil, il est obligatoire qu'il y ait au moins une ressource contenue : la•les ressource•s référencée•s dans les attributs author et authenticator
... Slices pour extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isArchived S 0..1 boolean Extension définie pour distinguer les fiches archivées des actives.
URL: https://interop.esante.gouv.fr/ig/fhir/pdsm/StructureDefinition/pdsm-ext-is-archived
... masterIdentifier S 1..1 UniqueIdIdentifier Représente l’identifiant unique global affecté au document par son créateur. Il est utilisable comme référence externe dans d’autres documents.
... Slices pour identifier SΣ 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
... type SΣC 1..1 CodeableConcept Représente le type du document.
Binding: JDV_J07_XdsTypeCode_CISIS (preferred)
Constraints: constr-bind-type
... category SΣC 1..1 CodeableConcept Représente la classe du document (compte rendu, imagerie médicale, traitement, certificat,...).
Binding: JDV_J06_XdsClassCode_CISIS (preferred)
Constraints: constr-bind-category
... subject SΣ 1..1 Reference(FR Core Patient Profile) Référence vers le patient concerné par le document. Cette même ressource est référencée depuis context.sourcePatientInfo.
... date SΣ 0..1 instant Représente la date de création de la ressource DocumentReference dans FHIR
... author SΣ 1..* Reference(AS PractitionerRole Profile | Device | FR Core Patient Profile) {c} Personnes physiques ou morales et/ou les dispositifs auteurs d'un document.
... authenticator S 1..1 Reference(AS PractitionerRole Profile | AS Organization Profile) {c} Cet attribut représente l’acteur validant le document et prenant la responsabilité du contenu médical de celui-ci. Il peut s’agir de l’auteur du document si celui-ci est une personne et s’il endosse la responsabilité du contenu médical de ses documents. Si l’auteur est un dispositif, cet attribut doit représenter la personne responsable de l’action effectuée par le dispositif. Pour les documents d’expression personnelle du patient, cet attribut fait référence au patient.
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣC 0..* BackboneElement Relation avec d'autres fiches
Constraints: constr-cdr-rempl, constr-bind-relatesTo
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Représente le type d'association entre deux fiches.
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target ΣC 1..1 Reference(DocumentReference) Représente l'identifiant d'une association entre deux fiches.
Constraints: constr-bind-relatesToTarget
... description SΣ 0..1 string Commentaire associé au document.
... securityLabel SΣC 1..* CodeableConcept Contient les informations définissant le niveau de confidentialité d'un document.
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Constraints: constr-bind-securityLabel
... content SΣ 1..1 BackboneElement Document référencé.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Exemple General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Pour tous les documents produits par les systèmes initiateurs français, le code est "fr-FR'.
Binding: CommonLanguages (preferred): A human language.
Bindings AdditionnelsBut
AllLanguages Binding Max

Exemple General: en-AU
..... url ΣC 1..1 url Représente la référence vers une ressource Binary où se trouvent les données du document référencé
Constraints: constr-bind-attachmenturl
Exemple General: http://www.acme.com/logo-small.png
..... size Σ 1..1 unsignedInt Représente la taille du document.
..... hash Σ 1..1 base64Binary Représente le résultat de hachage du document (SHA 1).
..... title Σ 1..1 string Label to display in place of the data
Exemple General: Official Corporate Logo
..... creation SΣ 1..1 dateTime Représente la date et l’heure de création du document
.... format SΣC 1..1 Coding Format technique détaillé du document.
Binding: JDV_J10_XdsFormatCode_CISIS (preferred)
Constraints: constr-bind-format
... context SΣ 1..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event C 0..* CodeableConcept Représente les actes et les pathologies en rapport avec le document.
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
Constraints: constr-bind-context-event
.... period SΣ 1..1 Period Time of service that is being documented
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 1..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType SC 1..1 CodeableConcept Secteur d'activité lié à la prise en charge de la personne, en lien avec le document produit.
Binding: JDV_J02_XdsHealthcareFacilityTypeCode_CISIS (preferred)
Constraints: constr-bind-ProducteurDoc
.... practiceSetting SC 1..1 CodeableConcept Cadre d’exercice de l’acte qui a engendré la création du document.
Binding: JDV_J04_XdsPracticeSettingCode_CISIS (preferred)
Constraints: constr-bind-ProducteurDoc
.... sourcePatientInfo S 1..1 Reference(FR Core Patient Profile) {c} Référence vers la ressource Patient titulaire du dossier.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... Slices pour related S 0..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by pattern:type
..... related:referenceIdList 0..* Reference(Resource) Données d’un « identifiant de référence » (referenceIdList)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ 0..1 uri Identity of the terminology system
Required Pattern: urn:ietf:rfc:3986
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣ 0..1 code [CXi.5] Identifier Type Code : urn:ihe:iti:xds:2016:studyInstanceUID | urn:ihe:iti:xds:2013:order | urn:ihe:iti:xds:2013:accession
......... display Σ 0..1 string Representation defined by the system
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
....... system SΣ 0..1 uri [CXi.4.2] Assigning Authority (ce champs n'est pas présent systématiquement, il ne l'est dans le cas de studyInstanceUID notamment).
Exemple General: http://www.acme.com/identifiers/patient
....... value SΣ 1..1 string [CXi.1] Accession number
Exemple General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Statut Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.meta.​tag Base example Common Tags 📦4.0.1 FHIR Std.
DocumentReference.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.0 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred JDV_J07_XdsTypeCode_CISIS 📦20250623120000 Terminologies de Santé v1.2
DocumentReference.category Base preferred JDV_J06_XdsClassCode_CISIS 📦20230922120000 Terminologies de Santé v1.2
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred JDV_J10_XdsFormatCode_CISIS 📦20240726120000 Terminologies de Santé v1.2
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v6.5
DocumentReference.context.​facilityType Base preferred JDV_J02_XdsHealthcareFacilityTypeCode_CISIS 📦20250523120000 Terminologies de Santé v1.2
DocumentReference.context.​practiceSetting Base preferred JDV_J04_XdsPracticeSettingCode_CISIS 📦20240927120000 Terminologies de Santé v1.2
DocumentReference.context.​sourcePatientInfo.type Base extensible ResourceType 📦4.0.1 FHIR Std.
DocumentReference.context.​related:referenceIdList.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DocumentReference.context.​related:referenceIdList.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.context.​related:referenceIdList.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
constr-bind-ProducteurDoc error DocumentReference.context.facilityType, DocumentReference.context.practiceSetting Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A00-ProducteurDocNonPS, OID : 1.2.250.1.213.1.1.4.6 (lorsque l’auteur du document est un patient ou un équipement sous sa responsabilité) - TRE_R02-SecteurActivite, OID : 1.2.250.1.71.4.2.4 (lorsque l’auteur du document est un professionnel ou un équipement sous sa responsabilité) Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J61-HealthcareFacilityTypeCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J02-XdsHealthcareFacilityTypeCode-CISIS peut être utilisé.
constr-bind-attachmenturl error DocumentReference.content.attachment.url Dans le cas de l’ajout de document, l’url fait référence à la ressource Binary (« Binary/[id] »). Dans le cas de la recherche, il s’agit de l’URL permettant d’accéder au document
constr-bind-category error DocumentReference.category Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A03-ClasseDocument-CISIS, OID : 1.2.250.1.213.1.1.4.1 - TRE_A10-NomenclatureURN, OID : URN Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J57-ClassCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J06-XdsClassCode-CISIS peut être utilisé.
constr-bind-context-event error DocumentReference.context.event Nomenclatures utilisées : 1) CCAM pour les actes médicaux (OID="1.2.250.1.213.2.5"); 2) CIM-10 pour les diagnostics de pathologie (OID="2.16.840.1.113883.6.3"), 3) TRE_A00-ProducteurDocNonPS pour les documents d'expression personnelle du patient, 4) autre
constr-bind-format error DocumentReference.content.format Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A06-FormatCodeComplementaire, OID : 1.2.250.1.213.1.1.4.2.282 - TRE_A11-IheFormatCode, OID : 1.3.6.1.4.1.19376.1.2.3 - TRE_A09-DICOMuidRegistry, OID : 1.2.840.10008.2.6.1 - TRE_A10-NomenclatureURN, OID : URN Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J60-FormatCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J10-XdsFormatCode-CISIS peut être utilisé.
constr-bind-relatesTo error DocumentReference.relatesTo Cardinalité contrainte à [1..1] lorsque le flux envoyé correspond au remplacement d’un document.
constr-bind-relatesToTarget error DocumentReference.relatesTo.target Référence contrainte au profil PDSm_ComprehensiveDocumentReference
constr-bind-securityLabel error DocumentReference.securityLabel Les codes pour cet élément doivent provenir du ValueSet spécifié par le standard. Lorsqu’aucun code ne correspond au concept recherché, un code provenant de la terminologie de référence TRE_A07-StatusVisibiliteDocument, OID : 1.2.250.1.213.1.1.4.13 peut être utilisé.
constr-bind-type error DocumentReference.type Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : TRE_A05-TypeDocComplementaireCISIS, OID : 1.2.250.1.213.1.1.4.12 LOINC, OID : 2.16.840.1.113883.6.1 TRE_A12-NomenclatureASTM, OID : ASTM Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J66-TypeCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J07-XdsTypeCode-CISIS peut être utilisé.
constr-cdr-rempl error DocumentReference.relatesTo Elément requis lorsque le flux envoyé correspond au remplacement d'un document
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
iti-mhd-repl error DocumentReference a DocumetReference replacements needs to relate to a superseded DocumentReference relatesTo.empty() or (relatesTo.code='replaces' implies relatesTo.target.exists())

This structure is derived from ComprehensiveDocumentReference

Résumé

Mandatory: 8 elements(1 nested mandatory element)
Must-Support: 14 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DocumentReference.context.related

Key Elements View

NomDrapeauxCard.TypeDescription et contraintes    Filter: Filtersdoco
.. DocumentReference C 0..* ComprehensiveDocumentReference A reference to a document
Constraints: iti-mhd-repl
... meta Σ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Numéro de version de la fiche d’un document attribué par le système cible. La valeur de la métadonnée version est égale à 1 pour la première version de la fiche. Cet élément est requis lorsque le flux envoyé correspond à une mise à jour des données d’une fiche.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained S 1..* Resource Ressource contenue. Dans le cadre de ce profil, il est obligatoire qu'il y ait au moins une ressource contenue : la•les ressource•s référencée•s dans les attributs author et authenticator
.... extension:isArchived S 0..1 boolean Extension définie pour distinguer les fiches archivées des actives.
URL: https://interop.esante.gouv.fr/ig/fhir/pdsm/StructureDefinition/pdsm-ext-is-archived
... masterIdentifier S 1..1 UniqueIdIdentifier Représente l’identifiant unique global affecté au document par son créateur. Il est utilisable comme référence externe dans d’autres documents.
... Slices pour identifier SΣ 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
... type SΣC 1..1 CodeableConcept Représente le type du document.
Binding: JDV_J07_XdsTypeCode_CISIS (preferred)
Constraints: constr-bind-type
... category SΣC 1..1 CodeableConcept Représente la classe du document (compte rendu, imagerie médicale, traitement, certificat,...).
Binding: JDV_J06_XdsClassCode_CISIS (preferred)
Constraints: constr-bind-category
... subject SΣ 1..1 Reference(FR Core Patient Profile) Référence vers le patient concerné par le document. Cette même ressource est référencée depuis context.sourcePatientInfo.
... date SΣ 0..1 instant Représente la date de création de la ressource DocumentReference dans FHIR
... author SΣ 1..* Reference(AS PractitionerRole Profile | Device | FR Core Patient Profile) {c} Personnes physiques ou morales et/ou les dispositifs auteurs d'un document.
... authenticator S 1..1 Reference(AS PractitionerRole Profile | AS Organization Profile) {c} Cet attribut représente l’acteur validant le document et prenant la responsabilité du contenu médical de celui-ci. Il peut s’agir de l’auteur du document si celui-ci est une personne et s’il endosse la responsabilité du contenu médical de ses documents. Si l’auteur est un dispositif, cet attribut doit représenter la personne responsable de l’action effectuée par le dispositif. Pour les documents d’expression personnelle du patient, cet attribut fait référence au patient.
... relatesTo SΣC 0..* BackboneElement Relation avec d'autres fiches
Constraints: constr-cdr-rempl, constr-bind-relatesTo
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Représente le type d'association entre deux fiches.
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target ΣC 1..1 Reference(DocumentReference) Représente l'identifiant d'une association entre deux fiches.
Constraints: constr-bind-relatesToTarget
... description SΣ 0..1 string Commentaire associé au document.
... securityLabel SΣC 1..* CodeableConcept Contient les informations définissant le niveau de confidentialité d'un document.
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Constraints: constr-bind-securityLabel
... content SΣ 1..1 BackboneElement Document référencé.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Exemple General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Pour tous les documents produits par les systèmes initiateurs français, le code est "fr-FR'.
Binding: CommonLanguages (preferred): A human language.
Bindings AdditionnelsBut
AllLanguages Binding Max

Exemple General: en-AU
..... url ΣC 1..1 url Représente la référence vers une ressource Binary où se trouvent les données du document référencé
Constraints: constr-bind-attachmenturl
Exemple General: http://www.acme.com/logo-small.png
..... size Σ 1..1 unsignedInt Représente la taille du document.
..... hash Σ 1..1 base64Binary Représente le résultat de hachage du document (SHA 1).
..... title Σ 1..1 string Label to display in place of the data
Exemple General: Official Corporate Logo
..... creation SΣ 1..1 dateTime Représente la date et l’heure de création du document
.... format SΣC 1..1 Coding Format technique détaillé du document.
Binding: JDV_J10_XdsFormatCode_CISIS (preferred)
Constraints: constr-bind-format
... context SΣ 1..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... event C 0..* CodeableConcept Représente les actes et les pathologies en rapport avec le document.
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
Constraints: constr-bind-context-event
.... period SΣ 1..1 Period Time of service that is being documented
..... start ΣC 1..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType SC 1..1 CodeableConcept Secteur d'activité lié à la prise en charge de la personne, en lien avec le document produit.
Binding: JDV_J02_XdsHealthcareFacilityTypeCode_CISIS (preferred)
Constraints: constr-bind-ProducteurDoc
.... practiceSetting SC 1..1 CodeableConcept Cadre d’exercice de l’acte qui a engendré la création du document.
Binding: JDV_J04_XdsPracticeSettingCode_CISIS (preferred)
Constraints: constr-bind-ProducteurDoc
.... sourcePatientInfo S 1..1 Reference(FR Core Patient Profile) {c} Référence vers la ressource Patient titulaire du dossier.
.... Slices pour related S 0..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by pattern:type
..... related:referenceIdList 0..* Reference(Resource) Données d’un « identifiant de référence » (referenceIdList)
...... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ coding Σ 0..* Coding Code defined by a terminology system
......... system Σ 0..1 uri Identity of the terminology system
Required Pattern: urn:ietf:rfc:3986
......... code SΣ 0..1 code [CXi.5] Identifier Type Code : urn:ihe:iti:xds:2016:studyInstanceUID | urn:ihe:iti:xds:2013:order | urn:ihe:iti:xds:2013:accession
....... system SΣ 0..1 uri [CXi.4.2] Assigning Authority (ce champs n'est pas présent systématiquement, il ne l'est dans le cas de studyInstanceUID notamment).
Exemple General: http://www.acme.com/identifiers/patient
....... value SΣ 1..1 string [CXi.1] Accession number
Exemple General: 123456

doco Documentation for this format

Terminology Bindings

Path Statut Usage ValueSet Version Source
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.0 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred JDV_J07_XdsTypeCode_CISIS 📦20250623120000 Terminologies de Santé v1.2
DocumentReference.category Base preferred JDV_J06_XdsClassCode_CISIS 📦20230922120000 Terminologies de Santé v1.2
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred JDV_J10_XdsFormatCode_CISIS 📦20240726120000 Terminologies de Santé v1.2
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v6.5
DocumentReference.context.​facilityType Base preferred JDV_J02_XdsHealthcareFacilityTypeCode_CISIS 📦20250523120000 Terminologies de Santé v1.2
DocumentReference.context.​practiceSetting Base preferred JDV_J04_XdsPracticeSettingCode_CISIS 📦20240927120000 Terminologies de Santé v1.2
DocumentReference.context.​related:referenceIdList.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.context.​related:referenceIdList.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
constr-bind-ProducteurDoc error DocumentReference.context.facilityType, DocumentReference.context.practiceSetting Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A00-ProducteurDocNonPS, OID : 1.2.250.1.213.1.1.4.6 (lorsque l’auteur du document est un patient ou un équipement sous sa responsabilité) - TRE_R02-SecteurActivite, OID : 1.2.250.1.71.4.2.4 (lorsque l’auteur du document est un professionnel ou un équipement sous sa responsabilité) Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J61-HealthcareFacilityTypeCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J02-XdsHealthcareFacilityTypeCode-CISIS peut être utilisé.
constr-bind-attachmenturl error DocumentReference.content.attachment.url Dans le cas de l’ajout de document, l’url fait référence à la ressource Binary (« Binary/[id] »). Dans le cas de la recherche, il s’agit de l’URL permettant d’accéder au document
constr-bind-category error DocumentReference.category Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A03-ClasseDocument-CISIS, OID : 1.2.250.1.213.1.1.4.1 - TRE_A10-NomenclatureURN, OID : URN Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J57-ClassCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J06-XdsClassCode-CISIS peut être utilisé.
constr-bind-context-event error DocumentReference.context.event Nomenclatures utilisées : 1) CCAM pour les actes médicaux (OID="1.2.250.1.213.2.5"); 2) CIM-10 pour les diagnostics de pathologie (OID="2.16.840.1.113883.6.3"), 3) TRE_A00-ProducteurDocNonPS pour les documents d'expression personnelle du patient, 4) autre
constr-bind-format error DocumentReference.content.format Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A06-FormatCodeComplementaire, OID : 1.2.250.1.213.1.1.4.2.282 - TRE_A11-IheFormatCode, OID : 1.3.6.1.4.1.19376.1.2.3 - TRE_A09-DICOMuidRegistry, OID : 1.2.840.10008.2.6.1 - TRE_A10-NomenclatureURN, OID : URN Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J60-FormatCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J10-XdsFormatCode-CISIS peut être utilisé.
constr-bind-relatesTo error DocumentReference.relatesTo Cardinalité contrainte à [1..1] lorsque le flux envoyé correspond au remplacement d’un document.
constr-bind-relatesToTarget error DocumentReference.relatesTo.target Référence contrainte au profil PDSm_ComprehensiveDocumentReference
constr-bind-securityLabel error DocumentReference.securityLabel Les codes pour cet élément doivent provenir du ValueSet spécifié par le standard. Lorsqu’aucun code ne correspond au concept recherché, un code provenant de la terminologie de référence TRE_A07-StatusVisibiliteDocument, OID : 1.2.250.1.213.1.1.4.13 peut être utilisé.
constr-bind-type error DocumentReference.type Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : TRE_A05-TypeDocComplementaireCISIS, OID : 1.2.250.1.213.1.1.4.12 LOINC, OID : 2.16.840.1.113883.6.1 TRE_A12-NomenclatureASTM, OID : ASTM Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J66-TypeCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J07-XdsTypeCode-CISIS peut être utilisé.
constr-cdr-rempl error DocumentReference.relatesTo Elément requis lorsque le flux envoyé correspond au remplacement d'un document
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
iti-mhd-repl error DocumentReference a DocumetReference replacements needs to relate to a superseded DocumentReference relatesTo.empty() or (relatesTo.code='replaces' implies relatesTo.target.exists())

Differential View

This structure is derived from ComprehensiveDocumentReference

NomDrapeauxCard.TypeDescription et contraintes    Filter: Filtersdoco
.. DocumentReference 0..* ComprehensiveDocumentReference A reference to a document
... meta
.... versionId S 0..1 id Numéro de version de la fiche d’un document attribué par le système cible. La valeur de la métadonnée version est égale à 1 pour la première version de la fiche. Cet élément est requis lorsque le flux envoyé correspond à une mise à jour des données d’une fiche.
... contained S 1..* Resource Ressource contenue. Dans le cadre de ce profil, il est obligatoire qu'il y ait au moins une ressource contenue : la•les ressource•s référencée•s dans les attributs author et authenticator
... Slices pour extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isArchived S 0..1 boolean Extension définie pour distinguer les fiches archivées des actives.
URL: https://interop.esante.gouv.fr/ig/fhir/pdsm/StructureDefinition/pdsm-ext-is-archived
... identifier 0..* Identifier Other identifiers for the document
... status S 1..1 code current | superseded | entered-in-error
... type C 1..1 CodeableConcept Représente le type du document.
Binding: JDV_J07_XdsTypeCode_CISIS (preferred)
Constraints: constr-bind-type
... category C 1..1 CodeableConcept Représente la classe du document (compte rendu, imagerie médicale, traitement, certificat,...).
Binding: JDV_J06_XdsClassCode_CISIS (preferred)
Constraints: constr-bind-category
... subject 1..1 Reference(FR Core Patient Profile) Référence vers le patient concerné par le document. Cette même ressource est référencée depuis context.sourcePatientInfo.
... date 0..1 instant Représente la date de création de la ressource DocumentReference dans FHIR
... author 1..* Reference(AS PractitionerRole Profile | Device | FR Core Patient Profile) {c} Personnes physiques ou morales et/ou les dispositifs auteurs d'un document.
... authenticator S 1..1 Reference(AS PractitionerRole Profile | AS Organization Profile) {c} Cet attribut représente l’acteur validant le document et prenant la responsabilité du contenu médical de celui-ci. Il peut s’agir de l’auteur du document si celui-ci est une personne et s’il endosse la responsabilité du contenu médical de ses documents. Si l’auteur est un dispositif, cet attribut doit représenter la personne responsable de l’action effectuée par le dispositif. Pour les documents d’expression personnelle du patient, cet attribut fait référence au patient.
... relatesTo C 0..* BackboneElement Relation avec d'autres fiches
Constraints: constr-cdr-rempl, constr-bind-relatesTo
.... code 1..1 code Représente le type d'association entre deux fiches.
.... target C 1..1 Reference(DocumentReference) Représente l'identifiant d'une association entre deux fiches.
Constraints: constr-bind-relatesToTarget
... description S 0..1 string Commentaire associé au document.
... securityLabel C 1..* CodeableConcept Contient les informations définissant le niveau de confidentialité d'un document.
Constraints: constr-bind-securityLabel
... content S 1..1 BackboneElement Document référencé.
.... attachment
..... language 1..1 code Pour tous les documents produits par les systèmes initiateurs français, le code est "fr-FR'.
..... url C 1..1 url Représente la référence vers une ressource Binary où se trouvent les données du document référencé
Constraints: constr-bind-attachmenturl
..... size 1..1 unsignedInt Représente la taille du document.
..... hash 1..1 base64Binary Représente le résultat de hachage du document (SHA 1).
..... title 1..1 string Label to display in place of the data
..... creation 1..1 dateTime Représente la date et l’heure de création du document
.... format C 1..1 Coding Format technique détaillé du document.
Binding: JDV_J10_XdsFormatCode_CISIS (preferred)
Constraints: constr-bind-format
... context S 1..1 BackboneElement Clinical context of document
.... event C 0..* CodeableConcept Représente les actes et les pathologies en rapport avec le document.
Constraints: constr-bind-context-event
.... period 1..1 Period Time of service that is being documented
..... start 1..1 dateTime Starting time with inclusive boundary
..... end 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType C 1..1 CodeableConcept Secteur d'activité lié à la prise en charge de la personne, en lien avec le document produit.
Binding: JDV_J02_XdsHealthcareFacilityTypeCode_CISIS (preferred)
Constraints: constr-bind-ProducteurDoc
.... practiceSetting C 1..1 CodeableConcept Cadre d’exercice de l’acte qui a engendré la création du document.
Binding: JDV_J04_XdsPracticeSettingCode_CISIS (preferred)
Constraints: constr-bind-ProducteurDoc
.... sourcePatientInfo 1..1 Reference(FR Core Patient Profile) {c} Référence vers la ressource Patient titulaire du dossier.
.... Slices pour related S 0..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by pattern:type
..... related:referenceIdList 0..* Reference(Resource) Données d’un « identifiant de référence » (referenceIdList)
...... identifier S 0..1 Identifier Logical reference, when literal reference is not known
....... type
........ coding
......... system 0..1 uri Identity of the terminology system
Required Pattern: urn:ietf:rfc:3986
......... code S 0..1 code [CXi.5] Identifier Type Code : urn:ihe:iti:xds:2016:studyInstanceUID | urn:ihe:iti:xds:2013:order | urn:ihe:iti:xds:2013:accession
....... system S 0..1 uri [CXi.4.2] Assigning Authority (ce champs n'est pas présent systématiquement, il ne l'est dans le cas de studyInstanceUID notamment).
....... value S 1..1 string [CXi.1] Accession number

doco Documentation for this format

Terminology Bindings (Differential)

Path Statut Usage ValueSet Version Source
DocumentReference.type Base preferred JDV_J07_XdsTypeCode_CISIS 📦20250623120000 Terminologies de Santé v1.2
DocumentReference.category Base preferred JDV_J06_XdsClassCode_CISIS 📦20230922120000 Terminologies de Santé v1.2
DocumentReference.content.​format Base preferred JDV_J10_XdsFormatCode_CISIS 📦20240726120000 Terminologies de Santé v1.2
DocumentReference.context.​facilityType Base preferred JDV_J02_XdsHealthcareFacilityTypeCode_CISIS 📦20250523120000 Terminologies de Santé v1.2
DocumentReference.context.​practiceSetting Base preferred JDV_J04_XdsPracticeSettingCode_CISIS 📦20240927120000 Terminologies de Santé v1.2

Constraints

Id Grade Path(s) Description Expression
constr-bind-ProducteurDoc error DocumentReference.context.facilityType, DocumentReference.context.practiceSetting Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A00-ProducteurDocNonPS, OID : 1.2.250.1.213.1.1.4.6 (lorsque l’auteur du document est un patient ou un équipement sous sa responsabilité) - TRE_R02-SecteurActivite, OID : 1.2.250.1.71.4.2.4 (lorsque l’auteur du document est un professionnel ou un équipement sous sa responsabilité) Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J61-HealthcareFacilityTypeCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J02-XdsHealthcareFacilityTypeCode-CISIS peut être utilisé.
constr-bind-attachmenturl error DocumentReference.content.attachment.url Dans le cas de l’ajout de document, l’url fait référence à la ressource Binary (« Binary/[id] »). Dans le cas de la recherche, il s’agit de l’URL permettant d’accéder au document
constr-bind-category error DocumentReference.category Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A03-ClasseDocument-CISIS, OID : 1.2.250.1.213.1.1.4.1 - TRE_A10-NomenclatureURN, OID : URN Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J57-ClassCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J06-XdsClassCode-CISIS peut être utilisé.
constr-bind-context-event error DocumentReference.context.event Nomenclatures utilisées : 1) CCAM pour les actes médicaux (OID="1.2.250.1.213.2.5"); 2) CIM-10 pour les diagnostics de pathologie (OID="2.16.840.1.113883.6.3"), 3) TRE_A00-ProducteurDocNonPS pour les documents d'expression personnelle du patient, 4) autre
constr-bind-format error DocumentReference.content.format Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A06-FormatCodeComplementaire, OID : 1.2.250.1.213.1.1.4.2.282 - TRE_A11-IheFormatCode, OID : 1.3.6.1.4.1.19376.1.2.3 - TRE_A09-DICOMuidRegistry, OID : 1.2.840.10008.2.6.1 - TRE_A10-NomenclatureURN, OID : URN Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J60-FormatCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J10-XdsFormatCode-CISIS peut être utilisé.
constr-bind-relatesTo error DocumentReference.relatesTo Cardinalité contrainte à [1..1] lorsque le flux envoyé correspond au remplacement d’un document.
constr-bind-relatesToTarget error DocumentReference.relatesTo.target Référence contrainte au profil PDSm_ComprehensiveDocumentReference
constr-bind-securityLabel error DocumentReference.securityLabel Les codes pour cet élément doivent provenir du ValueSet spécifié par le standard. Lorsqu’aucun code ne correspond au concept recherché, un code provenant de la terminologie de référence TRE_A07-StatusVisibiliteDocument, OID : 1.2.250.1.213.1.1.4.13 peut être utilisé.
constr-bind-type error DocumentReference.type Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : TRE_A05-TypeDocComplementaireCISIS, OID : 1.2.250.1.213.1.1.4.12 LOINC, OID : 2.16.840.1.113883.6.1 TRE_A12-NomenclatureASTM, OID : ASTM Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J66-TypeCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J07-XdsTypeCode-CISIS peut être utilisé.
constr-cdr-rempl error DocumentReference.relatesTo Elément requis lorsque le flux envoyé correspond au remplacement d'un document

Snapshot View

NomDrapeauxCard.TypeDescription et contraintes    Filter: Filtersdoco
.. DocumentReference C 0..* ComprehensiveDocumentReference A reference to a document
Constraints: iti-mhd-repl
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Numéro de version de la fiche d’un document attribué par le système cible. La valeur de la métadonnée version est égale à 1 pour la première version de la fiche. Cet élément est requis lorsque le flux envoyé correspond à une mise à jour des données d’une fiche.
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained S 1..* Resource Ressource contenue. Dans le cadre de ce profil, il est obligatoire qu'il y ait au moins une ressource contenue : la•les ressource•s référencée•s dans les attributs author et authenticator
... Slices pour extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isArchived S 0..1 boolean Extension définie pour distinguer les fiches archivées des actives.
URL: https://interop.esante.gouv.fr/ig/fhir/pdsm/StructureDefinition/pdsm-ext-is-archived
... masterIdentifier S 1..1 UniqueIdIdentifier Représente l’identifiant unique global affecté au document par son créateur. Il est utilisable comme référence externe dans d’autres documents.
... Slices pour identifier SΣ 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
... type SΣC 1..1 CodeableConcept Représente le type du document.
Binding: JDV_J07_XdsTypeCode_CISIS (preferred)
Constraints: constr-bind-type
... category SΣC 1..1 CodeableConcept Représente la classe du document (compte rendu, imagerie médicale, traitement, certificat,...).
Binding: JDV_J06_XdsClassCode_CISIS (preferred)
Constraints: constr-bind-category
... subject SΣ 1..1 Reference(FR Core Patient Profile) Référence vers le patient concerné par le document. Cette même ressource est référencée depuis context.sourcePatientInfo.
... date SΣ 0..1 instant Représente la date de création de la ressource DocumentReference dans FHIR
... author SΣ 1..* Reference(AS PractitionerRole Profile | Device | FR Core Patient Profile) {c} Personnes physiques ou morales et/ou les dispositifs auteurs d'un document.
... authenticator S 1..1 Reference(AS PractitionerRole Profile | AS Organization Profile) {c} Cet attribut représente l’acteur validant le document et prenant la responsabilité du contenu médical de celui-ci. Il peut s’agir de l’auteur du document si celui-ci est une personne et s’il endosse la responsabilité du contenu médical de ses documents. Si l’auteur est un dispositif, cet attribut doit représenter la personne responsable de l’action effectuée par le dispositif. Pour les documents d’expression personnelle du patient, cet attribut fait référence au patient.
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣC 0..* BackboneElement Relation avec d'autres fiches
Constraints: constr-cdr-rempl, constr-bind-relatesTo
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Représente le type d'association entre deux fiches.
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target ΣC 1..1 Reference(DocumentReference) Représente l'identifiant d'une association entre deux fiches.
Constraints: constr-bind-relatesToTarget
... description SΣ 0..1 string Commentaire associé au document.
... securityLabel SΣC 1..* CodeableConcept Contient les informations définissant le niveau de confidentialité d'un document.
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Constraints: constr-bind-securityLabel
... content SΣ 1..1 BackboneElement Document référencé.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Exemple General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Pour tous les documents produits par les systèmes initiateurs français, le code est "fr-FR'.
Binding: CommonLanguages (preferred): A human language.
Bindings AdditionnelsBut
AllLanguages Binding Max

Exemple General: en-AU
..... url ΣC 1..1 url Représente la référence vers une ressource Binary où se trouvent les données du document référencé
Constraints: constr-bind-attachmenturl
Exemple General: http://www.acme.com/logo-small.png
..... size Σ 1..1 unsignedInt Représente la taille du document.
..... hash Σ 1..1 base64Binary Représente le résultat de hachage du document (SHA 1).
..... title Σ 1..1 string Label to display in place of the data
Exemple General: Official Corporate Logo
..... creation SΣ 1..1 dateTime Représente la date et l’heure de création du document
.... format SΣC 1..1 Coding Format technique détaillé du document.
Binding: JDV_J10_XdsFormatCode_CISIS (preferred)
Constraints: constr-bind-format
... context SΣ 1..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event C 0..* CodeableConcept Représente les actes et les pathologies en rapport avec le document.
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
Constraints: constr-bind-context-event
.... period SΣ 1..1 Period Time of service that is being documented
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 1..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType SC 1..1 CodeableConcept Secteur d'activité lié à la prise en charge de la personne, en lien avec le document produit.
Binding: JDV_J02_XdsHealthcareFacilityTypeCode_CISIS (preferred)
Constraints: constr-bind-ProducteurDoc
.... practiceSetting SC 1..1 CodeableConcept Cadre d’exercice de l’acte qui a engendré la création du document.
Binding: JDV_J04_XdsPracticeSettingCode_CISIS (preferred)
Constraints: constr-bind-ProducteurDoc
.... sourcePatientInfo S 1..1 Reference(FR Core Patient Profile) {c} Référence vers la ressource Patient titulaire du dossier.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... Slices pour related S 0..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by pattern:type
..... related:referenceIdList 0..* Reference(Resource) Données d’un « identifiant de référence » (referenceIdList)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ 0..1 uri Identity of the terminology system
Required Pattern: urn:ietf:rfc:3986
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣ 0..1 code [CXi.5] Identifier Type Code : urn:ihe:iti:xds:2016:studyInstanceUID | urn:ihe:iti:xds:2013:order | urn:ihe:iti:xds:2013:accession
......... display Σ 0..1 string Representation defined by the system
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
....... system SΣ 0..1 uri [CXi.4.2] Assigning Authority (ce champs n'est pas présent systématiquement, il ne l'est dans le cas de studyInstanceUID notamment).
Exemple General: http://www.acme.com/identifiers/patient
....... value SΣ 1..1 string [CXi.1] Accession number
Exemple General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Statut Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.meta.​tag Base example Common Tags 📦4.0.1 FHIR Std.
DocumentReference.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.0 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred JDV_J07_XdsTypeCode_CISIS 📦20250623120000 Terminologies de Santé v1.2
DocumentReference.category Base preferred JDV_J06_XdsClassCode_CISIS 📦20230922120000 Terminologies de Santé v1.2
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred JDV_J10_XdsFormatCode_CISIS 📦20240726120000 Terminologies de Santé v1.2
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v6.5
DocumentReference.context.​facilityType Base preferred JDV_J02_XdsHealthcareFacilityTypeCode_CISIS 📦20250523120000 Terminologies de Santé v1.2
DocumentReference.context.​practiceSetting Base preferred JDV_J04_XdsPracticeSettingCode_CISIS 📦20240927120000 Terminologies de Santé v1.2
DocumentReference.context.​sourcePatientInfo.type Base extensible ResourceType 📦4.0.1 FHIR Std.
DocumentReference.context.​related:referenceIdList.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DocumentReference.context.​related:referenceIdList.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.context.​related:referenceIdList.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
constr-bind-ProducteurDoc error DocumentReference.context.facilityType, DocumentReference.context.practiceSetting Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A00-ProducteurDocNonPS, OID : 1.2.250.1.213.1.1.4.6 (lorsque l’auteur du document est un patient ou un équipement sous sa responsabilité) - TRE_R02-SecteurActivite, OID : 1.2.250.1.71.4.2.4 (lorsque l’auteur du document est un professionnel ou un équipement sous sa responsabilité) Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J61-HealthcareFacilityTypeCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J02-XdsHealthcareFacilityTypeCode-CISIS peut être utilisé.
constr-bind-attachmenturl error DocumentReference.content.attachment.url Dans le cas de l’ajout de document, l’url fait référence à la ressource Binary (« Binary/[id] »). Dans le cas de la recherche, il s’agit de l’URL permettant d’accéder au document
constr-bind-category error DocumentReference.category Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A03-ClasseDocument-CISIS, OID : 1.2.250.1.213.1.1.4.1 - TRE_A10-NomenclatureURN, OID : URN Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J57-ClassCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J06-XdsClassCode-CISIS peut être utilisé.
constr-bind-context-event error DocumentReference.context.event Nomenclatures utilisées : 1) CCAM pour les actes médicaux (OID="1.2.250.1.213.2.5"); 2) CIM-10 pour les diagnostics de pathologie (OID="2.16.840.1.113883.6.3"), 3) TRE_A00-ProducteurDocNonPS pour les documents d'expression personnelle du patient, 4) autre
constr-bind-format error DocumentReference.content.format Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : - TRE_A06-FormatCodeComplementaire, OID : 1.2.250.1.213.1.1.4.2.282 - TRE_A11-IheFormatCode, OID : 1.3.6.1.4.1.19376.1.2.3 - TRE_A09-DICOMuidRegistry, OID : 1.2.840.10008.2.6.1 - TRE_A10-NomenclatureURN, OID : URN Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J60-FormatCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J10-XdsFormatCode-CISIS peut être utilisé.
constr-bind-relatesTo error DocumentReference.relatesTo Cardinalité contrainte à [1..1] lorsque le flux envoyé correspond au remplacement d’un document.
constr-bind-relatesToTarget error DocumentReference.relatesTo.target Référence contrainte au profil PDSm_ComprehensiveDocumentReference
constr-bind-securityLabel error DocumentReference.securityLabel Les codes pour cet élément doivent provenir du ValueSet spécifié par le standard. Lorsqu’aucun code ne correspond au concept recherché, un code provenant de la terminologie de référence TRE_A07-StatusVisibiliteDocument, OID : 1.2.250.1.213.1.1.4.13 peut être utilisé.
constr-bind-type error DocumentReference.type Les valeurs possibles pour cet élément doivent provenir d’une des terminologies de référence suivantes : TRE_A05-TypeDocComplementaireCISIS, OID : 1.2.250.1.213.1.1.4.12 LOINC, OID : 2.16.840.1.113883.6.1 TRE_A12-NomenclatureASTM, OID : ASTM Les valeurs possibles peuvent être restreintes en fonction du jeu de valeurs correspondant mis à disposition par le projet (exemple : JDV_J66-TypeCode-DMP). En l’absence de spécifications complémentaires, le jeu de valeurs JDV_J07-XdsTypeCode-CISIS peut être utilisé.
constr-cdr-rempl error DocumentReference.relatesTo Elément requis lorsque le flux envoyé correspond au remplacement d'un document
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
iti-mhd-repl error DocumentReference a DocumetReference replacements needs to relate to a superseded DocumentReference relatesTo.empty() or (relatesTo.code='replaces' implies relatesTo.target.exists())

This structure is derived from ComprehensiveDocumentReference

Résumé

Mandatory: 8 elements(1 nested mandatory element)
Must-Support: 14 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DocumentReference.context.related

 

Other representations of profile: CSV, Excel, Schematron