Implementierungsleitfaden für DEMIS Common (Basismeldeinhalte)

There are no (further) constraints on this element

Element id

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

0..1

There are no (further) constraints on this element

Element id

Practitioner.meta.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

Practitioner.meta.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

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

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

versionId

0..1

There are no (further) constraints on this element

Element id

Practitioner.meta.versionId

Short description

Version specific identifier

Definition

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

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Data type

Constraints

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

lastUpdated

0..1

instant

There are no (further) constraints on this element

Element id

Practitioner.meta.lastUpdated

Short description

When the resource version last changed

Definition

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

Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Data type

instant

Constraints

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

source

0..1

There are no (further) constraints on this element

Element id

Practitioner.meta.source

Short description

Identifies where the resource comes from

Definition

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

Comments

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

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

Data type

canonical(StructureDefinition)

Constraints

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

profile

S Σ

1..1

canonical(StructureDefinition)Pattern

Element id

Practitioner.meta.profile

Short description

Profiles this resource claims to conform to

Definition

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

Comments

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

Data type

Constraints

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

Pattern

https://demis.rki.de/fhir/StructureDefinition/Notifier

security

0..*

CodingBinding

There are no (further) constraints on this element

Element id

Practitioner.meta.security

Short description

Security Labels applied to this resource

Definition

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

Comments

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

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

Constraints

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

tag

0..*

Coding

There are no (further) constraints on this element

Element id

Practitioner.meta.tag

Short description

Tags applied to this resource

Definition

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

Comments

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

Data type

Coding

Binding

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

CommonTags (example)

Constraints

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

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Practitioner.implicitRules

Short description

A set of rules under which this content was created

Definition

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

Comments

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

Data type

Constraints

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

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

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

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

Practitioner.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

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

Comments

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

Data type

Resource

Mappings

rim: N/A

extension

0..*

Element id

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

Data type

https://demis.rki.de/fhir/StructureDefinition/Salutation

Slicing

Unordered, Open, by url(Value)

Constraints

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

Mappings

rim: N/A

salutation

S C

0..1

Extension(Coding)

Element id

Practitioner.extension:salutation

Short description

Anrede des Melders

Alternate names

extensions, user content

Definition

Anrede des Melders. Der Wert muss entsprechend des vom RKI definierten ValueSets (https://demis.rki.de/fhir/ValueSet/salutation) im coding Element dargestellt werden.

Comments

Data type

Extension(Coding)

Extension URL

Conditions

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

Constraints

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

Mappings

rim: N/A
rim: n/a

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

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

Identifier

There are no (further) constraints on this element

Element id

Practitioner.identifier

Short description

An identifier for the person as this agent

Definition

An identifier that applies to this person in this role.

Requirements

Often, specific identities are assigned for the agent.

Data type

Identifier

Constraints

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

Mappings

w5: FiveWs.identifier
v2: PRD-7 (or XCN.1)
rim: ./id
servd: ./Identifiers

active

0..0

boolean

There are no (further) constraints on this element

Element id

Practitioner.active

Short description

Whether this practitioner's record is in active use

Definition

Whether this practitioner's record is in active use.

Requirements

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

Comments

If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.

Meaning when missing

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

Data type

boolean

Constraints

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

Mappings

w5: FiveWs.status
rim: ./statusCode

name

S Σ C

1..1

HumannameDeBasis

Element id

Practitioner.name

Short description

Name des Melders

Definition

Name des Melders. Mindestens ein Vorname und der Nachname müssen angegeben werden.

Requirements

The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.

Comments

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

Data type

HumannameDeBasis

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: XCN Components
rim: ./name
servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
rim: n/a
v2: XPN
rim: EN (actually, PN)
servd: ProviderName

0..1

There are no (further) constraints on this element

Element id

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

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

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Practitioner.name.use

Short description

Definition

Identifies the purpose for this name.

Requirements

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

Comments

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

Data type

Binding

The use of a human name.

NameUse (required)

Constraints

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

Mappings

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

text

0..1

There are no (further) constraints on this element

Element id

Practitioner.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 Σ

1..1

There are no (further) constraints on this element

Element id

Practitioner.name.family

Short description

Familienname

Alternate names

surname

Definition

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

Comments

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

Data type

Constraints

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

Mappings

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

0..1

There are no (further) constraints on this element

Element id

Practitioner.name.family.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

extension

0..*

There are no (further) constraints on this element

Element id

Practitioner.name.family.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Constraints

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

namenszusatz

0..1

There are no (further) constraints on this element

Element id

Practitioner.name.family.extension:namenszusatz

Short description

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

Alternate names

extensions, user content

Definition

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

Comments

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

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

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

nachname

0..1

There are no (further) constraints on this element

Element id

Practitioner.name.family.extension:nachname

Short description

Nachname ohne Vor- und Zusätze

Alternate names

extensions, user content

Definition

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

Comments

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

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

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

vorsatzwort

0..1

There are no (further) constraints on this element

Element id

Practitioner.name.family.extension:vorsatzwort

Short description

Vorsatzwort

Alternate names

extensions, user content

Definition

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

Comments

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

Data type

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

Extension URL

Conditions

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

Constraints

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

Mappings

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

value

0..1

System.String

There are no (further) constraints on this element

Element id

Practitioner.name.family.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

given

S Σ

1..*

There are no (further) constraints on this element

Element id

Practitioner.name.given

Short description

Vorname

Alternate names

first name, middle name

Definition

Vorname der Person

Comments

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

Data type

Constraints

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

Mappings

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

prefix

0..*

There are no (further) constraints on this element

Element id

Practitioner.name.prefix

Short description

Namensteile vor dem Vornamen

Definition

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

Data type

Constraints

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

Mappings

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

0..1

There are no (further) constraints on this element

Element id

Practitioner.name.prefix.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

extension

0..*

There are no (further) constraints on this element

Element id

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

Constraints

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

prefix-qualifier

0..*

Extension(code)

There are no (further) constraints on this element

Element id

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

Constraints

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

Mappings

rim: ENXP.qualifier

value

0..1

System.String

There are no (further) constraints on this element

Element id

Practitioner.name.prefix.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

suffix

0..*

There are no (further) constraints on this element

Element id

Practitioner.name.suffix

Short description

Namensteile nach dem Nachnamen

Definition

Namensteile nach dem Nachnamen

Data type

Constraints

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

Mappings

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

period

0..1

There are no (further) constraints on this element

Element id

Practitioner.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 Σ

1..*

Element id

Practitioner.telecom

Short description

Kontaktangaben des Melders

Definition

Kontaktangaben des Melders. Telefonnummern und E-Mailadressen können angegeben werden. Mindestens eine Telefonnummer muss angegeben werden.

Requirements

Need to know how to reach a practitioner independent to any roles the practitioner may have.

Comments

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.

Data type

Slicing

Unordered, Open, by system(Value)

Constraints

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

Mappings

v2: PRT-15, STF-10, ROL-12
rim: ./telecom
servd: ./ContactPoints

0..*

There are no (further) constraints on this element

Element id

Practitioner.telecom:Email

Short description

A contact detail for the practitioner (that apply to all roles)

Definition

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

Requirements

Need to know how to reach a practitioner independent to any roles the practitioner may have.

Comments

Data type

Constraints

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

Mappings

v2: PRT-15, STF-10, ROL-12
rim: ./telecom
servd: ./ContactPoints

0..1

There are no (further) constraints on this element

Element id

Practitioner.telecom:Email.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

Practitioner.telecom:Email.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

codeBindingFixed Value

Element id

Practitioner.telecom:Email.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.

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

Fixed value

email

Mappings

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

value

S Σ C

1..1

Element id

Practitioner.telecom:Email.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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
validEmailAddress: Die E-Mail-Adresse muss valide sein.
$this.matches('^[a-zA-Z0-9._%+-]+@(?:[a-zA-Z0-9-]+[.])+[a-zA-Z0-9]{2,63}$')

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

Practitioner.telecom:Email.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

There are no (further) constraints on this element

Element id

Practitioner.telecom:Email.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

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

Practitioner.telecom:Email.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

Phone

S Σ

1..1

There are no (further) constraints on this element

Element id

Practitioner.telecom:Phone

Short description

A contact detail for the practitioner (that apply to all roles)

Definition

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

Requirements

Need to know how to reach a practitioner independent to any roles the practitioner may have.

Comments

Data type

Constraints

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

Mappings

v2: PRT-15, STF-10, ROL-12
rim: ./telecom
servd: ./ContactPoints

0..1

There are no (further) constraints on this element

Element id

Practitioner.telecom:Phone.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..*

Element id

Practitioner.telecom:Phone.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

comment

0..1

Element id

Practitioner.telecom:Phone.extension:comment

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

https://demis.rki.de/fhir/StructureDefinition/Comment

Extension URL

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

system

S Σ C

1..1

codeBindingFixed Value

Element id

Practitioner.telecom:Phone.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.

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

Fixed value

phone

Mappings

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

value

S Σ C

1..1

Element id

Practitioner.telecom:Phone.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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
validPhoneNumber: Die Telefonnummer muss valide sein.
$this.matches('^[0+][0-9 \\-\$\$]{6,50}$')

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

Practitioner.telecom:Phone.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

There are no (further) constraints on this element

Element id

Practitioner.telecom:Phone.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

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

Practitioner.telecom:Phone.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

address

S Σ C

0..1

AddressDeBasis

Element id

Practitioner.address

Short description

Adresse des Melders

Definition

Adresse des Melders

Requirements

The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.

Comments

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

Data type

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

Examples
Beispiel für einfache Adresse

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

Mappings

v2: ORC-24, STF-11, ROL-11, PRT-14
rim: ./addr
servd: ./Addresses
rim: n/a
v2: XAD
rim: AD
servd: Address

0..1

There are no (further) constraints on this element

Element id

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

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

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

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

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

0..1

codeBinding

There are no (further) constraints on this element

Element id

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

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

Data type

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

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

Examples
General

both

Mappings

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

text

0..1

There are no (further) constraints on this element

Element id

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

There are no (further) constraints on this element

Element id

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

Data type

Constraints

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

Examples
General

137 Nowhere Street

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

Musterweg 42

Mappings

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

0..1

There are no (further) constraints on this element

Element id

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

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

Constraints

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

Strasse

0..1

There are no (further) constraints on this element

Element id

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

Constraints

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

Mappings

rim: ADXP[partType=STR]
KVDT: 3107
BDT: 3107

Hausnummer

0..1

There are no (further) constraints on this element

Element id

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

Constraints

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

Mappings

rim: ADXP[partType=BNR]
KVDT: 3109
BDT: 3109

Adresszusatz

0..1

There are no (further) constraints on this element

Element id

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

Constraints

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

Mappings

rim: ADXP[partType=ADL]
KVDT: 3115
BDT: 3115

Postfach

0..0

Element id

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

Constraints

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

Mappings

rim: ADXP[partType=POB]
KVDT: 3123
BDT: 3123

value

0..1

System.String

There are no (further) constraints on this element

Element id

Practitioner.address.line.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

city

S Σ

1..1

There are no (further) constraints on this element

Element id

Practitioner.address.city

Short description

Name of city, town etc.

Alternate names

Municpality

Definition

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

Data type

Constraints

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

Examples
General

Erewhon

Mappings

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

district

0..0

There are no (further) constraints on this element

Element id

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

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

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

There are no (further) constraints on this element

Element id

Practitioner.address.postalCode

Short description

Postleitzahl

Alternate names

Zip

Definition

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

Data type

Constraints

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

Examples
General

Mappings

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

country

S Σ

1..1

stringBinding

Element id

Practitioner.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 human readable country name.

Data type

Binding

Iso3166-1-2 (extensible)

Constraints

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

Mappings

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

period

0..1

There are no (further) constraints on this element

Element id

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

Data type

Constraints

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

Examples
General

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

Mappings

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

0..1

There are no (further) constraints on this element

Element id

Practitioner.address.period.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

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

Constraints

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

Mappings

rim: n/a

start

Σ C

0..1

There are no (further) constraints on this element

Element id

Practitioner.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: per-1

Constraints

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

Mappings

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

end

Σ C

0..1

There are no (further) constraints on this element

Element id

Practitioner.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 no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Comments

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

Meaning when missing

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

Data type

Conditions

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

Constraints

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

Mappings

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

gender

0..0

codeBinding

There are no (further) constraints on this element

Element id

Practitioner.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 to address the person correctly.

Data type