FR Document Core (FHIR)
0.1.0 - ci-build

FR Document Core (FHIR), publié par Agence du Numérique en Santé (ANS) - 2-10 Rue d'Oradour-sur-Glane, 75015 Paris. Ce guide n'est pas une publication autorisée ; C'est la version en intégration continue pour la version 0.1.0 construite par le CI Build FHIR (HL7® FHIR® Standard). Cette version est basée sur le contenu actuel de https://github.com/ansforge/interop-IG-fhir-document-core/ et change régulièrement. Voir le répertoire des versions publiées

## Profil de ressource: DocumentReference - FR Document reference Document - Descriptions détaillées

Draft à partir de 2026-08-07

Définitions pour le fr-document-reference-document profil de ressource

- Tableau des éléments clés
- Tableau différentiel (differential)
- Tableau récapitulatif (snapshot)

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.
Court | A reference to a document
Commentaires | Usually, this is used for documents other than those defined by FHIR.
Contrôle | 0..*
Est modificateur | false
Résumé | false
Invariants | dom-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()`) dom-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.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.
Court | A 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ôle | 0..1
Type | uri
Est modificateur | true 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 primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. DocumentReference.modifierExtension
Définition | 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).
Court | Extensions 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ôle | 0..*
Type | Extension
Est modificateur | true 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 alternatifs | extensions, user content
Invariants | ele-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()`) ele-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())
6. DocumentReference.identifier
Définition | Other identifiers associated with the document, including version independent identifiers.
Court | Identifiant principal unique du documentOther identifiers for the document
Note | Ceci est un identifiant métier, pas un identifiant de ressource (voir discussion)
Contrôle | 0..*
Type | Identifier
Est modificateur | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. DocumentReference.status
Définition | The status of this document reference.
Court | current | 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ôle | 1..1
Binding | Les codes DOIVENT (SHALL) être pris de DocumentReferenceStatus http://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.
Type | code
Est modificateur | true 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 primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. DocumentReference.docStatus
Définition | The status of the underlying document.
Court | Statut du documentpreliminary | final | amended | entered-in-error
Commentaires | The document that is pointed to might be in various lifecycle states.
Contrôle | 0..1
Binding | Les codes DOIVENT (SHALL) être pris de CompositionStatus http://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.
Type | code
Est modificateur | false
Valeur primitive | Cet é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 motif | `final`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. DocumentReference.type
Définition | 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.
Court | type du documentKind 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ôle | 10..1
Binding | Les codes DEVRAIENT (SHOULD) être pris de DocumentTypeValueSet http://hl7.org/fhir/ValueSet/c80-doc-typecodes|4.0.1 (preferred to `http://hl7.org/fhir/ValueSet/c80-doc-typecodes|4.0.1` ) Precise type of clinical document.
Type | CodeableConcept
Est modificateur | false
Doit être pris en charge (Must Support) | true
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. DocumentReference.date
Définition | When the document reference was created.
Court | Quand cette référence a été crééeWhen this document reference was created
Commentaires | Referencing/indexing time is used for tracking, organizing versions and searching.
Contrôle | 0..1
Type | instant
Est modificateur | false
Valeur primitive | Cet é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 alternatifs | indexed
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. DocumentReference.content
Définition | The document and format referenced. There may be multiple content element repetitions, each with a different format.
Court | Document référencéDocument referenced
Contrôle | 1..*
Type | BackboneElement
Est modificateur | false
Doit être pris en charge (Must Support) | true
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. 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).
Court | Extensions 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ôle | 0..*
Type | Extension
Est modificateur | true 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 alternatifs | extensions, user content, modifiers
Invariants | ele-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()`) ele-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())
20. DocumentReference.content.attachment
Définition | The document or URL of the document along with critical metadata to prove content has integrity.
Court | Document attachéWhere to access the document
Contrôle | 1..1
Type | Attachment
Est modificateur | false
Doit être pris en charge (Must Support) | true
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. DocumentReference.content.attachment.data
Définition | The actual data of the attachment - a sequence of bytes, base64 encoded.
Court | Representation en B64Data inline, base64ed
Commentaires | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
Contrôle | 0..1
Type | base64Binary
Est modificateur | false
Valeur primitive | Cet é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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. DocumentReference.content.attachment.url
Définition | A location where the data can be accessed.
Court | URIUri 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ôle | 0..1
Type | url
Est modificateur | false
Valeur primitive | Cet é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.
Exemple | General: http://www.acme.com/logo-small.png
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. DocumentReference.context
Définition | The clinical context in which the document was prepared.
Court | Clinical context of document
Commentaires | These values are primarily added to help with searching for interesting/relevant documents.
Contrôle | 0..1
Type | BackboneElement
Est modificateur | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. 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).
Court | Extensions 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ôle | 0..*
Type | Extension
Est modificateur | true 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 alternatifs | extensions, user content, modifiers
Invariants | ele-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()`) ele-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())
30. DocumentReference.context.related
Définition | Related identifiers or resources associated with the DocumentReference.
Court | Ressources ou identifiants liésRelated identifiers or resources
Commentaires | May be identifiers or resources that caused the DocumentReference or referenced Document to be created.
Contrôle | 0..*
Type | Reference(Resource)
Est modificateur | false
Doit être pris en charge (Must Support) | true
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-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.identifier
Court | Identifiant principal unique du document
Note | Ceci est un identifiant métier, pas un identifiant de ressource (voir discussion)
4. DocumentReference.docStatus
Court | Statut du document
Doit être pris en charge (Must Support) | true
Valeur de motif | `final`
6. DocumentReference.type
Court | type du document
Contrôle | 1..?
Doit être pris en charge (Must Support) | true
8. DocumentReference.date
Court | Quand cette référence a été créée
Doit être pris en charge (Must Support) | true
10. DocumentReference.content
Court | Document référencé
Doit être pris en charge (Must Support) | true
12. DocumentReference.content.attachment
Court | Document attaché
Doit être pris en charge (Must Support) | true
14. DocumentReference.content.attachment.data
Court | Representation en B64
16. DocumentReference.content.attachment.url
Court | URI
18. DocumentReference.context
20. DocumentReference.context.related
Court | Ressources ou identifiants liés
Doit être pris en charge (Must Support) | true

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.
Court | A reference to a document
Commentaires | Usually, this is used for documents other than those defined by FHIR.
Contrôle | 0..*
Est modificateur | false
Résumé | false
Invariants | dom-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.
Court | Logical 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ôle | 0..1
Type | id
Est modificateur | false
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.
Court | Metadata about the resource
Contrôle | 0..1
Type | Meta
Est modificateur | false
Résumé | true
Invariants | ele-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.
Court | A 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ôle | 0..1
Type | uri
Est modificateur | true 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 primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. DocumentReference.language
Définition | The base language in which the resource is written.
Court | Language 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ôle | 0..1
Binding | Les codes DEVRAIENT (SHOULD) être pris de CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Bindings Additionnels | But
AllLanguages | Binding Max
Type | code
Est modificateur | false
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. 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.
Court | Text 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ôle | 0..1
Type | Narrative
Est modificateur | false
Résumé | false
Noms alternatifs | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. 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.
Court | Contained, 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ôle | 0..*
Type | Resource
Est modificateur | false
Résumé | false
Noms alternatifs | inline resources, anonymous resources, contained resources
14. 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.
Court | Additional 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ôle | 0..*
Type | Extension
Est modificateur | false
Résumé | false
Noms alternatifs | extensions, user content
Invariants | ele-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()`)
16. DocumentReference.modifierExtension
Définition | 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).
Court | Extensions 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ôle | 0..*
Type | Extension
Est modificateur | true 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 alternatifs | extensions, user content
Invariants | ele-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()`)
18. 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.
Court | Master Version Specific Identifier
Commentaires | CDA Document Id extension and root.
Contrôle | 0..1
Type | Identifier
Est modificateur | false
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.).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. DocumentReference.identifier
Définition | Other identifiers associated with the document, including version independent identifiers.
Court | Identifiant principal unique du document
Note | Ceci est un identifiant métier, pas un identifiant de ressource (voir discussion)
Contrôle | 0..*
Type | Identifier
Est modificateur | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. DocumentReference.status
Définition | The status of this document reference.
Court | current | 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ôle | 1..1
Binding | Les 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.
Type | code
Est modificateur | true 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 primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. DocumentReference.docStatus
Définition | The status of the underlying document.
Court | Statut du document
Commentaires | The document that is pointed to might be in various lifecycle states.
Contrôle | 0..1
Binding | Les codes DOIVENT (SHALL) être pris de CompositionStatus (required to `http://hl7.org/fhir/ValueSet/composition-status|4.0.1` ) Status of the underlying document.
Type | code
Est modificateur | false
Valeur primitive | Cet é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 motif | `final`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. DocumentReference.type
Définition | 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.
Court | type du document
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ôle | 1..1
Binding | Les codes DEVRAIENT (SHOULD) être pris de DocumentTypeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-doc-typecodes|4.0.1` ) Precise type of clinical document.
Type | CodeableConcept
Est modificateur | false
Doit être pris en charge (Must Support) | true
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. 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.
Court | 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ôle | 0..*
Binding | Pour des exemples de codes, voir DocumentClassValueSet (example to `http://hl7.org/fhir/ValueSet/document-classcodes|4.0.1` ) High-level kind of a clinical document at a macro level.
Type | CodeableConcept
Est modificateur | false
Résumé | true
Noms alternatifs | claxs
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. 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).
Court | Who/what is the subject of the document
Contrôle | 0..1
Type | Reference(Patient, Practitioner, Group, Device)
Est modificateur | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. DocumentReference.date
Définition | When the document reference was created.
Court | Quand cette référence a été créée
Commentaires | Referencing/indexing time is used for tracking, organizing versions and searching.
Contrôle | 0..1
Type | instant
Est modificateur | false
Valeur primitive | Cet é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 alternatifs | indexed
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. DocumentReference.author
Définition | Identifies who is responsible for adding the information to the document.
Court | 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ôle | 0..*
Type | Reference(Practitioner, PractitionerRole, Organization, Device, Patient, RelatedPerson)
Est modificateur | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. DocumentReference.authenticator
Définition | Which person or organization authenticates that this document is valid.
Court | 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ôle | 0..1
Type | Reference(Practitioner, PractitionerRole, Organization)
Est modificateur | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. DocumentReference.custodian
Définition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
Court | Organization 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ôle | 0..1
Type | Reference(Organization)
Est modificateur | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. DocumentReference.relatesTo
Définition | Relationships that this document has with other document references that already exist.
Court | Relationships to other documents
Commentaires | This element is labeled as a modifier because documents that append to other documents are incomplete on their own.
Contrôle | 0..*
Type | BackboneElement
Est modificateur | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. 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.
Court | Unique id for inter-element referencing
Contrôle | 0..1
Type | string
Est modificateur | false
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Résumé | false
44. 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.
Court | Additional 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ôle | 0..*
Type | Extension
Est modificateur | false
Résumé | false
Noms alternatifs | extensions, user content
Invariants | ele-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.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).
Court | Extensions 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ôle | 0..*
Type | Extension
Est modificateur | true 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 alternatifs | extensions, user content, modifiers
Invariants | ele-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()`)
48. DocumentReference.relatesTo.code
Définition | The type of relationship that this document has with anther document.
Court | replaces | transforms | signs | appends
Commentaires | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.
Contrôle | 1..1
Binding | Les 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.
Type | code
Est modificateur | false
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. DocumentReference.relatesTo.target
Définition | The target document of this relationship.
Court | Target of the relationship
Contrôle | 1..1
Type | Reference(DocumentReference)
Est modificateur | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. DocumentReference.description
Définition | Human-readable description of the source document.
Court | Human-readable description
Commentaires | What the document is about, a terse summary of the document.
Contrôle | 0..1
Type | string
Est modificateur | false
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Résumé | true
Exigences | Helps humans to assess whether the document is of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. 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.
Court | 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ôle | 0..*
Binding | Sauf 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.
Type | CodeableConcept
Est modificateur | false
Résumé | true
Exigences | Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. DocumentReference.content
Définition | The document and format referenced. There may be multiple content element repetitions, each with a different format.
Court | Document référencé
Contrôle | 1..*
Type | BackboneElement
Est modificateur | false
Doit être pris en charge (Must Support) | true
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. 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.
Court | Unique id for inter-element referencing
Contrôle | 0..1
Type | string
Est modificateur | false
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Résumé | false
60. 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.
Court | Additional 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ôle | 0..*
Type | Extension
Est modificateur | false
Résumé | false
Noms alternatifs | extensions, user content
Invariants | ele-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.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).
Court | Extensions 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ôle | 0..*
Type | Extension
Est modificateur | true 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 alternatifs | extensions, user content, modifiers
Invariants | ele-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.content.attachment
Définition | The document or URL of the document along with critical metadata to prove content has integrity.
Court | Document attaché
Contrôle | 1..1
Type | Attachment
Est modificateur | false
Doit être pris en charge (Must Support) | true
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. 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.
Court | Unique id for inter-element referencing
Contrôle | 0..1
Type | string
Est modificateur | false
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Résumé | false
68. 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.
Court | Additional 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ôle | 0..*
Type | Extension
Est modificateur | false
Résumé | false
Noms alternatifs | extensions, user content
Invariants | ele-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()`)
Slicing | Cet é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
70. 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.
Court | Mime type of the content, with charset etc.
Contrôle | 0..1
Binding | Les 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.
Type | code
Est modificateur | false
Valeur primitive | Cet é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.
Exemple | General: text/plain; charset=UTF-8, image/png
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. DocumentReference.content.attachment.language
Définition | The human language of the content. The value can be any valid value according to BCP 47.
Court | Human language of the content (BCP-47)
Contrôle | 0..1
Binding | Les codes DEVRAIENT (SHOULD) être pris de CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Bindings Additionnels | But
AllLanguages | Binding Max
Type | code
Est modificateur | false
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Résumé | true
Exigences | Users need to be able to choose between the languages in a set of attachments.
Exemple | General: en-AU
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. DocumentReference.content.attachment.data
Définition | The actual data of the attachment - a sequence of bytes, base64 encoded.
Court | Representation en B64
Commentaires | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
Contrôle | 0..1
Type | base64Binary
Est modificateur | false
Valeur primitive | Cet é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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. DocumentReference.content.attachment.url
Définition | A location where the data can be accessed.
Court | URI
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ôle | 0..1
Type | url
Est modificateur | false
Valeur primitive | Cet é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.
Exemple | General: http://www.acme.com/logo-small.png
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. DocumentReference.content.attachment.size
Définition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
Court | 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ôle | 0..1
Type | unsignedInt
Est modificateur | false
Valeur primitive | Cet é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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. DocumentReference.content.attachment.hash
Définition | The calculated hash of the data using SHA-1. Represented using base64.
Court | 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.
Contrôle | 0..1
Type | base64Binary
Est modificateur | false
Valeur primitive | Cet é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).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. DocumentReference.content.attachment.title
Définition | A label or set of text to display in place of the data.
Court | Label to display in place of the data
Contrôle | 0..1
Type | string
Est modificateur | false
Valeur primitive | Cet é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.
Exemple | General: Official Corporate Logo
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. DocumentReference.content.attachment.creation
Définition | The date that the attachment was first created.
Court | Date attachment was first created
Contrôle | 0..1
Type | dateTime
Est modificateur | false
Valeur primitive | Cet élément primitif peut être présent, absent ou remplacé par une extension
Résumé | true
Exigences | This is often tracked as an integrity issue for use of the attachment.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. 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.
Court | 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ôle | 0..1
Binding | Les codes DEVRAIENT (SHOULD) être pris de DocumentReferenceFormatCodeSet (preferred to `http://hl7.org/fhir/ValueSet/formatcodes|4.0.1` ) Document Format Codes.
Type | Coding
Est modificateur | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. DocumentReference.context
Définition | The clinical context in which the document was prepared.
Court | Clinical context of document
Commentaires | These values are primarily added to help with searching for interesting/relevant documents.
Contrôle | 0..1
Type | BackboneElement
Est modificateur | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. 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.
Court | Unique id for inter-element referencing
Contrôle | 0..1
Type | string
Est modificateur | false
Format XML | Dans le format XML, cette propriété est représentée comme attribut.
Résumé | false
92. 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.
Court | Additional 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ôle | 0..*
Type | Extension
Est modificateur | false
Résumé | false
Noms alternatifs | extensions, user content
Invariants | ele-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()`)
94. 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).
Court | Extensions 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ôle | 0..*
Type | Extension
Est modificateur | true 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 alternatifs | extensions, user content, modifiers
Invariants | ele-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()`)
96. DocumentReference.context.encounter
Définition | Describes the clinical encounter or type of care that the document content is associated with.
Court | Context of the document content
Contrôle | 0..*
Type | Reference(Encounter, EpisodeOfCare)
Est modificateur | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. 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.
Court | 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ôle | 0..*
Binding | Pour des exemples de codes, voir ActCode (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0` ) This list of codes represents the main clinical acts being documented.
Type | CodeableConcept
Est modificateur | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. DocumentReference.context.period
Définition | The time period over which the service that is described by the document was provided.
Court | Time of service that is being documented
Contrôle | 0..1
Type | Period
Est modificateur | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. DocumentReference.context.facilityType
Définition | The kind of facility where the patient was seen.
Court | Kind of facility where patient was seen
Contrôle | 0..1
Binding | Pour des exemples de codes, voir FacilityTypeCodeValueSet (example to `http://hl7.org/fhir/ValueSet/c80-facilitycodes|4.0.1` ) XDS Facility Type.
Type | CodeableConcept
Est modificateur | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. DocumentReference.context.practiceSetting
Définition | This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
Court | 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ôle | 0..1
Binding | Pour des exemples de codes, voir PracticeSettingCodeValueSet (example to `http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1` ) Additional details about where the content was created (e.g. clinical specialty).
Type | CodeableConcept
Est modificateur | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. 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.
Court | Patient demographics from source
Contrôle | 0..1
Type | Reference(Patient)
Est modificateur | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. DocumentReference.context.related
Définition | Related identifiers or resources associated with the DocumentReference.
Court | Ressources ou identifiants liés
Commentaires | May be identifiers or resources that caused the DocumentReference or referenced Document to be created.
Contrôle | 0..*
Type | Reference(Resource)
Est modificateur | false
Doit être pris en charge (Must Support) | true
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)