Leitfaden Basis DE (STU3)

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.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

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

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

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.

Common Languages (extensible)

Binding extensions

maxValueSet	All Languages

Conditions

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

Constraints

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

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

Patient.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

Data type

Narrative

Conditions

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

Constraints

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

Mappings

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

contained

0..*

Resource

There are no (further) constraints on this element

Element id

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.

Data type

Resource

Mappings

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

extension

0..*

There are no (further) constraints on this element

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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

identifier

S Σ

0..*

There are no (further) constraints on this element

Element id

Patient.identifier

Short description

Identifikator für diesen Patienten

Definition

Identifikator für diesen Patienten

Requirements

Patients are almost always assigned specific numerical identifiers.

Data type

Slicing

Unordered, Open, by system(Value)

Conditions

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

Constraints

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

Mappings

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

VersichertenID_GKV

S Σ

1..1

Element id

Patient.identifier:VersichertenID_GKV

Short description

Die Krankenversichertennummer wie auf der eGK abgebildet.

Definition

Die Krankenversichertennummer wie auf der eGK abgebildet (10-stellige, unveränderliche Nummer). Für dieses Profil muss diese Nummer angegeben werden.

Requirements

Die gesetzliche Krankenversichertennummer ist ein zentrales Identififaktionsmerkmal im deutschen Gesundheitswesen.

Data type

Conditions

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

Constraints

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

Mappings

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

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

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

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

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

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

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

Constraints

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

Mappings

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

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.type

Short description

Description of identifier

Definition

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

Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

Identifier Type Codes (extensible)

Binding

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

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.type.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.type.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

coding

1..1

Coding

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.type.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

Comments

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

Data type

Coding

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.type.coding.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.type.coding.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

system

1..1

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.type.coding.system

Short description

Identity of the terminology system

Definition

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

Requirements

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

Comments

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

Data type

Conditions

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

Constraints

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

Mappings

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

version

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.type.coding.version

Short description

Version of the system - if relevant

Definition

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

Comments

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

Data type

Conditions

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

Constraints

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

Mappings

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

code

1..1

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.type.coding.code

Short description

Symbol in syntax defined by the system

Definition

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

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

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

display

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.type.coding.display

Short description

Representation defined by the system

Definition

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

Requirements

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

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

userSelected

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.type.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

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

Requirements

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

Comments

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

Data type

Conditions

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

Constraints

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

Mappings

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

text

0..1

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.type.text

Short description

Plain text representation of the concept

Definition

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

Requirements

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

Comments

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

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: 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

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

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

Die Versicherten-ID ist der 10-stellige unveränderliche Teil der 30-stelligen Krankenversichertennummer.

Data type

Conditions

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

Constraints

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

Fixed value

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

Examples
General

http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri

Mappings

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

value

1..1

There are no (further) constraints on this element

Element id

Patient.identifier:VersichertenID_GKV.value

Short description

The value that is unique

Definition

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

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Data type

Conditions

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

Constraints

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

Examples
General

Mappings

rim: n/a
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
KVDT: 3119

period

Σ C

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.

Comments

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

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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

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.

Requirements

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

Comments

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

This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.

Data type

Conditions

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

Constraints

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

Default value

true

Mappings

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

name

S Σ C

1..*

Element id

Patient.name

Short description

Personenname nach deutschem Profil

Definition

Personenname nach deutschem Profil. Dieser enthält bestimmte Extensions, die in Deutschland Verwendung finden. In diesem Profil sind die Kardinalitäten gemäß VSDM-Spezifikation berücksichtigt.

Requirements

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

Comments

Hinweis zur Repräsentation von Anreden: Diese sollten, sofern erforderlich, ausschließlich in HumanName.text erscheinen (z.B. "Frsu Dr. Martha Musterfrau"). Nach Möglichkeit sollte die Anrede aus dem Geschlecht der Person abgeleitet werden. Das Element prefix wird nur für akademische Titel und andere Namensbestandteile verwendet.

Data type

Conditions

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

Constraints

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

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

0..1

There are no (further) constraints on this element

Element id

Patient.name.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

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

This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. 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)

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: 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.text

Short description

Text representation of the full name

Definition

A full text representation of the name.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and structured parts.

Data type

Conditions

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

Constraints

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

Mappings

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

family

S Σ C

1..1

There are no (further) constraints on this element

Element id

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

Conditions

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

Constraints

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

Mappings

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

0..1

There are no (further) constraints on this element

Element id

Patient.name.family.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

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

Extensions are always sliced by (at least) url

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

namenszusatz

S C

0..1

Element id

Patient.name.family.extension:namenszusatz

Short description

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

Alternate names

extensions, user content

Definition

Namenszusatz, z.B. Adelstitel als Bestandteil das Nachnamens, z.B. Gräfin, Prinz oder Fürst. Im Kontext von VSDM sind ausschließlich die Namenszusätze aus DEÜV Anlage 7 zulässig.

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 http://build.fhir.org/extension-humanname-own-name.html 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/0.2

Extension URL

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A
KVDT: 3100
BDT: 3100

nachname

S C

0..1

Element id

Patient.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, hum-2

Constraints

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

Mappings

rim: n/a
rim: N/A
v2: FN.3
rim: ENXP where Qualifiers = (BR)
KVDT: 3101
BDT: 3101

0..1

There are no (further) constraints on this element

Element id

Patient.name.family.extension:nachname.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..0

There are no (further) constraints on this element

Element id

Patient.name.family.extension:nachname.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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Patient.name.family.extension:nachname.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

Conditions

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

Constraints

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

Fixed value

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

Mappings

rim: n/a
rim: N/A

valueString

0..1

There are no (further) constraints on this element

Element id

Patient.name.family.extension:nachname.value[x]:valueString

Short description

Value of extension

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Comments

A stream of bytes, base64 encoded

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

vorsatzwort

S C

0..1

Element id

Patient.name.family.extension:vorsatzwort

Short description

Vorsatzwort

Alternate names

extensions, user content

Definition

Vorsatzwort zum Nachnamen, z.B. "von" "van der", "zu" usw. Im Kontext von VSDM sind ausschließlich die Vorsatzwörter aus DEÜV Anlage 6 zulässig.

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, hum-3

Constraints

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

Mappings

rim: n/a
rim: N/A
v2: FN.2
rim: ENXP where Qualifiers = (VV, R)
BDT: 3120
KVDT: 3120

0..1

There are no (further) constraints on this element

Element id

Patient.name.family.extension:vorsatzwort.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..0

There are no (further) constraints on this element

Element id

Patient.name.family.extension:vorsatzwort.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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Patient.name.family.extension:vorsatzwort.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

Conditions

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

Constraints

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

Fixed value

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

Mappings

rim: n/a
rim: N/A

valueString

0..1

There are no (further) constraints on this element

Element id

Patient.name.family.extension:vorsatzwort.value[x]:valueString

Short description

Value of extension

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Comments

A stream of bytes, base64 encoded

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

value

0..1

There are no (further) constraints on this element

Element id

Patient.name.family.value

Short description

Primitive value for string

Definition

Primitive value for string

Maximum string length

1048576

given

S Σ

1..*

There are no (further) constraints on this element

Element id

Patient.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. Not called "first name" since given names do not always come first.

Data type

Conditions

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

Constraints

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

Mappings

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

prefix

S Σ C

0..*

There are no (further) constraints on this element

Element id

Patient.name.prefix

Short description

Namensteile vor dem Vornamen

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
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.prefix.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.name.prefix.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

prefix-qualifier

S C

0..*

Extension(code)

Element id

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

Extension(code)

Extension URL

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A
rim: ENXP.qualifier

0..1

There are no (further) constraints on this element

Element id

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

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..0

There are no (further) constraints on this element

Element id

Patient.name.prefix.extension:prefix-qualifier.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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Patient.name.prefix.extension:prefix-qualifier.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

Conditions

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

Constraints

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

Fixed value

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

Mappings

rim: n/a
rim: N/A

valueCode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.name.prefix.extension:prefix-qualifier.value[x]:valueCode

Short description

Value of extension

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Comments

A stream of bytes, base64 encoded

Data type

EntityNamePartQualifier (required)

Binding

A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

value

0..1

There are no (further) constraints on this element

Element id

Patient.name.prefix.value

Short description

Primitive value for string

Definition

Primitive value for string

Maximum string length

1048576

suffix

0..*

There are no (further) constraints on this element

Element id

Patient.name.suffix

Short description

Namensteile nach dem Nachnamen

Definition

Namensteile nach dem Nachnamen

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

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

period

Σ C

0..1

There are no (further) constraints on this element

Element id

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

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() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: XPN.13 + XPN.14
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

telecom

Σ C

0..*

There are no (further) constraints on this element

Element id

Patient.telecom

Short description

A contact detail for the individual

Definition

A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

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

Mappings

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

0..1

There are no (further) constraints on this element

Element id

Patient.telecom.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

system

Σ C

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.telecom.system

Short description

phone | fax | email | pager | url | sms | other

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Binding

Telecommunications form for contact point

ContactPointSystem (required)

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: XTN.3
rim: ./scheme
servd: ./ContactPointType
BDT: 1291 (abweichendes CodeSystem)

value

0..1

There are no (further) constraints on this element

Element id

Patient.telecom.value

Short description

The actual contact point details

Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: XTN.1 (or XTN.12)
rim: ./url
servd: ./Value
BDT: 1290, 7330, 7331, 7332, 7349, 7333, 7335, 7334

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.telecom.use

Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

Binding

Use of contact point

ContactPointUse (required)

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: XTN.2 - but often indicated by field
rim: unique(./use)
servd: ./ContactPointPurpose

rank

0..1

positiveInt

There are no (further) constraints on this element

Element id

Patient.telecom.rank

Short description

Specify preferred order of use (1 = highest)

Definition

Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

positiveInt

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: n/a

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.telecom.period

Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

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() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: N/A
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

gender

S Σ

1..1

codeBinding

Element id

Patient.gender

Short description

male | female | other | unknown

Definition

Geschlecht. In diesem Profil sind die Kardinalitäten gemäß VSDM-Spezifikation berücksichtigt.

Requirements

Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.

Comments

The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error.

Data type

AdministrativeGender (required)

Binding

The gender of a person used for administrative purposes.

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: 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). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

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/0.2

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

other-amtlich

S C

0..1

Extension(Coding)

Element id

Patient.gender.extension:other-amtlich

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

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

0..1

There are no (further) constraints on this element

Element id

Patient.gender.extension:other-amtlich.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.gender.extension:other-amtlich.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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Patient.gender.extension:other-amtlich.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

Conditions

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

Constraints

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

Fixed value

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

Mappings

rim: n/a
rim: N/A

valueCoding

1..1

CodingBinding

There are no (further) constraints on this element

Element id

Patient.gender.extension:other-amtlich.valueCoding:valueCoding

Short description

Value of extension

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Comments

A stream of bytes, base64 encoded

Data type

Coding

Binding

gender-amtlich-de (required)

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

0..1

There are no (further) constraints on this element

Element id

Patient.gender.extension:other-amtlich.value[x]:valueCoding.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.gender.extension:other-amtlich.value[x]:valueCoding.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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Patient.gender.extension:other-amtlich.valueCoding:valueCoding.system

Short description

Identity of the terminology system

Definition

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

Requirements

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

Comments

Data type

Conditions

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

Constraints

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

Mappings

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

version

0..1

There are no (further) constraints on this element

Element id

Patient.gender.extension:other-amtlich.value[x]:valueCoding.version

Short description

Version of the system - if relevant

Definition

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() | (children().count() > id.count())

Mappings

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

code

S Σ

1..1

There are no (further) constraints on this element

Element id

Patient.gender.extension:other-amtlich.valueCoding:valueCoding.code

Short description

Symbol in syntax defined by the system

Definition

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

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

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

display

0..1

There are no (further) constraints on this element

Element id

Patient.gender.extension:other-amtlich.value[x]:valueCoding.display

Short description

Representation defined by the system

Definition

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

Requirements

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

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

userSelected

0..1

There are no (further) constraints on this element

Element id

Patient.gender.extension:other-amtlich.value[x]:valueCoding.userSelected

Short description

If this coding was chosen directly by the user

Definition

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

Requirements

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

Comments

Data type

Conditions

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

Constraints

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

Mappings

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

value

0..1

There are no (further) constraints on this element

Element id

Patient.gender.value

Short description

Primitive value for code

Definition

Primitive value for code

Maximum string length

1048576

birthDate

S Σ

1..1

date

Element id

Patient.birthDate

Short description

Geburtsdatum

Definition

Geburtsdatum In diesem Profil sind die Kardinalitäten gemäß VSDM-Spezifikation berücksichtigt.

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 maternaty/infant care systems).

Data type

date

Conditions

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

Constraints

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

Mappings

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

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.

This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: 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

deceasedBoolean

There are no (further) constraints on this element

Data type

deceasedDateTime

There are no (further) constraints on this element

Data type

address

Σ C

1..*

There are no (further) constraints on this element

Element id

Patient.address

Short description

Adresse nach deutschem Profil

Definition

Adresse nach deutschem Profil. Die in diesem Profil verwendeten Extensions 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

Note: address is for postal addresses, not physical locations.

Data type

Conditions

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

Constraints

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

Examples
Beispiel für einfache Adresse

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

Mappings

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

0..1

There are no (further) constraints on this element

Element id

Patient.address.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.address.use

Short description

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

Definition

The purpose of this address.

Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. 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)

Conditions

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

Constraints

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

Examples
General

home

Mappings

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

type

Σ C

0..1

codeBinding

There are no (further) constraints on this element

Element id

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

Note that FHIR strings may not exceed 1MB in size

Data type

Binding

The type of an address (physical / postal)

AddressType (required)

Conditions

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

Constraints

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

Examples
General

both

Mappings

rim: n/a
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.text

Short description

Text representation of the address

Definition

A full text representation of the address.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts.

Data type

Conditions

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

Constraints

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

Examples
General

137 Nowhere Street, Erewhon 9132

Mappings

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

line

S Σ C

0..*

There are no (further) constraints on this element

Element id

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

Requirements

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, add-1, add-2, add-3, add-4, add-5, add-6

Constraints

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

Examples
General

137 Nowhere Street

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

Musterweg 42

Mappings

rim: n/a
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.line.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

Strasse

S C

0..1

Element id

Patient.address.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, add-2, add-6

Constraints

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

Mappings

rim: n/a
rim: N/A
rim: ADXP[partType=STR]
KVDT: 3107
BDT: 3107

0..1

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Strasse.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..0

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Strasse.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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Strasse.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

Conditions

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

Constraints

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

Fixed value

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

Mappings

rim: n/a
rim: N/A

valueString

0..1

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Strasse.value[x]:valueString

Short description

Value of extension

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Comments

A stream of bytes, base64 encoded

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

Hausnummer

S C

0..1

Element id

Patient.address.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, add-1, add-6

Constraints

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

Mappings

rim: n/a
rim: N/A
rim: ADXP[partType=BNR]
KVDT: 3109
BDT: 3109

0..1

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Hausnummer.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..0

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Hausnummer.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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Hausnummer.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

Conditions

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

Constraints

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

Fixed value

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

Mappings

rim: n/a
rim: N/A

valueString

0..1

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Hausnummer.value[x]:valueString

Short description

Value of extension

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Comments

A stream of bytes, base64 encoded

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

Adresszusatz

S C

0..1

Element id

Patient.address.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, add-5

Constraints

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

Mappings

rim: n/a
rim: N/A
rim: ADXP[partType=ADL]
KVDT: 3115
BDT: 3115

0..1

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Adresszusatz.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..0

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Adresszusatz.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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Adresszusatz.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

Conditions

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

Constraints

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

Fixed value

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

Mappings

rim: n/a
rim: N/A

valueString

0..1

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Adresszusatz.value[x]:valueString

Short description

Value of extension

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Comments

A stream of bytes, base64 encoded

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

Postfach

S C

0..1

Element id

Patient.address.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, add-3, add-4, add-6

Constraints

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

Mappings

rim: n/a
rim: N/A
rim: ADXP[partType=POB]
KVDT: 3123
BDT: 3123

0..1

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Postfach.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..0

There are no (further) constraints on this element

Element id

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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

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

Conditions

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

Constraints

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

Fixed value

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

Mappings

rim: n/a
rim: N/A

valueString

0..1

There are no (further) constraints on this element

Element id

Patient.address.line.extension:Postfach.value[x]:valueString

Short description

Value of extension

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Comments

A stream of bytes, base64 encoded

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

value

0..1

There are no (further) constraints on this element

Element id

Patient.address.line.value

Short description

Primitive value for string

Definition

Primitive value for string

Maximum string length

1048576

city

S Σ

1..1

There are no (further) constraints on this element

Element id

Patient.address.city

Short description

Name of city, town etc.

Alternate names

Municpality

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Examples
General

Erewhon

Mappings

rim: n/a
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.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

Conditions

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

Constraints

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

Examples
General

Madison

Mappings

rim: n/a
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.state

Short description

Bundesland

Alternate names

Province, Territory

Definition

Name (oder Kürzel) des Bundeslandes.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Binding

iso-bundeslaender (preferred)

Conditions

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

Constraints

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

Mappings

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

postalCode

S Σ

1..1

There are no (further) constraints on this element

Element id

Patient.address.postalCode

Short description

Postleitzahl

Alternate names

Zip

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Examples
General

Mappings

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

country

S Σ

1..1

stringBinding

There are no (further) constraints on this element

Element id

Patient.address.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 full country name.

Data type

Jurisdiction ValueSet (preferred)

Binding

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: 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

Σ C

0..1

There are no (further) constraints on this element

Element id

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

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() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Examples
General

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

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
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.period.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

start

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.address.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: ele-1, per-1

Constraints

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

Mappings

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

end

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.address.period.end

Short description

End time with inclusive boundary, if not ongoing

Definition

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

Comments

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

Meaning when missing

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

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
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.

Comments

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

Data type

Marital Status Codes (extensible)

Binding

The domestic partnership status of a person.

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: 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 (bool) 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 tripplets would be valueInteger=2 and the third born would have valueInteger=3 If a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: 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..*

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

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Attachment".

Data type

Attachment

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
att-1: It the Attachment has data, it SHALL have a contentType
data.empty() or contentType.exists()

Mappings

rim: n/a
v2: ED/RP
rim: ED
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

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
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: n/a
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

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

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

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Patient.contact.modifierExtension

Short description

Extensions that cannot be ignored

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Comments

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

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.

Comments

Data type

Binding

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

v2 Contact Role (extensible)

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: NK1-7, NK1-3
rim: code
cda: n/a

name

0..*

There are no (further) constraints on this element

Element id

Patient.contact.name

Short description

Personenname nach deutschem Profil.

Definition

Personenname nach deutschem Profil. Dieser enthält bestimmte Extensions, die in Deutschland Verwendung finden.

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

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

telecom

0..*

There are no (further) constraints on this element

Element id

Patient.contact.telecom

Short description

A contact detail for the person

Definition

A contact detail for the person, e.g. a telephone number or an email address.

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

Mappings

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

address

0..*

There are no (further) constraints on this element

Element id

Patient.contact.address

Short description

Adresse nach deutschem Profil.

Definition

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

Requirements

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

Comments

Note: address is for postal addresses, not physical locations.

Data type

Conditions

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

Constraints

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

Examples
Beispiel für einfache Adresse

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

Mappings

rim: n/a
v2: XAD
rim: AD
servd: Address
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.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

AdministrativeGender (required)

Binding

The gender of a person used for administrative purposes.

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: 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.

Comments

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

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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.

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() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
rim: effectiveTime
cda: n/a

animal

Σ ?!

0..0

There are no (further) constraints on this element

Element id

Patient.animal

Short description

This patient is known to be an animal (non-human)

Definition

This patient is known to be an animal.

Requirements

Many clinical systems are extended to care for animal patients as well as human.

Comments

Die verterinärmedizinische Profilierung von FHIR is außerhalb des Scopes der Basisprofile

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: player[classCode=ANM]
cda: n/a

communication

0..*

There are no (further) constraints on this element

Element id

Patient.communication

Short description

A list of Languages which may be used to communicate with the patient about his or her health

Definition

Languages which may be used to communicate with the patient about his or her health.

Requirements

If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an 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

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: LanguageCommunication
cda: patient.languageCommunication

0..1

There are no (further) constraints on this element

Element id

Patient.communication.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

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

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Patient.communication.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

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

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.

Common Languages (extensible)

Binding extensions

maxValueSet	All Languages

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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

Reference(Organisation, deutsches Basisprofil (Version 0.2) | Practitioner, deutsches Basisprofil (Version 0.2))

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: PID-15
rim: preferenceInd
cda: .preferenceInd

generalPractitioner

0..*

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/disablity 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.

Data type

Reference(Organisation, deutsches Basisprofil (Version 0.2) | Practitioner, deutsches Basisprofil (Version 0.2))

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: PD1-4
rim: subjectOf.CareEvent.performer.AssignedEntity
cda: n/a

managingOrganization

Σ C

0..1

Reference(Organisation, deutsches Basisprofil (Version 0.2))

There are no (further) constraints on this element

Element id

Patient.managingOrganization

Short description

haupt-behandelnde Organisation nach deutschem Profil

Definition

haupt-behandelnde Organisation nach deutschem Profil. Dieses Profil enthält für Deutschland spezififische Besonderheiten und Extensions.

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

Reference(Organisation, deutsches Basisprofil (Version 0.2))

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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 usecases:

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.

This element is labelled as a modifier because it may not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'.

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: outboundLink
cda: n/a

0..1

There are no (further) constraints on this element

Element id

Patient.link.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

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

Constraints

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

Mappings

rim: n/a

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

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Patient.link.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

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

other

Σ C

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)

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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 - type of link

Definition

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

Comments

Note that FHIR strings may not exceed 1MB in size

Data type