HiGHmed - Infection Control - ImplementationGuide

Person - Heilberufler

Abbildung Person (Heilberufler) - HiGHmed Use Case Infection Control

Beschreibung

Das vorliegende abgeleitete Profil beschreibt den Patient im HiGHmed Projekt, Infection Control.

Name	Canonical
Profile_HiGHmed_InfectionControl_Practitioner	http://highmed.org/fhir/StructureDefinition/ic/Practitioner

Differential

Profile_HiGHmed_InfectionControl_Practitioner (Practitioner)

Practitioner

There are no (further) constraints on this element

Element id

Practitioner

Short description

A person with a formal responsibility in the provisioning of healthcare or related services

Definition

A person who is directly or indirectly involved in the provisioning of healthcare.

Data type

Practitioner

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()

Mappings

rim: Entity. Role, or Act
v2: PRD (as one example)
rim: Role
servd: Provider

S Σ

0..1

string

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

string

Meta

There are no (further) constraints on this element

Element id

Practitioner.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Constraints

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

0..1

string

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

string

Mappings

rim: n/a

extension

0..*

Extension

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

Extension

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

S Σ

0..1

uri

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

uri

Constraints

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

profile

S Σ

0..*

canonical(StructureDefinition)

There are no (further) constraints on this element

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

canonical(StructureDefinition)

Constraints

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

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

uri

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

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

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

code

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

Extension

There are no (further) constraints on this element

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

Extension

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

Extension

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

Extension

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

S Σ

1..*

Identifier

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

Slicing

Unordered, Open, by $this(Pattern)

Constraints

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

Mappings

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

ANR

S Σ

0..*

IdentifierLanrPattern

Element id

Practitioner.identifier:ANR

Short description

An identifier intended for computation

Definition

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

Requirements

Often, specific identities are assigned for the agent.

Data type

IdentifierLanr

Conditions

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

Constraints

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

Pattern

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

Mappings

w5: FiveWs.identifier
v2: PRD-7 (or XCN.1)
rim: ./id
servd: ./Identifiers
rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier

active

0..1

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 Σ

1..*

HumanName

Element id

Practitioner.name

Short description

The name(s) associated with the practitioner

Definition

The name(s) associated with the practitioner.

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

The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate.

In general, select the value to be used in the ResourceReference.display based on this:

There is more than 1 name
Use = usual
Period is current to the date of the usage
Use = official
Other order as decided by internal business rules.

Data type

HumanName

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: XCN Components
rim: ./name
servd: ./PreferredName (GivenNames, FamilyName, TitleCode)

name

S Σ C

1..1

HumannameDeBasisPattern

Element id

Practitioner.name:name

Short description

Personenname

Definition

Personenname mit in Deutschland üblichen Erweiterungen

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

Pattern

{
  "use": "official"
}

Mappings

v2: XCN Components
rim: ./name
servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
rim: n/a
v2: XPN
rim: EN (actually, PN)
servd: ProviderName

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.name:name.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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 Σ ?!

1..1

codeBindingFixed ValuePattern

Element id

Practitioner.name:name.use

Short description

Definition

Identifies the purpose for this name.

Requirements

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

Comments

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

Data type

code

Binding

The use of a human name.

NameUse (required)

Constraints

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

Fixed value

official

Pattern

official

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

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

string

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

string

There are no (further) constraints on this element

Element id

Practitioner.name:name.family

Short description

Familienname

Alternate names

surname

Definition

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

Comments

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

Data type

string

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: 3120 + 3100 + 3101

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.name:name.family.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

string

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.name:name.family.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

S C

0..1

Extension(string)

Element id

Practitioner.name:name.family.extension:namenszusatz

Short description

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

Alternate names

extensions, user content

Definition

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

Comments

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

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.name:name.family.extension:nachname

Short description

Nachname ohne Vor- und Zusätze

Alternate names

extensions, user content

Definition

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

Comments

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

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.name:name.family.extension:vorsatzwort

Short description

Vorsatzwort

Alternate names

extensions, user content

Definition

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

Comments

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

Data type

Extension(string)

Extension URL

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

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:name.family.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

given

S Σ

1..*

string

There are no (further) constraints on this element

Element id

Practitioner.name:name.given

Short description

Vorname

Alternate names

first name, middle name

Definition

Vorname der Person

Comments

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

Data type

string

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

S Σ

0..*

string

There are no (further) constraints on this element

Element id

Practitioner.name:name.prefix

Short description

Namensteile vor dem Vornamen

Definition

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

Data type

string

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

string

There are no (further) constraints on this element

Element id

Practitioner.name:name.prefix.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

string

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.name:name.prefix.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

S C

0..*

Extension(code)

Element id

Practitioner.name:name.prefix.extension:prefix-qualifier

Short description

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

Alternate names

extensions, user content

Definition

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

Comments

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

Data type

Extension(code)

Extension URL

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

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:name.prefix.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

suffix

0..*

string

There are no (further) constraints on this element

Element id

Practitioner.name:name.suffix

Short description

Namensteile nach dem Nachnamen

Definition

Namensteile nach dem Nachnamen

Data type

string

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

Period

There are no (further) constraints on this element

Element id

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

Period

Constraints

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

Mappings

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

geburtsname

S Σ C

0..1

HumannameDeBasisPattern

Element id

Practitioner.name:geburtsname

Short description

Personenname

Definition

Personenname mit in Deutschland üblichen Erweiterungen

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

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

Pattern

{
  "use": "maiden"
}

Mappings

v2: XCN Components
rim: ./name
servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
rim: n/a
v2: XPN
rim: EN (actually, PN)
servd: ProviderName

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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 Σ ?!

1..1

codeBindingFixed ValuePattern

Element id

Practitioner.name:geburtsname.use

Short description

Definition

Identifies the purpose for this name.

Requirements

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

Comments

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

Data type

code

Binding

The use of a human name.

NameUse (required)

Constraints

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

Fixed value

maiden

Pattern

maiden

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.text

Short description

Text representation of the full name

Definition

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

Requirements

A renderable, unencoded form.

Comments

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

Data type

string

Constraints

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

Mappings

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

family

1..1

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.family

Short description

Familienname

Alternate names

surname

Definition

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

Comments

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

Data type

string

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: 3120 + 3100 + 3101

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.family.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

string

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.family.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

S C

0..1

Extension(string)

Element id

Practitioner.name:geburtsname.family.extension:namenszusatz

Short description

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

Alternate names

extensions, user content

Definition

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

Comments

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.name:geburtsname.family.extension:nachname

Short description

Nachname ohne Vor- und Zusätze

Alternate names

extensions, user content

Definition

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

Comments

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.name:geburtsname.family.extension:vorsatzwort

Short description

Vorsatzwort

Alternate names

extensions, user content

Definition

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

Comments

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

Data type

Extension(string)

Extension URL

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

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:geburtsname.family.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

given

0..0

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.given

Short description

Vorname

Alternate names

first name, middle name

Definition

Vorname der Person

Comments

Data type

string

Constraints

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

Mappings

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

prefix

0..0

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.prefix

Short description

Namensteile vor dem Vornamen

Definition

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

Data type

string

Constraints

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

Mappings

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

suffix

0..*

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.suffix

Short description

Namensteile nach dem Nachnamen

Definition

Namensteile nach dem Nachnamen

Data type

string

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

Period

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.period

Short description

Time period when name was/is in use

Definition

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

Requirements

Allows names to be placed in historical context.

Data type

Period

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

There are no (further) constraints on this element

Element id

Practitioner.telecom

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

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

ContactPoint

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

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.telecom.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

There are no (further) constraints on this element

Element id

Practitioner.telecom.system

Short description

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

Definition

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

Data type

code

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

string

There are no (further) constraints on this element

Element id

Practitioner.telecom.value

Short description

The actual contact point details

Definition

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

Requirements

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

Comments

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

Data type

string

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

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

code

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

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

Period

There are no (further) constraints on this element

Element id

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

Period

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 Σ

1..1

Address

Element id

Practitioner.address

Short description

Address(es) of the practitioner that are not role specific (typically home address)

Definition

Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.

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

The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).

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: ORC-24, STF-11, ROL-11, PRT-14
rim: ./addr
servd: ./Addresses

Strassenanschrift

S Σ C

0..*

AddressDeBasisPattern

Element id

Practitioner.address:Strassenanschrift

Short description

Eine Adresse gemäß postalischer Konventionen

Definition

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

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

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

Requirements

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 line.where(extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').valueString=$this).exists()

Pattern

{
  "type": "both"
}

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

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

Element id

Practitioner.address:Strassenanschrift.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

Extension(string)

Element id

Practitioner.address:Strassenanschrift.extension:Stadtteil

Short description

Stadt- oder Ortsteil

Alternate names

extensions, user content

Definition

A subsection of a municipality.

Comments

Data type

Extension(string)

Extension URL

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

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

code

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

codeBindingFixed ValuePattern

Element id

Practitioner.address:Strassenanschrift.type

Short description

postal | physical | both

Definition

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

Comments

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

Data type

code

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

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

Fixed value

both

Pattern

both

Examples
General

both

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

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

string

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.line

Short description

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

Definition

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

Data type

string

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

string

There are no (further) constraints on this element

Element id

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

string

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.line.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

S C

0..1

Extension(string)

Element id

Practitioner.address:Strassenanschrift.line.extension:Strasse

Short description

Strassenname (ohne Hausnummer)

Alternate names

extensions, user content

Definition

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

Comments

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.address:Strassenanschrift.line.extension:Hausnummer

Short description

Hausnummer

Alternate names

extensions, user content

Definition

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

Comments

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.address:Strassenanschrift.line.extension:Adresszusatz

Short description

Adresszusatz

Alternate names

extensions, user content

Definition

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

Comments

Data type

Extension(string)

Extension URL

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

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

Extension(string)

Element id

Practitioner.address:Strassenanschrift.line.extension:Postfach

Short description

Postfach

Alternate names

extensions, user content

Definition

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

Comments

Data type

Extension(string)

Extension URL

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

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.city

Short description

Name of city, town etc.

Alternate names

Municpality

Definition

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

Data type

string

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

string

There are no (further) constraints on this element

Element id

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

string

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:Strassenanschrift.state

Short description

Bundesland

Alternate names

Province, Territory

Definition

Name (oder Kürzel) des Bundeslandes.

Data type

string

Binding

ISO31662DE (preferred)

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.postalCode

Short description

Postleitzahl

Alternate names

Zip

Definition

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

Data type

string

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

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.country

Short description

Staat

Definition

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

Comments

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

Data type

string

Binding

Iso3166-1-2 (preferred)

Constraints

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

Mappings

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

period

0..1

Period

There are no (further) constraints on this element

Element id

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

Period

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.period.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

dateTime

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.period.start

Short description

Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Comments

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

Data type

dateTime

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

dateTime

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.period.end

Short description

End time with inclusive boundary, if not ongoing

Definition

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

Comments

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

Meaning when missing

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

Data type

dateTime

Conditions

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

Constraints

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

Mappings

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

Postfach

S Σ C

0..1

AddressDeBasisPattern

Element id

Practitioner.address:Postfach

Short description

Eine Adresse gemäß postalischer Konventionen

Definition

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

Requirements

Comments

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 line.where(extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').valueString=$this).exists()

Pattern

{
  "type": "postal"
}

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

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

Element id

Practitioner.address:Postfach.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

Extension(string)

Element id

Practitioner.address:Postfach.extension:Stadtteil

Short description

Stadt- oder Ortsteil

Alternate names

extensions, user content

Definition

A subsection of a municipality.

Comments

Data type

Extension(string)

Extension URL

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

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

code

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

codeBindingFixed ValuePattern

Element id

Practitioner.address:Postfach.type

Short description

postal | physical | both

Definition

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

Comments

Data type

code

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

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

Fixed value

postal

Pattern

postal

Examples
General

both

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

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

string

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.line

Short description

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

Definition

Data type

string

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

string

There are no (further) constraints on this element

Element id

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

string

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.line.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

Extension(string)

Element id

Practitioner.address:Postfach.line.extension:Strasse

Short description

Strassenname (ohne Hausnummer)

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(string)

Extension URL

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

Conditions

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

Constraints

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

Mappings

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

Hausnummer

0..0

Extension(string)

Element id

Practitioner.address:Postfach.line.extension:Hausnummer

Short description

Hausnummer

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(string)

Extension URL

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

Conditions

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

Constraints

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

Mappings

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

Adresszusatz

0..0

Extension(string)

Element id

Practitioner.address:Postfach.line.extension:Adresszusatz

Short description

Adresszusatz

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.address:Postfach.line.extension:Postfach

Short description

Postfach

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(string)

Extension URL

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

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.city

Short description

Name of city, town etc.

Alternate names

Municpality

Definition

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

Data type

string

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

string

There are no (further) constraints on this element

Element id

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

string

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:Postfach.state

Short description

Bundesland

Alternate names

Province, Territory

Definition

Name (oder Kürzel) des Bundeslandes.

Data type

string

Binding

ISO31662DE (preferred)

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.postalCode

Short description

Postleitzahl

Alternate names

Zip

Definition

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

Data type

string

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

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.country

Short description

Staat

Definition

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

Comments

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

Data type

string

Binding

Iso3166-1-2 (preferred)

Constraints

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

Mappings

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

period

0..1

Period

There are no (further) constraints on this element

Element id

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

Period

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.period.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

dateTime

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.period.start

Short description

Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Comments

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

Data type

dateTime

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

dateTime

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.period.end

Short description

End time with inclusive boundary, if not ongoing

Definition

Comments

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

Meaning when missing

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

Data type

dateTime

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

S Σ

0..1

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

code

Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)

Constraints

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

Mappings

v2: STF-5
rim: ./administrativeGender
servd: ./GenderCode

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.gender.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

string

extension

0..*

Extension

Element id

Practitioner.gender.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

other-amtlich

S C

0..1

Extension(Coding)

Element id

Practitioner.gender.extension:other-amtlich

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

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

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

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.gender.extension:other-amtlich.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Practitioner.gender.extension:other-amtlich.url

Short description

identifies the meaning of the extension

Definition

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

Comments

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

Data type

uri

Fixed value

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

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Practitioner.gender.extension:other-amtlich.value[x]

Short description

Value of extension

Definition

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

Binding

GenderAmtlichDE (required)

Constraints

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

Mappings

rim: N/A

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

value

0..1

System.String

There are no (further) constraints on this element

Element id

Practitioner.gender.value

Short description

Primitive value for code

Definition

Primitive value for code

Data type

System.String

birthDate

S Σ

1..1

date

There are no (further) constraints on this element

Element id

Practitioner.birthDate

Short description

The date on which the practitioner was born

Definition

The date of birth for the practitioner.

Requirements

Needed for identification.

Data type

date

Constraints

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

Mappings

v2: STF-6
rim: ./birthTime
servd: (not represented in ServD)

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.birthDate.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

string

extension

0..*

Extension

Element id

Practitioner.birthDate.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Constraints

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

data-absent-reason

S C

0..1

Extension(code)

Element id

Practitioner.birthDate.extension:data-absent-reason

Short description

Alternate names

extensions, user content

Definition

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

Comments

Data type

Extension(code)

Extension URL

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

Conditions

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

Constraints

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

Mappings

rim: ANY.nullFlavor

value

0..1

System.Date

There are no (further) constraints on this element

Element id

Practitioner.birthDate.value

Short description

Primitive value for date

Definition

The actual value

Data type

System.Date

photo

0..*

Attachment

There are no (further) constraints on this element

Element id

Practitioner.photo

Short description

Image of the person

Definition

Image of the person.

Requirements

Many EHR systems have the capability to capture an image of patients and personnel. 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

rim: ./subjectOf/ObservationEvent[code="photo"]/value
servd: ./ImageURI (only supports the URI reference)

qualification

1..*

BackboneElement

There are no (further) constraints on this element

Element id

Practitioner.qualification

Short description

Certification, licenses, or training pertaining to the provision of care

Definition

The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.

Data type

BackboneElement

Constraints

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

Mappings

v2: CER?
rim: .playingEntity.playingRole[classCode=QUAL].code
servd: ./Qualifications

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.qualification.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

Extension

There are no (further) constraints on this element

Element id

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

Extension

Constraints

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

Mappings

rim: N/A

identifier

0..*

Identifier

There are no (further) constraints on this element

Element id

Practitioner.qualification.identifier

Short description

An identifier for this qualification for the practitioner

Definition

An identifier that applies to this person's qualification in this role.

Requirements

Often, specific identities are assigned for the qualification.

Data type

Identifier

Constraints

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

Mappings

rim: .playingEntity.playingRole[classCode=QUAL].id

code

1..1

CodeableConcept

There are no (further) constraints on this element

Element id

Practitioner.qualification.code

Short description

Coded representation of the qualification

Definition

Coded representation of the qualification.

Data type

CodeableConcept

Binding

Specific qualification the practitioner has to provide a service.

v2.0360.2.7 (example)

Constraints

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

Mappings

rim: .playingEntity.playingRole[classCode=QUAL].code
servd: ./Qualifications.Value

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.qualification.code.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.qualification.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

coding

S Σ

1..*

CodingBinding

Element id

Practitioner.qualification.code.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

Comments

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

Data type

Coding

Binding

KBV_VS_Base_Practitioner_Speciality (preferred)

Constraints

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

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.qualification.code.text

Short description

Plain text representation of the concept

Definition

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

Requirements

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

Comments

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

Data type

string

Constraints

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

Mappings

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

period

0..1

Period

There are no (further) constraints on this element

Element id

Practitioner.qualification.period

Short description

Period during which the qualification is valid

Definition

Period during which the qualification is valid.

Requirements

Qualifications are often for a limited period of time, and can be revoked.

Data type

Period

Constraints

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

Mappings

rim: .playingEntity.playingRole[classCode=QUAL].effectiveTime
servd: ./Qualifications.StartDate and ./Qualifications.EndDate

issuer

0..1

Reference(Organization)

There are no (further) constraints on this element

Element id

Practitioner.qualification.issuer

Short description

Organization that regulates and issues the qualification

Definition

Organization that regulates and issues the qualification.

Data type

Reference(Organization)

Constraints

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

Mappings

rim: .playingEntity.playingRole[classCode=QUAL].scoper

communication

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Practitioner.communication

Short description

A language the practitioner can use in patient communication

Definition

A language the practitioner can use in patient communication.

Requirements

Knowing which language a practitioner speaks can help in facilitating communication with patients.

Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems 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

v2: PID-15, NK1-20, LAN-2
rim: ./languageCommunication
servd: ./Languages.LanguageSpokenCode

Mapping

Alle Elemente für das Konzept Person des Use Case - Infection Control lassen sich durch das oben genannte Profil wie folgt abbilden:

Logischer Datensatz	FHIR Element
Person.PersonenID	Practitioner.identifier:ANR
Art der Person	Implizite Entscheidung, das vorliegende Profil definiert eine Person als Heilberufler. Siehe Abschnitt Person - Patient für die Abbildung von Patienteninformationen.
Person.Titel	Practitioner.name:name.prefix
Person.Vorname	Practitioner.name:name.given
Person.WeitererVorname	Practitioner.name:name.given
Person.Nachname	Practitioner.name:name.family
Person.Suffix	Practitioner.name:name.suffix
Person.Geburtsdatum	Practitioner.birthDate
Person.Kontaktart	Practitioner.telecom.system
Person.Kontaktdaten	Practitioner.telecom.value
Person.PersönlicheDatenHeilberufler-Fachbezeichnung	Practitioner.qualification
Person.PersönlicheDatenHeilberufler-Adresse-Zeile	Practitioner.address:Strassenanschrift.line
Person.PersönlicheDatenHeilberufler-Adresse-Stadt	Practitioner.address:Strassenanschrift.city
Person.PersönlicheDatenHeilberufler-Adresse-Postleitzahl	Practitioner.address:Strassenanschrift.postalCode

Snapshot

Profile_HiGHmed_InfectionControl_Practitioner (Practitioner)

Practitioner

There are no (further) constraints on this element

Element id

Practitioner

Short description

A person with a formal responsibility in the provisioning of healthcare or related services

Definition

A person who is directly or indirectly involved in the provisioning of healthcare.

Data type

Practitioner

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()

Mappings

rim: Entity. Role, or Act
v2: PRD (as one example)
rim: Role
servd: Provider

S Σ

0..1

string

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

string

Meta

There are no (further) constraints on this element

Element id

Practitioner.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Constraints

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

0..1

string

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

string

Mappings

rim: n/a

extension

0..*

Extension

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

Comments

Data type

Extension

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

Data type

instant

Constraints

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

source

S Σ

0..1

uri

There are no (further) constraints on this element

Element id

Practitioner.meta.source

Short description

Identifies where the resource comes from

Definition

Comments

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

uri

Constraints

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

profile

S Σ

0..*

canonical(StructureDefinition)

There are no (further) constraints on this element

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

canonical(StructureDefinition)

Constraints

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

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

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

uri

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

Comments

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

Practitioner.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

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

Comments

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

Comments

Data type

Resource

Mappings

rim: N/A

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

Extension

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

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

Extension

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

S Σ

1..*

Identifier

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

Slicing

Unordered, Open, by $this(Pattern)

Constraints

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

Mappings

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

ANR

S Σ

0..*

IdentifierLanrPattern

Element id

Practitioner.identifier:ANR

Short description

An identifier intended for computation

Definition

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

Requirements

Often, specific identities are assigned for the agent.

Data type

IdentifierLanr

Conditions

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

Constraints

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

Pattern

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

Mappings

w5: FiveWs.identifier
v2: PRD-7 (or XCN.1)
rim: ./id
servd: ./Identifiers
rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier

active

0..1

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 Σ

1..*

HumanName

Element id

Practitioner.name

Short description

The name(s) associated with the practitioner

Definition

The name(s) associated with the practitioner.

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

The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate.

In general, select the value to be used in the ResourceReference.display based on this:

There is more than 1 name
Use = usual
Period is current to the date of the usage
Use = official
Other order as decided by internal business rules.

Data type

HumanName

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: XCN Components
rim: ./name
servd: ./PreferredName (GivenNames, FamilyName, TitleCode)

name

S Σ C

1..1

HumannameDeBasisPattern

Element id

Practitioner.name:name

Short description

Personenname

Definition

Personenname mit in Deutschland üblichen Erweiterungen

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

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

Pattern

{
  "use": "official"
}

Mappings

v2: XCN Components
rim: ./name
servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
rim: n/a
v2: XPN
rim: EN (actually, PN)
servd: ProviderName

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.name:name.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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 Σ ?!

1..1

codeBindingFixed ValuePattern

Element id

Practitioner.name:name.use

Short description

Definition

Identifies the purpose for this name.

Requirements

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

Comments

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

Data type

code

Binding

The use of a human name.

NameUse (required)

Constraints

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

Fixed value

official

Pattern

official

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

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

string

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

string

There are no (further) constraints on this element

Element id

Practitioner.name:name.family

Short description

Familienname

Alternate names

surname

Definition

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

Comments

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

Data type

string

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: 3120 + 3100 + 3101

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.name:name.family.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

string

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.name:name.family.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

S C

0..1

Extension(string)

Element id

Practitioner.name:name.family.extension:namenszusatz

Short description

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

Alternate names

extensions, user content

Definition

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

Comments

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.name:name.family.extension:nachname

Short description

Nachname ohne Vor- und Zusätze

Alternate names

extensions, user content

Definition

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

Comments

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.name:name.family.extension:vorsatzwort

Short description

Vorsatzwort

Alternate names

extensions, user content

Definition

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

Comments

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

Data type

Extension(string)

Extension URL

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

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:name.family.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

given

S Σ

1..*

string

There are no (further) constraints on this element

Element id

Practitioner.name:name.given

Short description

Vorname

Alternate names

first name, middle name

Definition

Vorname der Person

Comments

Data type

string

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

S Σ

0..*

string

There are no (further) constraints on this element

Element id

Practitioner.name:name.prefix

Short description

Namensteile vor dem Vornamen

Definition

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

Data type

string

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

string

There are no (further) constraints on this element

Element id

Practitioner.name:name.prefix.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

string

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.name:name.prefix.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

S C

0..*

Extension(code)

Element id

Practitioner.name:name.prefix.extension:prefix-qualifier

Short description

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

Alternate names

extensions, user content

Definition

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

Comments

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

Data type

Extension(code)

Extension URL

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

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:name.prefix.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

suffix

0..*

string

There are no (further) constraints on this element

Element id

Practitioner.name:name.suffix

Short description

Namensteile nach dem Nachnamen

Definition

Namensteile nach dem Nachnamen

Data type

string

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

Period

There are no (further) constraints on this element

Element id

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

Period

Constraints

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

Mappings

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

geburtsname

S Σ C

0..1

HumannameDeBasisPattern

Element id

Practitioner.name:geburtsname

Short description

Personenname

Definition

Personenname mit in Deutschland üblichen Erweiterungen

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

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

Pattern

{
  "use": "maiden"
}

Mappings

v2: XCN Components
rim: ./name
servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
rim: n/a
v2: XPN
rim: EN (actually, PN)
servd: ProviderName

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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 Σ ?!

1..1

codeBindingFixed ValuePattern

Element id

Practitioner.name:geburtsname.use

Short description

Definition

Identifies the purpose for this name.

Requirements

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

Comments

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

Data type

code

Binding

The use of a human name.

NameUse (required)

Constraints

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

Fixed value

maiden

Pattern

maiden

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.text

Short description

Text representation of the full name

Definition

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

Requirements

A renderable, unencoded form.

Comments

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

Data type

string

Constraints

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

Mappings

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

family

1..1

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.family

Short description

Familienname

Alternate names

surname

Definition

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

Comments

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

Data type

string

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: 3120 + 3100 + 3101

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.family.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

string

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.family.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

S C

0..1

Extension(string)

Element id

Practitioner.name:geburtsname.family.extension:namenszusatz

Short description

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

Alternate names

extensions, user content

Definition

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

Comments

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.name:geburtsname.family.extension:nachname

Short description

Nachname ohne Vor- und Zusätze

Alternate names

extensions, user content

Definition

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

Comments

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.name:geburtsname.family.extension:vorsatzwort

Short description

Vorsatzwort

Alternate names

extensions, user content

Definition

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

Comments

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

Data type

Extension(string)

Extension URL

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

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:geburtsname.family.value

Short description

Primitive value for string

Definition

The actual value

Data type

System.String

Maximum string length

1048576

given

0..0

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.given

Short description

Vorname

Alternate names

first name, middle name

Definition

Vorname der Person

Comments

Data type

string

Constraints

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

Mappings

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

prefix

0..0

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.prefix

Short description

Namensteile vor dem Vornamen

Definition

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

Data type

string

Constraints

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

Mappings

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

suffix

0..*

string

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.suffix

Short description

Namensteile nach dem Nachnamen

Definition

Namensteile nach dem Nachnamen

Data type

string

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

Period

There are no (further) constraints on this element

Element id

Practitioner.name:geburtsname.period

Short description

Time period when name was/is in use

Definition

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

Requirements

Allows names to be placed in historical context.

Data type

Period

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

There are no (further) constraints on this element

Element id

Practitioner.telecom

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

ContactPoint

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

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.telecom.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

There are no (further) constraints on this element

Element id

Practitioner.telecom.system

Short description

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

Definition

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

Data type

code

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

string

There are no (further) constraints on this element

Element id

Practitioner.telecom.value

Short description

The actual contact point details

Definition

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

Requirements

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

Comments

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

Data type

string

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

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

code

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

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

Period

There are no (further) constraints on this element

Element id

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

Period

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 Σ

1..1

Address

Element id

Practitioner.address

Short description

Address(es) of the practitioner that are not role specific (typically home address)

Definition

Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.

Requirements

Comments

The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).

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: ORC-24, STF-11, ROL-11, PRT-14
rim: ./addr
servd: ./Addresses

Strassenanschrift

S Σ C

0..*

AddressDeBasisPattern

Element id

Practitioner.address:Strassenanschrift

Short description

Eine Adresse gemäß postalischer Konventionen

Definition

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

Requirements

Comments

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 line.where(extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').valueString=$this).exists()

Pattern

{
  "type": "both"
}

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

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

Element id

Practitioner.address:Strassenanschrift.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

Extension(string)

Element id

Practitioner.address:Strassenanschrift.extension:Stadtteil

Short description

Stadt- oder Ortsteil

Alternate names

extensions, user content

Definition

A subsection of a municipality.

Comments

Data type

Extension(string)

Extension URL

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

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

code

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

codeBindingFixed ValuePattern

Element id

Practitioner.address:Strassenanschrift.type

Short description

postal | physical | both

Definition

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

Comments

Data type

code

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

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

Fixed value

both

Pattern

both

Examples
General

both

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

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

Data type

string

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.line

Short description

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

Definition

Data type

string

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

string

There are no (further) constraints on this element

Element id

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

string

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.line.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

S C

0..1

Extension(string)

Element id

Practitioner.address:Strassenanschrift.line.extension:Strasse

Short description

Strassenname (ohne Hausnummer)

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.address:Strassenanschrift.line.extension:Hausnummer

Short description

Hausnummer

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.address:Strassenanschrift.line.extension:Adresszusatz

Short description

Adresszusatz

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(string)

Extension URL

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

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

Extension(string)

Element id

Practitioner.address:Strassenanschrift.line.extension:Postfach

Short description

Postfach

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(string)

Extension URL

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

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.city

Short description

Name of city, town etc.

Alternate names

Municpality

Definition

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

Data type

string

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

string

There are no (further) constraints on this element

Element id

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

string

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:Strassenanschrift.state

Short description

Bundesland

Alternate names

Province, Territory

Definition

Name (oder Kürzel) des Bundeslandes.

Data type

string

Binding

ISO31662DE (preferred)

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.postalCode

Short description

Postleitzahl

Alternate names

Zip

Definition

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

Data type

string

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

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.country

Short description

Staat

Definition

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

Comments

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

Data type

string

Binding

Iso3166-1-2 (preferred)

Constraints

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

Mappings

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

period

0..1

Period

There are no (further) constraints on this element

Element id

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

Period

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.period.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

dateTime

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.period.start

Short description

Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Comments

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

Data type

dateTime

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

dateTime

There are no (further) constraints on this element

Element id

Practitioner.address:Strassenanschrift.period.end

Short description

End time with inclusive boundary, if not ongoing

Definition

Comments

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

Meaning when missing

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

Data type

dateTime

Conditions

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

Constraints

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

Mappings

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

Postfach

S Σ C

0..1

AddressDeBasisPattern

Element id

Practitioner.address:Postfach

Short description

Eine Adresse gemäß postalischer Konventionen

Definition

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

Requirements

Comments

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 line.where(extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').valueString=$this).exists()

Pattern

{
  "type": "postal"
}

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

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

Element id

Practitioner.address:Postfach.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

Extension(string)

Element id

Practitioner.address:Postfach.extension:Stadtteil

Short description

Stadt- oder Ortsteil

Alternate names

extensions, user content

Definition

A subsection of a municipality.

Comments

Data type

Extension(string)

Extension URL

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

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

code

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

codeBindingFixed ValuePattern

Element id

Practitioner.address:Postfach.type

Short description

postal | physical | both

Definition

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

Comments

Data type

code

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

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

Fixed value

postal

Pattern

postal

Examples
General

both

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

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

string

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.line

Short description

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

Definition

Data type

string

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

string

There are no (further) constraints on this element

Element id

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

string

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.line.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

Extension(string)

Element id

Practitioner.address:Postfach.line.extension:Strasse

Short description

Strassenname (ohne Hausnummer)

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(string)

Extension URL

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

Conditions

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

Constraints

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

Mappings

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

Hausnummer

0..0

Extension(string)

Element id

Practitioner.address:Postfach.line.extension:Hausnummer

Short description

Hausnummer

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(string)

Extension URL

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

Conditions

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

Constraints

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

Mappings

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

Adresszusatz

0..0

Extension(string)

Element id

Practitioner.address:Postfach.line.extension:Adresszusatz

Short description

Adresszusatz

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(string)

Extension URL

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

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

S C

0..1

Extension(string)

Element id

Practitioner.address:Postfach.line.extension:Postfach

Short description

Postfach

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(string)

Extension URL

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

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.city

Short description

Name of city, town etc.

Alternate names

Municpality

Definition

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

Data type

string

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

string

There are no (further) constraints on this element

Element id

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

string

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:Postfach.state

Short description

Bundesland

Alternate names

Province, Territory

Definition

Name (oder Kürzel) des Bundeslandes.

Data type

string

Binding

ISO31662DE (preferred)

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.postalCode

Short description

Postleitzahl

Alternate names

Zip

Definition

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

Data type

string

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

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.country

Short description

Staat

Definition

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

Comments

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

Data type

string

Binding

Iso3166-1-2 (preferred)

Constraints

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

Mappings

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

period

0..1

Period

There are no (further) constraints on this element

Element id

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

Period

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

string

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.period.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

dateTime

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.period.start

Short description

Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Comments

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

Data type

dateTime

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

dateTime

There are no (further) constraints on this element

Element id

Practitioner.address:Postfach.period.end

Short description

End time with inclusive boundary, if not ongoing

Definition

Comments

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

Meaning when missing

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

Data type

dateTime

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

S Σ

0..1

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

code

Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)

Constraints

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

Mappings

v2: STF-5
rim: ./administrativeGender
servd: ./GenderCode

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.gender.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

string

extension

0..*

Extension

Element id

Practitioner.gender.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

other-amtlich

S C

0..1

Extension(Coding)

Element id

Practitioner.gender.extension:other-amtlich

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

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

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

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.gender.extension:other-amtlich.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Practitioner.gender.extension:other-amtlich.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

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

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Practitioner.gender.extension:other-amtlich.value[x]

Short description

Value of extension

Definition

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

Binding

GenderAmtlichDE (required)

Constraints

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

Mappings

rim: N/A

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

value

0..1

System.String

There are no (further) constraints on this element

Element id

Practitioner.gender.value

Short description

Primitive value for code

Definition

Primitive value for code

Data type

System.String

birthDate

S Σ

1..1

date

There are no (further) constraints on this element

Element id

Practitioner.birthDate

Short description

The date on which the practitioner was born

Definition

The date of birth for the practitioner.

Requirements

Needed for identification.

Data type

date

Constraints

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

Mappings

v2: STF-6
rim: ./birthTime
servd: (not represented in ServD)

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.birthDate.id

Short description

xml:id (or equivalent in JSON)

Definition

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

Data type

string

extension

0..*

Extension

Element id

Practitioner.birthDate.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Constraints

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

data-absent-reason

S C

0..1

Extension(code)

Element id

Practitioner.birthDate.extension:data-absent-reason

Short description

Alternate names

extensions, user content

Definition

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

Comments

Data type

Extension(code)

Extension URL

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

Conditions

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

Constraints

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

Mappings

rim: ANY.nullFlavor

value

0..1

System.Date

There are no (further) constraints on this element

Element id

Practitioner.birthDate.value

Short description

Primitive value for date

Definition

The actual value

Data type

System.Date

photo

0..*

Attachment

There are no (further) constraints on this element

Element id

Practitioner.photo

Short description

Image of the person

Definition

Image of the person.

Requirements

Many EHR systems have the capability to capture an image of patients and personnel. 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

rim: ./subjectOf/ObservationEvent[code="photo"]/value
servd: ./ImageURI (only supports the URI reference)

qualification

1..*

BackboneElement

There are no (further) constraints on this element

Element id

Practitioner.qualification

Short description

Certification, licenses, or training pertaining to the provision of care

Definition

Data type

BackboneElement

Constraints

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

Mappings

v2: CER?
rim: .playingEntity.playingRole[classCode=QUAL].code
servd: ./Qualifications

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.qualification.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

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

Extension

There are no (further) constraints on this element

Element id

Practitioner.qualification.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

Extension

Constraints

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

Mappings

rim: N/A

identifier

0..*

Identifier

There are no (further) constraints on this element

Element id

Practitioner.qualification.identifier

Short description

An identifier for this qualification for the practitioner

Definition

An identifier that applies to this person's qualification in this role.

Requirements

Often, specific identities are assigned for the qualification.

Data type

Identifier

Constraints

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

Mappings

rim: .playingEntity.playingRole[classCode=QUAL].id

code

1..1

CodeableConcept

There are no (further) constraints on this element

Element id

Practitioner.qualification.code

Short description

Coded representation of the qualification

Definition

Coded representation of the qualification.

Data type

CodeableConcept

Binding

Specific qualification the practitioner has to provide a service.

v2.0360.2.7 (example)

Constraints

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

Mappings

rim: .playingEntity.playingRole[classCode=QUAL].code
servd: ./Qualifications.Value

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.qualification.code.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Practitioner.qualification.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

coding

S Σ

1..*

CodingBinding

Element id

Practitioner.qualification.code.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

Comments

Data type

Coding

Binding

KBV_VS_Base_Practitioner_Speciality (preferred)

Constraints

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

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

Practitioner.qualification.code.text

Short description

Plain text representation of the concept

Definition

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

Requirements

Comments

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

Data type

string

Constraints