Implementierungsleitfaden DGUV-Basisprofile

There are no (further) constraints on this element

Element id

Patient.id

Short description

Logical id of this artifact

Definition

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

Comments

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

Data type

Meta

Constraints

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

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Patient.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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.

Data type

Constraints

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

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

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

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

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

text

0..1

Narrative

Element id

Patient.text

Short description

Textzusammenfassung der Ressource

Alternate names

narrative, html, xhtml, display

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.

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.

Data type

Narrative

Constraints

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

Mappings

rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

Patient.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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings

rim: N/A

extension

0..*

Element id

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

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://hl7.org/fhir/StructureDefinition/patient-nationality

Slicing

Unordered, Open, by url(Value)

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

nationality

0..*

Extension(Complex)

Element id

Patient.extension:nationality

Short description

Staatsbürgerschaft

Alternate names

extensions, user content

Definition

Staatsbürgerschaft der Person, rechtlichen Zugehörigkeit zur Gemeinschaft (Rechtsgemeinschaft) von Bürgern eines Staates

Comments

Data type

Extension(Complex)

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

0..1

There are no (further) constraints on this element

Element id

Patient.extension:nationality.id

Short description

Unique id for inter-element referencing

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

Patient.extension:nationality.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. 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.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

code

0..1

There are no (further) constraints on this element

Element id

Patient.extension:nationality.extension:code

Short description

Nationality Code

Definition

Code representing nationality of patient.

Data type

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

0..1

There are no (further) constraints on this element

Element id

Patient.extension:nationality.extension:code.id

Short description

Unique id for inter-element referencing

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

There are no (further) constraints on this element

Element id

Patient.extension:nationality.extension:code.extension

Short description

Extension

Definition

An Extension

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Patient.extension:nationality.extension:code.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Data type

Fixed value

code

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Patient.extension:nationality.extension:code.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

valueCodeableConcept

There are no (further) constraints on this element

Data type

0..1

There are no (further) constraints on this element

Element id

Patient.extension:nationality.extension:code.value[x].id

Short description

Unique id for inter-element referencing

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

Patient.extension:nationality.extension:code.value[x].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

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

coding

0..*

CodingBinding

Element id

Patient.extension:nationality.extension:code.value[x].coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

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

Binding

Iso3166-1-2 (required)

Constraints

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

Mappings

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

text

0..1

There are no (further) constraints on this element

Element id

Patient.extension:nationality.extension:code.value[x].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

Constraints

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

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

period

0..1

There are no (further) constraints on this element

Element id

Patient.extension:nationality.extension:period

Short description

Nationality Period

Definition

Period when nationality was effective.

Data type

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

0..1

There are no (further) constraints on this element

Element id

Patient.extension:nationality.extension:period.id

Short description

Unique id for inter-element referencing

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

There are no (further) constraints on this element

Element id

Patient.extension:nationality.extension:period.extension

Short description

Extension

Definition

An Extension

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Patient.extension:nationality.extension:period.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Fixed value

period

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Patient.extension:nationality.extension:period.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

valuePeriod

There are no (further) constraints on this element

Data type

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Patient.extension:nationality.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Fixed value

http://hl7.org/fhir/StructureDefinition/patient-nationality

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Patient.extension:nationality.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

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

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.

Comments

Data type

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

identifier

0..*

Identifier

Element id

Patient.identifier

Short description

Identifikator für den Patienten

Definition

Identifikator für den Patienten.

Requirements

Patients are almost always assigned specific numerical identifiers.

Data type

Identifier

Slicing

Unordered, Open, by $this(Pattern)

Constraints

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

Mappings

w5: FiveWs.identifier
v2: PID-3
rim: id
cda: .id

VersichertenId

0..*

IdentifierKvid10Pattern

Element id

Patient.identifier:VersichertenId

Short description

Lebenslange Krankenversichertennummer

Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Requirements

Patients are almost always assigned specific numerical identifiers.

Comments

Die als 'KVZ10' kodierte Versichertennummer ist der 10-stellige, unveränderbare Teil der Versichertennummer, der lesbar auf die Elektronische Gesundheitskarte aufgedruckt ist. Er gilt für alle Krankenversichertennummern, unabhängig davon, ob es sich um GKV, PKV oder Sonderkostenträger handelt.

Data type

IdentifierKvid10

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

Pattern

{
  "type": {
    "coding": [
      {
        "system": "http://fhir.de/CodeSystem/identifier-type-de-basis",
        "code": "KVZ10"
      }
    ]
  }
}

Mappings

w5: FiveWs.identifier
v2: PID-3
rim: id
cda: .id
rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - 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

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenId.id

Short description

Unique id for inter-element referencing

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

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

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

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenId.use

Short description

usual | official | temp | secondary | old (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

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 .

Constraints

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

Mappings

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

type

1..1

CodeableConceptBindingPattern

Element id

Patient.identifier:VersichertenId.type

Short description

Art des Identifiers

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

Hier ist stets der Code KVZ10 aus dem CodeSystem http://fhir.de/CodeSystem/identifier-type-de-basis anzugeben. Begründung Pflichtfeld: type dient der Unterscheidung verschiedener Identifier-Typen

Data type

Binding

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

Constraints

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

Pattern

{
  "coding": [
    {
      "system": "http://fhir.de/CodeSystem/identifier-type-de-basis",
      "code": "GKV"
    }
  ]
}

Mappings

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

system

1..1

uriFixed Value

Element id

Patient.identifier:VersichertenId.system

Short description

Namensraum der Versichertennummer

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.

Comments

Hier ist stets der Wert http://fhir.de/sid/gkv/kvid-10 anzugeben. Begründung Pflichtfeld: system stellt in Kombination mit value die Eindeutigkeit eines Identifiers sicher.

Data type

Constraints

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

Fixed value

http://fhir.de/sid/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

Σ C

1..1

Element id

Patient.identifier:VersichertenId.value

Short description

Konkrete lebenslange Krankenversichertennummer

Definition

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

Comments

Der 10-stellige, unveränderbare Teil der Versichertennummer

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
kvid-1: Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen
matches('^[A-Z][0-9]{9}$')

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

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

Constraints

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

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

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

Constraints

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

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_GKV

0..1

IdentifierKvid10Pattern

Element id

Patient.identifier:VersichertenId_GKV

Short description

Gesetzliche Krankenversichertennummer

Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Requirements

Patients are almost always assigned specific numerical identifiers.

Comments

WARNUNG: Die Verwendung der 'GKV'-Kodierung einer Versichertennummer ist abgekündigt, da die lebenslange Versichertennummer ab 2024 auch für PKV oder Sonderkostenträger eingeführt wird. Bitte statt dessen künftig den 'VersichertenId'-Slice verwenden.

Data type

IdentifierKvid10

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

Pattern

{
  "type": {
    "coding": [
      {
        "system": "http://fhir.de/CodeSystem/identifier-type-de-basis",
        "code": "GKV"
      }
    ]
  }
}

Mappings

w5: FiveWs.identifier
v2: PID-3
rim: id
cda: .id
rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - 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

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenId_GKV.id

Short description

Unique id for inter-element referencing

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

Patient.identifier:VersichertenId_GKV.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

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

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenId_GKV.use

Short description

usual | official | temp | secondary | old (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

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 .

Constraints

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

Mappings

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

type

1..1

CodeableConceptBindingPattern

Element id

Patient.identifier:VersichertenId_GKV.type

Short description

Art des Identifiers

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

Hier ist stets der Code GKV aus dem CodeSystem http://fhir.de/CodeSystem/identifier-type-de-basis anzugeben. Begründung Pflichtfeld: type dient der Unterscheidung verschiedener Identifier-Typen

Data type

Binding

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

Constraints

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

Pattern

{
  "coding": [
    {
      "system": "http://fhir.de/CodeSystem/identifier-type-de-basis",
      "code": "GKV"
    }
  ]
}

Mappings

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

system

1..1

uriFixed Value

Element id

Patient.identifier:VersichertenId_GKV.system

Short description

Namensraum der Versichertennummer

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.

Comments

Hier ist stets der Wert http://fhir.de/sid/gkv/kvid-10 anzugeben. Begründung Pflichtfeld: system stellt in Kombination mit value die Eindeutigkeit eines Identifiers sicher.

Data type

Constraints

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

Fixed value

http://fhir.de/sid/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

Σ C

1..1

Element id

Patient.identifier:VersichertenId_GKV.value

Short description

Konkrete gesetzliche Krankenversichertennummer

Definition

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

Comments

Enthält den eigentlichen Wert des Identifiers. Begründung Pflichtfeld: Ist der Wert nicht bekannt, sollte der gesamte Slice weggelassen werden.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
kvid-1: Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen
matches('^[A-Z][0-9]{9}$')

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

Patient.identifier:VersichertenId_GKV.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

Constraints

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

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

Patient.identifier:VersichertenId_GKV.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

Constraints

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

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

Patientennummer

0..1

IdentifierPidPattern

Element id

Patient.identifier:Patientennummer

Short description

Organisationsinterner Patienten-Identifier (PID)

Definition

Ein Identifikator - Eindeutige und unmissverständliche Identifizierung einer Entität.

Requirements

Patients are almost always assigned specific numerical identifiers.

Comments

Organisationsintere Patienten-Identifier werden von z.B. von KIS-Systemen vergeben und dienen innerhalb einer Einreichtung meist als primäres Identifikationsmerkmal für Patienten, u.A. in der HL7 V2-Kommunikation.

Data type

IdentifierPid

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

Pattern

{
  "type": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code": "MR"
      }
    ]
  }
}

Mappings

w5: FiveWs.identifier
v2: PID-3
rim: id
cda: .id
rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - 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

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:Patientennummer.id

Short description

Unique id for inter-element referencing

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

Patient.identifier:Patientennummer.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

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

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.identifier:Patientennummer.use

Short description

usual | official | temp | secondary | old (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

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 .

Constraints

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

Mappings

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

type

1..1

CodeableConceptBindingPattern

Element id

Patient.identifier:Patientennummer.type

Short description

Art des Identifiers

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

Hier ist stets der Code MR aus dem CodeSystem http://terminology.hl7.org/CodeSystem/v2-0203 anzugeben. Begründung Pflichtfeld: type dient der Unterscheidung verschiedener Identifier-Typen

Data type

Binding

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

Constraints

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

Pattern

{
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code": "MR"
    }
  ]
}

Mappings

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

system

1..1

Element id

Patient.identifier:Patientennummer.system

Short description

Namensraum des Identifiers

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.

Comments

Hier ist stets der eindeutige Name (URL) des Namensraums anzugeben, aus dem der Identifier stammt. Hinweise zur Festlegung der URLs für lokale Namensräume sind in den Deutschen Basisprofilen beschrieben. Begründung Pflichtfeld: system stellt in Kombination mit value die Eindeutigkeit eines Identifiers sicher.

Data type

Constraints

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

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

Element id

Patient.identifier:Patientennummer.value

Short description

Konkrete Patientennummer

Definition

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

Comments

Enthält den eigentlichen Wert des Identifiers. Begründung Pflichtfeld: Ist der Wert nicht bekannt, sollte der gesamte Slice weggelassen werden.

Data type

Constraints

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

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

Patient.identifier:Patientennummer.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

Constraints

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

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

Patient.identifier:Patientennummer.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

Constraints

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

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

Versichertennummer_PKV

0..1

IdentifierPkvPattern

Element id

Patient.identifier:Versichertennummer_PKV

Short description

Private Krankenversichertennummer

Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Requirements

Patients are almost always assigned specific numerical identifiers.

Comments

Für Privatpatienten, die noch nicht über eine lebenslange, unveränderliche Krankenversichertennummer (KVNR) verfügen, können bis auf weiteres noch die versicherungsspezifischen PKV-Nummern angegeben werden. Da bei diesen der Bezeichner des vom Kostenträger verwendeten Namensraums meist nicht ermittelt werden kann, ist statt dessen der Name des Kostenträgers in assigner anzugeben.

Data type

IdentifierPkv

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

Pattern

{
  "type": {
    "coding": [
      {
        "system": "http://fhir.de/CodeSystem/identifier-type-de-basis",
        "code": "PKV"
      }
    ]
  }
}

Mappings

w5: FiveWs.identifier
v2: PID-3
rim: id
cda: .id
rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - 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

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:Versichertennummer_PKV.id

Short description

Unique id for inter-element referencing

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

Patient.identifier:Versichertennummer_PKV.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

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

use

Σ ?!

0..1

codeBindingFixed Value

Element id

Patient.identifier:Versichertennummer_PKV.use

Short description

usual | official | temp | secondary | old (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

Verwendungszeck des Identifiers. Hier ist stets der Wert secondary anzugeben.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Fixed value

secondary

Mappings

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

type

1..1

CodeableConceptBindingPattern

Element id

Patient.identifier:Versichertennummer_PKV.type

Short description

Art des Identifiers

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

Hier ist stets der Code PKV aus dem CodeSystem http://fhir.de/CodeSystem/identifier-type-de-basis anzugeben. Begründung Pflichtfeld: type dient der Unterscheidung verschiedener Identifier-Typen

Data type

Binding

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

Constraints

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

Pattern

{
  "coding": [
    {
      "system": "http://fhir.de/CodeSystem/identifier-type-de-basis",
      "code": "PKV"
    }
  ]
}

Mappings

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

system

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:Versichertennummer_PKV.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.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

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

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

Element id

Patient.identifier:Versichertennummer_PKV.value

Short description

Konkrete private Krankenversichertennummer

Definition

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

Comments

Enthält den eigentlichen Wert des Identifiers. Begründung Pflichtfeld: Ist der Wert nicht bekannt, sollte der gesamte Slice weggelassen werden.

Data type

Constraints

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

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

Patient.identifier:Versichertennummer_PKV.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

Constraints

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

Mappings

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

assigner

1..1

Element id

Patient.identifier:Versichertennummer_PKV.assigner

Short description

Private Krankenversichertennummer ausgebende Organisation

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

Constraints

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

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

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:Versichertennummer_PKV.assigner.id

Short description

Unique id for inter-element referencing

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

Patient.identifier:Versichertennummer_PKV.assigner.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

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

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:Versichertennummer_PKV.assigner.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

Constraints

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

Mappings

rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Patient.identifier:Versichertennummer_PKV.assigner.type

Short description

Type the reference refers to (e.g. "Patient")

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

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.

Data type

Binding

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

ResourceType (extensible)

Constraints

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

Mappings

rim: N/A

identifier

0..1

IdentifierIknr

There are no (further) constraints on this element

Element id

Patient.identifier:Versichertennummer_PKV.assigner.identifier

Short description

An identifier intended for computation

Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

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

Data type

IdentifierIknr

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

Mappings

rim: .identifier
rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - 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

display

1..1

Element id

Patient.identifier:Versichertennummer_PKV.assigner.display

Short description

Konkreter Name des Kostenträgers

Definition

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

Comments

Name des Kostenträgers, aus dessen Nummernkreis die PKV-Nummer stammt.

Data type

Constraints

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

Mappings

rim: N/A

active

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Patient.active

Short description

Whether this patient's record is in active use

Definition

Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

It is often used to filter patient lists to exclude inactive patients

Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

Requirements

Need to be able to mark a patient record as not to be used because it was created in error.

Comments

If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

Constraints

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

Mappings

w5: FiveWs.status
rim: statusCode
cda: n/a

name

Σ C

1..*

Element id

Patient.name

Short description

Personenname

Definition

Personenname mit in Deutschland üblichen Erweiterungen.

Requirements

Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Comments

Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.

Data type

Slicing

Unordered, Open, by use(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() or (children().count() > id.count())
hum-1: Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2: Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3: Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4: Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden
prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())

Mappings

v2: PID-5, PID-9
rim: name
cda: .patient.name
rim: n/a
v2: XPN
rim: EN (actually, PN)
servd: ProviderName

Name

Σ C

1..1

Element id

Patient.name:Name

Short description

Personenname

Definition

Personenname mit in Deutschland üblichen Erweiterungen.

Requirements

Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Comments

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() or (children().count() > id.count())
hum-1: Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2: Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3: Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4: Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden
prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())

Mappings

v2: PID-5, PID-9
rim: name
cda: .patient.name
rim: n/a
v2: XPN
rim: EN (actually, PN)
servd: ProviderName

0..1

There are no (further) constraints on this element

Element id

Patient.name:Name.id

Short description

Unique id for inter-element referencing

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

Patient.name:Name.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

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

use

Σ ?!

1..1

codeBindingFixed Value

Element id

Patient.name:Name.use

Short description

Definition

Identifies the purpose for this name.

Requirements

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

Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Data type

Binding

The use of a human name.

NameUse (required)

Constraints

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

Fixed value

official

Mappings

v2: XPN.7, but often indicated by which field contains the name
rim: unique(./use)
servd: ./NamePurpose
BDT: 1211 (in BDT als Freitext!)

text

0..1

There are no (further) constraints on this element

Element id

Patient.name:Name.text

Short description

Text representation of the full name

Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

Constraints

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

Mappings

v2: implied by XPN.11
rim: ./formatted

family

1..1

There are no (further) constraints on this element

Element id

Patient.name:Name.family

Short description

Familienname

Alternate names

surname

Definition

Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt.

Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Data type

Constraints

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

Mappings

v2: XPN.1/FN.1
rim: ./part[partType = FAM]
servd: ./FamilyName
BDT: 3120 + 3100 + 3101
KVDT: 3100 + 3120 + 3101

0..1

There are no (further) constraints on this element

Element id

Patient.name:Name.family.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references)

Data type

extension

1..*

There are no (further) constraints on this element

Element id

Patient.name:Name.family.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

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

namenszusatz

0..1

There are no (further) constraints on this element

Element id

Patient.name:Name.family.extension:namenszusatz

Short description

Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")

Alternate names

extensions, user content

Definition

Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst

Comments

Die Extension wurde erstellt aufgrund der Anforderung, die auf der eGK vorhandenen Patientenstammdaten in FHIR abbilden zu können. Auf der eGK werden die Namensbestandteile "Namenszusatz" und "Vorsatzwort" getrennt vom Nachnamen gespeichert. Anhand der Liste der zulässigen Namenszusätze ist deutlich erkennbar, dass es sich hierbei sinngemäß um Adelstitel handelt. Das Vorsatzwort kann durch die Core-Extension own-prefix (Canonical: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix) abgebildet werden, für den Namenszusatz ergibt sich jedoch die Notwendikeit einer nationalen Extension, da in andern Ländern Adelstitel entweder gar nicht oder als reguläres Namenspräfix erfasst werden.

Data type

http://fhir.de/StructureDefinition/humanname-namenszusatz

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
KVDT: 3100
BDT: 3100

nachname

1..1

Element id

Patient.name:Name.family.extension:nachname

Short description

Nachname ohne Vor- und Zusätze

Alternate names

extensions, user content

Definition

Nachname ohne Vor- und Zusätze. Dient z.B. der alphabetischen Einordnung des Namens.

Comments

If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".

Data type

http://hl7.org/fhir/StructureDefinition/humanname-own-name

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

v2: FN.3
rim: ENXP where Qualifiers = (BR)
KVDT: 3101
BDT: 3101

vorsatzwort

0..1

There are no (further) constraints on this element

Element id

Patient.name:Name.family.extension:vorsatzwort

Short description

Vorsatzwort

Alternate names

extensions, user content

Definition

Vorsatzwort wie z.B.: von, van, zu Vgl. auch VSDM-Spezifikation der Gematik (Versichertenstammdatenmanagement, "eGK")

Comments

An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.

Data type

http://hl7.org/fhir/StructureDefinition/humanname-own-prefix

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

v2: FN.2
rim: ENXP where Qualifiers = (VV, R)
BDT: 3120
KVDT: 3120

value

0..1

System.String

There are no (further) constraints on this element

Element id

Patient.name:Name.family.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

given

0..*

There are no (further) constraints on this element

Element id

Patient.name:Name.given

Short description

Vorname

Alternate names

first name, middle name

Definition

Vorname der Person

Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Data type

Constraints

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

Mappings

v2: XPN.2 + XPN.3
rim: ./part[partType = GIV]
servd: ./GivenNames
KVDT: 3102
BDT: 3102

prefix

0..*

There are no (further) constraints on this element

Element id

Patient.name:Name.prefix

Short description

Namensteile vor dem Vornamen

Definition

Namensteile vor dem Vornamen, z.B. akademischer Titel.

Data type

Constraints

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

Mappings

v2: XPN.5
rim: ./part[partType = PFX]
servd: ./TitleCode
KVDT: 3104
BDT: 3104

0..1

There are no (further) constraints on this element

Element id

Patient.name:Name.prefix.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references)

Data type

extension

0..*

There are no (further) constraints on this element

Element id

Patient.name:Name.prefix.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

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

prefix-qualifier

0..*

There are no (further) constraints on this element

Element id

Patient.name:Name.prefix.extension:prefix-qualifier

Short description

LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV

Alternate names

extensions, user content

Definition

Spezialisierung der Art des Präfixes, z.B. "AC" für Akademische Titel

Comments

Used to indicate additional information about the name part and how it should be used.

Data type

http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier

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: ENXP.qualifier

value

0..1

System.String

There are no (further) constraints on this element

Element id

Patient.name:Name.prefix.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

suffix

0..*

There are no (further) constraints on this element

Element id

Patient.name:Name.suffix

Short description

Namensteile nach dem Nachnamen

Definition

Namensteile nach dem Nachnamen

Data type

Constraints

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

Mappings

v2: XPN/4
rim: ./part[partType = SFX]

period

0..1

There are no (further) constraints on this element

Element id

Patient.name:Name.period

Short description

Time period when name was/is in use

Definition

Indicates the period of time when this name was valid for the named person.

Requirements

Allows names to be placed in historical context.

Data type

Constraints

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

Mappings

v2: XPN.13 + XPN.14
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

Geburtsname

Σ C

0..1

Element id

Patient.name:Geburtsname

Short description

Personenname

Definition

Personenname mit in Deutschland üblichen Erweiterungen.

Requirements

Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Comments

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() or (children().count() > id.count())
hum-1: Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2: Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3: Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4: Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden
prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())

Mappings

v2: PID-5, PID-9
rim: name
cda: .patient.name
rim: n/a
v2: XPN
rim: EN (actually, PN)
servd: ProviderName

0..1

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.id

Short description

Unique id for inter-element referencing

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

Patient.name:Geburtsname.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

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

use

Σ ?!

1..1

codeBindingFixed Value

Element id

Patient.name:Geburtsname.use

Short description

Definition

Identifies the purpose for this name.

Requirements

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

Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Data type

Binding

The use of a human name.

NameUse (required)

Constraints

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

Fixed value

maiden

Mappings

v2: XPN.7, but often indicated by which field contains the name
rim: unique(./use)
servd: ./NamePurpose
BDT: 1211 (in BDT als Freitext!)

text

0..1

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.text

Short description

Text representation of the full name

Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

Constraints

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

Mappings

v2: implied by XPN.11
rim: ./formatted

family

0..1

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.family

Short description

Familienname

Alternate names

surname

Definition

Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt.

Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Data type

Constraints

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

Mappings

v2: XPN.1/FN.1
rim: ./part[partType = FAM]
servd: ./FamilyName
BDT: 3120 + 3100 + 3101
KVDT: 3100 + 3120 + 3101

0..1

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.family.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references)

Data type

extension

0..*

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.family.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

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

namenszusatz

0..1

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.family.extension:namenszusatz

Short description

Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")

Alternate names

extensions, user content

Definition

Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst

Comments

Data type

http://fhir.de/StructureDefinition/humanname-namenszusatz

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
KVDT: 3100
BDT: 3100

nachname

0..1

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.family.extension:nachname

Short description

Nachname ohne Vor- und Zusätze

Alternate names

extensions, user content

Definition

Nachname ohne Vor- und Zusätze. Dient z.B. der alphabetischen Einordnung des Namens.

Comments

Data type

http://hl7.org/fhir/StructureDefinition/humanname-own-name

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

v2: FN.3
rim: ENXP where Qualifiers = (BR)
KVDT: 3101
BDT: 3101

vorsatzwort

0..1

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.family.extension:vorsatzwort

Short description

Vorsatzwort

Alternate names

extensions, user content

Definition

Vorsatzwort wie z.B.: von, van, zu Vgl. auch VSDM-Spezifikation der Gematik (Versichertenstammdatenmanagement, "eGK")

Comments

An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.

Data type

http://hl7.org/fhir/StructureDefinition/humanname-own-prefix

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

v2: FN.2
rim: ENXP where Qualifiers = (VV, R)
BDT: 3120
KVDT: 3120

value

0..1

System.String

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.family.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

given

0..0

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.given

Short description

Vorname

Alternate names

first name, middle name

Definition

Vorname der Person

Comments

Data type

Constraints

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

Mappings

v2: XPN.2 + XPN.3
rim: ./part[partType = GIV]
servd: ./GivenNames
KVDT: 3102
BDT: 3102

prefix

0..0

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.prefix

Short description

Namensteile vor dem Vornamen

Definition

Namensteile vor dem Vornamen, z.B. akademischer Titel.

Data type

Constraints

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

Mappings

v2: XPN.5
rim: ./part[partType = PFX]
servd: ./TitleCode
KVDT: 3104
BDT: 3104

suffix

0..*

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.suffix

Short description

Namensteile nach dem Nachnamen

Definition

Namensteile nach dem Nachnamen

Data type

Constraints

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

Mappings

v2: XPN/4
rim: ./part[partType = SFX]

period

0..1

There are no (further) constraints on this element

Element id

Patient.name:Geburtsname.period

Short description

Time period when name was/is in use

Definition

Indicates the period of time when this name was valid for the named person.

Requirements

Allows names to be placed in historical context.

Data type

Constraints

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

Mappings

v2: XPN.13 + XPN.14
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

telecom

Σ C

0..*

Element id

Patient.telecom

Short description

Angaben zu bestehenden Kontaktmöglichkeiten. (Telefon, Fax, E-Mail usw.)

Definition

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Comments

A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

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() or (children().count() > id.count())
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()

Mappings

v2: PID-13, PID-14, PID-40
rim: telecom
cda: .telecom
rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint

gender

1..1

codeBinding

Element id

Patient.gender

Short description

männlich | weiblich | unbestimmt | divers

Definition

Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

Requirements

Needed for identification of the individual, in combination with (at least) name and birth date.

Comments

Für die Geschlechtskennzeichen "unbestimmt" und "divers" ist der code "other" zu verwenden. Falls ein administratives Geschlecht 'divers' abzubilden ist (z.B. da dieses Geschlecht auf offiziellen Ausweisen eingetragen ist) muss eine Differenzierung zwischen 'other' und 'divers' als positiver Geschlechtseintrag erfolgen. Hierfür ist die 'other-amtlich'-Extension zu verwenden.

Data type

AdministrativeGender (required)

Binding

The gender of a person used for administrative purposes.

Constraints

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

Mappings

v2: PID-8
rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
cda: .patient.administrativeGenderCode

0..1

There are no (further) constraints on this element

Element id

Patient.gender.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references)

Data type

extension

0..*

Element id

Patient.gender.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://fhir.de/StructureDefinition/gender-amtlich-de

Slicing

Unordered, Open, by url(Value)

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

gender-amtlich

0..1

Extension(Coding)

Element id

Patient.gender.extension:gender-amtlich

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Extension zur genaueren Differenzierung des administrativen Geschlechts.

Comments

Data type

Extension(Coding)

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

value

0..1

System.String

There are no (further) constraints on this element

Element id

Patient.gender.value

Short description

Primitive value for code

Definition

Primitive value for code

Data type

System.String

birthDate

1..1

date

There are no (further) constraints on this element

Element id

Patient.birthDate

Short description

The date of birth for the individual

Definition

The date of birth for the individual.

Requirements

Age of the individual drives many clinical processes.

Comments

At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

Data type

date

Constraints

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

Mappings

v2: PID-7
rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
cda: .patient.birthTime
loinc: 21112-8

0..1

There are no (further) constraints on this element

Element id

Patient.birthDate.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references)

Data type

extension

0..*

Element id

Patient.birthDate.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

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

data_absent_reason

0..1

Element id

Patient.birthDate.extension:data_absent_reason

Short description

Alternate names

extensions, user content

Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Comments

Data type

http://hl7.org/fhir/StructureDefinition/data-absent-reason

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: ANY.nullFlavor

value

0..1

System.Date

There are no (further) constraints on this element

Element id

Patient.birthDate.value

Short description

Primitive value for date

Definition

The actual value

Data type

System.Date

deceased[x]

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Patient.deceased[x]

Short description

Indicates if the individual is deceased or not

Definition

Indicates if the individual is deceased or not.

Requirements

The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

Comments

If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

Constraints

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

Mappings

v2: PID-30 (bool) and PID-29 (datetime)
rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
cda: n/a

deceasedDateTime

Data type

address

1..*

Element id

Patient.address

Short description

An address for the individual

Definition

An address for the individual.

Requirements

May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Comments

Patient may have multiple addresses with different uses or applicable periods.

Data type

Slicing

Unordered, Open, by type(Value)

Constraints

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

Mappings

v2: PID-11
rim: addr
cda: .addr

Strassenanschrift

Σ C

0..1

Element id

Patient.address:Strassenanschrift

Short description

Eine Adresse gemäß postalischer Konventionen

Definition

Eine Adresse gemäß postalischer Konventionen (im Gegensatz zu bspw. GPS-Koordinaten). Die Adresse kann sowohl zur Zustellung von Postsendungen oder zum Aufsuchen von Orten, die keine gültige Postadresse haben, verwendet werden.

Die verwendeten Extensions in diesem Profil bilden die Struktur der Adresse ab, wie sie im VSDM-Format der elektronischen Versichertenkarte verwendet wird.

Insbesondere bei ausländischen Adresse oder Adressen, die nicht durch Einlesen einer elektronischen Versichertenkarte erfasst wurden, sind abweichende Strukturen möglich. Die Verwendung der Extensions ist nicht verpflichtend.

Requirements

May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Comments

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

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() or (children().count() > id.count())
add-1: Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
add-2: Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
add-3: Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue())
add-4: Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein.
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty()
add-5: Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())
add-6: Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty()))
add-7: Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein.
extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))

Examples
Beispiel für einfache Adresse

{
  "use": "home",
  "type": "postal",
  "line": [
    "Musterweg 42"
  ],
  "city": "Musterhausen",
  "postalCode": "99999"
}

Mappings

v2: PID-11
rim: addr
cda: .addr
rim: n/a
v2: XAD
rim: AD
servd: Address

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.id

Short description

Unique id for inter-element referencing

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

Patient.address:Strassenanschrift.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

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

Stadtteil

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.extension:Stadtteil

Short description

Stadt- oder Ortsteil

Alternate names

extensions, user content

Definition

A subsection of a municipality.

Comments

Data type

http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct

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: ADXP[partType=PRE]

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.use

Short description

home | work | temp | old | billing - purpose of this address

Definition

The purpose of this address.

Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Data type

Binding

The use of an address.

AddressUse (required)

Constraints

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

Examples
General

home

Mappings

v2: XAD.7
rim: unique(./use)
servd: ./AddressPurpose

type

1..1

codeBindingFixed Value

Element id

Patient.address:Strassenanschrift.type

Short description

postal | physical | both

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Data type

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

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

Fixed value

both

Examples
General

both

Mappings

v2: XAD.18
rim: unique(./use)
vcard: address type parameter
BDT: 1202 (1=physical, 2=postal)

text

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.text

Short description

Text representation of the address

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

Constraints

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

Examples
General

137 Nowhere Street, Erewhon 9132

Mappings

v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
rim: ./formatted
vcard: address label parameter

line

0..3

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.line

Short description

Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung

Definition

Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können.

Data type

Constraints

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

Examples
General

137 Nowhere Street

Beipiel für Adresszeile mit Extensions für Straße und Hausnummer

Musterweg 42

Mappings

v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
rim: AD.part[parttype = AL]
vcard: street
servd: ./StreetAddress (newline delimitted)
KVDT: 3107 + 3109 + 3115 oder 3123
BDT: 3107 + 3109 + 3115 oder 3123

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.line.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references)

Data type

extension

0..*

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.line.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

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

Strasse

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.line.extension:Strasse

Short description

Strassenname (ohne Hausnummer)

Alternate names

extensions, user content

Definition

Strassenname (ohne Hausnummer) Bei Angabe einer Strasse in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.

Comments

Data type

http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName

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: ADXP[partType=STR]
KVDT: 3107
BDT: 3107

Hausnummer

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.line.extension:Hausnummer

Short description

Hausnummer

Alternate names

extensions, user content

Definition

Hausnummer, sowie Zusätze (Appartmentnummer, Etage...) Bei Angabe einer Hausnummer in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.

Comments

Data type

http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber

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: ADXP[partType=BNR]
KVDT: 3109
BDT: 3109

Adresszusatz

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.line.extension:Adresszusatz

Short description

Adresszusatz

Alternate names

extensions, user content

Definition

Zusätzliche Informationen, wie z.B. "3. Etage", "Appartment C" Bei Angabe einer Zusatzinformation in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.

Comments

Data type

http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator

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: ADXP[partType=ADL]
KVDT: 3115
BDT: 3115

Postfach

0..0

Element id

Patient.address:Strassenanschrift.line.extension:Postfach

Short description

Postfach

Alternate names

extensions, user content

Definition

Postfach-Adresse. Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. Eine Postfach-Adresse darf nicht in Verbindung mit Address.type "physical" oder "both" verwendet werden.

Comments

Data type

http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox

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: ADXP[partType=POB]
KVDT: 3123
BDT: 3123

value

0..1

System.String

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.line.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

city

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.city

Short description

Name of city, town etc.

Alternate names

Municpality

Definition

The name of the city, town, suburb, village or other community or delivery center.

Data type

Constraints

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

Examples
General

Erewhon

Mappings

v2: XAD.3
rim: AD.part[parttype = CTY]
vcard: locality
servd: ./Jurisdiction
BDT: 3113 oder 3122 (Postfach)
KVDT: 3113 oder 3122 (Postfach)

district

0..0

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.district

Short description

District name (aka county)

Alternate names

County

Definition

The name of the administrative area (county).

Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Data type

Constraints

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

Examples
General

Madison

Mappings

v2: XAD.9
rim: AD.part[parttype = CNT | CPA]

state

0..1

stringBinding

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.state

Short description

Bundesland

Alternate names

Province, Territory

Definition

Name (oder Kürzel) des Bundeslandes.

Data type

ValueSetISO31662DE (preferred)

Binding

Constraints

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

Mappings

v2: XAD.4
rim: AD.part[parttype = STA]
vcard: region
servd: ./Region

postalCode

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.postalCode

Short description

Postleitzahl

Alternate names

Zip

Definition

Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen

Data type

Constraints

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

Examples
General

Mappings

v2: XAD.5
rim: AD.part[parttype = ZIP]
vcard: code
servd: ./PostalIdentificationCode
BDT: 3112 oder 3121 (Postfach)
KVDT: 3112 oder 3121 (Postfach)

country

0..1

stringBinding

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.country

Short description

Staat

Definition

Staat (vorzugsweise als 2-Stelliger ISO-Ländercode). Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Data type

Binding

Iso3166-1-2 (preferred)

Constraints

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

Mappings

v2: XAD.6
rim: AD.part[parttype = CNT]
vcard: country
servd: ./Country
BDT: 3114 oder 3124 (Postfach), abweichendes CodeSystem
KVDT: 3114 oder 3124 (Postfach), abweichendes CodeSystem

period

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.period

Short description

Time period when address was/is in use

Definition

Time period when address was/is in use.

Requirements

Allows addresses to be placed in historical context.

Data type

Constraints

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

Examples
General

{
  "start": "2010-03-23",
  "end": "2010-07-01"
}

Mappings

v2: XAD.12 / XAD.13 + XAD.14
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.period.id

Short description

Unique id for inter-element referencing

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

Patient.address:Strassenanschrift.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

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

start

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.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

Constraints

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

Mappings

v2: DR.1
rim: ./low
BDT: 8226

end

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.address:Strassenanschrift.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 no end was known or planned at the time the instance was created. 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 an 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

Conditions

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

Constraints

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

Mappings

v2: DR.2
rim: ./high
BDT: 8227

Postfach

Σ C

0..1

Element id

Patient.address:Postfach

Short description

Eine Adresse gemäß postalischer Konventionen

Definition

Die verwendeten Extensions in diesem Profil bilden die Struktur der Adresse ab, wie sie im VSDM-Format der elektronischen Versichertenkarte verwendet wird.

Requirements

May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Comments

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() or (children().count() > id.count())
add-1: Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
add-2: Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
add-3: Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue())
add-4: Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein.
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty()
add-5: Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())
add-6: Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty()))
add-7: Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein.
extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))

Examples
Beispiel für einfache Adresse

{
  "use": "home",
  "type": "postal",
  "line": [
    "Musterweg 42"
  ],
  "city": "Musterhausen",
  "postalCode": "99999"
}

Mappings

v2: PID-11
rim: addr
cda: .addr
rim: n/a
v2: XAD
rim: AD
servd: Address

0..1

There are no (further) constraints on this element

Element id

Patient.address:Postfach.id

Short description

Unique id for inter-element referencing

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

Patient.address:Postfach.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

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

Stadtteil

0..1

There are no (further) constraints on this element

Element id

Patient.address:Postfach.extension:Stadtteil

Short description

Stadt- oder Ortsteil

Alternate names

extensions, user content

Definition

A subsection of a municipality.

Comments

Data type

http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct

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: ADXP[partType=PRE]

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.address:Postfach.use

Short description

home | work | temp | old | billing - purpose of this address

Definition

The purpose of this address.

Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Data type

Binding

The use of an address.

AddressUse (required)

Constraints

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

Examples
General

home

Mappings

v2: XAD.7
rim: unique(./use)
servd: ./AddressPurpose

type

1..1

codeBindingFixed Value

Element id

Patient.address:Postfach.type

Short description

postal | physical | both

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Comments

Data type

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

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

Fixed value

postal

Examples
General

both

Mappings

v2: XAD.18
rim: unique(./use)
vcard: address type parameter
BDT: 1202 (1=physical, 2=postal)

text

0..1

There are no (further) constraints on this element

Element id

Patient.address:Postfach.text

Short description

Text representation of the address

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Data type

Constraints

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

Examples
General

137 Nowhere Street, Erewhon 9132

Mappings

v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
rim: ./formatted
vcard: address label parameter

line

0..3

There are no (further) constraints on this element

Element id

Patient.address:Postfach.line

Short description

Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung

Definition

Data type

Constraints

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

Examples
General

137 Nowhere Street

Beipiel für Adresszeile mit Extensions für Straße und Hausnummer

Musterweg 42

Mappings

v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
rim: AD.part[parttype = AL]
vcard: street
servd: ./StreetAddress (newline delimitted)
KVDT: 3107 + 3109 + 3115 oder 3123
BDT: 3107 + 3109 + 3115 oder 3123

0..1

There are no (further) constraints on this element

Element id

Patient.address:Postfach.line.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references)

Data type

extension

0..*

There are no (further) constraints on this element

Element id

Patient.address:Postfach.line.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

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

Strasse

0..0

Element id

Patient.address:Postfach.line.extension:Strasse

Short description

Strassenname (ohne Hausnummer)

Alternate names

extensions, user content

Definition

Comments

Data type

http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName

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: ADXP[partType=STR]
KVDT: 3107
BDT: 3107

Hausnummer

0..0

Element id

Patient.address:Postfach.line.extension:Hausnummer

Short description

Hausnummer

Alternate names

extensions, user content

Definition

Comments

Data type

http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber

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: ADXP[partType=BNR]
KVDT: 3109
BDT: 3109

Adresszusatz

0..0

Element id

Patient.address:Postfach.line.extension:Adresszusatz

Short description

Adresszusatz

Alternate names

extensions, user content

Definition

Comments

Data type

http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator

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: ADXP[partType=ADL]
KVDT: 3115
BDT: 3115

Postfach

0..1

There are no (further) constraints on this element

Element id

Patient.address:Postfach.line.extension:Postfach

Short description

Postfach

Alternate names

extensions, user content

Definition

Comments

Data type

http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox

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: ADXP[partType=POB]
KVDT: 3123
BDT: 3123

value

0..1

System.String

There are no (further) constraints on this element

Element id

Patient.address:Postfach.line.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

city

0..1

There are no (further) constraints on this element

Element id

Patient.address:Postfach.city

Short description

Name of city, town etc.

Alternate names

Municpality

Definition

The name of the city, town, suburb, village or other community or delivery center.

Data type

Constraints

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

Examples
General

Erewhon

Mappings

v2: XAD.3
rim: AD.part[parttype = CTY]
vcard: locality
servd: ./Jurisdiction
BDT: 3113 oder 3122 (Postfach)
KVDT: 3113 oder 3122 (Postfach)

district

0..0

There are no (further) constraints on this element

Element id

Patient.address:Postfach.district

Short description

District name (aka county)

Alternate names

County

Definition

The name of the administrative area (county).

Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Data type

Constraints

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

Examples
General

Madison

Mappings

v2: XAD.9
rim: AD.part[parttype = CNT | CPA]

state

0..1

stringBinding

There are no (further) constraints on this element

Element id

Patient.address:Postfach.state

Short description

Bundesland

Alternate names

Province, Territory

Definition

Name (oder Kürzel) des Bundeslandes.

Data type

ValueSetISO31662DE (preferred)

Binding

Constraints

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

Mappings

v2: XAD.4
rim: AD.part[parttype = STA]
vcard: region
servd: ./Region

postalCode

0..1

There are no (further) constraints on this element

Element id

Patient.address:Postfach.postalCode

Short description

Postleitzahl

Alternate names

Zip

Definition

Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen

Data type

Constraints

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

Examples
General

Mappings

v2: XAD.5
rim: AD.part[parttype = ZIP]
vcard: code
servd: ./PostalIdentificationCode
BDT: 3112 oder 3121 (Postfach)
KVDT: 3112 oder 3121 (Postfach)

country

0..1

stringBinding

There are no (further) constraints on this element

Element id

Patient.address:Postfach.country

Short description

Staat

Definition

Staat (vorzugsweise als 2-Stelliger ISO-Ländercode). Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Data type

Binding

Iso3166-1-2 (preferred)

Constraints

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

Mappings

v2: XAD.6
rim: AD.part[parttype = CNT]
vcard: country
servd: ./Country
BDT: 3114 oder 3124 (Postfach), abweichendes CodeSystem
KVDT: 3114 oder 3124 (Postfach), abweichendes CodeSystem

period

0..1

There are no (further) constraints on this element

Element id

Patient.address:Postfach.period

Short description

Time period when address was/is in use

Definition

Time period when address was/is in use.

Requirements

Allows addresses to be placed in historical context.

Data type

Constraints

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

Examples
General

{
  "start": "2010-03-23",
  "end": "2010-07-01"
}

Mappings

v2: XAD.12 / XAD.13 + XAD.14
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

0..1

There are no (further) constraints on this element

Element id

Patient.address:Postfach.period.id

Short description

Unique id for inter-element referencing

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

Patient.address:Postfach.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

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

start

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.address:Postfach.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

Constraints

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

Mappings

v2: DR.1
rim: ./low
BDT: 8226

end

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.address:Postfach.period.end

Short description

End time with inclusive boundary, if not ongoing

Definition

Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an 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

Conditions

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

Constraints

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

Mappings

v2: DR.2
rim: ./high
BDT: 8227

maritalStatus

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Patient.maritalStatus

Short description

Marital (civil) status of a patient

Definition

This field contains a patient's most recent marital (civil) status.

Requirements

Most, if not all systems capture it.

Data type

Marital Status Codes (extensible)

Binding

The domestic partnership status of a person.

Constraints

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

Mappings

v2: PID-16
rim: player[classCode=PSN]/maritalStatusCode
cda: .patient.maritalStatusCode

multipleBirth[x]

0..1

There are no (further) constraints on this element

Element id

Patient.multipleBirth[x]

Short description

Whether patient is part of a multiple birth

Definition

Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

Requirements

For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

Comments

Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

Constraints

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

Mappings

v2: PID-24 (bool), PID-25 (integer)
rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
cda: n/a

multipleBirthBoolean

There are no (further) constraints on this element

Data type

multipleBirthInteger

integer

There are no (further) constraints on this element

Data type

integer

photo

0..0

Attachment

There are no (further) constraints on this element

Element id

Patient.photo

Short description

Image of the patient

Definition

Image of the patient.

Requirements

Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

Comments

Guidelines:

Use id photos, not clinical photos.
Limit dimensions to thumbnail.
Keep byte count low to ease resource updates.

Data type

Attachment

Constraints

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

Mappings

v2: OBX-5 - needs a profile
rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
cda: n/a

contact

0..*

There are no (further) constraints on this element

Element id

Patient.contact

Short description

A contact party (e.g. guardian, partner, friend) for the patient

Definition

A contact party (e.g. guardian, partner, friend) for the patient.

Requirements

Need to track people you can contact about the patient.

Comments

Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
pat-1: SHALL at least contain a contact's details or a reference to an organization
name.exists() or telecom.exists() or address.exists() or organization.exists()

Mappings

rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
cda: n/a

0..1

There are no (further) constraints on this element

Element id

Patient.contact.id

Short description

Unique id for inter-element referencing

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

Patient.contact.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Patient.contact.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

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

Requirements

Comments

Data type

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

relationship

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Patient.contact.relationship

Short description

The kind of relationship

Definition

The nature of the relationship between the patient and the contact person.

Requirements

Used to determine which contact person is the most relevant to approach, depending on circumstances.

Data type

PatientContactRelationship (extensible)

Binding

The nature of the relationship between a patient and a contact person for that patient.

Constraints

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

Mappings

v2: NK1-7, NK1-3
rim: code
cda: n/a

name

0..1

Element id

Patient.contact.name

Short description

Personenname

Definition

Personenname mit in Deutschland üblichen Erweiterungen

Requirements

Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

Comments

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() or (children().count() > id.count())
hum-1: Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2: Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3: Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4: Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden
prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())

Mappings

v2: NK1-2
rim: name
cda: n/a
rim: n/a
v2: XPN
rim: EN (actually, PN)
servd: ProviderName

telecom

0..*

Element id

Patient.contact.telecom

Short description

Angaben zu bestehenden Kontaktmöglichkeiten. (Telefon, Fax, E-Mail usw.)

Definition

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Comments

Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

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() or (children().count() > id.count())
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()

Mappings

v2: NK1-5, NK1-6, NK1-40
rim: telecom
cda: n/a
rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint

address

0..1

There are no (further) constraints on this element

Element id

Patient.contact.address

Short description

Address for the contact person

Definition

Address for the contact person.

Requirements

Need to keep track where the contact person can be contacted per postal mail or visited.

Data type

Constraints

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

Mappings

v2: NK1-4
rim: addr
cda: n/a

gender

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.contact.gender

Short description

male | female | other | unknown

Definition

Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

Requirements

Needed to address the person correctly.

Data type

AdministrativeGender (required)

Binding

The gender of a person used for administrative purposes.

Constraints

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

Mappings

v2: NK1-15
rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
cda: n/a

organization

0..1

There are no (further) constraints on this element

Element id

Patient.contact.organization

Short description

Organization that is associated with the contact

Definition

Organization on behalf of which the contact is acting or for which the contact is working.

Requirements

For guardians or business related contacts, the organization is relevant.

Data type

Conditions

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

Constraints

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

Mappings

v2: NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
rim: scoper
cda: n/a

period

0..1

There are no (further) constraints on this element

Element id

Patient.contact.period

Short description

The period during which this contact person or organization is valid to be contacted relating to this patient

Definition

The period during which this contact person or organization is valid to be contacted relating to this patient.

Data type

Constraints

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

Mappings

rim: effectiveTime
cda: n/a

communication

0..*

Element id

Patient.communication

Short description

Bevorzugte Sprache

Definition

Die Sprache, in der mit dem Patienten über seine Gesundheit kommuniziert werden soll.

Requirements

If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

Comments

If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

Data type

Constraints

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

Mappings

rim: LanguageCommunication
cda: patient.languageCommunication

0..1

There are no (further) constraints on this element

Element id

Patient.communication.id

Short description

Unique id for inter-element referencing

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

Patient.communication.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Patient.communication.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

language

1..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Patient.communication.language

Short description

The language which can be used to communicate with the patient about his or her health

Definition

The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

Requirements

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

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

Mappings

v2: PID-15, LAN-2
rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
cda: .languageCode

preferred

0..1

There are no (further) constraints on this element

Element id

Patient.communication.preferred

Short description

Language preference indicator

Definition

Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

Requirements

People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

Comments

This language is specifically identified for communicating healthcare information.

Data type

Constraints

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

Mappings

v2: PID-15
rim: preferenceInd
cda: .preferenceInd

generalPractitioner

0..*

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

Patient.generalPractitioner

Short description

Patient's nominated primary care provider

Alternate names

careProvider

Definition

Patient's nominated care provider.

Comments

This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

Data type

Reference(Organization | Practitioner | PractitionerRole)

Constraints

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

Mappings

v2: PD1-4
rim: subjectOf.CareEvent.performer.AssignedEntity
cda: n/a

managingOrganization

0..1

There are no (further) constraints on this element

Element id

Patient.managingOrganization

Short description

Organization that is the custodian of the patient record

Definition

Organization that is the custodian of the patient record.

Requirements

Need to know who recognizes this patient record, manages and updates it.

Comments

There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

Data type

Constraints

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

Mappings

rim: scoper
cda: .providerOrganization

link

Σ ?!

0..*

There are no (further) constraints on this element

Element id

Patient.link

Short description

Link to another patient resource that concerns the same actual person

Definition

Link to another patient resource that concerns the same actual patient.

Requirements

There are multiple use cases:

Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
Distribution of patient information across multiple servers.

Comments

There is no assumption that linked patient records have mutual links.

Data type

Constraints

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

Mappings

rim: outboundLink
cda: n/a

0..1

There are no (further) constraints on this element

Element id

Patient.link.id

Short description

Unique id for inter-element referencing

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

Patient.link.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Patient.link.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

other

1..1

Reference(Patient | RelatedPerson)

There are no (further) constraints on this element

Element id

Patient.link.other

Short description

The other patient or related person resource that the link refers to

Definition

The other patient resource that the link refers to.

Comments

Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

Data type

Reference(Patient | RelatedPerson)

Constraints

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

Mappings

v2: PID-3, MRG-1
rim: id
cda: n/a

type

1..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.link.type

Short description

replaced-by | replaces | refer | seealso

Definition

The type of link between this patient resource and another patient resource.

Data type