Leitfaden Basis DE (STU3)

There are no (further) constraints on this element

Element id

Coverage.implicitRules

Short description

A set of rules under which this content was created

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.

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Coverage.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

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

Data type

Binding

A human language.

Common Languages (extensible)

Binding extensions

maxValueSet	All Languages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

Coverage.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource, and may 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.

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 in formation is added later.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, dom-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

Coverage.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

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.

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.

Data type

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Element id

Coverage.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order 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.

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.

Data type

http://fhir.de/StructureDefinition/gkv/einlesedatum-karte/0.2

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

einlesedatum-karte

0..*

Extension(dateTime)

Element id

Coverage.extension:einlesedatum-karte

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(dateTime)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

generation-egk

0..1

Element id

Coverage.extension:generation-egk

Short description

eGK Generation ( 1 | 1+ | 2 )

Alternate names

extensions, user content

Definition

Angabe der Generation der Versichertenkarte

Comments

Data type

http://fhir.de/StructureDefinition/gkv/generation-egk/0.2

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

version-egk

0..*

Element id

Coverage.extension:version-egk

Short description

eGK Version (z.B. 5.2.0)

Alternate names

extensions, user content

Definition

Extension zur Erfassung der Version des VSDM-Datensatzes auf der eGK

Comments

Data type

http://fhir.de/StructureDefinition/gkv/version-egk/0.2

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

gkv-zusatzinfo-geschuetzt

0..1

Extension(Complex)

Element id

Coverage.extension:gkv-zusatzinfo-geschuetzt

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Complex)

Extension URL

http://fhir.de/StructureDefinition/gkv/zusatzinfos-geschuetzt/0.2

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

gkv-zusatzinfos-allgemein

0..1

Extension(Complex)

Element id

Coverage.extension:gkv-zusatzinfos-allgemein

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Complex)

Extension URL

http://fhir.de/StructureDefinition/gkv/zusatzinfos-allgemein/0.2

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

gkv-onlinepruefung-egk

0..*

Extension(Complex)

Element id

Coverage.extension:gkv-onlinepruefung-egk

Short description

Informationen zur Onlineprüfung und -aktualisierung

Alternate names

extensions, user content

Definition

Informationen zur Onlineprüfung und -aktualisierung

Comments

Data type

Extension(Complex)

Extension URL

http://fhir.de/StructureDefinition/gkv/onlinepruefung-egk/0.2

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Coverage.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

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. Usually modifier elements provide negation or qualification. In order 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.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

1..*

Element id

Coverage.identifier

Short description

Primärer Identifier der Versicherung

Definition

Ein gesetzliches Versicherungsverhältnis sollte stets durch die eindeutige 30-stellige Versichertennummer identifiziert werden. Ist diese nicht bekannt, so wird die 10-stellige VersichertenID statt dessen verwendet.

Requirements

This value may uniquely identify the coverage or it may be used in conjunction with the additional identifiers below.

Comments

TODO: Constraint, der prüft, dass mindestens entweder eine VersichertenID oder eine Krankenversichertennummer angegeben wurde.

Data type

Slicing

Unordered, Open, by system(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Event.identifier
cdanetv4: C02
v2: IN1-2
cpha3pharm: C.32, C.33, C.39
w5: id

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Coverage.identifier.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Coverage.identifier.use

Short description

usual | official | temp | secondary (If known)

Definition

The purpose of this identifier.

Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Coverage.identifier.type

Short description

Description of identifier

Definition

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

Requirements

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

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.

Data type

Binding

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

Mappings

v2: CX.5
rim: Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier.system

Short description

The namespace for the identifier value

Definition

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

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.

Data type

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier.value

Short description

The value that is unique

Definition

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

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.

Data type

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Data type

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

VersichertenID

0..1

Element id

Coverage.identifier:VersichertenID

Short description

Versicherten-ID

Definition

Die Versicherten-ID ist der 10-stellige unveränderliche Teil der 30-stelligen Krankenversichertennummer. Sie wird häufig ebenfalls als Krankenversichertennummer bezeichnet. Der Term 'Versicherten-ID' wird hier in Übereinstimmung mit der Gematik-Spezifikation für das VSDM verwendet.

Requirements

This value may uniquely identify the coverage or it may be used in conjunction with the additional identifiers below.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Event.identifier
cdanetv4: C02
v2: IN1-2
cpha3pharm: C.32, C.33, C.39
w5: id
KHEntgG: Krankenversichertennummer (Versicherten –ID)

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier:VersichertenID.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Coverage.identifier:VersichertenID.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Coverage.identifier:VersichertenID.use

Short description

usual | official | temp | secondary (If known)

Definition

The purpose of this identifier.

Requirements

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

Comments

Data type

Binding

Identifies the purpose for this identifier, if known .

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Coverage.identifier:VersichertenID.type

Short description

Description of identifier

Definition

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

Requirements

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

Comments

Data type

Binding

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

Mappings

v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

Element id

Coverage.identifier:VersichertenID.system

Short description

The namespace for the identifier value

Definition

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

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.

Data type

Fixed value

http://fhir.de/NamingSystem/gkv/kvid-10

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

There are no (further) constraints on this element

Element id

Coverage.identifier:VersichertenID.value

Short description

The value that is unique

Definition

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

Comments

Data type

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier:VersichertenID.period

Short description

Time period when id is/was valid for use

Definition

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

Data type

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier:VersichertenID.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

Krankenversichertennummer

0..1

Element id

Coverage.identifier:Krankenversichertennummer

Short description

Krankenversichertennummer

Definition

Die vollständige, bis zu 30-stellige Krankenversichertennummer.

Requirements

This value may uniquely identify the coverage or it may be used in conjunction with the additional identifiers below.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Event.identifier
cdanetv4: C02
v2: IN1-2
cpha3pharm: C.32, C.33, C.39
w5: id

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier:Krankenversichertennummer.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Coverage.identifier:Krankenversichertennummer.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Coverage.identifier:Krankenversichertennummer.use

Short description

usual | official | temp | secondary (If known)

Definition

The purpose of this identifier.

Requirements

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

Comments

Data type

Binding

Identifies the purpose for this identifier, if known .

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Coverage.identifier:Krankenversichertennummer.type

Short description

Description of identifier

Definition

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

Requirements

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

Comments

Data type

Binding

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

Mappings

v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

Element id

Coverage.identifier:Krankenversichertennummer.system

Short description

The namespace for the identifier value

Definition

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

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.

Data type

Fixed value

http://fhir.de/NamingSystem/gkv/kvnr-30

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

There are no (further) constraints on this element

Element id

Coverage.identifier:Krankenversichertennummer.value

Short description

The value that is unique

Definition

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

Comments

Data type

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier:Krankenversichertennummer.period

Short description

Time period when id is/was valid for use

Definition

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

Data type

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier:Krankenversichertennummer.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

PseudoVersichertenID

0..1

Element id

Coverage.identifier:PseudoVersichertenID

Short description

pseudonymisierte VersichertenID

Definition

Wird für Registermeldungen verwendet

Requirements

This value may uniquely identify the coverage or it may be used in conjunction with the additional identifiers below.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Event.identifier
cdanetv4: C02
v2: IN1-2
cpha3pharm: C.32, C.33, C.39
w5: id

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier:PseudoVersichertenID.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Coverage.identifier:PseudoVersichertenID.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Coverage.identifier:PseudoVersichertenID.use

Short description

usual | official | temp | secondary (If known)

Definition

The purpose of this identifier.

Requirements

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

Comments

Data type

Binding

Identifies the purpose for this identifier, if known .

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Coverage.identifier:PseudoVersichertenID.type

Short description

Description of identifier

Definition

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

Requirements

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

Comments

Data type

Binding

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

Mappings

v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

Element id

Coverage.identifier:PseudoVersichertenID.system

Short description

The namespace for the identifier value

Definition

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

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.

Data type

Fixed value

http://fhir.de/NamingSystem/gkv/pseudo-kvid

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

There are no (further) constraints on this element

Element id

Coverage.identifier:PseudoVersichertenID.value

Short description

The value that is unique

Definition

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

Comments

Data type

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier:PseudoVersichertenID.period

Short description

Time period when id is/was valid for use

Definition

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

Data type

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Coverage.identifier:PseudoVersichertenID.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

status

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

Coverage.status

Short description

active | cancelled | draft | entered-in-error

Definition

The status of the resource instance.

Comments

This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

Data type

Financial Resource Status Codes (required)

Binding

A code specifying the state of the resource instance.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.status
w5: status

type

1..1

CodeableConceptBinding

Element id

Coverage.type

Short description

Versicherungsart

Definition

Art der Versicherung: Selbstzahler, gesetzliche/private Versicherung, Berufsgenossenschaft oder Sozialamt

Requirements

The order of application of coverages is dependent on the types of coverage.

Comments

28.07.2017 (zulip): TC Konsens bzgl. Verwendung eines eigenen ValueSets anstelle des im Standrad definierten preferred bindings, da die dortigen Codes nicht passen.

Data type

versicherungsart-de-basis (required)

Binding

Art der Versicherung: Selbstzahler, gesetzliche/private Versicherung, Berufsgenossenschaft oder Sozialamt

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: IN1-15
w5: class

0..1

There are no (further) constraints on this element

Element id

Coverage.type.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Coverage.type.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

coding

0..*

Coding

There are no (further) constraints on this element

Element id

Coverage.type.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

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.

Data type

Coding

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Coverage.type.coding.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Coverage.type.coding.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

system

0..1

uriFixed Value

Element id

Coverage.type.coding.system

Short description

Identity of the terminology system

Definition

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

Requirements

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

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 de-reference to some definition that establish the system clearly and unambiguously.

Data type

Fixed value

http://fhir.de/CodeSystem/versicherungsart-de-basis

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Coverage.type.coding.version

Short description

Version of the system - if relevant

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.

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.

Data type

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

codeFixed Value

Element id

Coverage.type.coding.code

Short description

Symbol in syntax defined by the system

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

Requirements

Need to refer to a particular code in the system.

Data type

Fixed value

GKV

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Coverage.type.coding.display

Short description

Representation defined by the system

Definition

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

Requirements

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

Data type

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Coverage.type.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

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

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.

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.

Data type

boolean

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

Coverage.type.text

Short description

Plain text representation of the concept

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.

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.

Comments

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

Data type

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

policyHolder

Σ C

0..0

Reference(Patient | RelatedPerson | Organization)

There are no (further) constraints on this element

Element id

Coverage.policyHolder

Short description

Owner of the policy

Definition

The party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer.

Comments

Es gibt derzeit in DE keine Verwendung für dieses Attribut (Konsens Interop-Forum 12.6.2017) Falls es UseCases gibt, die dieses Attribut benötigen, bitte Info auf chat.fhir.org

Data type

Reference(Patient | RelatedPerson | Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cdanetv4: D01 through D09
v2: IN1-16, 18, 19-name of insured, address, date of birth
cpha3pharm: C.35
w5: who.focus

subscriber

Σ C

0..1

There are no (further) constraints on this element

Element id

Coverage.subscriber

Short description

Hauptversicherte Person / Mitglied

Definition

Hauptversicherte Person (ggf. abweichend von beneficiary), z.B. bei Familienversicherung

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cdanetv4: D01 through D09
v2: IN1-16, 18, 19-name of insured, address, date of birth
cpha3pharm: C.35
w5: who.focus

0..1

There are no (further) constraints on this element

Element id

Coverage.subscriber.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Coverage.subscriber.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Coverage.subscriber.reference

Short description

Literal reference, Relative, internal or absolute URL

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.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Mappings

rim: N/A

identifier

0..1

IdentifierPattern

Element id

Coverage.subscriber.identifier

Short description

VersichertenID (10-stellig) des Hauptversicherten

Definition

An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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.

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.

Data type

Pattern

{
  "system": "http://fhir.de/NamingSystem/gkv/kvid-10"
}

Mappings

rim: .identifier

display

0..1

Element id

Coverage.subscriber.display

Short description

Name des Hauptversicherten

Definition

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

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.

Data type

Mappings

rim: N/A

subscriberId

0..0

There are no (further) constraints on this element

Element id

Coverage.subscriberId

Short description

ID assigned to the Subscriber

Definition

The insurer assigned ID for the Subscriber.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Reference(Patient, deutsches Basisprofil (Version 0.2))

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
cdanetv4: D01 through D09
v2: IN1-16, 18, 19-name of insured, address, date of birth
cpha3pharm: C.35
w5: who.focus

beneficiary

Σ C

1..1

Element id

Coverage.beneficiary

Short description

Begünstigte Person

Definition

Person, auf die sich die Kostenübernahme bezieht (der Patient)

Comments

Die Angabe der 10-stelligen Krankenversichertennummer ist verpflichtend. Durch die Referenz auf eine Patient-Resource können weitere Informationen zum Patienten hinterlegt werden.

Data type

Reference(Patient, deutsches Basisprofil (Version 0.2))

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.subject
cdanetv4: D01 through D09
v2: IN1-16, 18, 19-name of insured, address, date of birth
cpha3pharm: C.35
w5: who.focus

0..1

There are no (further) constraints on this element

Element id

Coverage.beneficiary.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Coverage.beneficiary.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Coverage.beneficiary.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Mappings

rim: N/A

identifier

0..1

IdentifierPattern

Element id

Coverage.beneficiary.identifier

Short description

Identifier der versicherten Person

Definition

Comments

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

Data type

Pattern

{
  "system": "http://fhir.de/NamingSystem/gkv/kvid-10"
}

Mappings

rim: .identifier

display

0..1

Element id

Coverage.beneficiary.display

Short description

Name der Versicherten Person

Definition

Die Angabe des Namens des Versicherten dient der geeigenten Darstellung für den Benutzer und hat keine technische Bedeutung.

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.

Data type

Mappings

rim: N/A

relationship

0..1

There are no (further) constraints on this element

Element id

Coverage.relationship

Short description

Beneficiary relationship to the Subscriber

Definition

The relationship of beneficiary (patient) to the subscriber.

Requirements

To determine relationship between the patient and the subscriber.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data type

Policyholder Relationship Codes (example)

Binding

The relationship between the Policyholder and the Beneficiary (insured/covered party/patient).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
cdanetv4: C03

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Coverage.period

Short description

Coverage start and end dates

Definition

Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.

Comments

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
workflow: Event.occurrence
v2: IN1-12 / IN1-13
w5: when.done

0..1

There are no (further) constraints on this element

Element id

Coverage.period.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Coverage.period.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

start

Σ C

0..1

Element id

Coverage.period.start

Short description

Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Mappings

v2: DR.1
rim: ./low
KVDT: 4133

end

Σ C

0..1

Element id

Coverage.period.end

Short description

End time with inclusive boundary, if not ongoing

Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

Reference(organization-de-basis)

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Mappings

v2: DR.2
rim: ./high
KVDT: 4110

payor

Σ C

1..2

Element id

Coverage.payor

Short description

Versicherer

Definition

Gibt den Kostenträger des Versicherten an. Die Angabe der IK-Nummer als logische Referenz sowie des Namend als Display ist zwingend erforderlich. Die Referenz auf eine Resource vom Typ Organization, die weitere Details zur Versicherung enthalten kann (z.B. Adresse, Kontaktdaten) ist optional. Sofern eine zweite Referenz auf einen Kostenträger existiert, so handelt es sich hierbei um den abrechnenden Kostenträger

Requirements

Need to identify the issuer to target for processing and for coordination of benefit processing.

Comments

Die Angabe der IK-Nummer des Versicherers in payor.identifier ist verpflichtend. Weitere Angaben zum Versicherer (Name, Adresse) können in einer Organization-Resource hinterlegt werden, auf die hier referenziert wird.

Data type

Reference(organization-de-basis)

Slicing

Ordered, Closed, by

1. Kostenträger 2. Abrechnender Kostenträger

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cdanetv4: A05
v2: IN1-3
cpha3pharm: C.30
w5: who.author

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Coverage.payor.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Coverage.payor.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Coverage.payor.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Mappings

rim: N/A

identifier

1..1

IdentifierFixed Value

Element id

Coverage.payor.identifier

Short description

IK-Nummer des Versicherers

Definition

Die Angabe der IK-Nummer des Versicherers ist verpflichtend.

Comments

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

Data type

Fixed value

{
  "system": "http://fhir.de/NamingSystem/arge-ik/iknr"
}

Mappings

rim: .identifier
KVDT: 4111 Gibt den Kostenträger des Versicherten an. Die Angabe der IK-Nummer als logische Referenz sowie des Namend als Display ist zwingend erforderlich.

display

1..1

Element id

Coverage.payor.display

Short description

Name des Versicherers

Definition

Die Angabe des Namens des Versicherers dient der geeigenten Darstellung für den Benutzer. Technisch ist ausschließlich die IK-Nummer relevant

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.

Data type

Reference(Organisation, deutsches Basisprofil (Version 0.2))

Mappings

rim: N/A
KVDT: 4134 (abrechnender Kostenträger = 1. Priorität)

Kostentraeger

Σ C

1..1

Element id

Coverage.payor:Kostentraeger

Short description

Versicherer

Definition

Requirements

Need to identify the issuer to target for processing and for coordination of benefit processing.

Comments

Data type

Reference(Organisation, deutsches Basisprofil (Version 0.2))

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cdanetv4: A05
v2: IN1-3
cpha3pharm: C.30
w5: who.author

0..1

There are no (further) constraints on this element

Element id

Coverage.payor:Kostentraeger.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Coverage.payor:Kostentraeger.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Coverage.payor:Kostentraeger.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Mappings

rim: N/A

identifier

1..1

IdentifierFixed ValuePattern

Element id

Coverage.payor:Kostentraeger.identifier

Short description

IK-Nummer des Versicherers

Definition

Die Angabe der IK-Nummer des Versicherers ist verpflichtend.

Comments

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

Data type

Fixed value

{
  "system": "http://fhir.de/NamingSystem/arge-ik/iknr"
}

Pattern

{
  "system": "http://fhir.de/NamingSystem/arge-ik/iknr"
}

Mappings

rim: .identifier
KVDT: 4111
KHEntgG: Institutionskennzeichen der Krankenkasse
KVDT: 4111 Gibt den Kostenträger des Versicherten an. Die Angabe der IK-Nummer als logische Referenz sowie des Namend als Display ist zwingend erforderlich.

display

1..1

Element id

Coverage.payor:Kostentraeger.display

Short description

Name des Versicherers

Definition

Die Angabe des Namens des Versicherers dient der geeigenten Darstellung für den Benutzer. Technisch ist ausschließlich die IK-Nummer relevant

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.

Data type

Reference(Organisation, deutsches Basisprofil (Version 0.2))

Mappings

rim: N/A
KVDT: 4134
KVDT: 4134 (abrechnender Kostenträger = 1. Priorität)

abrechnenderKostentraeger

Σ C

0..1

Element id

Coverage.payor:abrechnenderKostentraeger

Short description

Versicherer

Definition

Versicherer, der die Police ausgegeben hat oder Persopn/Organisation, die die Kosten übernimmt.

Requirements

Need to identify the issuer to target for processing and for coordination of benefit processing.

Comments

Data type

Reference(Organisation, deutsches Basisprofil (Version 0.2))

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cdanetv4: A05
v2: IN1-3
cpha3pharm: C.30
w5: who.author

0..1

There are no (further) constraints on this element

Element id

Coverage.payor:abrechnenderKostentraeger.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Coverage.payor:abrechnenderKostentraeger.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Coverage.payor:abrechnenderKostentraeger.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Mappings

rim: N/A

identifier

1..1

IdentifierFixed ValuePattern

Element id

Coverage.payor:abrechnenderKostentraeger.identifier

Short description

IK-Nummer des abrechnenden Kostenträgers

Definition

Die Angabe der IK-Nummer des abrechnenden Kostenträgers ist verpflichtend.

Comments

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

Data type

Fixed value

{
  "system": "http://fhir.de/NamingSystem/arge-ik/iknr"
}

Pattern

{
  "system": "http://fhir.de/NamingSystem/arge-ik/iknr"
}

Mappings

rim: .identifier
KVDT: 4111
KVDT: 4111 Gibt den Kostenträger des Versicherten an. Die Angabe der IK-Nummer als logische Referenz sowie des Namend als Display ist zwingend erforderlich.

display

1..1

Element id

Coverage.payor:abrechnenderKostentraeger.display

Short description

Name des Versicherers

Definition

Die Angabe des Namens des Versicherers dient der geeigenten Darstellung für den Benutzer. Technisch ist ausschließlich die IK-Nummer relevant

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.

Data type

Mappings

rim: N/A
KVDT: 4134
KVDT: 4134 (abrechnender Kostenträger = 1. Priorität)

grouping

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Coverage.grouping

Short description

Additional coverage classifications

Definition

A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan.

Comments

Es gibt derzeit in DE keine Verwendung für dieses Attribut (Konsens Interop-Forum 12.6.2017) Falls es UseCases gibt, die dieses Attribut benötigen, bitte Info auf chat.fhir.org

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

dependent

0..0

There are no (further) constraints on this element

Element id

Coverage.dependent

Short description

Dependent number

Definition

Identifikation einer unter dieser Police versicherten Partei Bsp: eine Familie ist mit der Police mit dem Identifier "12345" versichert Vater 12345a Mutter 12345b Kind 12345c a, b und c wären dann jeweils die "dependents"

Requirements

For some coverage a single identifier is issued to the Subscriber and a dependent number issued to each beneficiary.

Comments

Es gibt derzeit in DE keine Verwendung für dieses Attribut (Konsens Interop-Forum 12.6.2017) Falls es UseCases gibt, die dieses Attribut benötigen, bitte Info auf chat.fhir.org

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
cdanetv4: C17
v2: - No exact HL7 v2 equivalent concept seems to exist;

sequence

0..0

There are no (further) constraints on this element

Element id

Coverage.sequence

Short description

The plan instance or sequence counter

Definition

An optional counter for a particular instance of the identified coverage which increments upon each renewal.

Requirements

Some coverage, for example social plans, may be offered in short time increments, for example for a week or a month at a time, so while the rest of the plan details and identifiers may remain constant over time, the instance is incremented with each renewal and provided to the covered party on their 'card'.

Comments

Es gibt derzeit in DE keine Verwendung für dieses Attribut (Konsens Interop-Forum 12.6.2017) Falls es UseCases gibt, die dieses Attribut benötigen, bitte Info auf chat.fhir.org

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
cdanetv4: D11
v2: No HL7 v2 equivalent concept seems to exist

order

0..0

positiveInt

There are no (further) constraints on this element

Element id

Coverage.order

Short description

Relative order of the coverage

Definition

The order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.

Comments

Es git derzeit in DE keine Verwendung für dieses Attribut (Konsens Interop-Forum 12.6.2017) Für die Priorisierung der Versicherungsverhältnisse sollte statt dessen Account.coverage.priority verwendet werden, da die Priorisierung abhängig von Fall- und Abrechnungsart unterschiedlich sein kann. Falls es UseCases gibt, die dieses Attribut benötigen, bitte Info auf chat.fhir.org

Data type

positiveInt

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: - No exact HL7 v2 equivalent concept seems to exist;

network

0..0

There are no (further) constraints on this element

Element id

Coverage.network

Short description

Insurer network

Definition

Die Versicherungsleistungen sind an ein bestimmtes Netzwerk von Gesundheitsdienstleistern gebunden

Comments

Es gibt derzeit in DE keine Verwendung für dieses Attribut (Konsens Interop-Forum 12.6.2017) Falls es UseCases gibt, die dieses Attribut benötigen, bitte Info auf chat.fhir.org

Data type