Implementierungsleitfaden ISiK-Basismodul (4.0.0)

There are no (further) constraints on this element

Element id

RelatedPerson.id

Short description

Logical id of this artifact

Definition

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

Comments

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

Data type

Meta

Constraints

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

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

RelatedPerson.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Constraints

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

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

RelatedPerson.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

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

text

0..1

Narrative

There are no (further) constraints on this element

Element id

RelatedPerson.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 can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

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

Data type

Narrative

Constraints

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

Mappings

rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

RelatedPerson.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings

rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

RelatedPerson.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

Comments

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

Data type

Constraints

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

Mappings

rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

RelatedPerson.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

Data type

Constraints

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

Mappings

rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

RelatedPerson.identifier

Short description

A human identifier for this person

Definition

Identifier for a person within a particular scope.

Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Data type

Constraints

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

Mappings

w5: FiveWs.identifier
v2: NK1-33
rim: .id

active

Σ ?!

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.active

Short description

Whether this related person's record is in active use

Definition

Whether this related person record is in active use.

Requirements

Need to be able to mark a related person record as not to be used, such as if it was created in error.

Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

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

Data type

Constraints

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

Mappings

w5: FiveWs.status
rim: .statusCode

patient

S Σ

1..1

Reference(Patient)

Element id

RelatedPerson.patient

Short description

Patientenbezug

Definition

The patient this person is related to.

Requirements

We need to know which patient this RelatedPerson is related to.

Data type

Reference(Patient)

Constraints

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

Mappings

v2: PID-3
rim: scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.patient.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

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

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

reference

S Σ C

1..1

Element id

RelatedPerson.patient.reference

Short description

Patienten-Link

Definition

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

Comments

Begründung Pflichtfeld: Die Verlinkung auf eine Patienten-Ressource dient der technischen Zuordnung der Information zu einem Patienten und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.

Data type

Conditions

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

Constraints

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

Mappings

rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

RelatedPerson.patient.type

Short description

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

Definition

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

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

Comments

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

Data type

uri

Binding

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

ResourceType (extensible)

Constraints

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

Mappings

rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.patient.identifier

Short description

Logical reference, when literal reference is not known

Definition

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

Comments

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

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

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

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

Data type

Constraints

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

Mappings

rim: .identifier

display

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.patient.display

Short description

Text alternative for the resource

Definition

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

Comments

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

Data type

PatientRelationshipType (preferred)

Constraints

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

Mappings

rim: N/A

relationship

S Σ

0..*

CodeableConceptBinding

Element id

RelatedPerson.relationship

Short description

Verwandtschaftsverhältnis

Definition

The nature of the relationship between a patient and the related person.

Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

Comments

Begründung MS: Harmonisierung mit KBV (KBV_PR_Base_RelatedPerson)

Data type

CodeableConcept

Binding

The nature of the relationship between a patient and the related person.

Constraints

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

Mappings

w5: FiveWs.class
v2: NK1-3
rim: code

name

S Σ C

1..*

HumannameDeBasis

Element id

RelatedPerson.name

Short description

Offizieller Name der angehörigen Person

Definition

Personenname mit in Deutschland üblichen Erweiterungen

Requirements

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

Comments

Aufgrund der primären Nutzung von Angehörigen-Informationen im ISiK-Kontext als Brief- und Rechnungsempfänger, ist die Angabe des offiziellen Namens relevant. Wenn kein Name vorliegt, MUSS die data-absent-reason-Extension eingesetzt werden.
Weitere Hinweise: siehe Deutsche Basisprofile

Data type

HumannameDeBasis

Slicing

Unordered, Open, by $this(Pattern)

Conditions

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

Constraints

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

Mappings

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

Name

S Σ

1..1

HumanName

There are no (further) constraints on this element

Element id

RelatedPerson.name:Name

Short description

A name associated with the person

Definition

A name associated with the person.

Requirements

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

Data type

HumanName

Constraints

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

Mappings

v2: NK1-2
rim: name

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.name:Name.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

RelatedPerson.name:Name.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

use

S Σ ?!

0..1

codeBinding

Element id

RelatedPerson.name:Name.use

Short description

Verwendungszweck

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

Verwendungszweck des Namens. Der präferierte Namen für die Brief- und Rechnungszustellung SOLLTE als official gekennzeichnet werden und mindestens über einen Vor- und Nachnamen verfügen.
Begründung MS: Dient als Unterscheidungs- und Auswahlkriterium

Data type

Binding

The use of a human name.

NameUse (required)

Constraints

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

Mappings

v2: XPN.7, but often indicated by which field contains the name
rim: unique(./use)
servd: ./NamePurpose

text

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.name:Name.text

Short description

Text representation of the full name

Definition

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

Requirements

A renderable, unencoded form.

Comments

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

Data type

Constraints

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

Mappings

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

family

S Σ

0..1

Element id

RelatedPerson.name:Name.family

Short description

Nachname

Alternate names

surname

Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

Comments

Vollständiger Nachname bzw. Familienname der Person, einschließlich Vor- und Zusätze.
Begründung Pflichtfeld: Ein offizieller Name ist nur zulässig, wenn der Nachname und mindestens ein Vorname angegeben sind.

Data type

Constraints

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

Mappings

v2: XPN.1/FN.1
rim: ./part[partType = FAM]
servd: ./FamilyName

given

S Σ

0..*

Element id

RelatedPerson.name:Name.given

Short description

Vorname

Alternate names

first name, middle name

Definition

Given name.

Comments

Kann mehrfach verwendet werden, um den Rufnamen sowie weitere Vornamen, Mittelnamen oder Mittel-Initialen abzubilden. Begründung Pflichtfeld: Ein offizieller Name ist nur zulässig, wenn der Nachname und mindestens ein Vorname angegeben sind.

Data type

Constraints

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

Mappings

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

prefix

S Σ

0..*

Element id

RelatedPerson.name:Name.prefix

Short description

Präfix

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Comments

Präfix, z.B. akademischer Titel od. militärischer Rang

Data type

Constraints

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

Mappings

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

suffix

0..*

There are no (further) constraints on this element

Element id

RelatedPerson.name:Name.suffix

Short description

Parts that come after the name

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Data type

Constraints

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

Mappings

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

period

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.name:Name.period

Short description

Time period when name was/is in use

Definition

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

Requirements

Allows names to be placed in historical context.

Data type

Constraints

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

Mappings

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

telecom

S Σ

0..*

ContactPoint

Element id

RelatedPerson.telecom

Short description

Telekommunikationsverbindung

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

Telekommunikationsverbindung (z.B. Telefonnummer, eMail-Adresse)
Begründung MS: Harmonisierung mit KBV (KBV_PR_Base_RelatedPerson)

Data type

ContactPoint

Constraints

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

Mappings

v2: NK1-5 / NK1-6 / NK1-40
rim: telecom

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.telecom.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

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

Constraints

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

Mappings

rim: n/a

system

S Σ C

1..1

codeBinding

Element id

RelatedPerson.telecom.system

Short description

Art der Telekommunikationsverbindung

Definition

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

Comments

Begründung Pflichtfeld: Harmonisierung mit KBV (KBV_PR_Base_RelatedPerson)

Data type

Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Conditions

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

Constraints

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

Mappings

v2: XTN.3
rim: ./scheme
servd: ./ContactPointType

value

S Σ

1..1

Element id

RelatedPerson.telecom.value

Short description

Telekommunikations-Endpunkt

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

Begründung Pflichtfeld: Harmonisierung mit KBV (KBV_PR_Base_RelatedPerson)

Data type

Constraints

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

Mappings

v2: XTN.1 (or XTN.12)
rim: ./url
servd: ./Value

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

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

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)

Constraints

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

Mappings

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

RelatedPerson.telecom.rank

Short description

Specify preferred order of use (1 = highest)

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Comments

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

Data type

positiveInt

Constraints

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

Mappings

v2: n/a
rim: n/a

period

0..1

There are no (further) constraints on this element

Element id

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

Data type

Constraints

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

Mappings

v2: N/A
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

gender

0..1

codeBinding

There are no (further) constraints on this element

Element id

RelatedPerson.gender

Short description

male | female | other | unknown

Definition

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

Requirements

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

Data type

AdministrativeGender (required)

Binding

The gender of a person used for administrative purposes.

Constraints

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

Mappings

v2: NK1-15
rim: administrativeGender

birthDate

0..1

date

There are no (further) constraints on this element

Element id

RelatedPerson.birthDate

Short description

The date on which the related person was born

Definition

The date on which the related person was born.

Data type

date

Constraints

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

Mappings

rim: player.birthTime

address

S Σ

0..*

Address

Element id

RelatedPerson.address

Short description

Address where the related person can be contacted or visited

Definition

Address where the related person can be contacted or visited.

Requirements

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

Comments

In order to differentiate between post box addresses and physical addresses, street names and house numbers, and to add city district names, vendors can opt to support the extensions as suggested in the German Address Base Profile http://fhir.de/StructureDefinition/address-de-basis. Such differentiations are however not required within the scope of this specification.

Data type

Address

Slicing

Unordered, Open, by $this(Pattern)

Constraints

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

Mappings

v2: NK1-4
rim: addr

Strassenanschrift

S Σ C

0..*

AddressDeBasisPattern

Element id

RelatedPerson.address:Strassenanschrift

Short description

Straßenanschrift

Definition

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

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

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

Requirements

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

Comments

Wohn- oder Aufenthaltsort des Angehörigen

Data type

AddressDeBasis

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
add-1: Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
add-2: Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
add-3: Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue())
add-4: Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein.
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty()
add-5: Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())
add-6: Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty()))
add-7: Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein.
extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))
address-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Pattern

{
  "type": "both"
}

Examples
Beispiel für einfache Adresse

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

Mappings

v2: NK1-4
rim: addr
rim: n/a
v2: XAD
rim: AD
servd: Address

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.address:Strassenanschrift.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

RelatedPerson.address:Strassenanschrift.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

Stadtteil

S C

0..1

Element id

RelatedPerson.address:Strassenanschrift.extension:Stadtteil

Short description

Stadt- oder Ortsteil

Alternate names

extensions, user content

Definition

A subsection of a municipality.

Comments

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: ADXP[partType=PRE]

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

RelatedPerson.address:Strassenanschrift.use

Short description

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

Definition

The purpose of this address.

Requirements

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

Comments

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

Data type

Binding

The use of an address.

AddressUse (required)

Constraints

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

Examples
General

home

Mappings

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

type

S Σ

1..1

codeBindingPattern

Element id

RelatedPerson.address:Strassenanschrift.type

Short description

Adresstyp

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

Hier ist stets der Wert both anzugeben.
Begründung Pflichtfeld: Dient als Unterscheidungs- und Auswahlkriterium

Data type

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

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

Pattern

both

Examples
General

both

Mappings

v2: XAD.18
rim: unique(./use)
vcard: address type parameter

text

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.address:Strassenanschrift.text

Short description

Text representation of the address

Definition

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

Requirements

A renderable, unencoded form.

Comments

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

Data type

Constraints

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

Examples
General

137 Nowhere Street, Erewhon 9132

Mappings

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

line

S Σ

1..3

Element id

RelatedPerson.address:Strassenanschrift.line

Short description

Adresszeile

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.

Comments

Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, 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.
Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.
Begründung für Reduktion der max. Kardinalität: Die maximale Kardinalität wurde in Übereinstimmung mit der DIN-Norm 5008 (Schreib- und Gestaltungsregeln für die Text- und Informationsverarbeitung) auf 3 beschränkt.

Data type

Constraints

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

Examples
General

137 Nowhere Street

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

Musterweg 42

Mappings

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

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.address:Strassenanschrift.line.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

extension

0..*

There are no (further) constraints on this element

Element id

RelatedPerson.address:Strassenanschrift.line.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Constraints

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

Strasse

0..1

Element id

RelatedPerson.address:Strassenanschrift.line.extension:Strasse

Short description

Strassenname

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

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.
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

rim: ADXP[partType=STR]

Hausnummer

0..1

Element id

RelatedPerson.address:Strassenanschrift.line.extension:Hausnummer

Short description

Hausnummer

Alternate names

extensions, user content

Definition

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

Comments

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.
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

rim: ADXP[partType=BNR]

Adresszusatz

0..1

Element id

RelatedPerson.address:Strassenanschrift.line.extension:Adresszusatz

Short description

Adresszusatz

Alternate names

extensions, user content

Definition

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

Comments

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.
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

rim: ADXP[partType=ADL]

Postfach

0..0

Element id

RelatedPerson.address:Strassenanschrift.line.extension:Postfach

Short description

Postfachnummer

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

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.
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

rim: ADXP[partType=POB]

value

0..1

System.String

There are no (further) constraints on this element

Element id

RelatedPerson.address:Strassenanschrift.line.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

city

S Σ

1..1

Element id

RelatedPerson.address:Strassenanschrift.city

Short description

Stadt

Alternate names

Municpality

Definition

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

Comments

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.

Data type

Constraints

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

Examples
General

Erewhon

Mappings

v2: XAD.3
rim: AD.part[parttype = CTY]
vcard: locality
servd: ./Jurisdiction

district

0..0

There are no (further) constraints on this element

Element id

RelatedPerson.address:Strassenanschrift.district

Short description

District name (aka county)

Alternate names

County

Definition

The name of the administrative area (county).

Comments

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

Data type

Constraints

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

Examples
General

Madison

Mappings

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

state

0..1

stringBinding

There are no (further) constraints on this element

Element id

RelatedPerson.address:Strassenanschrift.state

Short description

Bundesland

Alternate names

Province, Territory

Definition

Name (oder Kürzel) des Bundeslandes.

Data type

ValueSetISO31662DE (preferred)

Binding

Constraints

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

Mappings

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

postalCode

S Σ

1..1

Element id

RelatedPerson.address:Strassenanschrift.postalCode

Short description

Postleitzahl

Alternate names

Zip

Definition

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

Comments

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.

Data type

Constraints

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

Examples
General

Mappings

v2: XAD.5
rim: AD.part[parttype = ZIP]
vcard: code
servd: ./PostalIdentificationCode

country

S Σ

1..1

stringBinding

Element id

RelatedPerson.address:Strassenanschrift.country

Short description

Land

Definition

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

Comments

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.

Data type

Binding

Iso3166-1-2 (preferred)

Constraints

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

Mappings

v2: XAD.6
rim: AD.part[parttype = CNT]
vcard: country
servd: ./Country

period

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.address:Strassenanschrift.period

Short description

Time period when address was/is in use

Definition

Time period when address was/is in use.

Requirements

Allows addresses to be placed in historical context.

Data type

Constraints

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

Examples
General

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

Mappings

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

Postfach

S Σ C

0..*

AddressDeBasisPattern

Element id

RelatedPerson.address:Postfach

Short description

Postfachadresse

Definition

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

Requirements

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

Comments

Adresse, die nur für postalische Zustellung genutzt werden kann.

Data type

AddressDeBasis

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
add-1: Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
add-2: Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
add-3: Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue())
add-4: Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein.
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty()
add-5: Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())
add-6: Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty()))
add-7: Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein.
extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))
address-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Pattern

{
  "type": "postal"
}

Examples
Beispiel für einfache Adresse

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

Mappings

v2: NK1-4
rim: addr
rim: n/a
v2: XAD
rim: AD
servd: Address

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.address:Postfach.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

RelatedPerson.address:Postfach.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

Stadtteil

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.address:Postfach.extension:Stadtteil

Short description

Stadt- oder Ortsteil

Alternate names

extensions, user content

Definition

A subsection of a municipality.

Comments

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: ADXP[partType=PRE]

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

RelatedPerson.address:Postfach.use

Short description

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

Definition

The purpose of this address.

Requirements

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

Comments

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

Data type

Binding

The use of an address.

AddressUse (required)

Constraints

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

Examples
General

home

Mappings

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

type

S Σ

1..1

codeBindingPattern

Element id

RelatedPerson.address:Postfach.type

Short description

Adresstyp

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

Hier ist stets der Wert postal anzugeben.
Begründung Pflichtfeld: Dient als Unterscheidungs- und Auswahlkriterium

Data type

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

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

Pattern

postal

Examples
General

both

Mappings

v2: XAD.18
rim: unique(./use)
vcard: address type parameter

text

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.address:Postfach.text

Short description

Text representation of the address

Definition

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

Requirements

A renderable, unencoded form.

Comments

Data type

Constraints

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

Examples
General

137 Nowhere Street, Erewhon 9132

Mappings

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

line

S Σ

1..3

Element id

RelatedPerson.address:Postfach.line

Short description

Adresszeile

Definition

Comments

Diese Komponente enthält die Postfachadresse als String der Form 'Postfach: 12345'. Bei Verwendung der Postfach-Extension, um die Postfachnummer 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.
Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.
Begründung für Reduktion der max. Kardinalität: Die maximale Kardinalität wurde in Übereinstimmung mit der DIN-Norm 5008 (Schreib- und Gestaltungsregeln für die Text- und Informationsverarbeitung) auf 3 beschränkt.

Data type

Constraints

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

Examples
General

137 Nowhere Street

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

Musterweg 42

Mappings

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

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.address:Postfach.line.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

extension

0..*

There are no (further) constraints on this element

Element id

RelatedPerson.address:Postfach.line.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Constraints

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

Strasse

0..0

Element id

RelatedPerson.address:Postfach.line.extension:Strasse

Short description

Strassenname (ohne Hausnummer)

Alternate names

extensions, user content

Definition

Comments

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

rim: ADXP[partType=STR]

Hausnummer

0..0

Element id

RelatedPerson.address:Postfach.line.extension:Hausnummer

Short description

Hausnummer

Alternate names

extensions, user content

Definition

Comments

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

rim: ADXP[partType=BNR]

Adresszusatz

0..0

Element id

RelatedPerson.address:Postfach.line.extension:Adresszusatz

Short description

Adresszusatz

Alternate names

extensions, user content

Definition

Comments

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

rim: ADXP[partType=ADL]

Postfach

0..1

Element id

RelatedPerson.address:Postfach.line.extension:Postfach

Short description

Postfachnummer

Alternate names

extensions, user content

Definition

Comments

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

rim: ADXP[partType=POB]

value

0..1

System.String

There are no (further) constraints on this element

Element id

RelatedPerson.address:Postfach.line.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

city

S Σ

1..1

Element id

RelatedPerson.address:Postfach.city

Short description

Stadt

Alternate names

Municpality

Definition

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

Comments

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.

Data type

Constraints

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

Examples
General

Erewhon

Mappings

v2: XAD.3
rim: AD.part[parttype = CTY]
vcard: locality
servd: ./Jurisdiction

district

0..0

There are no (further) constraints on this element

Element id

RelatedPerson.address:Postfach.district

Short description

District name (aka county)

Alternate names

County

Definition

The name of the administrative area (county).

Comments

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

Data type

Constraints

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

Examples
General

Madison

Mappings

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

state

0..1

stringBinding

There are no (further) constraints on this element

Element id

RelatedPerson.address:Postfach.state

Short description

Bundesland

Alternate names

Province, Territory

Definition

Name (oder Kürzel) des Bundeslandes.

Data type

ValueSetISO31662DE (preferred)

Binding

Constraints

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

Mappings

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

postalCode

S Σ

1..1

Element id

RelatedPerson.address:Postfach.postalCode

Short description

Postleitzahl

Alternate names

Zip

Definition

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

Comments

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.

Data type

Constraints

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

Examples
General

Mappings

v2: XAD.5
rim: AD.part[parttype = ZIP]
vcard: code
servd: ./PostalIdentificationCode

country

S Σ

1..1

stringBinding

Element id

RelatedPerson.address:Postfach.country

Short description

Land

Definition

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

Comments

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.

Data type

Binding

Iso3166-1-2 (preferred)

Constraints

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

Mappings

v2: XAD.6
rim: AD.part[parttype = CNT]
vcard: country
servd: ./Country

period

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.address:Postfach.period

Short description

Time period when address was/is in use

Definition

Time period when address was/is in use.

Requirements

Allows addresses to be placed in historical context.

Data type

Constraints

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

Examples
General

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

Mappings

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

photo

0..*

Attachment

There are no (further) constraints on this element

Element id

RelatedPerson.photo

Short description

Image of the person

Definition

Image of the person.

Requirements

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

Data type

Attachment

Constraints

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

Mappings

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

period

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.period

Short description

Period of time that this relationship is considered valid

Definition

The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.

Data type

Constraints

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

Mappings

w5: FiveWs.done[x]
rim: .effectiveTime

communication

0..*

BackboneElement

There are no (further) constraints on this element

Element id

RelatedPerson.communication

Short description

A language which may be used to communicate with about the patient's health

Definition

A language which may be used to communicate with about the patient's health.

Requirements

If a related person 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 RelatedPerson.Communication associations. If the RelatedPerson 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

BackboneElement

Constraints

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

Mappings

rim: LanguageCommunication

0..1

There are no (further) constraints on this element

Element id

RelatedPerson.communication.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

RelatedPerson.communication.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

RelatedPerson.communication.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

Requirements

Comments

Data type

Constraints

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

Mappings

rim: N/A

language

1..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

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

CodeableConcept

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

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

Mappings

rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code

preferred

0..1

There are no (further) constraints on this element

Element id

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