Search FHIR

Médicosocial - Transfert de données DUI
2.3.0 - trial-implementation France flag

Médicosocial - Transfert de données DUI - version de développement local (intégration continue v2.3.0) construite par les outils de publication FHIR (HL7® FHIR® Standard). Voir le répertoire des versions publiées

Resource Profile: TDDUIDocumentReference - Detailed Descriptions

Active as of 2026-03-17

Definitions for the tddui-document-reference resource profile.

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

0. DocumentReference
Définition

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

CourtA reference to a document
Commentaires

Usually, this is used for documents other than those defined by FHIR.

Contrôle0..*
Est modificateurfalse
Résuméfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. DocumentReference.meta
Définition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

CourtMetadata about the resource
Contrôle0..1
TypeMeta
Est modificateurfalse
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. DocumentReference.meta.versionId
Définition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

CourtNumé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.Version specific identifier
Commentaires

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Contrôle0..1
Typeid
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Doit être pris en charge (Must Support)true
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. DocumentReference.implicitRules
Définition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

CourtA set of rules under which this content was created
Commentaires

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Contrôle0..1
Typeuri
Est modificateurtrue parce que This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. DocumentReference.modifierExtension
Définition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CourtExtensionExtensions that cannot be ignored
Commentaires

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Contrôle0..0*
TypeExtension
Est modificateurtrue parce que Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Résuméfalse
Exigences

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Noms alternatifsextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. DocumentReference.masterIdentifier
Définition

Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

CourtReprésente l’identifiant unique global affecté au document par son créateur. Il est utilisable comme référence externe dans d’autres documents.Master Version Specific Identifier
Commentaires

CDA Document Id extension and root.

Contrôle10..1
TypeIdentifier
Est modificateurfalse
Doit être pris en charge (Must Support)true
Résumétrue
Exigences

The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. DocumentReference.identifier
Définition

Other identifiers associated with the document, including version independent identifiers.

CourtOther identifiers for the document
NoteCeci est un identifiant métier, pas un identifiant de ressource (voir discussion)
Contrôle0..0*
TypeIdentifier
Est modificateurfalse
Doit être pris en charge (Must Support)true
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. DocumentReference.status
Définition

The status of this document reference.

Courtcurrent | superseded | entered-in-error
Commentaires

This is the status of the DocumentReference object, which might be independent from the docStatus element.

This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.

Contrôle1..1
BindingLes codes DOIVENT (SHALL) être pris de DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1)

The status of the document reference.

Typecode
Est modificateurtrue parce que This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Doit être pris en charge (Must Support)true
Résumétrue
Valeur de motifcurrent
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. DocumentReference.docStatus
Définition

The status of the underlying document.

Courtpreliminary | final | amended | entered-in-error
Commentaires

The document that is pointed to might be in various lifecycle states.

Contrôle0..01
BindingLes codes DOIVENT (SHALL) être pris de CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/composition-status|4.0.1)

Status of the underlying document.

Typecode
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. DocumentReference.type
Définition

Représente le type du document.


Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

CourtKind of document (LOINC if possible)
Commentaires

Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.

Contrôle0..1
BindingLes codes DEVRAIENT (SHOULD) être pris de JDV_J07_XdsTypeCode_CISIShttp://hl7.org/fhir/ValueSet/c80-doc-typecodes|4.0.1
(preferred to https://mos.esante.gouv.fr/NOS/JDV_J07-XdsTypeCode-CISIS/FHIR/JDV-J07-XdsTypeCode-CISIS)
TypeCodeableConcept
Est modificateurfalse
Doit être pris en charge (Must Support)true
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
constr-bind-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é. ()
20. DocumentReference.category
Définition

A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

CourtReprésente la classe du document (compte rendu, imagerie médicale, traitement, certificat,...).Categorization of document
Commentaires

Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.

Contrôle0..1*
BindingLes codes DEVRAIENT (SHOULD) être pris de Pour des exemples de codes, voir JDV_J06_XdsClassCode_CISIShttp://hl7.org/fhir/ValueSet/document-classcodes|4.0.1
(preferred to https://mos.esante.gouv.fr/NOS/JDV_J06-XdsClassCode-CISIS/FHIR/JDV-J06-XdsClassCode-CISIS)
TypeCodeableConcept
Est modificateurfalse
Doit être pris en charge (Must Support)true
Résumétrue
Noms alternatifsclaxs
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
constr-bind-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é. ()
22. DocumentReference.subject
Définition

Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

CourtPatient concerné par ce document. La ressource référencée peut être présente sous l’élément DocumentReference.contained ou via le champ identifier.Who/what is the subject of the document
Contrôle10..1
TypeReference(TDDUI Patient, TDDUI Patient INS, Patient, Practitioner, Group, Device)
Est modificateurfalse
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. DocumentReference.date
Définition

When the document reference was created.

CourtReprésente la date de création de la ressource DocumentReference dans FHIRWhen this document reference was created
Commentaires

Referencing/indexing time is used for tracking, organizing versions and searching.

Contrôle0..1
Typeinstant
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Doit être pris en charge (Must Support)true
Résumétrue
Noms alternatifsindexed
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. DocumentReference.author
Définition

Identifies who is responsible for adding the information to the document.

CourtPersonnes physiques ou morales et/ou les dispositifs auteurs d'un document.Who and/or what authored the document
Commentaires

Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).

Contrôle10..*
TypeReference(TDDUI Practitioner Role, TDDUI Practitioner, TDDUI Organization, TDDUI Patient, TDDUI Patient INS, Device, FR Core Related Person Profile, Practitioner, PractitionerRole, Organization, Device, Patient, RelatedPerson)
Est modificateurfalse
Doit être pris en charge (Must Support)true
Types qui doivent être pris en charge (Must Support)Aucune règle de prise en charge obligatoire concernant le choix des types/profils
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. DocumentReference.authenticator
Définition

Which person or organization authenticates that this document is valid.

CourtCet 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.Who/what authenticated the document
Commentaires

Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.

Contrôle0..1
TypeReference(TDDUI Practitioner Role, TDDUI Organization, Practitioner, PractitionerRole, Organization)
Est modificateurfalse
Doit être pris en charge (Must Support)true
Types qui doivent être pris en charge (Must Support)Aucune règle de prise en charge obligatoire concernant le choix des types/profils
Résuméfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. DocumentReference.relatesTo
Définition

Relationships that this document has with other document references that already exist.

CourtRelationships to other documents
Commentaires

This element is labeled as a modifier because documents that append to other documents are incomplete on their own.

Contrôle0..*
TypeBackboneElement
Est modificateurfalse
Doit être pris en charge (Must Support)true
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. DocumentReference.relatesTo.modifierExtension
Définition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CourtExtensions that cannot be ignored even if unrecognized
Commentaires

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Contrôle0..*
TypeExtension
Est modificateurtrue parce que Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Résumétrue
Exigences

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Noms alternatifsextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. DocumentReference.relatesTo.code
Définition

The type of relationship that this document has with anther document.

Courtreplaces | transforms | signs | appends
Commentaires

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

Contrôle1..1
BindingLes codes DOIVENT (SHALL) être pris de DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1)

The type of relationship between documents.

Typecode
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. DocumentReference.relatesTo.target
Définition

The target document of this relationship.

CourtTarget of the relationship
Contrôle1..1
TypeReference(DocumentReference, DocumentReference)
Est modificateurfalse
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. DocumentReference.description
Définition

Human-readable description of the source document.

CourtCommentaire associé au document.Human-readable description
Commentaires

What the document is about, a terse summary of the document.

Contrôle0..1
Typestring
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Doit être pris en charge (Must Support)true
Résumétrue
Exigences

Helps humans to assess whether the document is of interest.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. DocumentReference.securityLabel
Définition

A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

CourtContient les informations définissant le niveau de confidentialité d'un document.Document security-tags
Commentaires

The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce.

In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.

Contrôle0..*
BindingSauf si inapproprié, ces codes DOIVENT (SHALL) être pris de All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/security-labels)

Security Labels from the Healthcare Privacy and Security Classification System.

TypeCodeableConcept
Est modificateurfalse
Doit être pris en charge (Must Support)true
Résumétrue
Exigences

Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
constr-bind-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é. ()
42. DocumentReference.content
Définition

The document and format referenced.


The document and format referenced. There may be multiple content element repetitions, each with a different format.

CourtDocument contenu.Document referenced
Contrôle1..1*
TypeBackboneElement
Est modificateurfalse
Doit être pris en charge (Must Support)true
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. DocumentReference.content.modifierExtension
Définition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CourtExtensions that cannot be ignored even if unrecognized
Commentaires

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Contrôle0..*
TypeExtension
Est modificateurtrue parce que Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Résumétrue
Exigences

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Noms alternatifsextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
46. DocumentReference.content.attachment
Définition

The document or URL of the document along with critical metadata to prove content has integrity.

CourtWhere to access the document
Contrôle1..1
TypeAttachment
Est modificateurfalse
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. DocumentReference.content.attachment.contentType
Définition

Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

CourtMime type of the content, with charset etc.
Contrôle10..1
BindingLes codes DOIVENT (SHALL) être pris de Mime Typeshttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
(required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

The mime type of an attachment. Any valid mime type is allowed.

Typecode
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Résumétrue
Exigences

Processors of the data need to be able to know how to interpret the data.

ExempleGeneral: text/plain; charset=UTF-8, image/png
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. DocumentReference.content.attachment.language
Définition

The human language of the content. The value can be any valid value according to BCP 47.

CourtPour tous les documents produits par les systèmes initiateurs français, le code est "fr-FR'.Human language of the content (BCP-47)
Contrôle0..1
BindingLes codes DEVRAIENT (SHOULD) être pris de CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Bindings AdditionnelsBut
AllLanguagesBinding Max
Typecode
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Doit être pris en charge (Must Support)true
Résumétrue
Exigences

Users need to be able to choose between the languages in a set of attachments.

ExempleGeneral: en-AU
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. DocumentReference.content.attachment.data
Définition

The actual data of the attachment - a sequence of bytes, base64 encoded.

CourtLe document est contenu dans l'élément .data au format base64.Data inline, base64ed
Commentaires

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

Contrôle10..1
Typebase64Binary
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Résuméfalse
Exigences

The data needs to able to be transmitted inline.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. DocumentReference.content.attachment.url
Définition

A location where the data can be accessed.

CourtUri where the data can be found
Commentaires

If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

Contrôle0..01
Typeurl
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Résumétrue
Exigences

The data needs to be transmitted by reference.

ExempleGeneral: http://www.acme.com/logo-small.png
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. DocumentReference.content.attachment.size
Définition

The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

CourtReprésente la taille du document.Number of bytes of content (if url provided)
Commentaires

The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

Contrôle0..1
TypeunsignedInt
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Résumétrue
Exigences

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. DocumentReference.content.attachment.hash
Définition

The calculated hash of the data using SHA-1. Represented using base64.

CourtReprésente le résultat de hachage du document (SHA 1).Hash of the data (sha-1, base64ed)
Commentaires

The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.


The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

Contrôle0..1
Typebase64Binary
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Résumétrue
Exigences

Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. DocumentReference.content.attachment.title
Définition

A label or set of text to display in place of the data.

CourtLabel to display in place of the data
Contrôle10..1
Typestring
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Résumétrue
Exigences

Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

ExempleGeneral: Official Corporate Logo
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. DocumentReference.content.attachment.creation
Définition

The date that the attachment was first created.

CourtReprésente la date et l’heure de création du document.Date attachment was first created
Contrôle0..1
TypedateTime
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Doit être pris en charge (Must Support)true
Résumétrue
Exigences

This is often tracked as an integrity issue for use of the attachment.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. DocumentReference.content.format
Définition

An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

CourtFormat technique détaillé du document.Format/content rules for the document
Commentaires

Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI.

Contrôle0..1
BindingLes codes DEVRAIENT (SHOULD) être pris de JDV_J10_XdsFormatCode_CISIShttp://hl7.org/fhir/ValueSet/formatcodes|4.0.1
(preferred to https://mos.esante.gouv.fr/NOS/JDV_J10-XdsFormatCode-CISIS/FHIR/JDV-J10-XdsFormatCode-CISIS)
TypeCoding
Est modificateurfalse
Doit être pris en charge (Must Support)true
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
constr-bind-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é. ()
66. DocumentReference.context
Définition

The clinical context in which the document was prepared.

CourtClinical context of document
Commentaires

These values are primarily added to help with searching for interesting/relevant documents.

Contrôle0..1
TypeBackboneElement
Est modificateurfalse
Doit être pris en charge (Must Support)true
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. DocumentReference.context.modifierExtension
Définition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CourtExtensions that cannot be ignored even if unrecognized
Commentaires

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Contrôle0..*
TypeExtension
Est modificateurtrue parce que Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Résumétrue
Exigences

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Noms alternatifsextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
70. DocumentReference.context.event
Définition

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

CourtReprésente les actes et les pathologies en rapport avec le document.Main clinical acts documented
Commentaires

An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.

Contrôle0..1*
BindingPour des exemples de codes, voir v3 Code System ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode
(example to http://terminology.hl7.org/ValueSet/v3-ActCode)

This list of codes represents the main clinical acts being documented.

TypeCodeableConcept
Est modificateurfalse
Résuméfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
constr-bind-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 ()
72. DocumentReference.context.period
Définition

The time period over which the service that is described by the document was provided.

CourtTime of service that is being documented
Contrôle0..1
TypePeriod
Est modificateurfalse
Doit être pris en charge (Must Support)true
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. DocumentReference.context.facilityType
Définition

The kind of facility where the patient was seen.

CourtSecteur d'activité lié à la prise en charge de la personne, en lien avec le document produit.Kind of facility where patient was seen
Contrôle0..1
BindingLes codes DEVRAIENT (SHOULD) être pris de Pour des exemples de codes, voir JDV_J02_XdsHealthcareFacilityTypeCode_CISIShttp://hl7.org/fhir/ValueSet/c80-facilitycodes|4.0.1
(preferred to https://mos.esante.gouv.fr/NOS/JDV_J02-XdsHealthcareFacilityTypeCode-CISIS/FHIR/JDV-J02-XdsHealthcareFacilityTypeCode-CISIS)
TypeCodeableConcept
Est modificateurfalse
Doit être pris en charge (Must Support)true
Résuméfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
constr-bind-ProducteurDoc-simplified: L’utilisation de cette nomenclature est recommandée mais non obligatoire (prefered) : - 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é. ()
76. DocumentReference.context.practiceSetting
Définition

This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

CourtCadre d’exercice de l’acte qui a engendré la création du document.Additional details about where the content was created (e.g. clinical specialty)
Commentaires

This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.

Contrôle0..1
BindingLes codes DEVRAIENT (SHOULD) être pris de Pour des exemples de codes, voir JDV_J04_XdsPracticeSettingCode_CISIShttp://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1
(preferred to https://mos.esante.gouv.fr/NOS/JDV_J04-XdsPracticeSettingCode-CISIS/FHIR/JDV-J04-XdsPracticeSettingCode-CISIS)
TypeCodeableConcept
Est modificateurfalse
Doit être pris en charge (Must Support)true
Résuméfalse
Exigences

This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
constr-bind-ProducteurDoc-simplified: L’utilisation de cette nomenclature est recommandée mais non obligatoire (prefered) : - 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é. ()
78. DocumentReference.context.sourcePatientInfo
Définition

The Patient Information as known when the document was published. May be a reference to a version specific, or contained.

CourtRéférence vers la ressource Patient titulaire du dossier.Patient demographics from source
Contrôle0..1
TypeReference(TDDUI Patient, TDDUI Patient INS, Patient)
Est modificateurfalse
Doit être pris en charge (Must Support)true
Types qui doivent être pris en charge (Must Support)Aucune règle de prise en charge obligatoire concernant le choix des types/profils
Résuméfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. DocumentReference
2. DocumentReference.meta
4. DocumentReference.meta.versionId
CourtNumé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.
Doit être pris en charge (Must Support)true
6. DocumentReference.masterIdentifier
CourtReprésente l’identifiant unique global affecté au document par son créateur. Il est utilisable comme référence externe dans d’autres documents.
Doit être pris en charge (Must Support)true
8. DocumentReference.identifier
NoteCeci est un identifiant métier, pas un identifiant de ressource (voir discussion)
Doit être pris en charge (Must Support)true
10. DocumentReference.status
Doit être pris en charge (Must Support)true
12. DocumentReference.type
Définition

Représente le type du document.

BindingLes codes DEVRAIENT (SHOULD) être pris de JDV_J07_XdsTypeCode_CISIS
(preferred to https://mos.esante.gouv.fr/NOS/JDV_J07-XdsTypeCode-CISIS/FHIR/JDV-J07-XdsTypeCode-CISIS)
Invariantsconstr-bind-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é. ()
14. DocumentReference.category
CourtReprésente la classe du document (compte rendu, imagerie médicale, traitement, certificat,...).
BindingLes codes DEVRAIENT (SHOULD) être pris de JDV_J06_XdsClassCode_CISIS
(preferred to https://mos.esante.gouv.fr/NOS/JDV_J06-XdsClassCode-CISIS/FHIR/JDV-J06-XdsClassCode-CISIS)
Invariantsconstr-bind-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é. ()
16. DocumentReference.subject
CourtPatient concerné par ce document. La ressource référencée peut être présente sous l’élément DocumentReference.contained ou via le champ identifier.
TypeReference(TDDUI Patient, TDDUI Patient INS)
18. DocumentReference.date
CourtReprésente la date de création de la ressource DocumentReference dans FHIR
20. DocumentReference.author
CourtPersonnes physiques ou morales et/ou les dispositifs auteurs d'un document.
Contrôle1..?
TypeReference(TDDUI Practitioner Role, TDDUI Practitioner, TDDUI Organization, TDDUI Patient, TDDUI Patient INS, Device, FR Core Related Person Profile)
22. DocumentReference.authenticator
CourtCet 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.
TypeReference(TDDUI Practitioner Role, TDDUI Organization)
Doit être pris en charge (Must Support)true
Types qui doivent être pris en charge (Must Support)Aucune règle de prise en charge obligatoire concernant le choix des types/profils
24. DocumentReference.description
CourtCommentaire associé au document.
Doit être pris en charge (Must Support)true
26. DocumentReference.securityLabel
CourtContient les informations définissant le niveau de confidentialité d'un document.
Invariantsconstr-bind-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é. ()
28. DocumentReference.content
CourtDocument contenu.
Doit être pris en charge (Must Support)true
30. DocumentReference.content.attachment
32. DocumentReference.content.attachment.language
CourtPour tous les documents produits par les systèmes initiateurs français, le code est "fr-FR'.
34. DocumentReference.content.attachment.data
CourtLe document est contenu dans l'élément .data au format base64.
36. DocumentReference.content.attachment.size
CourtReprésente la taille du document.
38. DocumentReference.content.attachment.hash
CourtReprésente le résultat de hachage du document (SHA 1).
40. DocumentReference.content.attachment.title
Contrôle1..?
42. DocumentReference.content.attachment.creation
CourtReprésente la date et l’heure de création du document.
44. DocumentReference.content.format
CourtFormat technique détaillé du document.
BindingLes codes DEVRAIENT (SHOULD) être pris de JDV_J10_XdsFormatCode_CISIS
(preferred to https://mos.esante.gouv.fr/NOS/JDV_J10-XdsFormatCode-CISIS/FHIR/JDV-J10-XdsFormatCode-CISIS)
Invariantsconstr-bind-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é. ()
46. DocumentReference.context
Doit être pris en charge (Must Support)true
48. DocumentReference.context.event
CourtReprésente les actes et les pathologies en rapport avec le document.
Contrôle0..1
Invariantsconstr-bind-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 ()
50. DocumentReference.context.facilityType
CourtSecteur d'activité lié à la prise en charge de la personne, en lien avec le document produit.
BindingLes codes DEVRAIENT (SHOULD) être pris de JDV_J02_XdsHealthcareFacilityTypeCode_CISIS
(preferred to https://mos.esante.gouv.fr/NOS/JDV_J02-XdsHealthcareFacilityTypeCode-CISIS/FHIR/JDV-J02-XdsHealthcareFacilityTypeCode-CISIS)
Invariantsconstr-bind-ProducteurDoc-simplified: L’utilisation de cette nomenclature est recommandée mais non obligatoire (prefered) : - 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é. ()
52. DocumentReference.context.practiceSetting
CourtCadre d’exercice de l’acte qui a engendré la création du document.
BindingLes codes DEVRAIENT (SHOULD) être pris de JDV_J04_XdsPracticeSettingCode_CISIS
(preferred to https://mos.esante.gouv.fr/NOS/JDV_J04-XdsPracticeSettingCode-CISIS/FHIR/JDV-J04-XdsPracticeSettingCode-CISIS)
Invariantsconstr-bind-ProducteurDoc-simplified: L’utilisation de cette nomenclature est recommandée mais non obligatoire (prefered) : - 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é. ()
54. DocumentReference.context.sourcePatientInfo
CourtRéférence vers la ressource Patient titulaire du dossier.
TypeReference(TDDUI Patient, TDDUI Patient INS)

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

0. DocumentReference
Définition

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

CourtA reference to a document
Commentaires

Usually, this is used for documents other than those defined by FHIR.

Contrôle0..*
Est modificateurfalse
Résuméfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. DocumentReference.id
Définition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

CourtLogical id of this artifact
Commentaires

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Contrôle0..1
Typeid
Est modificateurfalse
Résumétrue
4. DocumentReference.meta
Définition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

CourtMetadata about the resource
Contrôle0..1
TypeMeta
Est modificateurfalse
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. DocumentReference.meta.id
Définition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

CourtUnique id for inter-element referencing
Contrôle0..1
Typestring
Est modificateurfalse
Format XMLDans le format XML, cette propriété est représentée comme attribut.
Résuméfalse
8. DocumentReference.meta.extension
Définition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

CourtAdditional content defined by implementations
Commentaires

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Contrôle0..*
TypeExtension
Est modificateurfalse
Résuméfalse
Noms alternatifsextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingCet élément introduit un ensemble de slices sur DocumentReference.meta.extension. Les slices sontNon ordonné et Open, et peut être différencié en utilisant les discriminateurs suivants :
  • value @ url
  • 10. DocumentReference.meta.versionId
    Définition

    The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

    CourtNumé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.
    Commentaires

    The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

    Contrôle0..1
    Typeid
    Est modificateurfalse
    Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
    Doit être pris en charge (Must Support)true
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. DocumentReference.meta.lastUpdated
    Définition

    When the resource last changed - e.g. when the version changed.

    CourtWhen the resource version last changed
    Commentaires

    This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

    Contrôle0..1
    Typeinstant
    Est modificateurfalse
    Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. DocumentReference.meta.source
    Définition

    A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

    CourtIdentifies where the resource comes from
    Commentaires

    In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

    This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

    Contrôle0..1
    Typeuri
    Est modificateurfalse
    Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. DocumentReference.meta.profile
    Définition

    A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

    CourtProfiles this resource claims to conform to
    Commentaires

    It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

    Contrôle0..*
    Typecanonical(StructureDefinition)
    Est modificateurfalse
    Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. DocumentReference.meta.security
    Définition

    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

    CourtSecurity Labels applied to this resource
    Commentaires

    The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

    Contrôle0..*
    BindingSauf si inapproprié, ces codes DOIVENT (SHALL) être pris de All Security Labels
    (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

    Security Labels from the Healthcare Privacy and Security Classification System.

    TypeCoding
    Est modificateurfalse
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. DocumentReference.meta.tag
    Définition

    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

    CourtTags applied to this resource
    Commentaires

    The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

    Contrôle0..*
    BindingPour des exemples de codes, voir CommonTags
    (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

    Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

    TypeCoding
    Est modificateurfalse
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. DocumentReference.implicitRules
    Définition

    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

    CourtA set of rules under which this content was created
    Commentaires

    Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

    Contrôle0..1
    Typeuri
    Est modificateurtrue parce que This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. DocumentReference.language
    Définition

    The base language in which the resource is written.

    CourtLanguage of the resource content
    Commentaires

    Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

    Contrôle0..1
    BindingLes codes DEVRAIENT (SHOULD) être pris de CommonLanguages
    (preferred to http://hl7.org/fhir/ValueSet/languages)

    A human language.

    Bindings AdditionnelsBut
    AllLanguagesBinding Max
    Typecode
    Est modificateurfalse
    Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
    Résuméfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. DocumentReference.text
    Définition

    A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

    CourtText summary of the resource, for human interpretation
    Commentaires

    Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

    Contrôle0..1
    TypeNarrative
    Est modificateurfalse
    Résuméfalse
    Noms alternatifsnarrative, html, xhtml, display
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. DocumentReference.contained
    Définition

    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

    CourtContained, inline Resources
    Commentaires

    This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

    Contrôle0..*
    TypeResource
    Est modificateurfalse
    Résuméfalse
    Noms alternatifsinline resources, anonymous resources, contained resources
    30. DocumentReference.extension
    Définition

    May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    CourtAdditional content defined by implementations
    Commentaires

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Contrôle0..*
    TypeExtension
    Est modificateurfalse
    Résuméfalse
    Noms alternatifsextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    32. DocumentReference.modifierExtension
    Définition

    An Extension

    CourtExtension
    Contrôle0..0
    TypeExtension
    Est modificateurtrue parce que Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Résuméfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    34. DocumentReference.masterIdentifier
    Définition

    Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

    CourtReprésente l’identifiant unique global affecté au document par son créateur. Il est utilisable comme référence externe dans d’autres documents.
    Commentaires

    CDA Document Id extension and root.

    Contrôle1..1
    TypeIdentifier
    Est modificateurfalse
    Doit être pris en charge (Must Support)true
    Résumétrue
    Exigences

    The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. DocumentReference.identifier
    Définition

    Other identifiers associated with the document, including version independent identifiers.

    CourtOther identifiers for the document
    NoteCeci est un identifiant métier, pas un identifiant de ressource (voir discussion)
    Contrôle0..0
    TypeIdentifier
    Est modificateurfalse
    Doit être pris en charge (Must Support)true
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. DocumentReference.status
    Définition

    The status of this document reference.

    Courtcurrent | superseded | entered-in-error
    Commentaires

    This is the status of the DocumentReference object, which might be independent from the docStatus element.

    This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.

    Contrôle1..1
    BindingLes codes DOIVENT (SHALL) être pris de DocumentReferenceStatus
    (required to http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1)

    The status of the document reference.

    Typecode
    Est modificateurtrue parce que This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
    Doit être pris en charge (Must Support)true
    Résumétrue
    Valeur de motifcurrent
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. DocumentReference.docStatus
    Définition

    The status of the underlying document.

    Courtpreliminary | final | amended | entered-in-error
    Commentaires

    The document that is pointed to might be in various lifecycle states.

    Contrôle0..0
    BindingLes codes DOIVENT (SHALL) être pris de CompositionStatus
    (required to http://hl7.org/fhir/ValueSet/composition-status|4.0.1)

    Status of the underlying document.

    Typecode
    Est modificateurfalse
    Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. DocumentReference.type
    Définition

    Représente le type du document.

    CourtKind of document (LOINC if possible)
    Commentaires

    Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.

    Contrôle0..1
    BindingLes codes DEVRAIENT (SHOULD) être pris de JDV_J07_XdsTypeCode_CISIS
    (preferred to https://mos.esante.gouv.fr/NOS/JDV_J07-XdsTypeCode-CISIS/FHIR/JDV-J07-XdsTypeCode-CISIS)
    TypeCodeableConcept
    Est modificateurfalse
    Doit être pris en charge (Must Support)true
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    constr-bind-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é. ()
    44. DocumentReference.category
    Définition

    A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

    CourtReprésente la classe du document (compte rendu, imagerie médicale, traitement, certificat,...).
    Commentaires

    Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.

    Contrôle0..1
    BindingLes codes DEVRAIENT (SHOULD) être pris de JDV_J06_XdsClassCode_CISIS
    (preferred to https://mos.esante.gouv.fr/NOS/JDV_J06-XdsClassCode-CISIS/FHIR/JDV-J06-XdsClassCode-CISIS)
    TypeCodeableConcept
    Est modificateurfalse
    Doit être pris en charge (Must Support)true
    Résumétrue
    Noms alternatifsclaxs
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    constr-bind-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é. ()
    46. DocumentReference.subject
    Définition

    Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

    CourtPatient concerné par ce document. La ressource référencée peut être présente sous l’élément DocumentReference.contained ou via le champ identifier.
    Contrôle1..1
    TypeReference(TDDUI Patient, TDDUI Patient INS)
    Est modificateurfalse
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. DocumentReference.date
    Définition

    When the document reference was created.

    CourtReprésente la date de création de la ressource DocumentReference dans FHIR
    Commentaires

    Referencing/indexing time is used for tracking, organizing versions and searching.

    Contrôle0..1
    Typeinstant
    Est modificateurfalse
    Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
    Doit être pris en charge (Must Support)true
    Résumétrue
    Noms alternatifsindexed
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. DocumentReference.author
    Définition

    Identifies who is responsible for adding the information to the document.

    CourtPersonnes physiques ou morales et/ou les dispositifs auteurs d'un document.
    Commentaires

    Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).

    Contrôle1..*
    TypeReference(TDDUI Practitioner Role, TDDUI Practitioner, TDDUI Organization, TDDUI Patient, TDDUI Patient INS, Device, FR Core Related Person Profile)
    Est modificateurfalse
    Doit être pris en charge (Must Support)true
    Types qui doivent être pris en charge (Must Support)Aucune règle de prise en charge obligatoire concernant le choix des types/profils
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. DocumentReference.authenticator
    Définition

    Which person or organization authenticates that this document is valid.

    CourtCet 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.
    Commentaires

    Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.

    Contrôle0..1
    TypeReference(TDDUI Practitioner Role, TDDUI Organization)
    Est modificateurfalse
    Doit être pris en charge (Must Support)true
    Types qui doivent être pris en charge (Must Support)Aucune règle de prise en charge obligatoire concernant le choix des types/profils
    Résuméfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    54. DocumentReference.custodian
    Définition

    Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

    CourtOrganization which maintains the document
    Commentaires

    Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.

    Contrôle0..1
    TypeReference(Organization)
    Est modificateurfalse
    Résuméfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    56. DocumentReference.relatesTo
    Définition

    Relationships that this document has with other document references that already exist.

    CourtRelationships to other documents
    Commentaires

    This element is labeled as a modifier because documents that append to other documents are incomplete on their own.

    Contrôle0..*
    TypeBackboneElement
    Est modificateurfalse
    Doit être pris en charge (Must Support)true
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. DocumentReference.relatesTo.id
    Définition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    CourtUnique id for inter-element referencing
    Contrôle0..1
    Typestring
    Est modificateurfalse
    Format XMLDans le format XML, cette propriété est représentée comme attribut.
    Résuméfalse
    60. DocumentReference.relatesTo.extension
    Définition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    CourtAdditional content defined by implementations
    Commentaires

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Contrôle0..*
    TypeExtension
    Est modificateurfalse
    Résuméfalse
    Noms alternatifsextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    62. DocumentReference.relatesTo.modifierExtension
    Définition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    CourtExtensions that cannot be ignored even if unrecognized
    Commentaires

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Contrôle0..*
    TypeExtension
    Est modificateurtrue parce que Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Résumétrue
    Exigences

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Noms alternatifsextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    64. DocumentReference.relatesTo.code
    Définition

    The type of relationship that this document has with anther document.

    Courtreplaces | transforms | signs | appends
    Commentaires

    If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

    Contrôle1..1
    BindingLes codes DOIVENT (SHALL) être pris de DocumentRelationshipType
    (required to http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1)

    The type of relationship between documents.

    Typecode
    Est modificateurfalse
    Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    66. DocumentReference.relatesTo.target
    Définition

    The target document of this relationship.

    CourtTarget of the relationship
    Contrôle1..1
    TypeReference(DocumentReference)
    Est modificateurfalse
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    68. DocumentReference.description
    Définition

    Human-readable description of the source document.

    CourtCommentaire associé au document.
    Commentaires

    What the document is about, a terse summary of the document.

    Contrôle0..1
    Typestring
    Est modificateurfalse
    Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
    Doit être pris en charge (Must Support)true
    Résumétrue
    Exigences

    Helps humans to assess whether the document is of interest.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    70. DocumentReference.securityLabel
    Définition

    A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

    CourtContient les informations définissant le niveau de confidentialité d'un document.
    Commentaires

    The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce.

    In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.

    Contrôle0..*
    BindingSauf si inapproprié, ces codes DOIVENT (SHALL) être pris de All Security Labels
    (extensible to http://hl7.org/fhir/ValueSet/security-labels)

    Security Labels from the Healthcare Privacy and Security Classification System.

    TypeCodeableConcept
    Est modificateurfalse
    Doit être pris en charge (Must Support)true
    Résumétrue
    Exigences

    Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    constr-bind-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é. ()
    72. DocumentReference.content
    Définition

    The document and format referenced.

    CourtDocument contenu.
    Contrôle1..1
    TypeBackboneElement
    Est modificateurfalse
    Doit être pris en charge (Must Support)true
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    74. DocumentReference.content.id
    Définition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    CourtUnique id for inter-element referencing
    Contrôle0..1
    Typestring
    Est modificateurfalse
    Format XMLDans le format XML, cette propriété est représentée comme attribut.
    Résuméfalse
    76. DocumentReference.content.extension
    Définition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    CourtAdditional content defined by implementations
    Commentaires

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Contrôle0..*
    TypeExtension
    Est modificateurfalse
    Résuméfalse
    Noms alternatifsextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    78. DocumentReference.content.modifierExtension
    Définition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    CourtExtensions that cannot be ignored even if unrecognized
    Commentaires

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Contrôle0..*
    TypeExtension
    Est modificateurtrue parce que Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Résumétrue
    Exigences

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Noms alternatifsextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    80. DocumentReference.content.attachment
    Définition

    The document or URL of the document along with critical metadata to prove content has integrity.

    CourtWhere to access the document
    Contrôle1..1
    TypeAttachment
    Est modificateurfalse
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    82. DocumentReference.content.attachment.id
    Définition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    CourtUnique id for inter-element referencing
    Contrôle0..1
    Typestring
    Est modificateurfalse
    Format XMLDans le format XML, cette propriété est représentée comme attribut.
    Résuméfalse
    84. DocumentReference.content.attachment.extension
    Définition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    CourtAdditional content defined by implementations
    Commentaires

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Contrôle0..*
    TypeExtension
    Est modificateurfalse
    Résuméfalse
    Noms alternatifsextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingCet élément introduit un ensemble de slices sur DocumentReference.content.attachment.extension. Les slices sontNon ordonné et Open, et peut être différencié en utilisant les discriminateurs suivants :
    • value @ url
    • 86. DocumentReference.content.attachment.contentType
      Définition

      Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

      CourtMime type of the content, with charset etc.
      Contrôle1..1
      BindingLes codes DOIVENT (SHALL) être pris de Mime Types
      (required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

      The mime type of an attachment. Any valid mime type is allowed.

      Typecode
      Est modificateurfalse
      Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
      Résumétrue
      Exigences

      Processors of the data need to be able to know how to interpret the data.

      ExempleGeneral: text/plain; charset=UTF-8, image/png
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      88. DocumentReference.content.attachment.language
      Définition

      The human language of the content. The value can be any valid value according to BCP 47.

      CourtPour tous les documents produits par les systèmes initiateurs français, le code est "fr-FR'.
      Contrôle0..1
      BindingLes codes DEVRAIENT (SHOULD) être pris de CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages)

      A human language.

      Bindings AdditionnelsBut
      AllLanguagesBinding Max
      Typecode
      Est modificateurfalse
      Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
      Doit être pris en charge (Must Support)true
      Résumétrue
      Exigences

      Users need to be able to choose between the languages in a set of attachments.

      ExempleGeneral: en-AU
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      90. DocumentReference.content.attachment.data
      Définition

      The actual data of the attachment - a sequence of bytes, base64 encoded.

      CourtLe document est contenu dans l'élément .data au format base64.
      Commentaires

      The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

      Contrôle1..1
      Typebase64Binary
      Est modificateurfalse
      Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
      Résuméfalse
      Exigences

      The data needs to able to be transmitted inline.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      92. DocumentReference.content.attachment.url
      Définition

      A location where the data can be accessed.

      CourtUri where the data can be found
      Commentaires

      If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

      Contrôle0..0
      Typeurl
      Est modificateurfalse
      Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
      Résumétrue
      Exigences

      The data needs to be transmitted by reference.

      ExempleGeneral: http://www.acme.com/logo-small.png
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      94. DocumentReference.content.attachment.size
      Définition

      The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

      CourtReprésente la taille du document.
      Commentaires

      The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

      Contrôle0..1
      TypeunsignedInt
      Est modificateurfalse
      Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
      Résumétrue
      Exigences

      Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      96. DocumentReference.content.attachment.hash
      Définition

      The calculated hash of the data using SHA-1. Represented using base64.

      CourtReprésente le résultat de hachage du document (SHA 1).
      Commentaires

      The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

      Contrôle0..1
      Typebase64Binary
      Est modificateurfalse
      Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
      Résumétrue
      Exigences

      Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      98. DocumentReference.content.attachment.title
      Définition

      A label or set of text to display in place of the data.

      CourtLabel to display in place of the data
      Contrôle1..1
      Typestring
      Est modificateurfalse
      Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
      Résumétrue
      Exigences

      Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

      ExempleGeneral: Official Corporate Logo
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      100. DocumentReference.content.attachment.creation
      Définition

      The date that the attachment was first created.

      CourtReprésente la date et l’heure de création du document.
      Contrôle0..1
      TypedateTime
      Est modificateurfalse
      Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
      Doit être pris en charge (Must Support)true
      Résumétrue
      Exigences

      This is often tracked as an integrity issue for use of the attachment.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      102. DocumentReference.content.format
      Définition

      An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

      CourtFormat technique détaillé du document.
      Commentaires

      Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI.

      Contrôle0..1
      BindingLes codes DEVRAIENT (SHOULD) être pris de JDV_J10_XdsFormatCode_CISIS
      (preferred to https://mos.esante.gouv.fr/NOS/JDV_J10-XdsFormatCode-CISIS/FHIR/JDV-J10-XdsFormatCode-CISIS)
      TypeCoding
      Est modificateurfalse
      Doit être pris en charge (Must Support)true
      Résumétrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      constr-bind-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é. ()
      104. DocumentReference.context
      Définition

      The clinical context in which the document was prepared.

      CourtClinical context of document
      Commentaires

      These values are primarily added to help with searching for interesting/relevant documents.

      Contrôle0..1
      TypeBackboneElement
      Est modificateurfalse
      Doit être pris en charge (Must Support)true
      Résumétrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      106. DocumentReference.context.id
      Définition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      CourtUnique id for inter-element referencing
      Contrôle0..1
      Typestring
      Est modificateurfalse
      Format XMLDans le format XML, cette propriété est représentée comme attribut.
      Résuméfalse
      108. DocumentReference.context.extension
      Définition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      CourtAdditional content defined by implementations
      Commentaires

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Contrôle0..*
      TypeExtension
      Est modificateurfalse
      Résuméfalse
      Noms alternatifsextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      110. DocumentReference.context.modifierExtension
      Définition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      CourtExtensions that cannot be ignored even if unrecognized
      Commentaires

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Contrôle0..*
      TypeExtension
      Est modificateurtrue parce que Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Résumétrue
      Exigences

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Noms alternatifsextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      112. DocumentReference.context.encounter
      Définition

      Describes the clinical encounter or type of care that the document content is associated with.

      CourtContext of the document content
      Contrôle0..*
      TypeReference(Encounter, EpisodeOfCare)
      Est modificateurfalse
      Résuméfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      114. DocumentReference.context.event
      Définition

      This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

      CourtReprésente les actes et les pathologies en rapport avec le document.
      Commentaires

      An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.

      Contrôle0..1
      BindingPour des exemples de codes, voir v3 Code System ActCode
      (example to http://terminology.hl7.org/ValueSet/v3-ActCode)

      This list of codes represents the main clinical acts being documented.

      TypeCodeableConcept
      Est modificateurfalse
      Résuméfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      constr-bind-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 ()
      116. DocumentReference.context.period
      Définition

      The time period over which the service that is described by the document was provided.

      CourtTime of service that is being documented
      Contrôle0..1
      TypePeriod
      Est modificateurfalse
      Doit être pris en charge (Must Support)true
      Résumétrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      118. DocumentReference.context.facilityType
      Définition

      The kind of facility where the patient was seen.

      CourtSecteur d'activité lié à la prise en charge de la personne, en lien avec le document produit.
      Contrôle0..1
      BindingLes codes DEVRAIENT (SHOULD) être pris de JDV_J02_XdsHealthcareFacilityTypeCode_CISIS
      (preferred to https://mos.esante.gouv.fr/NOS/JDV_J02-XdsHealthcareFacilityTypeCode-CISIS/FHIR/JDV-J02-XdsHealthcareFacilityTypeCode-CISIS)
      TypeCodeableConcept
      Est modificateurfalse
      Doit être pris en charge (Must Support)true
      Résuméfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      constr-bind-ProducteurDoc-simplified: L’utilisation de cette nomenclature est recommandée mais non obligatoire (prefered) : - 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é. ()
      120. DocumentReference.context.practiceSetting
      Définition

      This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

      CourtCadre d’exercice de l’acte qui a engendré la création du document.
      Commentaires

      This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.

      Contrôle0..1
      BindingLes codes DEVRAIENT (SHOULD) être pris de JDV_J04_XdsPracticeSettingCode_CISIS
      (preferred to https://mos.esante.gouv.fr/NOS/JDV_J04-XdsPracticeSettingCode-CISIS/FHIR/JDV-J04-XdsPracticeSettingCode-CISIS)
      TypeCodeableConcept
      Est modificateurfalse
      Doit être pris en charge (Must Support)true
      Résuméfalse
      Exigences

      This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      constr-bind-ProducteurDoc-simplified: L’utilisation de cette nomenclature est recommandée mais non obligatoire (prefered) : - 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é. ()
      122. DocumentReference.context.sourcePatientInfo
      Définition

      The Patient Information as known when the document was published. May be a reference to a version specific, or contained.

      CourtRéférence vers la ressource Patient titulaire du dossier.
      Contrôle0..1
      TypeReference(TDDUI Patient, TDDUI Patient INS)
      Est modificateurfalse
      Doit être pris en charge (Must Support)true
      Types qui doivent être pris en charge (Must Support)Aucune règle de prise en charge obligatoire concernant le choix des types/profils
      Résuméfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      124. DocumentReference.context.related
      Définition

      Related identifiers or resources associated with the DocumentReference.

      CourtRelated identifiers or resources
      Commentaires

      May be identifiers or resources that caused the DocumentReference or referenced Document to be created.

      Contrôle0..*
      TypeReference(Resource)
      Est modificateurfalse
      Résuméfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))