Cumuluz Translate Implementation Guide
0.1.0 - ci-build

Cumuluz Translate Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: XibDocumentReference - Detailed Descriptions

Draft as of 2026-07-11

Definitions for the xib-DocumentReference resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. DocumentReference
Definitie

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.

KortA reference to a document
Opmerkingen

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

Control0..*
Is modifierfalse
Samenvattingfalse
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.implicitRules
Definitie

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.

KortA set of rules under which this content was created
Opmerkingen

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.

Control0..1
Typeuri
Is modifiertrue omdat 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
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. DocumentReference.modifierExtension
Definitie

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).

KortExtensions that cannot be ignored
Opmerkingen

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.

Control0..*
TypeExtension
Is modifiertrue omdat Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Samenvattingfalse
Requirements

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.

Alternatieve namenextensions, 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())
6. DocumentReference.status
Definitie

The status of this document reference.

Kortcurrent | superseded | entered-in-error
Opmerkingen

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.

Control1..1
BindingDe codes MOETEN komen uit 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
Is modifiertrue omdat 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
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. DocumentReference.type
Definitie

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.

KortKind of document (LOINC if possible)
Opmerkingen

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.

Control0..1
BindingDe codes ZOUDEN MOETEN komen uit DocumentTypeValueSethttp://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.

TypeCodeableConcept
Is modifierfalse
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. DocumentReference.subject
Definitie

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).

KortWho/what is the subject of the document
Control0..1
TypeReference(Patient, Practitioner, Group, Device)
Is modifierfalse
Moet ondersteunentrue
Moet ondersteunen typesGeen moet-ondersteunen-regels over de keuze uit types/profielen
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. DocumentReference.date
Definitie

When the document reference was created.

KortWhen this document reference was created
Opmerkingen

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

Control0..1
Typeinstant
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Moet ondersteunentrue
Samenvattingtrue
Alternatieve namenindexed
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. DocumentReference.author
Definitie

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

KortWho and/or what authored the document
Opmerkingen

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

Control0..*
TypeReference(Practitioner, PractitionerRole, Organization, Device, Patient, RelatedPerson)
Is modifierfalse
Moet ondersteunentrue
Moet ondersteunen typesGeen moet-ondersteunen-regels over de keuze uit types/profielen
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. DocumentReference.content
Definitie

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

KortDocument referenced
Control1..*
TypeBackboneElement
Is modifierfalse
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. DocumentReference.content.modifierExtension
Definitie

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).

KortExtensions that cannot be ignored even if unrecognized
Opmerkingen

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.

Control0..*
TypeExtension
Is modifiertrue omdat Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Samenvattingtrue
Requirements

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.

Alternatieve namenextensions, 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())
20. DocumentReference.content.attachment
Definitie

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

KortWhere to access the document
Control1..1
TypeAttachment
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. DocumentReference
2. DocumentReference.status
Moet ondersteunentrue
4. DocumentReference.type
Moet ondersteunentrue
6. DocumentReference.subject
Moet ondersteunentrue
8. DocumentReference.date
Moet ondersteunentrue
10. DocumentReference.author
Moet ondersteunentrue
12. DocumentReference.content
Moet ondersteunentrue

Guidance on how to interpret the contents of this table can be foundhere

0. DocumentReference
Definitie

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.

KortA reference to a document
Opmerkingen

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

Control0..*
Is modifierfalse
Samenvattingfalse
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
Definitie

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

KortLogical id of this artifact
Opmerkingen

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

Control0..1
Typeid
Is modifierfalse
Samenvattingtrue
4. DocumentReference.meta
Definitie

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.

KortMetadata about the resource
Control0..1
TypeMeta
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. DocumentReference.implicitRules
Definitie

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.

KortA set of rules under which this content was created
Opmerkingen

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.

Control0..1
Typeuri
Is modifiertrue omdat 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
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. DocumentReference.language
Definitie

The base language in which the resource is written.

KortLanguage of the resource content
Opmerkingen

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).

Control0..1
BindingDe codes ZOUDEN MOETEN komen uit CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additionele bindingsDoel
AllLanguagesMax binding
Typecode
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. DocumentReference.text
Definitie

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.

KortText summary of the resource, for human interpretation
Opmerkingen

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.

Control0..1
TypeNarrative
Is modifierfalse
Samenvattingfalse
Alternatieve namennarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. DocumentReference.contained
Definitie

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.

KortContained, inline Resources
Opmerkingen

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.

Control0..*
TypeResource
Is modifierfalse
Samenvattingfalse
Alternatieve nameninline resources, anonymous resources, contained resources
14. DocumentReference.extension
Definitie

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.

KortAdditional content defined by implementations
Opmerkingen

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.

Control0..*
TypeExtension
Is modifierfalse
Samenvattingfalse
Alternatieve namenextensions, 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())
16. DocumentReference.modifierExtension
Definitie

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).

KortExtensions that cannot be ignored
Opmerkingen

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.

Control0..*
TypeExtension
Is modifiertrue omdat Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Samenvattingfalse
Requirements

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.

Alternatieve namenextensions, 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())
18. DocumentReference.masterIdentifier
Definitie

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.

KortMaster Version Specific Identifier
Opmerkingen

CDA Document Id extension and root.

Control0..1
TypeIdentifier
Is modifierfalse
Samenvattingtrue
Requirements

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()))
20. DocumentReference.identifier
Definitie

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

KortOther identifiers for the document
NotitieDit is een business-identifier, geen resource-identifier (zie discussie)
Control0..*
TypeIdentifier
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. DocumentReference.status
Definitie

The status of this document reference.

Kortcurrent | superseded | entered-in-error
Opmerkingen

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.

Control1..1
BindingDe codes MOETEN komen uit DocumentReferenceStatus
(required to http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1)

The status of the document reference.

Typecode
Is modifiertrue omdat 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
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. DocumentReference.docStatus
Definitie

The status of the underlying document.

Kortpreliminary | final | amended | entered-in-error
Opmerkingen

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

Control0..1
BindingDe codes MOETEN komen uit CompositionStatus
(required to http://hl7.org/fhir/ValueSet/composition-status|4.0.1)

Status of the underlying document.

Typecode
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. DocumentReference.type
Definitie

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.

KortKind of document (LOINC if possible)
Opmerkingen

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.

Control0..1
BindingDe codes ZOUDEN MOETEN komen uit DocumentTypeValueSet
(preferred to http://hl7.org/fhir/ValueSet/c80-doc-typecodes|4.0.1)

Precise type of clinical document.

TypeCodeableConcept
Is modifierfalse
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. DocumentReference.category
Definitie

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.

KortCategorization of document
Opmerkingen

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.

Control0..*
BindingVoor voorbeeldcodes, zie DocumentClassValueSet
(example to http://hl7.org/fhir/ValueSet/document-classcodes|4.0.1)

High-level kind of a clinical document at a macro level.

TypeCodeableConcept
Is modifierfalse
Samenvattingtrue
Alternatieve namenclaxs
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. DocumentReference.subject
Definitie

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).

KortWho/what is the subject of the document
Control0..1
TypeReference(Patient, Practitioner, Group, Device)
Is modifierfalse
Moet ondersteunentrue
Moet ondersteunen typesGeen moet-ondersteunen-regels over de keuze uit types/profielen
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. DocumentReference.date
Definitie

When the document reference was created.

KortWhen this document reference was created
Opmerkingen

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

Control0..1
Typeinstant
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Moet ondersteunentrue
Samenvattingtrue
Alternatieve namenindexed
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. DocumentReference.author
Definitie

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

KortWho and/or what authored the document
Opmerkingen

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

Control0..*
TypeReference(Practitioner, PractitionerRole, Organization, Device, Patient, RelatedPerson)
Is modifierfalse
Moet ondersteunentrue
Moet ondersteunen typesGeen moet-ondersteunen-regels over de keuze uit types/profielen
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. DocumentReference.authenticator
Definitie

Which person or organization authenticates that this document is valid.

KortWho/what authenticated the document
Opmerkingen

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.

Control0..1
TypeReference(Practitioner, PractitionerRole, Organization)
Is modifierfalse
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. DocumentReference.custodian
Definitie

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

KortOrganization which maintains the document
Opmerkingen

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.

Control0..1
TypeReference(Organization)
Is modifierfalse
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. DocumentReference.relatesTo
Definitie

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

KortRelationships to other documents
Opmerkingen

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

Control0..*
TypeBackboneElement
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. DocumentReference.relatesTo.id
Definitie

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

KortUnique id for inter-element referencing
Control0..1
Typestring
Is modifierfalse
Xml-formaatIn xml wordt dit attribuut gerepresenteerd als attribuut.
Samenvattingfalse
44. DocumentReference.relatesTo.extension
Definitie

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.

KortAdditional content defined by implementations
Opmerkingen

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.

Control0..*
TypeExtension
Is modifierfalse
Samenvattingfalse
Alternatieve namenextensions, 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())
46. DocumentReference.relatesTo.modifierExtension
Definitie

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).

KortExtensions that cannot be ignored even if unrecognized
Opmerkingen

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.

Control0..*
TypeExtension
Is modifiertrue omdat Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Samenvattingtrue
Requirements

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.

Alternatieve namenextensions, 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())
48. DocumentReference.relatesTo.code
Definitie

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

Kortreplaces | transforms | signs | appends
Opmerkingen

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

Control1..1
BindingDe codes MOETEN komen uit DocumentRelationshipType
(required to http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1)

The type of relationship between documents.

Typecode
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. DocumentReference.relatesTo.target
Definitie

The target document of this relationship.

KortTarget of the relationship
Control1..1
TypeReference(DocumentReference)
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. DocumentReference.description
Definitie

Human-readable description of the source document.

KortHuman-readable description
Opmerkingen

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

Control0..1
Typestring
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingtrue
Requirements

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()))
54. DocumentReference.securityLabel
Definitie

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.

KortDocument security-tags
Opmerkingen

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.

Control0..*
BindingTenzij dat niet past, MOETEN deze codes worden gehaald uit 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.

TypeCodeableConcept
Is modifierfalse
Samenvattingtrue
Requirements

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()))
56. DocumentReference.content
Definitie

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

KortDocument referenced
Control1..*
TypeBackboneElement
Is modifierfalse
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. DocumentReference.content.id
Definitie

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

KortUnique id for inter-element referencing
Control0..1
Typestring
Is modifierfalse
Xml-formaatIn xml wordt dit attribuut gerepresenteerd als attribuut.
Samenvattingfalse
60. DocumentReference.content.extension
Definitie

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.

KortAdditional content defined by implementations
Opmerkingen

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.

Control0..*
TypeExtension
Is modifierfalse
Samenvattingfalse
Alternatieve namenextensions, 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.content.modifierExtension
Definitie

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).

KortExtensions that cannot be ignored even if unrecognized
Opmerkingen

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.

Control0..*
TypeExtension
Is modifiertrue omdat Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Samenvattingtrue
Requirements

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.

Alternatieve namenextensions, 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.content.attachment
Definitie

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

KortWhere to access the document
Control1..1
TypeAttachment
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. DocumentReference.content.format
Definitie

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

KortFormat/content rules for the document
Opmerkingen

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

Control0..1
BindingDe codes ZOUDEN MOETEN komen uit DocumentReferenceFormatCodeSet
(preferred to http://hl7.org/fhir/ValueSet/formatcodes|4.0.1)

Document Format Codes.

TypeCoding
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. DocumentReference.context
Definitie

The clinical context in which the document was prepared.

KortClinical context of document
Opmerkingen

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

Control0..1
TypeBackboneElement
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. DocumentReference.context.id
Definitie

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

KortUnique id for inter-element referencing
Control0..1
Typestring
Is modifierfalse
Xml-formaatIn xml wordt dit attribuut gerepresenteerd als attribuut.
Samenvattingfalse
72. DocumentReference.context.extension
Definitie

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.

KortAdditional content defined by implementations
Opmerkingen

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.

Control0..*
TypeExtension
Is modifierfalse
Samenvattingfalse
Alternatieve namenextensions, 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())
74. DocumentReference.context.modifierExtension
Definitie

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).

KortExtensions that cannot be ignored even if unrecognized
Opmerkingen

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.

Control0..*
TypeExtension
Is modifiertrue omdat Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Samenvattingtrue
Requirements

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.

Alternatieve namenextensions, 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())
76. DocumentReference.context.encounter
Definitie

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

KortContext of the document content
Control0..*
TypeReference(Encounter, EpisodeOfCare)
Is modifierfalse
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. DocumentReference.context.event
Definitie

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.

KortMain clinical acts documented
Opmerkingen

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.

Control0..*
BindingVoor voorbeeldcodes, zie 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
Is modifierfalse
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. DocumentReference.context.period
Definitie

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

KortTime of service that is being documented
Control0..1
TypePeriod
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. DocumentReference.context.facilityType
Definitie

The kind of facility where the patient was seen.

KortKind of facility where patient was seen
Control0..1
BindingVoor voorbeeldcodes, zie FacilityTypeCodeValueSet
(example to http://hl7.org/fhir/ValueSet/c80-facilitycodes|4.0.1)

XDS Facility Type.

TypeCodeableConcept
Is modifierfalse
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. DocumentReference.context.practiceSetting
Definitie

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

KortAdditional details about where the content was created (e.g. clinical specialty)
Opmerkingen

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.

Control0..1
BindingVoor voorbeeldcodes, zie 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).

TypeCodeableConcept
Is modifierfalse
Samenvattingfalse
Requirements

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()))
86. DocumentReference.context.sourcePatientInfo
Definitie

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

KortPatient demographics from source
Control0..1
TypeReference(Patient)
Is modifierfalse
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. DocumentReference.context.related
Definitie

Related identifiers or resources associated with the DocumentReference.

KortRelated identifiers or resources
Opmerkingen

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

Control0..*
TypeReference(Resource)
Is modifierfalse
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))