ISiK Dokumentenaustausch Implementierungsleitfaden
Version 6.0.0-rc - ci-build

Resource Profile: ISiKDokumentenMetadaten - Detailed Descriptions

Active as of 2025-12-17

Definitions for the ISiKDokumentenMetadaten resource profile.

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

0. DocumentReference
Definition

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.

ShortA reference to a document
Comments

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

Control0..*
Is Modifierfalse
Summaryfalse
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
Definition

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

Shortserverseitige, interne ID des DatensatzesLogical id of this artifact
Comments

bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine id verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine idverfügen.


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
Typeidstring
Is Modifierfalse
Must Supporttrue
Summarytrue
4. DocumentReference.implicitRules
Definition

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.

ShortA set of rules under which this content was created
Comments

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 because 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. DocumentReference.modifierExtension
Definition

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

ShortExtensions that cannot be ignored
Comments

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 because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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.

Alternate Namesextensions, 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())
8. DocumentReference.masterIdentifier
Definition

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.

ShortVersionsspezifische OID des DokumentesMaster Version Specific Identifier
Comments

Begründung Must Support: Die OID ist erforderlich, um die Version des Dokumentes eindeutig zu identifizieren.


CDA Document Id extension and root.

Control10..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
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()))
10. DocumentReference.masterIdentifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. DocumentReference.masterIdentifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortNamensraum des IdentifiersThe namespace for the identifier value
Comments

Bei OIDs und UUIDs ist hier stets der Wert urn:ietf:rfc:3986 anzugeben. Weitere Hinweise zur AbbildungVerwendung von MasterIdentifiern und deren Abbildung auf FHIR sind in IHE-ITI zu finden.


Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. DocumentReference.masterIdentifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortWert des IdentifiersThe value that is unique
Comments

OID mit URI-Präfix "urn:oid:". Es sei darauf hingewiesen, dass OIDs auf Basis von UUIDs generiert werden können, ohne einen eigenen Namesraum zu beantragen. Zunächst müssen hierzu alle 128 Bit der UUID in einen Integer-Wert umgerechnet werden. Das Ergebnis muss ohne Bindestriche an die Root-OID '2.25' angehängt werden. Siehe IHE International - Creating Unique IDs - OID and UUID.


If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. DocumentReference.identifier
Definition

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

ShortIdentifier des DokumentesOther identifiers for the document
Comments

Abweichend zu MHD V4.0.1 ist die Angabe eines Identifiers in ISiK nicht erforderlich. Ein solcher kann bei Bedarf (z.B. zur Weitergabe des Dokumentes per XDS) erzeugt werden. [Konsens der Arbeitsgruppe vom 12.11.2021]

Update für Stufe 3: In MHD 4.2.0 wurde die Verpflichtung zur Angabe eines Identifiers gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. DocumentReference.status
Definition

The status of this document reference.

ShortStatus des Dokumentenmetadatensatzescurrent | superseded | entered-in-error
Comments

Der Status des Dokumentes wird in DocumentReference.docStatus gesetzt.


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
BindingThe codes SHALL be taken from 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 because 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. DocumentReference.docStatus
Definition

The status of the underlying document.

ShortBearbeitungsstatus des Dokumentespreliminary | final | amended | entered-in-error
Comments

Abweichend zu MHD V4.0.1 ist die Verwendung von docStatus im ISiK-Kontext erlaubt. Die Verwendung von docStatus bleibt jedoch optional, da nicht alle Dokumentenerzeugende Systeme einen expliziten Freigabe-Workflow haben. Dokumentenserver müssen jedoch in der Lage sein, den Dokumentenstatus (sofern vorhanden) zu persistieren, anzuzeigen und zu reproduzieren. [Konsens der Arbeitsgruppe vom 10.12.2021]


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

Control0..1
BindingThe codes SHALL be taken from CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/composition-status|4.0.1)

Status of the underlying document.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. DocumentReference.type
Definition

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.

ShortDokumententypKind of document (LOINC if possible)
Comments

Im ISiK-Kontext ist die Typisierung eines Dokumentes mit Hilfe eines KDL-Codes und des IHE-XDS-Type-Codes erforderlich und ein Server MUSS beide Kodierungen bereitstellen - trotz der Kardinalität DocumentReference.type.coding:XDS 0..1 -, jedoch ist der IHE-XDS-Type-Code bei Übermittlung für Clients nicht verpflichtend (s.u. zu XDS). Während KDL-Codes eine feingranulare Dokumentenklassifikation für die gezielte Suche nach medizinischen und Administrativen Dokumenten ermöglichen, sind IHE-XDS-Type-Codes für den einrichtungsübergreifenden Dokumentenaustausch maßgeblich. Der XDS-Type-Code kann mit Hilfe der bereitgestellten ConceptMaps aus dem KDL-Code ermittelt werden. Weitere Typisierungen (z.B. nach SNOMED oder LOINC) sind uneingeschränkt erlaubt. [Konsens der Arbeitsgruppe vom 18.02.2022]. Im Falle, dass der Code 'UNK' entsprechend der ConceptMap verwendet werden soll, MUSS das System 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor' verwendet werden.


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.

Control10..1
BindingThe codes SHOULD be taken from 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
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. DocumentReference.type.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control10..*
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DocumentReference.type.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • pattern @ $this
  • 26. DocumentReference.type.coding:KDL
    Slice NameKDL
    Definition

    A reference to a code defined by a terminology system.

    ShortDokumenttyp gem. KDL-TerminologieCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control10..1*
    BindingThe codes SHALL be taken from For codes, see ValueSet Klinische Dokumentenklassen-Liste (Version 2025)
    (required to http://dvmd.de/fhir/ValueSet/kdl)
    TypeCoding
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Allows for alternative encodings within a code system, and translations to other code systems.

    Pattern Value{
      "system" : "http://dvmd.de/fhir/CodeSystem/kdl"
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. DocumentReference.type.coding:KDL.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortKodiersystemIdentity of the terminology system
    Comments

    Fix: "http://dvmd.de/fhir/CodeSystem/kdl"


    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. DocumentReference.type.coding:KDL.code
    Definition

    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    ShortCodeSymbol in syntax defined by the system
    Comments

    Der KDL-Code

    Control10..1
    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to refer to a particular code in the system.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. DocumentReference.type.coding:KDL.display
    Definition

    A representation of the meaning of the code in the system, following the rules of the system.

    ShortAnzeigetextRepresentation defined by the system
    Comments

    Der Anzeigetext zum KDL-Code

    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. DocumentReference.type.coding:XDS
    Slice NameXDS
    Definition

    A reference to a code defined by a terminology system.

    ShortDokumenttyp gem. IHE-De-TerminologieCode defined by a terminology system
    Comments

    Die Übermittlung des XDS-Type-Codes ist im Rahmen der Dokumentenbereitstellung für Clients nicht verpflichtend, MUSS jedoch vom Server bei der Entgegennahme ggf. ergänzt und bei der Dokumentenabfrage zurückgegeben werden. Der XDS-Type-Code kann über die im Rahmen der KDL-Spezifikation publizierten ConceptMaps aus dem KDL-Code ermittelt werden


    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control0..1*
    BindingThe codes SHALL be taken from For codes, see IHE XDS typeCode
    (required to http://ihe-d.de/ValueSets/IHEXDStypeCode)
    TypeCoding
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Allows for alternative encodings within a code system, and translations to other code systems.

    Pattern Value{
      "system" : "http://ihe-d.de/CodeSystems/IHEXDStypeCode"
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. DocumentReference.type.coding:XDS.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortKodiersystemIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. DocumentReference.type.coding:XDS.code
    Definition

    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    ShortCodeSymbol in syntax defined by the system
    Comments

    Der XDS-Type-Code

    Control10..1
    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to refer to a particular code in the system.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. DocumentReference.type.coding:XDS.display
    Definition

    A representation of the meaning of the code in the system, following the rules of the system.

    ShortAnzeigetextRepresentation defined by the system
    Comments

    Der Anzeigetext zum XDS-Type-Code

    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. DocumentReference.category
    Definition

    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.

    ShortDokumentklasse/-KategorieCategorization of document
    Comments

    Die Kategorisierung von Dokumenten erfolgt mittels der von IHE Deutschland publizierten XDS-Class-Codes. Die übermittlung des XDS-Class-Codes ist im Rahmen der Dokumentenbereitstellung für Clients nicht verpflichtend, muss jedoch vom Server bei der Entgegennahme ggf. ergänzt und bei der Dokumentenabfrage zurückgegeben werden. Der XDS-Class-Code kann mit Hilfe der bereitgestellten ConceptMap aus dem KDL-Code ermittelt werden.


    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..1*
    BindingFor example codes, see DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes|4.0.1
    (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
    Must Supporttrue
    Summarytrue
    Alternate Namesclaxs
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. DocumentReference.category.coding
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control10..*
    TypeCoding
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows for alternative encodings within a code system, and translations to other code systems.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on DocumentReference.category.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • pattern @ $this
    • 46. DocumentReference.category.coding:XDS
      Slice NameXDS
      Definition

      A reference to a code defined by a terminology system.

      ShortCode defined by a terminology system
      Comments

      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

      Control10..1*
      BindingThe codes SHALL be taken from For codes, see IHE XDS classCode
      (required to http://ihe-d.de/ValueSets/IHEXDSclassCode)
      TypeCoding
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Pattern Value{
        "system" : "http://ihe-d.de/CodeSystems/IHEXDSclassCode"
      }
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. DocumentReference.category.coding:XDS.system
      Definition

      The identification of the code system that defines the meaning of the symbol in the code.

      ShortKodiersystemIdentity of the terminology system
      Comments

      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Need to be unambiguous about the source of the definition of the symbol.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      50. DocumentReference.category.coding:XDS.code
      Definition

      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      ShortCodeSymbol in syntax defined by the system
      Comments

      Der XDS-Class-Code

      Control10..1
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Need to refer to a particular code in the system.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      52. DocumentReference.category.coding:XDS.display
      Definition

      A representation of the meaning of the code in the system, following the rules of the system.

      ShortAnzeigetextRepresentation defined by the system
      Comments

      Der Anzeigetext zum XDS-Class-Code

      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      54. DocumentReference.subject
      Definition

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

      ShortPatientenbezugWho/what is the subject of the document
      Comments

      Begründung Must-Support: Ein Patientenbezug der Prozedur MUSS stets zum Zwecke der Nachvollziehbarkeit und Datenintegrität vorliegen.

      Control10..1
      TypeReference(Patient, Practitioner, Group, Device)
      Is Modifierfalse
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. DocumentReference.subject.reference
      Definition

      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

      ShortPatienten-LinkLiteral reference, Relative, internal or absolute URL
      Comments

      Bedingtes Pflichtfeld: Clients und Server sind verpflichtet, Dokumente stets mit einem Bezug zu einem Patienten zu versehen.
      Leer bleiben darf dieses Element einzig im Kontext der Dokumentenbereitstellung in Verbindung mit der Patientenzuordnung über logische Referenzen, siehe {{pagelink:Dokumentenbereitstellung text:Interaktion:Dokumentenbereitstellung > Herstellung von Patienten- und Encounterkontext > Option 5}}

      Die Verlinkung auf eine Patienten-Ressource dient der technischen Zuordnung der Dokumentation zu einem Patienten und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc. Im ISik Kontext MUSS die referenzierte Ressource konform zu ISiKPatient sein. Jenseits von ISiK KÖNNEN weitere Instanzen mit anderen Profilen referenziert werden.


      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

      Control0..1
      This element is affected by the following invariants: ref-1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      58. DocumentReference.subject.identifier
      Definition

      An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

      ShortPatienten-Link (logische Referenz)Logical reference, when literal reference is not known
      Comments

      Bedingtes Must Support: Logische Referenzen KÖNNEN als Alternative zur Verlinkung über referencegenutzt werden. BITTE HINWEISE BEACHTEN: {{pagelink:Dokumentenbereitstellung text:Interaktion:Dokumentenbereitstellung > Herstellung von Patienten- und Encounterkontext > Option 5}}


      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      60. DocumentReference.subject.identifier.use
      Definition

      The purpose of this identifier.

      Shortusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control0..1
      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      Identifies the purpose for this identifier, if known .

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      62. DocumentReference.subject.identifier.system
      Definition

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      ShortThe namespace for the identifier value
      Comments

      Identifier.system is always case sensitive.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

      ExampleGeneral: http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      64. DocumentReference.subject.identifier.value
      Definition

      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      ShortThe value that is unique
      Comments

      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      ExampleGeneral: 123456
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      66. DocumentReference.date
      Definition

      When the document reference was created.

      ShortWhen this document reference was created
      Comments

      Abweichend zu MHD V4.0.1 ist die Verwendung von date im ISiK-Kontext nicht verpflichtend. Die Motivation für die verbindliche Verwendung von date seitens IHE ist nicht nachvollziehbar. Ein entsprechender Change Request zur Harmonisierung wurde eingereicht. Das Dokumentendatum wird in attachment.creation gesetzt.

      Update für Stufe 3: In MHD 4.2.0 wurde die Verpflichtung zur Angabe von date gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.


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

      Control0..1
      Typeinstant
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Alternate Namesindexed
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      68. DocumentReference.author
      Definition

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

      ShortAutor des DokumentesWho and/or what authored the document
      Comments

      In dieser Ausbaustufe ist die Nennung des Namens oder Kürzels des Autors ausreichend. Eine darüber hinaus gehende Verlinkung auf einen Practitioner (auflösbar auf dem Server) ist möglich aber nicht erforderlich.


      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
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      70. DocumentReference.author.display
      Definition

      Plain text narrative that identifies the resource in addition to the resource reference.

      ShortText alternative for the resource
      Comments

      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      72. DocumentReference.relatesTo
      Definition

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

      ShortBeziehung zu anderen DokumentenRelationships to other documents
      Comments

      Inbesondere relevant im Kontext von Updates. Bei inhaltlichen Updates MUSS eine replaces-Relation angegeben werden.


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

      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      74. DocumentReference.relatesTo.modifierExtension
      Definition

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

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      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 because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      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.

      Alternate Namesextensions, 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.relatesTo.code
      Definition

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

      Shortreplaces | transforms | signs | appends
      Comments

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

      Control1..1
      BindingThe codes SHALL be taken from DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
      (required to http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1)

      The type of relationship between documents.

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      78. DocumentReference.relatesTo.target
      Definition

      The target document of this relationship.

      ShortTarget of the relationship
      Control1..1
      TypeReference(DocumentReference)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      80. DocumentReference.description
      Definition

      Human-readable description of the source document.

      ShortHuman-readable description
      Comments

      Optionaler Freitext zur ergänzenden Beschreibung des Dokumentes. Die eigentliche menschenlesbare Bezeichnung des Dokuments zur Anzeige in Benutzeroberflächen sollte in 'content.attachment.title' angegeben werden.

      Update für Stufe 5: Ab dieser Stufe ist für die menschenlesbare Bezeichnung des Dokuments das Element content.attachment.title zu verwenden. Die bisherige Nutzung von DocumentReference.description entfällt zugunsten einer besseren Angleichung an MHD und die ePA-Spezifikation. Implementierungen sollten daher den Titel des Dokuments ausschließlich in content.attachment.title angeben.

      Das Element 'description' kann weiterhin verwendet werden, um inhaltliche Hinweise zum Dokument, eine knappe Zusammenfassung oder ergänzende Kommentare bereitzustellen.


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

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      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()))
      82. DocumentReference.securityLabel
      Definition

      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.

      ShortVertraulichkeitDocument security-tags
      Comments

      Die Bereitstellung der Vertraulichkeitsinformation durch den Ersteller des Dokumentes ist verpflichtend. Ebenso sind Dokumentenserver verpflichtet, diese Information zu persistieren und bei der Dokumentenabfrage zu reproduzieren. Die ISiK-Spezifikation trifft jedoch keine Annahmen darüber, wie sich einzelne Vertraulichkeitsstufen auf die Zugriffsberechtigungen verschiedener benutzer auf ein Dokument auswirken. Im ISiK-Kontext ist die Angabe einer der drei Vertraulichkeitsstufen N | R | V verpflichtend, jedoch ohne Einschränkung der Verwendung zusätzlicher Vertraulichkeits-Flags.

      [Konsens der Arbeitsgruppe vom 12.11.2021]


      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.

      Control10..*
      BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from ISiKConfidentialityCodeshttp://hl7.org/fhir/ValueSet/security-labels|4.0.1
      (required to https://gematik.de/fhir/isik/ValueSet/ISiKConfidentialityCodes)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      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()))
      84. DocumentReference.content
      Definition

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

      ShortBeschreibung des DokumenteninhaltesDocument referenced
      Comments

      Die Kardinalität wurde angepasst, um den Vorgaben von IHE MHD zu ensprechen [Änderung im Zuge der Kommentierung Stufe 3].

      Control1..1*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      86. DocumentReference.content.modifierExtension
      Definition

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

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      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 because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      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.

      Alternate Namesextensions, 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())
      88. DocumentReference.content.attachment
      Definition

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

      ShortAnhangWhere to access the document
      Control1..1
      TypeAttachment
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      90. DocumentReference.content.attachment.contentType
      Definition

      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.

      ShortMimetype des DokumentesMime type of the content, with charset etc.
      Comments

      Mimetype (Dateityp) des Dokumentes (z.B. "application/pdf")

      Control10..1
      BindingThe codes SHALL be taken from Mime Typeshttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
      (required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

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

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

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

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

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

      ShortSprache, in der das Dokument verfasst wurde.Human language of the content (BCP-47)
      Comments

      Kann bei Systemen, die keine Mehrsprachigkeit unterstützen, fest auf "de" oder "de-DE" gesetzt werden.

      Control10..1
      BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1
      (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

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

      ExampleGeneral: en-AU
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      94. DocumentReference.content.attachment.data
      Definition

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

      ShortBase64-codierte BinärdatenData inline, base64ed
      Comments

      Um die Suche nach Dokumenten effizient zu gestalten, dürfen die Dokumente selbst nicht in die DocumentReference eingebettet werden, sondern müssen als separates Datenobjekt referenziert werden.

      Update für Stufe 3: Die Ausnahme bildet die Interaktion "Dokumentenbereitstellung", bei der die Binärdaten des Dokumentes eingebettet in die DocumentReference an den Server übermittelt und dort dann in eine separate Ressource ausgelagert und über Attachment.url referenziert werden.

      Es ist zu beachten, dass diese base64-codierten Daten wiederum ein FHIR-Bundle (z.B. ein MIO oder ein ISiK Bericht aus einem Subsystem) repräsentieren können. Um eine einheitliche Handhabung der Dokumente für Clients zu ermöglichen werden diese trotz strukturiertem Inhalt per base64 abgebildet.


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

      Control0..1
      Typebase64Binary
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summaryfalse
      Requirements

      The data needs to able to be transmitted inline.

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

      A location where the data can be accessed.

      ShortReferenz auf DokumentUri where the data can be found
      Comments

      Um die Suche nach Dokumenten effizient zu gestalten, dürfen die Dokumente selbst nicht in die DocumentReference eingebettet werden, sondern müssen als separates Datenobjekt referenziert werden.

      Wird ein separates Datenobjekt im ISIK-Kontext referenziert, so MUSS dieses konform zum Profil ISIKBinary aus dem Basismodul sein.

      Update für Stufe 3: Die Ausnahme bildet die Interaktion "Dokumentenbereitstellung", bei der die Binärdaten des Dokumentes eingebettet in die DocumentReference an den Server übermittelt und dort dann in eine separate Ressource ausgelagert und über Attachment.url referenziert werden.


      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.

      Control0..1
      Typeurl
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      The data needs to be transmitted by reference.

      ExampleGeneral: http://www.acme.com/logo-small.png
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      98. DocumentReference.content.attachment.title
      Definition

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

      ShortBezeichnung des DokumentsLabel to display in place of the data
      Comments

      Menschenlesbare Bezeichnung des Dokuments zur Anzeige in Benutzeroberflächen, z.B. als Titel in einer Dokumentenliste ('Lungenfunktionstest vom 18.02.2022').

      Update für Stufe 5: Ab dieser Stufe ist für die menschenlesbare Bezeichnung des Dokuments das Element content.attachment.title zu verwenden. Die bisherige Nutzung von DocumentReference.description entfällt zugunsten einer besseren Angleichung an MHD und die ePA-Spezifikation. Implementierungen sollten daher den Titel des Dokuments ausschließlich in content.attachment.title angeben.

      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      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.

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

      The date that the attachment was first created.

      ShortDokumentendatumDate attachment was first created
      Comments

      Es obliegt dem erzeugenden System, zu entscheiden, welches Datum als Dokumentendatum geeignet ist, z.B. Datum der Erstellung oder Datum der letzten Änderung

      Control10..1
      TypedateTime
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

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

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

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

      ShortFormat des DokumentesFormat/content rules for the document
      Comments

      Sofern das Dokument nicht auf einem standardisierten, strukturierten Austauschformat (z.B. CDA) basiert, für dessen Interpretation ein konkretes Schema herangezogen werden muss, genügt die Angabe des Codes "urn:ihe:iti:xds:2017:mimeTypeSufficient"


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

      Control10..1
      BindingThe codes SHALL be taken from The codes SHOULD be taken from IHE XDS formatCodehttp://hl7.org/fhir/ValueSet/formatcodes|4.0.1
      (required to http://ihe-d.de/ValueSets/IHEXDSformatCodeDE)
      TypeCoding
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      104. DocumentReference.context
      Definition

      The clinical context in which the document was prepared.

      ShortKontextinformationen zum DokumentClinical context of document
      Comments

      Begründung Must Support: Kontextinformationen sind erforderlich, um die Relevanz und den Bezug des Dokuments zu verstehen.


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

      Control10..1
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      106. DocumentReference.context.modifierExtension
      Definition

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

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      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 because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      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.

      Alternate Namesextensions, 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())
      108. DocumentReference.context.encounter
      Definition

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

      ShortAufenthaltsbezugContext of the document content
      Comments

      Hinweis Kompatibilität: In MHD 4.2.0 wurde das Verbot der Angabe einer Encounter-Referenz gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.

      Control0..1*
      TypeReference(Encounter, EpisodeOfCare)
      Is Modifierfalse
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      110. DocumentReference.context.encounter.reference
      Definition

      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

      ShortEncounter-LinkLiteral reference, Relative, internal or absolute URL
      Comments

      Begründung Pflichtfeld: Die Verlinkung auf eine Encounter-Ressource dient der technischen Zuordnung der Dokumentation zu einem Aufenthalt und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc. Im ISik Kontext MUSS die referenzierte Ressource konform zu ISiKKontaktGesundheitseinrichtung sein. Jenseits von ISiK KÖNNEN weitere Instanzen mit anderen Profilen referenziert werden.


      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

      Control10..1
      This element is affected by the following invariants: ref-1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      112. DocumentReference.context.event
      Definition

      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.

      ShortMain clinical acts documented
      Comments

      Binding auf IHE-DE Terminologie hinzugefügt


      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..*
      BindingThe codes SHALL be taken from For example codes, see IHE XDS eventCodeListhttp://terminology.hl7.org/ValueSet/v3-ActCode
      (required to http://ihe-d.de/ValueSets/IHEXDSeventCodeList)
      TypeCodeableConcept
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      114. DocumentReference.context.event.coding
      Definition

      A reference to a code defined by a terminology system.

      ShortCode defined by a terminology system
      Comments

      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

      Control10..1*
      TypeCoding
      Is Modifierfalse
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      116. DocumentReference.context.event.coding.system
      Definition

      The identification of the code system that defines the meaning of the symbol in the code.

      ShortIdentity of the terminology system
      Comments

      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be unambiguous about the source of the definition of the symbol.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      118. DocumentReference.context.event.coding.code
      Definition

      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      ShortSymbol in syntax defined by the system
      Control10..1
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to refer to a particular code in the system.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      120. DocumentReference.context.facilityType
      Definition

      The kind of facility where the patient was seen.

      ShortArt der Einrichtung, aus der das Dokument stammtKind of facility where patient was seen
      Comments

      Kann, sofern keine abweichende Information bekannt ist auf "KHS" gesetzt werden.

      Control10..1
      BindingThe codes SHALL be taken from For example codes, see IHE XDS healthcareFacilityTypeCodehttp://hl7.org/fhir/ValueSet/c80-facilitycodes|4.0.1
      (required to http://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      122. DocumentReference.context.practiceSetting
      Definition

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

      ShortAdditional details about where the content was created (e.g. clinical specialty)
      Comments

      Binding auf IHE-DE Terminologie hinzugefügt


      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.

      Control10..1
      BindingThe codes SHALL be taken from For example codes, see IHE XDS practiceSettingCodehttp://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1
      (required to http://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      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()))

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

      0. DocumentReference
      2. DocumentReference.id
      Shortserverseitige, interne ID des Datensatzes
      Comments

      bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine id verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine idverfügen.

      Must Supporttrue
      4. DocumentReference.meta
      6. DocumentReference.meta.versionId
      ShortEindeutiger Name der serverseitigen Version des Datensatzes
      Comments

      Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine versionID verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine versionIDverfügen.

      8. DocumentReference.meta.lastUpdated
      ShortZeitpunkt der letzten Änderung
      Comments

      Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein lastUpdate verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über ein lastUpdateverfügen.

      10. DocumentReference.masterIdentifier
      ShortVersionsspezifische OID des Dokumentes
      Comments

      Begründung Must Support: Die OID ist erforderlich, um die Version des Dokumentes eindeutig zu identifizieren.

      Control1..?
      Must Supporttrue
      12. DocumentReference.masterIdentifier.system
      ShortNamensraum des Identifiers
      Comments

      Bei OIDs und UUIDs ist hier stets der Wert urn:ietf:rfc:3986 anzugeben. Weitere Hinweise zur AbbildungVerwendung von MasterIdentifiern und deren Abbildung auf FHIR sind in IHE-ITI zu finden.

      Control1..?
      Must Supporttrue
      14. DocumentReference.masterIdentifier.value
      ShortWert des Identifiers
      Comments

      OID mit URI-Präfix "urn:oid:". Es sei darauf hingewiesen, dass OIDs auf Basis von UUIDs generiert werden können, ohne einen eigenen Namesraum zu beantragen. Zunächst müssen hierzu alle 128 Bit der UUID in einen Integer-Wert umgerechnet werden. Das Ergebnis muss ohne Bindestriche an die Root-OID '2.25' angehängt werden. Siehe IHE International - Creating Unique IDs - OID and UUID.

      Control1..?
      Must Supporttrue
      16. DocumentReference.identifier
      ShortIdentifier des Dokumentes
      Comments

      Abweichend zu MHD V4.0.1 ist die Angabe eines Identifiers in ISiK nicht erforderlich. Ein solcher kann bei Bedarf (z.B. zur Weitergabe des Dokumentes per XDS) erzeugt werden. [Konsens der Arbeitsgruppe vom 12.11.2021]

      Update für Stufe 3: In MHD 4.2.0 wurde die Verpflichtung zur Angabe eines Identifiers gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.

      NoteThis is a business identifier, not a resource identifier (see discussion)
      Must Supporttrue
      18. DocumentReference.status
      ShortStatus des Dokumentenmetadatensatzes
      Comments

      Der Status des Dokumentes wird in DocumentReference.docStatus gesetzt.

      Must Supporttrue
      20. DocumentReference.docStatus
      ShortBearbeitungsstatus des Dokumentes
      Comments

      Abweichend zu MHD V4.0.1 ist die Verwendung von docStatus im ISiK-Kontext erlaubt. Die Verwendung von docStatus bleibt jedoch optional, da nicht alle Dokumentenerzeugende Systeme einen expliziten Freigabe-Workflow haben. Dokumentenserver müssen jedoch in der Lage sein, den Dokumentenstatus (sofern vorhanden) zu persistieren, anzuzeigen und zu reproduzieren. [Konsens der Arbeitsgruppe vom 10.12.2021]

      Must Supporttrue
      22. DocumentReference.type
      ShortDokumententyp
      Comments

      Im ISiK-Kontext ist die Typisierung eines Dokumentes mit Hilfe eines KDL-Codes und des IHE-XDS-Type-Codes erforderlich und ein Server MUSS beide Kodierungen bereitstellen - trotz der Kardinalität DocumentReference.type.coding:XDS 0..1 -, jedoch ist der IHE-XDS-Type-Code bei Übermittlung für Clients nicht verpflichtend (s.u. zu XDS). Während KDL-Codes eine feingranulare Dokumentenklassifikation für die gezielte Suche nach medizinischen und Administrativen Dokumenten ermöglichen, sind IHE-XDS-Type-Codes für den einrichtungsübergreifenden Dokumentenaustausch maßgeblich. Der XDS-Type-Code kann mit Hilfe der bereitgestellten ConceptMaps aus dem KDL-Code ermittelt werden. Weitere Typisierungen (z.B. nach SNOMED oder LOINC) sind uneingeschränkt erlaubt. [Konsens der Arbeitsgruppe vom 18.02.2022]. Im Falle, dass der Code 'UNK' entsprechend der ConceptMap verwendet werden soll, MUSS das System 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor' verwendet werden.

      Control1..?
      Must Supporttrue
      24. DocumentReference.type.coding
      Control1..?
      SlicingThis element introduces a set of slices on DocumentReference.type.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • pattern @ $this
      • 26. DocumentReference.type.coding:KDL
        Slice NameKDL
        ShortDokumenttyp gem. KDL-Terminologie
        Control1..1
        BindingThe codes SHALL be taken from ValueSet Klinische Dokumentenklassen-Liste (Version 2025)
        (required to http://dvmd.de/fhir/ValueSet/kdl)
        Must Supporttrue
        Pattern Value{
          "system" : "http://dvmd.de/fhir/CodeSystem/kdl"
        }
        28. DocumentReference.type.coding:KDL.system
        ShortKodiersystem
        Comments

        Fix: "http://dvmd.de/fhir/CodeSystem/kdl"

        Control1..?
        Must Supporttrue
        30. DocumentReference.type.coding:KDL.code
        ShortCode
        Comments

        Der KDL-Code

        Control1..?
        Must Supporttrue
        32. DocumentReference.type.coding:KDL.display
        ShortAnzeigetext
        Comments

        Der Anzeigetext zum KDL-Code

        Control1..?
        Must Supporttrue
        34. DocumentReference.type.coding:XDS
        Slice NameXDS
        ShortDokumenttyp gem. IHE-De-Terminologie
        Comments

        Die Übermittlung des XDS-Type-Codes ist im Rahmen der Dokumentenbereitstellung für Clients nicht verpflichtend, MUSS jedoch vom Server bei der Entgegennahme ggf. ergänzt und bei der Dokumentenabfrage zurückgegeben werden. Der XDS-Type-Code kann über die im Rahmen der KDL-Spezifikation publizierten ConceptMaps aus dem KDL-Code ermittelt werden

        Control0..1
        BindingThe codes SHALL be taken from IHE XDS typeCode
        (required to http://ihe-d.de/ValueSets/IHEXDStypeCode)
        Must Supporttrue
        Pattern Value{
          "system" : "http://ihe-d.de/CodeSystems/IHEXDStypeCode"
        }
        36. DocumentReference.type.coding:XDS.system
        ShortKodiersystem
        Control1..?
        Must Supporttrue
        38. DocumentReference.type.coding:XDS.code
        ShortCode
        Comments

        Der XDS-Type-Code

        Control1..?
        Must Supporttrue
        40. DocumentReference.type.coding:XDS.display
        ShortAnzeigetext
        Comments

        Der Anzeigetext zum XDS-Type-Code

        Control1..?
        Must Supporttrue
        42. DocumentReference.category
        ShortDokumentklasse/-Kategorie
        Comments

        Die Kategorisierung von Dokumenten erfolgt mittels der von IHE Deutschland publizierten XDS-Class-Codes. Die übermittlung des XDS-Class-Codes ist im Rahmen der Dokumentenbereitstellung für Clients nicht verpflichtend, muss jedoch vom Server bei der Entgegennahme ggf. ergänzt und bei der Dokumentenabfrage zurückgegeben werden. Der XDS-Class-Code kann mit Hilfe der bereitgestellten ConceptMap aus dem KDL-Code ermittelt werden.

        Control0..1
        Must Supporttrue
        44. DocumentReference.category.coding
        Control1..?
        SlicingThis element introduces a set of slices on DocumentReference.category.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • pattern @ $this
        • 46. DocumentReference.category.coding:XDS
          Slice NameXDS
          Control1..1
          BindingThe codes SHALL be taken from IHE XDS classCode
          (required to http://ihe-d.de/ValueSets/IHEXDSclassCode)
          Must Supporttrue
          Pattern Value{
            "system" : "http://ihe-d.de/CodeSystems/IHEXDSclassCode"
          }
          48. DocumentReference.category.coding:XDS.system
          ShortKodiersystem
          Control1..?
          Must Supporttrue
          50. DocumentReference.category.coding:XDS.code
          ShortCode
          Comments

          Der XDS-Class-Code

          Control1..?
          Must Supporttrue
          52. DocumentReference.category.coding:XDS.display
          ShortAnzeigetext
          Comments

          Der Anzeigetext zum XDS-Class-Code

          Control1..?
          Must Supporttrue
          54. DocumentReference.subject
          ShortPatientenbezug
          Comments

          Begründung Must-Support: Ein Patientenbezug der Prozedur MUSS stets zum Zwecke der Nachvollziehbarkeit und Datenintegrität vorliegen.

          Control1..?
          Must Supporttrue
          56. DocumentReference.subject.reference
          ShortPatienten-Link
          Comments

          Bedingtes Pflichtfeld: Clients und Server sind verpflichtet, Dokumente stets mit einem Bezug zu einem Patienten zu versehen.
          Leer bleiben darf dieses Element einzig im Kontext der Dokumentenbereitstellung in Verbindung mit der Patientenzuordnung über logische Referenzen, siehe {{pagelink:Dokumentenbereitstellung text:Interaktion:Dokumentenbereitstellung > Herstellung von Patienten- und Encounterkontext > Option 5}}

          Die Verlinkung auf eine Patienten-Ressource dient der technischen Zuordnung der Dokumentation zu einem Patienten und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc. Im ISik Kontext MUSS die referenzierte Ressource konform zu ISiKPatient sein. Jenseits von ISiK KÖNNEN weitere Instanzen mit anderen Profilen referenziert werden.

          Must Supporttrue
          58. DocumentReference.subject.identifier
          ShortPatienten-Link (logische Referenz)
          Comments

          Bedingtes Must Support: Logische Referenzen KÖNNEN als Alternative zur Verlinkung über referencegenutzt werden. BITTE HINWEISE BEACHTEN: {{pagelink:Dokumentenbereitstellung text:Interaktion:Dokumentenbereitstellung > Herstellung von Patienten- und Encounterkontext > Option 5}}

          NoteThis is a business identifier, not a resource identifier (see discussion)
          Must Supporttrue
          60. DocumentReference.subject.identifier.system
          Control1..?
          Must Supporttrue
          62. DocumentReference.subject.identifier.value
          Control1..?
          Must Supporttrue
          64. DocumentReference.date
          Comments

          Abweichend zu MHD V4.0.1 ist die Verwendung von date im ISiK-Kontext nicht verpflichtend. Die Motivation für die verbindliche Verwendung von date seitens IHE ist nicht nachvollziehbar. Ein entsprechender Change Request zur Harmonisierung wurde eingereicht. Das Dokumentendatum wird in attachment.creation gesetzt.

          Update für Stufe 3: In MHD 4.2.0 wurde die Verpflichtung zur Angabe von date gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.

          66. DocumentReference.author
          ShortAutor des Dokumentes
          Comments

          In dieser Ausbaustufe ist die Nennung des Namens oder Kürzels des Autors ausreichend. Eine darüber hinaus gehende Verlinkung auf einen Practitioner (auflösbar auf dem Server) ist möglich aber nicht erforderlich.

          Must Supporttrue
          68. DocumentReference.author.display
          Must Supporttrue
          70. DocumentReference.relatesTo
          ShortBeziehung zu anderen Dokumenten
          Comments

          Inbesondere relevant im Kontext von Updates. Bei inhaltlichen Updates MUSS eine replaces-Relation angegeben werden.

          Must Supporttrue
          72. DocumentReference.relatesTo.code
          74. DocumentReference.relatesTo.target
          76. DocumentReference.description
          Comments

          Optionaler Freitext zur ergänzenden Beschreibung des Dokumentes. Die eigentliche menschenlesbare Bezeichnung des Dokuments zur Anzeige in Benutzeroberflächen sollte in 'content.attachment.title' angegeben werden.

          Update für Stufe 5: Ab dieser Stufe ist für die menschenlesbare Bezeichnung des Dokuments das Element content.attachment.title zu verwenden. Die bisherige Nutzung von DocumentReference.description entfällt zugunsten einer besseren Angleichung an MHD und die ePA-Spezifikation. Implementierungen sollten daher den Titel des Dokuments ausschließlich in content.attachment.title angeben.

          Das Element 'description' kann weiterhin verwendet werden, um inhaltliche Hinweise zum Dokument, eine knappe Zusammenfassung oder ergänzende Kommentare bereitzustellen.

          78. DocumentReference.securityLabel
          ShortVertraulichkeit
          Comments

          Die Bereitstellung der Vertraulichkeitsinformation durch den Ersteller des Dokumentes ist verpflichtend. Ebenso sind Dokumentenserver verpflichtet, diese Information zu persistieren und bei der Dokumentenabfrage zu reproduzieren. Die ISiK-Spezifikation trifft jedoch keine Annahmen darüber, wie sich einzelne Vertraulichkeitsstufen auf die Zugriffsberechtigungen verschiedener benutzer auf ein Dokument auswirken. Im ISiK-Kontext ist die Angabe einer der drei Vertraulichkeitsstufen N | R | V verpflichtend, jedoch ohne Einschränkung der Verwendung zusätzlicher Vertraulichkeits-Flags.

          [Konsens der Arbeitsgruppe vom 12.11.2021]

          Control1..?
          BindingThe codes SHALL be taken from ISiKConfidentialityCodes
          (required to https://gematik.de/fhir/isik/ValueSet/ISiKConfidentialityCodes)
          Must Supporttrue
          80. DocumentReference.content
          ShortBeschreibung des Dokumenteninhaltes
          Comments

          Die Kardinalität wurde angepasst, um den Vorgaben von IHE MHD zu ensprechen [Änderung im Zuge der Kommentierung Stufe 3].

          Control0..1
          Must Supporttrue
          82. DocumentReference.content.attachment
          ShortAnhang
          Must Supporttrue
          84. DocumentReference.content.attachment.contentType
          ShortMimetype des Dokumentes
          Comments

          Mimetype (Dateityp) des Dokumentes (z.B. "application/pdf")

          Control1..?
          Must Supporttrue
          86. DocumentReference.content.attachment.language
          ShortSprache, in der das Dokument verfasst wurde.
          Comments

          Kann bei Systemen, die keine Mehrsprachigkeit unterstützen, fest auf "de" oder "de-DE" gesetzt werden.

          Control1..?
          Must Supporttrue
          88. DocumentReference.content.attachment.data
          ShortBase64-codierte Binärdaten
          Comments

          Um die Suche nach Dokumenten effizient zu gestalten, dürfen die Dokumente selbst nicht in die DocumentReference eingebettet werden, sondern müssen als separates Datenobjekt referenziert werden.

          Update für Stufe 3: Die Ausnahme bildet die Interaktion "Dokumentenbereitstellung", bei der die Binärdaten des Dokumentes eingebettet in die DocumentReference an den Server übermittelt und dort dann in eine separate Ressource ausgelagert und über Attachment.url referenziert werden.

          Es ist zu beachten, dass diese base64-codierten Daten wiederum ein FHIR-Bundle (z.B. ein MIO oder ein ISiK Bericht aus einem Subsystem) repräsentieren können. Um eine einheitliche Handhabung der Dokumente für Clients zu ermöglichen werden diese trotz strukturiertem Inhalt per base64 abgebildet.

          Must Supporttrue
          90. DocumentReference.content.attachment.url
          ShortReferenz auf Dokument
          Comments

          Um die Suche nach Dokumenten effizient zu gestalten, dürfen die Dokumente selbst nicht in die DocumentReference eingebettet werden, sondern müssen als separates Datenobjekt referenziert werden.

          Wird ein separates Datenobjekt im ISIK-Kontext referenziert, so MUSS dieses konform zum Profil ISIKBinary aus dem Basismodul sein.

          Update für Stufe 3: Die Ausnahme bildet die Interaktion "Dokumentenbereitstellung", bei der die Binärdaten des Dokumentes eingebettet in die DocumentReference an den Server übermittelt und dort dann in eine separate Ressource ausgelagert und über Attachment.url referenziert werden.

          Must Supporttrue
          92. DocumentReference.content.attachment.title
          ShortBezeichnung des Dokuments
          Comments

          Menschenlesbare Bezeichnung des Dokuments zur Anzeige in Benutzeroberflächen, z.B. als Titel in einer Dokumentenliste ('Lungenfunktionstest vom 18.02.2022').

          Update für Stufe 5: Ab dieser Stufe ist für die menschenlesbare Bezeichnung des Dokuments das Element content.attachment.title zu verwenden. Die bisherige Nutzung von DocumentReference.description entfällt zugunsten einer besseren Angleichung an MHD und die ePA-Spezifikation. Implementierungen sollten daher den Titel des Dokuments ausschließlich in content.attachment.title angeben.

          Control1..?
          Must Supporttrue
          94. DocumentReference.content.attachment.creation
          ShortDokumentendatum
          Comments

          Es obliegt dem erzeugenden System, zu entscheiden, welches Datum als Dokumentendatum geeignet ist, z.B. Datum der Erstellung oder Datum der letzten Änderung

          Control1..?
          Must Supporttrue
          96. DocumentReference.content.format
          ShortFormat des Dokumentes
          Comments

          Sofern das Dokument nicht auf einem standardisierten, strukturierten Austauschformat (z.B. CDA) basiert, für dessen Interpretation ein konkretes Schema herangezogen werden muss, genügt die Angabe des Codes "urn:ihe:iti:xds:2017:mimeTypeSufficient"

          Control1..?
          BindingThe codes SHALL be taken from IHE XDS formatCode
          (required to http://ihe-d.de/ValueSets/IHEXDSformatCodeDE)
          Must Supporttrue
          98. DocumentReference.context
          ShortKontextinformationen zum Dokument
          Comments

          Begründung Must Support: Kontextinformationen sind erforderlich, um die Relevanz und den Bezug des Dokuments zu verstehen.

          Control1..?
          Must Supporttrue
          100. DocumentReference.context.encounter
          ShortAufenthaltsbezug
          Comments

          Hinweis Kompatibilität: In MHD 4.2.0 wurde das Verbot der Angabe einer Encounter-Referenz gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.

          Control0..1
          Must Supporttrue
          102. DocumentReference.context.encounter.reference
          ShortEncounter-Link
          Comments

          Begründung Pflichtfeld: Die Verlinkung auf eine Encounter-Ressource dient der technischen Zuordnung der Dokumentation zu einem Aufenthalt und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc. Im ISik Kontext MUSS die referenzierte Ressource konform zu ISiKKontaktGesundheitseinrichtung sein. Jenseits von ISiK KÖNNEN weitere Instanzen mit anderen Profilen referenziert werden.

          Control1..?
          Must Supporttrue
          104. DocumentReference.context.event
          Comments

          Binding auf IHE-DE Terminologie hinzugefügt

          BindingThe codes SHALL be taken from IHE XDS eventCodeList
          (required to http://ihe-d.de/ValueSets/IHEXDSeventCodeList)
          106. DocumentReference.context.event.coding
          Control1..1
          108. DocumentReference.context.event.coding.system
          Control1..?
          110. DocumentReference.context.event.coding.code
          Control1..?
          112. DocumentReference.context.facilityType
          ShortArt der Einrichtung, aus der das Dokument stammt
          Comments

          Kann, sofern keine abweichende Information bekannt ist auf "KHS" gesetzt werden.

          Control1..?
          BindingThe codes SHALL be taken from IHE XDS healthcareFacilityTypeCode
          (required to http://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode)
          Must Supporttrue
          114. DocumentReference.context.practiceSetting
          Comments

          Binding auf IHE-DE Terminologie hinzugefügt

          Control1..?
          BindingThe codes SHALL be taken from IHE XDS practiceSettingCode
          (required to http://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode)
          Must Supporttrue

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

          0. DocumentReference
          Definition

          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.

          ShortA reference to a document
          Comments

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

          Control0..*
          Is Modifierfalse
          Summaryfalse
          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
          Definition

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

          Shortserverseitige, interne ID des Datensatzes
          Comments

          bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine id verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine idverfügen.

          Control0..1
          Typeid
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          4. DocumentReference.meta
          Definition

          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.

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          6. DocumentReference.meta.id
          Definition

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

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          8. DocumentReference.meta.extension
          Definition

          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.

          ShortAdditional content defined by implementations
          Comments

          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
          Summaryfalse
          Alternate Namesextensions, 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())
          SlicingThis element introduces a set of slices on DocumentReference.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 10. DocumentReference.meta.versionId
            Definition

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

            ShortEindeutiger Name der serverseitigen Version des Datensatzes
            Comments

            Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine versionID verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine versionIDverfügen.

            Control0..1
            Typeid
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            12. DocumentReference.meta.lastUpdated
            Definition

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

            ShortZeitpunkt der letzten Änderung
            Comments

            Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein lastUpdate verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über ein lastUpdateverfügen.

            Control0..1
            Typeinstant
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            14. DocumentReference.meta.source
            Definition

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

            ShortIdentifies where the resource comes from
            Comments

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

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

            Control0..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            16. DocumentReference.meta.profile
            Definition

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

            ShortProfiles this resource claims to conform to
            Comments

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

            Control0..*
            Typecanonical(StructureDefinition)
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            18. DocumentReference.meta.security
            Definition

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

            ShortSecurity Labels applied to this resource
            Comments

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

            Control0..*
            BindingUnless not suitable, these codes SHALL be taken from All Security Labels
            (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

            Security Labels from the Healthcare Privacy and Security Classification System.

            TypeCoding
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            20. DocumentReference.meta.tag
            Definition

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

            ShortTags applied to this resource
            Comments

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

            Control0..*
            BindingFor example codes, see CommonTags
            (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

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

            TypeCoding
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            22. DocumentReference.implicitRules
            Definition

            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.

            ShortA set of rules under which this content was created
            Comments

            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 because 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
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            24. DocumentReference.language
            Definition

            The base language in which the resource is written.

            ShortLanguage of the resource content
            Comments

            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
            BindingThe codes SHOULD be taken from CommonLanguages
            (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

            A human language.

            Additional BindingsPurpose
            AllLanguagesMax Binding
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            26. DocumentReference.text
            Definition

            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.

            ShortText summary of the resource, for human interpretation
            Comments

            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
            Summaryfalse
            Alternate Namesnarrative, html, xhtml, display
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            28. DocumentReference.contained
            Definition

            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.

            ShortContained, inline Resources
            Comments

            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
            Summaryfalse
            Alternate Namesinline resources, anonymous resources, contained resources
            30. DocumentReference.extension
            Definition

            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.

            ShortAdditional content defined by implementations
            Comments

            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
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            32. DocumentReference.modifierExtension
            Definition

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

            ShortExtensions that cannot be ignored
            Comments

            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 because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Summaryfalse
            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.

            Alternate Namesextensions, 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())
            34. DocumentReference.masterIdentifier
            Definition

            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.

            ShortVersionsspezifische OID des Dokumentes
            Comments

            Begründung Must Support: Die OID ist erforderlich, um die Version des Dokumentes eindeutig zu identifizieren.

            Control1..1
            TypeIdentifier
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            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()))
            36. DocumentReference.masterIdentifier.id
            Definition

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

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            38. DocumentReference.masterIdentifier.extension
            Definition

            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.

            ShortAdditional content defined by implementations
            Comments

            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
            Summaryfalse
            Alternate Namesextensions, 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())
            SlicingThis element introduces a set of slices on DocumentReference.masterIdentifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 40. DocumentReference.masterIdentifier.use
              Definition

              The purpose of this identifier.

              Shortusual | official | temp | secondary | old (If known)
              Comments

              Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

              Control0..1
              BindingThe codes SHALL be taken from IdentifierUse
              (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

              Identifies the purpose for this identifier, if known .

              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              42. DocumentReference.masterIdentifier.type
              Definition

              A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

              ShortDescription of identifier
              Comments

              This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

              Control0..1
              BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
              (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

              A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Requirements

              Allows users to make use of identifiers when the identifier system is not known.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              44. DocumentReference.masterIdentifier.system
              Definition

              Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

              ShortNamensraum des Identifiers
              Comments

              Bei OIDs und UUIDs ist hier stets der Wert urn:ietf:rfc:3986 anzugeben. Weitere Hinweise zur AbbildungVerwendung von MasterIdentifiern und deren Abbildung auf FHIR sind in IHE-ITI zu finden.

              Control1..1
              Typeuri
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Requirements

              There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

              ExampleGeneral: http://www.acme.com/identifiers/patient
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              46. DocumentReference.masterIdentifier.value
              Definition

              The portion of the identifier typically relevant to the user and which is unique within the context of the system.

              ShortWert des Identifiers
              Comments

              OID mit URI-Präfix "urn:oid:". Es sei darauf hingewiesen, dass OIDs auf Basis von UUIDs generiert werden können, ohne einen eigenen Namesraum zu beantragen. Zunächst müssen hierzu alle 128 Bit der UUID in einen Integer-Wert umgerechnet werden. Das Ergebnis muss ohne Bindestriche an die Root-OID '2.25' angehängt werden. Siehe IHE International - Creating Unique IDs - OID and UUID.

              Control1..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              ExampleGeneral: 123456
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              48. DocumentReference.masterIdentifier.period
              Definition

              Time period during which identifier is/was valid for use.

              ShortTime period when id is/was valid for use
              Control0..1
              TypePeriod
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              50. DocumentReference.masterIdentifier.assigner
              Definition

              Organization that issued/manages the identifier.

              ShortOrganization that issued id (may be just text)
              Comments

              The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

              Control0..1
              TypeReference(Organization)
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              52. DocumentReference.identifier
              Definition

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

              ShortIdentifier des Dokumentes
              Comments

              Abweichend zu MHD V4.0.1 ist die Angabe eines Identifiers in ISiK nicht erforderlich. Ein solcher kann bei Bedarf (z.B. zur Weitergabe des Dokumentes per XDS) erzeugt werden. [Konsens der Arbeitsgruppe vom 12.11.2021]

              Update für Stufe 3: In MHD 4.2.0 wurde die Verpflichtung zur Angabe eines Identifiers gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.

              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..*
              TypeIdentifier
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              54. DocumentReference.status
              Definition

              The status of this document reference.

              ShortStatus des Dokumentenmetadatensatzes
              Comments

              Der Status des Dokumentes wird in DocumentReference.docStatus gesetzt.

              Control1..1
              BindingThe codes SHALL be taken from DocumentReferenceStatus
              (required to http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1)

              The status of the document reference.

              Typecode
              Is Modifiertrue because 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
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              56. DocumentReference.docStatus
              Definition

              The status of the underlying document.

              ShortBearbeitungsstatus des Dokumentes
              Comments

              Abweichend zu MHD V4.0.1 ist die Verwendung von docStatus im ISiK-Kontext erlaubt. Die Verwendung von docStatus bleibt jedoch optional, da nicht alle Dokumentenerzeugende Systeme einen expliziten Freigabe-Workflow haben. Dokumentenserver müssen jedoch in der Lage sein, den Dokumentenstatus (sofern vorhanden) zu persistieren, anzuzeigen und zu reproduzieren. [Konsens der Arbeitsgruppe vom 10.12.2021]

              Control0..1
              BindingThe codes SHALL be taken from CompositionStatus
              (required to http://hl7.org/fhir/ValueSet/composition-status|4.0.1)

              Status of the underlying document.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              58. DocumentReference.type
              Definition

              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.

              ShortDokumententyp
              Comments

              Im ISiK-Kontext ist die Typisierung eines Dokumentes mit Hilfe eines KDL-Codes und des IHE-XDS-Type-Codes erforderlich und ein Server MUSS beide Kodierungen bereitstellen - trotz der Kardinalität DocumentReference.type.coding:XDS 0..1 -, jedoch ist der IHE-XDS-Type-Code bei Übermittlung für Clients nicht verpflichtend (s.u. zu XDS). Während KDL-Codes eine feingranulare Dokumentenklassifikation für die gezielte Suche nach medizinischen und Administrativen Dokumenten ermöglichen, sind IHE-XDS-Type-Codes für den einrichtungsübergreifenden Dokumentenaustausch maßgeblich. Der XDS-Type-Code kann mit Hilfe der bereitgestellten ConceptMaps aus dem KDL-Code ermittelt werden. Weitere Typisierungen (z.B. nach SNOMED oder LOINC) sind uneingeschränkt erlaubt. [Konsens der Arbeitsgruppe vom 18.02.2022]. Im Falle, dass der Code 'UNK' entsprechend der ConceptMap verwendet werden soll, MUSS das System 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor' verwendet werden.

              Control1..1
              BindingThe codes SHOULD be taken from DocumentTypeValueSet
              (preferred to http://hl7.org/fhir/ValueSet/c80-doc-typecodes|4.0.1)

              Precise type of clinical document.

              TypeCodeableConcept
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              60. DocumentReference.type.id
              Definition

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

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              62. DocumentReference.type.extension
              Definition

              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.

              ShortAdditional content defined by implementations
              Comments

              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
              Summaryfalse
              Alternate Namesextensions, 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())
              SlicingThis element introduces a set of slices on DocumentReference.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 64. DocumentReference.type.coding
                Definition

                A reference to a code defined by a terminology system.

                ShortCode defined by a terminology system
                Comments

                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                Control1..*
                TypeCoding
                Is Modifierfalse
                Summarytrue
                Requirements

                Allows for alternative encodings within a code system, and translations to other code systems.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on DocumentReference.type.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • pattern @ $this
                • 66. DocumentReference.type.coding:KDL
                  Slice NameKDL
                  Definition

                  A reference to a code defined by a terminology system.

                  ShortDokumenttyp gem. KDL-Terminologie
                  Comments

                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                  Control1..1
                  BindingThe codes SHALL be taken from ValueSet Klinische Dokumentenklassen-Liste (Version 2025)
                  (required to http://dvmd.de/fhir/ValueSet/kdl)
                  TypeCoding
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  Allows for alternative encodings within a code system, and translations to other code systems.

                  Pattern Value{
                    "system" : "http://dvmd.de/fhir/CodeSystem/kdl"
                  }
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  68. DocumentReference.type.coding:KDL.id
                  Definition

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

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  70. DocumentReference.type.coding:KDL.extension
                  Definition

                  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.

                  ShortAdditional content defined by implementations
                  Comments

                  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
                  Summaryfalse
                  Alternate Namesextensions, 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())
                  SlicingThis element introduces a set of slices on DocumentReference.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 72. DocumentReference.type.coding:KDL.system
                    Definition

                    The identification of the code system that defines the meaning of the symbol in the code.

                    ShortKodiersystem
                    Comments

                    Fix: "http://dvmd.de/fhir/CodeSystem/kdl"

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    Need to be unambiguous about the source of the definition of the symbol.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    74. DocumentReference.type.coding:KDL.version
                    Definition

                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                    ShortVersion of the system - if relevant
                    Comments

                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                    NoteThis is a business version Id, not a resource version Id (see discussion)
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    76. DocumentReference.type.coding:KDL.code
                    Definition

                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                    ShortCode
                    Comments

                    Der KDL-Code

                    Control1..1
                    Typecode
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    Need to refer to a particular code in the system.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    78. DocumentReference.type.coding:KDL.display
                    Definition

                    A representation of the meaning of the code in the system, following the rules of the system.

                    ShortAnzeigetext
                    Comments

                    Der Anzeigetext zum KDL-Code

                    Control1..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    80. DocumentReference.type.coding:KDL.userSelected
                    Definition

                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                    ShortIf this coding was chosen directly by the user
                    Comments

                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                    Control0..1
                    Typeboolean
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    82. DocumentReference.type.coding:XDS
                    Slice NameXDS
                    Definition

                    A reference to a code defined by a terminology system.

                    ShortDokumenttyp gem. IHE-De-Terminologie
                    Comments

                    Die Übermittlung des XDS-Type-Codes ist im Rahmen der Dokumentenbereitstellung für Clients nicht verpflichtend, MUSS jedoch vom Server bei der Entgegennahme ggf. ergänzt und bei der Dokumentenabfrage zurückgegeben werden. Der XDS-Type-Code kann über die im Rahmen der KDL-Spezifikation publizierten ConceptMaps aus dem KDL-Code ermittelt werden

                    Control0..1
                    BindingThe codes SHALL be taken from IHE XDS typeCode
                    (required to http://ihe-d.de/ValueSets/IHEXDStypeCode)
                    TypeCoding
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    Allows for alternative encodings within a code system, and translations to other code systems.

                    Pattern Value{
                      "system" : "http://ihe-d.de/CodeSystems/IHEXDStypeCode"
                    }
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    84. DocumentReference.type.coding:XDS.id
                    Definition

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

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    86. DocumentReference.type.coding:XDS.extension
                    Definition

                    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.

                    ShortAdditional content defined by implementations
                    Comments

                    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
                    Summaryfalse
                    Alternate Namesextensions, 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())
                    SlicingThis element introduces a set of slices on DocumentReference.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 88. DocumentReference.type.coding:XDS.system
                      Definition

                      The identification of the code system that defines the meaning of the symbol in the code.

                      ShortKodiersystem
                      Comments

                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                      Control1..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Need to be unambiguous about the source of the definition of the symbol.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      90. DocumentReference.type.coding:XDS.version
                      Definition

                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                      ShortVersion of the system - if relevant
                      Comments

                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                      NoteThis is a business version Id, not a resource version Id (see discussion)
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      92. DocumentReference.type.coding:XDS.code
                      Definition

                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                      ShortCode
                      Comments

                      Der XDS-Type-Code

                      Control1..1
                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Need to refer to a particular code in the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      94. DocumentReference.type.coding:XDS.display
                      Definition

                      A representation of the meaning of the code in the system, following the rules of the system.

                      ShortAnzeigetext
                      Comments

                      Der Anzeigetext zum XDS-Type-Code

                      Control1..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      96. DocumentReference.type.coding:XDS.userSelected
                      Definition

                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                      ShortIf this coding was chosen directly by the user
                      Comments

                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                      Control0..1
                      Typeboolean
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      98. DocumentReference.type.text
                      Definition

                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                      ShortPlain text representation of the concept
                      Comments

                      Very often the text is the same as a displayName of one of the codings.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      100. DocumentReference.category
                      Definition

                      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.

                      ShortDokumentklasse/-Kategorie
                      Comments

                      Die Kategorisierung von Dokumenten erfolgt mittels der von IHE Deutschland publizierten XDS-Class-Codes. Die übermittlung des XDS-Class-Codes ist im Rahmen der Dokumentenbereitstellung für Clients nicht verpflichtend, muss jedoch vom Server bei der Entgegennahme ggf. ergänzt und bei der Dokumentenabfrage zurückgegeben werden. Der XDS-Class-Code kann mit Hilfe der bereitgestellten ConceptMap aus dem KDL-Code ermittelt werden.

                      Control0..1
                      BindingFor example codes, see 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
                      Must Supporttrue
                      Summarytrue
                      Alternate Namesclaxs
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      102. DocumentReference.category.id
                      Definition

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

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      104. DocumentReference.category.extension
                      Definition

                      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.

                      ShortAdditional content defined by implementations
                      Comments

                      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
                      Summaryfalse
                      Alternate Namesextensions, 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())
                      SlicingThis element introduces a set of slices on DocumentReference.category.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 106. DocumentReference.category.coding
                        Definition

                        A reference to a code defined by a terminology system.

                        ShortCode defined by a terminology system
                        Comments

                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                        Control1..*
                        TypeCoding
                        Is Modifierfalse
                        Summarytrue
                        Requirements

                        Allows for alternative encodings within a code system, and translations to other code systems.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        SlicingThis element introduces a set of slices on DocumentReference.category.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • pattern @ $this
                        • 108. DocumentReference.category.coding:XDS
                          Slice NameXDS
                          Definition

                          A reference to a code defined by a terminology system.

                          ShortCode defined by a terminology system
                          Comments

                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                          Control1..1
                          BindingThe codes SHALL be taken from IHE XDS classCode
                          (required to http://ihe-d.de/ValueSets/IHEXDSclassCode)
                          TypeCoding
                          Is Modifierfalse
                          Must Supporttrue
                          Summarytrue
                          Requirements

                          Allows for alternative encodings within a code system, and translations to other code systems.

                          Pattern Value{
                            "system" : "http://ihe-d.de/CodeSystems/IHEXDSclassCode"
                          }
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          110. DocumentReference.category.coding:XDS.id
                          Definition

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

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          112. DocumentReference.category.coding:XDS.extension
                          Definition

                          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.

                          ShortAdditional content defined by implementations
                          Comments

                          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
                          Summaryfalse
                          Alternate Namesextensions, 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())
                          SlicingThis element introduces a set of slices on DocumentReference.category.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 114. DocumentReference.category.coding:XDS.system
                            Definition

                            The identification of the code system that defines the meaning of the symbol in the code.

                            ShortKodiersystem
                            Comments

                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Requirements

                            Need to be unambiguous about the source of the definition of the symbol.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            116. DocumentReference.category.coding:XDS.version
                            Definition

                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                            ShortVersion of the system - if relevant
                            Comments

                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                            NoteThis is a business version Id, not a resource version Id (see discussion)
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            118. DocumentReference.category.coding:XDS.code
                            Definition

                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                            ShortCode
                            Comments

                            Der XDS-Class-Code

                            Control1..1
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Requirements

                            Need to refer to a particular code in the system.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            120. DocumentReference.category.coding:XDS.display
                            Definition

                            A representation of the meaning of the code in the system, following the rules of the system.

                            ShortAnzeigetext
                            Comments

                            Der Anzeigetext zum XDS-Class-Code

                            Control1..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Requirements

                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            122. DocumentReference.category.coding:XDS.userSelected
                            Definition

                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                            ShortIf this coding was chosen directly by the user
                            Comments

                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                            Control0..1
                            Typeboolean
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            124. DocumentReference.category.text
                            Definition

                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                            ShortPlain text representation of the concept
                            Comments

                            Very often the text is the same as a displayName of one of the codings.

                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            126. DocumentReference.subject
                            Definition

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

                            ShortPatientenbezug
                            Comments

                            Begründung Must-Support: Ein Patientenbezug der Prozedur MUSS stets zum Zwecke der Nachvollziehbarkeit und Datenintegrität vorliegen.

                            Control1..1
                            TypeReference(Patient, Practitioner, Group, Device)
                            Is Modifierfalse
                            Must Supporttrue
                            Must Support TypesNo must-support rules about the choice of types/profiles
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            128. DocumentReference.subject.id
                            Definition

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

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            130. DocumentReference.subject.extension
                            Definition

                            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.

                            ShortAdditional content defined by implementations
                            Comments

                            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
                            Summaryfalse
                            Alternate Namesextensions, 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())
                            SlicingThis element introduces a set of slices on DocumentReference.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 132. DocumentReference.subject.reference
                              Definition

                              A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                              ShortPatienten-Link
                              Comments

                              Bedingtes Pflichtfeld: Clients und Server sind verpflichtet, Dokumente stets mit einem Bezug zu einem Patienten zu versehen.
                              Leer bleiben darf dieses Element einzig im Kontext der Dokumentenbereitstellung in Verbindung mit der Patientenzuordnung über logische Referenzen, siehe {{pagelink:Dokumentenbereitstellung text:Interaktion:Dokumentenbereitstellung > Herstellung von Patienten- und Encounterkontext > Option 5}}

                              Die Verlinkung auf eine Patienten-Ressource dient der technischen Zuordnung der Dokumentation zu einem Patienten und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc. Im ISik Kontext MUSS die referenzierte Ressource konform zu ISiKPatient sein. Jenseits von ISiK KÖNNEN weitere Instanzen mit anderen Profilen referenziert werden.

                              Control0..1
                              This element is affected by the following invariants: ref-1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              134. DocumentReference.subject.type
                              Definition

                              The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                              The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                              ShortType the reference refers to (e.g. "Patient")
                              Comments

                              This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                              Control0..1
                              BindingUnless not suitable, these codes SHALL be taken from ResourceType
                              (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                              Aa resource (or, for logical models, the URI of the logical model).

                              Typeuri
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              136. DocumentReference.subject.identifier
                              Definition

                              An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                              ShortPatienten-Link (logische Referenz)
                              Comments

                              Bedingtes Must Support: Logische Referenzen KÖNNEN als Alternative zur Verlinkung über referencegenutzt werden. BITTE HINWEISE BEACHTEN: {{pagelink:Dokumentenbereitstellung text:Interaktion:Dokumentenbereitstellung > Herstellung von Patienten- und Encounterkontext > Option 5}}

                              NoteThis is a business identifier, not a resource identifier (see discussion)
                              Control0..1
                              TypeIdentifier
                              Is Modifierfalse
                              Must Supporttrue
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              138. DocumentReference.subject.identifier.id
                              Definition

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

                              ShortUnique id for inter-element referencing
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              140. DocumentReference.subject.identifier.extension
                              Definition

                              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.

                              ShortAdditional content defined by implementations
                              Comments

                              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
                              Summaryfalse
                              Alternate Namesextensions, 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())
                              SlicingThis element introduces a set of slices on DocumentReference.subject.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 142. DocumentReference.subject.identifier.use
                                Definition

                                The purpose of this identifier.

                                Shortusual | official | temp | secondary | old (If known)
                                Comments

                                Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                Control0..1
                                BindingThe codes SHALL be taken from IdentifierUse
                                (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                Identifies the purpose for this identifier, if known .

                                Typecode
                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                144. DocumentReference.subject.identifier.type
                                Definition

                                A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                ShortDescription of identifier
                                Comments

                                This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                Control0..1
                                BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                                A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                TypeCodeableConcept
                                Is Modifierfalse
                                Summarytrue
                                Requirements

                                Allows users to make use of identifiers when the identifier system is not known.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                146. DocumentReference.subject.identifier.system
                                Definition

                                Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                ShortThe namespace for the identifier value
                                Comments

                                Identifier.system is always case sensitive.

                                Control1..1
                                Typeuri
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summarytrue
                                Requirements

                                There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                ExampleGeneral: http://www.acme.com/identifiers/patient
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                148. DocumentReference.subject.identifier.value
                                Definition

                                The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                ShortThe value that is unique
                                Comments

                                If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                Control1..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summarytrue
                                ExampleGeneral: 123456
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                150. DocumentReference.subject.identifier.period
                                Definition

                                Time period during which identifier is/was valid for use.

                                ShortTime period when id is/was valid for use
                                Control0..1
                                TypePeriod
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                152. DocumentReference.subject.identifier.assigner
                                Definition

                                Organization that issued/manages the identifier.

                                ShortOrganization that issued id (may be just text)
                                Comments

                                The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                Control0..1
                                TypeReference(Organization)
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                154. DocumentReference.subject.display
                                Definition

                                Plain text narrative that identifies the resource in addition to the resource reference.

                                ShortText alternative for the resource
                                Comments

                                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                156. DocumentReference.date
                                Definition

                                When the document reference was created.

                                ShortWhen this document reference was created
                                Comments

                                Abweichend zu MHD V4.0.1 ist die Verwendung von date im ISiK-Kontext nicht verpflichtend. Die Motivation für die verbindliche Verwendung von date seitens IHE ist nicht nachvollziehbar. Ein entsprechender Change Request zur Harmonisierung wurde eingereicht. Das Dokumentendatum wird in attachment.creation gesetzt.

                                Update für Stufe 3: In MHD 4.2.0 wurde die Verpflichtung zur Angabe von date gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.

                                Control0..1
                                Typeinstant
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate Namesindexed
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                158. DocumentReference.author
                                Definition

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

                                ShortAutor des Dokumentes
                                Comments

                                In dieser Ausbaustufe ist die Nennung des Namens oder Kürzels des Autors ausreichend. Eine darüber hinaus gehende Verlinkung auf einen Practitioner (auflösbar auf dem Server) ist möglich aber nicht erforderlich.

                                Control0..*
                                TypeReference(Practitioner, PractitionerRole, Organization, Device, Patient, RelatedPerson)
                                Is Modifierfalse
                                Must Supporttrue
                                Must Support TypesNo must-support rules about the choice of types/profiles
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                160. DocumentReference.author.id
                                Definition

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

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                162. DocumentReference.author.extension
                                Definition

                                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.

                                ShortAdditional content defined by implementations
                                Comments

                                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
                                Summaryfalse
                                Alternate Namesextensions, 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())
                                SlicingThis element introduces a set of slices on DocumentReference.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 164. DocumentReference.author.reference
                                  Definition

                                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                  ShortLiteral reference, Relative, internal or absolute URL
                                  Comments

                                  Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                  Control0..1
                                  This element is affected by the following invariants: ref-1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  166. DocumentReference.author.type
                                  Definition

                                  The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                  The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                  ShortType the reference refers to (e.g. "Patient")
                                  Comments

                                  This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                  Control0..1
                                  BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                  (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                  Aa resource (or, for logical models, the URI of the logical model).

                                  Typeuri
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  168. DocumentReference.author.identifier
                                  Definition

                                  An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                  ShortLogical reference, when literal reference is not known
                                  Comments

                                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                  Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Control0..1
                                  TypeIdentifier
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  170. DocumentReference.author.display
                                  Definition

                                  Plain text narrative that identifies the resource in addition to the resource reference.

                                  ShortText alternative for the resource
                                  Comments

                                  This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  172. DocumentReference.authenticator
                                  Definition

                                  Which person or organization authenticates that this document is valid.

                                  ShortWho/what authenticated the document
                                  Comments

                                  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
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  174. DocumentReference.custodian
                                  Definition

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

                                  ShortOrganization which maintains the document
                                  Comments

                                  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
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  176. DocumentReference.relatesTo
                                  Definition

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

                                  ShortBeziehung zu anderen Dokumenten
                                  Comments

                                  Inbesondere relevant im Kontext von Updates. Bei inhaltlichen Updates MUSS eine replaces-Relation angegeben werden.

                                  Control0..*
                                  TypeBackboneElement
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  178. DocumentReference.relatesTo.id
                                  Definition

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

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  180. DocumentReference.relatesTo.extension
                                  Definition

                                  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.

                                  ShortAdditional content defined by implementations
                                  Comments

                                  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
                                  Summaryfalse
                                  Alternate Namesextensions, 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())
                                  182. DocumentReference.relatesTo.modifierExtension
                                  Definition

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

                                  ShortExtensions that cannot be ignored even if unrecognized
                                  Comments

                                  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 because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                  Summarytrue
                                  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.

                                  Alternate Namesextensions, 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())
                                  184. DocumentReference.relatesTo.code
                                  Definition

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

                                  Shortreplaces | transforms | signs | appends
                                  Comments

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

                                  Control1..1
                                  BindingThe codes SHALL be taken from DocumentRelationshipType
                                  (required to http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1)

                                  The type of relationship between documents.

                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  186. DocumentReference.relatesTo.target
                                  Definition

                                  The target document of this relationship.

                                  ShortTarget of the relationship
                                  Control1..1
                                  TypeReference(DocumentReference)
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  188. DocumentReference.description
                                  Definition

                                  Human-readable description of the source document.

                                  ShortHuman-readable description
                                  Comments

                                  Optionaler Freitext zur ergänzenden Beschreibung des Dokumentes. Die eigentliche menschenlesbare Bezeichnung des Dokuments zur Anzeige in Benutzeroberflächen sollte in 'content.attachment.title' angegeben werden.

                                  Update für Stufe 5: Ab dieser Stufe ist für die menschenlesbare Bezeichnung des Dokuments das Element content.attachment.title zu verwenden. Die bisherige Nutzung von DocumentReference.description entfällt zugunsten einer besseren Angleichung an MHD und die ePA-Spezifikation. Implementierungen sollten daher den Titel des Dokuments ausschließlich in content.attachment.title angeben.

                                  Das Element 'description' kann weiterhin verwendet werden, um inhaltliche Hinweise zum Dokument, eine knappe Zusammenfassung oder ergänzende Kommentare bereitzustellen.

                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  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()))
                                  190. DocumentReference.securityLabel
                                  Definition

                                  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.

                                  ShortVertraulichkeit
                                  Comments

                                  Die Bereitstellung der Vertraulichkeitsinformation durch den Ersteller des Dokumentes ist verpflichtend. Ebenso sind Dokumentenserver verpflichtet, diese Information zu persistieren und bei der Dokumentenabfrage zu reproduzieren. Die ISiK-Spezifikation trifft jedoch keine Annahmen darüber, wie sich einzelne Vertraulichkeitsstufen auf die Zugriffsberechtigungen verschiedener benutzer auf ein Dokument auswirken. Im ISiK-Kontext ist die Angabe einer der drei Vertraulichkeitsstufen N | R | V verpflichtend, jedoch ohne Einschränkung der Verwendung zusätzlicher Vertraulichkeits-Flags.

                                  [Konsens der Arbeitsgruppe vom 12.11.2021]

                                  Control1..*
                                  BindingThe codes SHALL be taken from ISiKConfidentialityCodes
                                  (required to https://gematik.de/fhir/isik/ValueSet/ISiKConfidentialityCodes)
                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Summarytrue
                                  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()))
                                  192. DocumentReference.content
                                  Definition

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

                                  ShortBeschreibung des Dokumenteninhaltes
                                  Comments

                                  Die Kardinalität wurde angepasst, um den Vorgaben von IHE MHD zu ensprechen [Änderung im Zuge der Kommentierung Stufe 3].

                                  Control1..1
                                  TypeBackboneElement
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  194. DocumentReference.content.id
                                  Definition

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

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  196. DocumentReference.content.extension
                                  Definition

                                  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.

                                  ShortAdditional content defined by implementations
                                  Comments

                                  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
                                  Summaryfalse
                                  Alternate Namesextensions, 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())
                                  198. DocumentReference.content.modifierExtension
                                  Definition

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

                                  ShortExtensions that cannot be ignored even if unrecognized
                                  Comments

                                  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 because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                  Summarytrue
                                  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.

                                  Alternate Namesextensions, 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())
                                  200. DocumentReference.content.attachment
                                  Definition

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

                                  ShortAnhang
                                  Control1..1
                                  TypeAttachment
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  202. DocumentReference.content.attachment.id
                                  Definition

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

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  204. DocumentReference.content.attachment.extension
                                  Definition

                                  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.

                                  ShortAdditional content defined by implementations
                                  Comments

                                  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
                                  Summaryfalse
                                  Alternate Namesextensions, 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())
                                  SlicingThis element introduces a set of slices on DocumentReference.content.attachment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 206. DocumentReference.content.attachment.contentType
                                    Definition

                                    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.

                                    ShortMimetype des Dokumentes
                                    Comments

                                    Mimetype (Dateityp) des Dokumentes (z.B. "application/pdf")

                                    Control1..1
                                    BindingThe codes SHALL be taken from Mime Types
                                    (required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

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

                                    Typecode
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

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

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

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

                                    ShortSprache, in der das Dokument verfasst wurde.
                                    Comments

                                    Kann bei Systemen, die keine Mehrsprachigkeit unterstützen, fest auf "de" oder "de-DE" gesetzt werden.

                                    Control1..1
                                    BindingThe codes SHOULD be taken from CommonLanguages
                                    (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                                    A human language.

                                    Additional BindingsPurpose
                                    AllLanguagesMax Binding
                                    Typecode
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

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

                                    ExampleGeneral: en-AU
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    210. DocumentReference.content.attachment.data
                                    Definition

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

                                    ShortBase64-codierte Binärdaten
                                    Comments

                                    Um die Suche nach Dokumenten effizient zu gestalten, dürfen die Dokumente selbst nicht in die DocumentReference eingebettet werden, sondern müssen als separates Datenobjekt referenziert werden.

                                    Update für Stufe 3: Die Ausnahme bildet die Interaktion "Dokumentenbereitstellung", bei der die Binärdaten des Dokumentes eingebettet in die DocumentReference an den Server übermittelt und dort dann in eine separate Ressource ausgelagert und über Attachment.url referenziert werden.

                                    Es ist zu beachten, dass diese base64-codierten Daten wiederum ein FHIR-Bundle (z.B. ein MIO oder ein ISiK Bericht aus einem Subsystem) repräsentieren können. Um eine einheitliche Handhabung der Dokumente für Clients zu ermöglichen werden diese trotz strukturiertem Inhalt per base64 abgebildet.

                                    Control0..1
                                    Typebase64Binary
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summaryfalse
                                    Requirements

                                    The data needs to able to be transmitted inline.

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

                                    A location where the data can be accessed.

                                    ShortReferenz auf Dokument
                                    Comments

                                    Um die Suche nach Dokumenten effizient zu gestalten, dürfen die Dokumente selbst nicht in die DocumentReference eingebettet werden, sondern müssen als separates Datenobjekt referenziert werden.

                                    Wird ein separates Datenobjekt im ISIK-Kontext referenziert, so MUSS dieses konform zum Profil ISIKBinary aus dem Basismodul sein.

                                    Update für Stufe 3: Die Ausnahme bildet die Interaktion "Dokumentenbereitstellung", bei der die Binärdaten des Dokumentes eingebettet in die DocumentReference an den Server übermittelt und dort dann in eine separate Ressource ausgelagert und über Attachment.url referenziert werden.

                                    Control0..1
                                    Typeurl
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

                                    The data needs to be transmitted by reference.

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

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

                                    ShortNumber of bytes of content (if url provided)
                                    Comments

                                    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.

                                    Control0..1
                                    TypeunsignedInt
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

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

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

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

                                    ShortHash of the data (sha-1, base64ed)
                                    Comments

                                    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.

                                    Control0..1
                                    Typebase64Binary
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

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

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

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

                                    ShortBezeichnung des Dokuments
                                    Comments

                                    Menschenlesbare Bezeichnung des Dokuments zur Anzeige in Benutzeroberflächen, z.B. als Titel in einer Dokumentenliste ('Lungenfunktionstest vom 18.02.2022').

                                    Update für Stufe 5: Ab dieser Stufe ist für die menschenlesbare Bezeichnung des Dokuments das Element content.attachment.title zu verwenden. Die bisherige Nutzung von DocumentReference.description entfällt zugunsten einer besseren Angleichung an MHD und die ePA-Spezifikation. Implementierungen sollten daher den Titel des Dokuments ausschließlich in content.attachment.title angeben.

                                    Control1..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

                                    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.

                                    ExampleGeneral: Official Corporate Logo
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    220. DocumentReference.content.attachment.creation
                                    Definition

                                    The date that the attachment was first created.

                                    ShortDokumentendatum
                                    Comments

                                    Es obliegt dem erzeugenden System, zu entscheiden, welches Datum als Dokumentendatum geeignet ist, z.B. Datum der Erstellung oder Datum der letzten Änderung

                                    Control1..1
                                    TypedateTime
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

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

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

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

                                    ShortFormat des Dokumentes
                                    Comments

                                    Sofern das Dokument nicht auf einem standardisierten, strukturierten Austauschformat (z.B. CDA) basiert, für dessen Interpretation ein konkretes Schema herangezogen werden muss, genügt die Angabe des Codes "urn:ihe:iti:xds:2017:mimeTypeSufficient"

                                    Control1..1
                                    BindingThe codes SHALL be taken from IHE XDS formatCode
                                    (required to http://ihe-d.de/ValueSets/IHEXDSformatCodeDE)
                                    TypeCoding
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    224. DocumentReference.context
                                    Definition

                                    The clinical context in which the document was prepared.

                                    ShortKontextinformationen zum Dokument
                                    Comments

                                    Begründung Must Support: Kontextinformationen sind erforderlich, um die Relevanz und den Bezug des Dokuments zu verstehen.

                                    Control1..1
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    226. DocumentReference.context.id
                                    Definition

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

                                    ShortUnique id for inter-element referencing
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    228. DocumentReference.context.extension
                                    Definition

                                    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.

                                    ShortAdditional content defined by implementations
                                    Comments

                                    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
                                    Summaryfalse
                                    Alternate Namesextensions, 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())
                                    230. DocumentReference.context.modifierExtension
                                    Definition

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

                                    ShortExtensions that cannot be ignored even if unrecognized
                                    Comments

                                    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 because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                    Summarytrue
                                    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.

                                    Alternate Namesextensions, 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())
                                    232. DocumentReference.context.encounter
                                    Definition

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

                                    ShortAufenthaltsbezug
                                    Comments

                                    Hinweis Kompatibilität: In MHD 4.2.0 wurde das Verbot der Angabe einer Encounter-Referenz gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.

                                    Control0..1
                                    TypeReference(Encounter, EpisodeOfCare)
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Must Support TypesNo must-support rules about the choice of types/profiles
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    234. DocumentReference.context.encounter.id
                                    Definition

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

                                    ShortUnique id for inter-element referencing
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    236. DocumentReference.context.encounter.extension
                                    Definition

                                    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.

                                    ShortAdditional content defined by implementations
                                    Comments

                                    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
                                    Summaryfalse
                                    Alternate Namesextensions, 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())
                                    SlicingThis element introduces a set of slices on DocumentReference.context.encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 238. DocumentReference.context.encounter.reference
                                      Definition

                                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                      ShortEncounter-Link
                                      Comments

                                      Begründung Pflichtfeld: Die Verlinkung auf eine Encounter-Ressource dient der technischen Zuordnung der Dokumentation zu einem Aufenthalt und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc. Im ISik Kontext MUSS die referenzierte Ressource konform zu ISiKKontaktGesundheitseinrichtung sein. Jenseits von ISiK KÖNNEN weitere Instanzen mit anderen Profilen referenziert werden.

                                      Control1..1
                                      This element is affected by the following invariants: ref-1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      240. DocumentReference.context.encounter.type
                                      Definition

                                      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                      ShortType the reference refers to (e.g. "Patient")
                                      Comments

                                      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                      Control0..1
                                      BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                      (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                      Aa resource (or, for logical models, the URI of the logical model).

                                      Typeuri
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      242. DocumentReference.context.encounter.identifier
                                      Definition

                                      An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                      ShortLogical reference, when literal reference is not known
                                      Comments

                                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                      Control0..1
                                      TypeIdentifier
                                      Is Modifierfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      244. DocumentReference.context.encounter.display
                                      Definition

                                      Plain text narrative that identifies the resource in addition to the resource reference.

                                      ShortText alternative for the resource
                                      Comments

                                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      246. DocumentReference.context.event
                                      Definition

                                      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.

                                      ShortMain clinical acts documented
                                      Comments

                                      Binding auf IHE-DE Terminologie hinzugefügt

                                      Control0..*
                                      BindingThe codes SHALL be taken from IHE XDS eventCodeList
                                      (required to http://ihe-d.de/ValueSets/IHEXDSeventCodeList)
                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      248. DocumentReference.context.event.id
                                      Definition

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

                                      ShortUnique id for inter-element referencing
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      250. DocumentReference.context.event.extension
                                      Definition

                                      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.

                                      ShortAdditional content defined by implementations
                                      Comments

                                      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
                                      Summaryfalse
                                      Alternate Namesextensions, 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())
                                      SlicingThis element introduces a set of slices on DocumentReference.context.event.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 252. DocumentReference.context.event.coding
                                        Definition

                                        A reference to a code defined by a terminology system.

                                        ShortCode defined by a terminology system
                                        Comments

                                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                        Control1..1
                                        TypeCoding
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        Allows for alternative encodings within a code system, and translations to other code systems.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        254. DocumentReference.context.event.coding.id
                                        Definition

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

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        256. DocumentReference.context.event.coding.extension
                                        Definition

                                        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.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        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
                                        Summaryfalse
                                        Alternate Namesextensions, 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())
                                        SlicingThis element introduces a set of slices on DocumentReference.context.event.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 258. DocumentReference.context.event.coding.system
                                          Definition

                                          The identification of the code system that defines the meaning of the symbol in the code.

                                          ShortIdentity of the terminology system
                                          Comments

                                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                          Control1..1
                                          Typeuri
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          Need to be unambiguous about the source of the definition of the symbol.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          260. DocumentReference.context.event.coding.version
                                          Definition

                                          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                          ShortVersion of the system - if relevant
                                          Comments

                                          Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                          NoteThis is a business version Id, not a resource version Id (see discussion)
                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          262. DocumentReference.context.event.coding.code
                                          Definition

                                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                          ShortSymbol in syntax defined by the system
                                          Control1..1
                                          Typecode
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          Need to refer to a particular code in the system.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          264. DocumentReference.context.event.coding.display
                                          Definition

                                          A representation of the meaning of the code in the system, following the rules of the system.

                                          ShortRepresentation defined by the system
                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          266. DocumentReference.context.event.coding.userSelected
                                          Definition

                                          Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                          ShortIf this coding was chosen directly by the user
                                          Comments

                                          Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                          Control0..1
                                          Typeboolean
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          268. DocumentReference.context.event.text
                                          Definition

                                          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                          ShortPlain text representation of the concept
                                          Comments

                                          Very often the text is the same as a displayName of one of the codings.

                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          270. DocumentReference.context.period
                                          Definition

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

                                          ShortTime of service that is being documented
                                          Control0..1
                                          TypePeriod
                                          Is Modifierfalse
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          272. DocumentReference.context.facilityType
                                          Definition

                                          The kind of facility where the patient was seen.

                                          ShortArt der Einrichtung, aus der das Dokument stammt
                                          Comments

                                          Kann, sofern keine abweichende Information bekannt ist auf "KHS" gesetzt werden.

                                          Control1..1
                                          BindingThe codes SHALL be taken from IHE XDS healthcareFacilityTypeCode
                                          (required to http://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode)
                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          274. DocumentReference.context.practiceSetting
                                          Definition

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

                                          ShortAdditional details about where the content was created (e.g. clinical specialty)
                                          Comments

                                          Binding auf IHE-DE Terminologie hinzugefügt

                                          Control1..1
                                          BindingThe codes SHALL be taken from IHE XDS practiceSettingCode
                                          (required to http://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode)
                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summaryfalse
                                          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()))
                                          276. DocumentReference.context.sourcePatientInfo
                                          Definition

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

                                          ShortPatient demographics from source
                                          Control0..1
                                          TypeReference(Patient)
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          278. DocumentReference.context.related
                                          Definition

                                          Related identifiers or resources associated with the DocumentReference.

                                          ShortRelated identifiers or resources
                                          Comments

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

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