Profil: Patient (Patient)


Fachlicher Kontext

Dieses Profil bildet einen Patienten im Kontext einer Terminbuchung ab. Auf Basis der Patientendetails und anderer Merkmale kann ein Matching stattfinden, um den passenden 116117 Termin zur Abrechnung eines Behandlungsfalls zu identifizieren.


Folgende Patientendaten werden durch den 116117 Terminservice verarbeitet:

  • Name
  • Geschlecht
  • Geburtsdatum
  • Versichertennummer der elektronischen Gesundheitskarte (eGK) und/oder der Krankenversichertenkarte (KVK) (optional)
  • Akademischer Titel (optional)
  • Straßenanschrift und/oder Postfach (optional)
  • Telefonnummer (optional)
  • E-Mail-Adresse (optional)

Bitte beachten: Die Versichertennummer eines Patienten wird aktuell nur gespeichert, wenn der Vermittlungscode zur Terminvermittlung für den Patienten über die Schnittstelle 116117 Terminservice – Vermittlungscode angefordert wurde. In der Schnittstelle 116117 Terminservice – Vermittlungscode ist die Versichertennummer eine Pflichtangabe. Bei anderen Schnittstellen (bspw. dem 116117 Terminservice für Patienten) kann die Versichertennummer aktuell nicht angegeben und somit auch nicht gespeichert werden. Daher kann es vorkommen, dass zu einem Patienten keine Versichertennummer im 116117 Terminservice hinterlegt ist.


FHIR-Profil

Name KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient
Type Patient
Base Definition https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Patient|1.6.0 (Version: 1.6.0)
Canonical URL https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient
Beschreibung

Diese Ressource beschreibt eine Person, die eine oder mehrere medizinische Leistungen in Anspruch nimmt.


idΣ0..1string
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
kvdigitalProfilΣ1..1canonical(StructureDefinition)Pattern
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriPattern
versionΣ0..1string
codeΣ1..1codePattern
displayΣ0..1stringPattern
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ1..1uri
valueΣ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriAuto ValuePattern
versionS Σ0..1string
codeS Σ1..1codeAuto ValuePattern
displayS Σ1..1stringPattern
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ1..1uriAuto Value
valueS Σ C1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBindingAuto Value
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriPattern
versionΣ0..1string
codeΣ1..1codePattern
displayΣ0..1stringPattern
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ0..1uri
valueΣ1..1string
periodΣ0..1Period
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
typeΣ0..1uriBinding
identifierΣ0..1IdentifierIknr
displayΣ1..1string
reisepassnummerΣ0..*KBV_PR_Base_Identifier_Reisepassnummer
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriAuto ValuePattern
versionS Σ0..1string
codeS Σ1..1codeAuto ValuePattern
displayS Σ1..1stringPattern
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ1..1uriAuto Value
valueS Σ C1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uriPattern
versionΣ0..1string
codeΣ0..1codePattern
displayΣ0..1stringPattern
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ1..1uriAuto Value
valueΣ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
activeΣ ?!0..1boolean
id0..1string
extensionC0..*Extension
useS Σ ?!1..1codeBindingPattern
textΣ0..1string
id0..1string
id0..1string
extensionC0..*Extension
url1..1uriAuto Value
valueStringstring
id0..1string
extensionC0..0Extension
url1..1uriAuto Value
valueStringstring
id0..1string
extensionC0..0Extension
url1..1uriAuto Value
valueStringstring
value0..1System.String
givenS Σ1..1string
id0..1string
id0..1string
extensionC0..0Extension
url1..1uriAuto Value
valueCodeS0..1codeBindingAuto Value
value0..1System.String
suffixΣ0..1string
periodΣ0..1Period
geburtsnameΣ C0..1KBV_PR_Base_Datatype_Maiden_Name
id0..1string
extensionC0..*Extension
systemS Σ C1..1codeBindingAuto Value
valueS Σ1..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ0..1Period
id0..1string
extensionC0..*Extension
systemS Σ C1..1codeBindingAuto Value
valueS Σ1..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ0..1Period
id0..1string
id0..1string
extensionC0..*Extension
url1..1uriAuto Value
id0..1string
extensionC0..*Extension
systemS Σ1..1uriAuto Value
versionS Σ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
value0..1System.String
id0..1string
id0..1string
extensionC0..0Extension
url1..1uriAuto Value
valueCodeS0..1codeBindingAuto Value
value0..1System.Date
deceasedBooleanboolean
deceasedDateTimedateTime
id0..1string
StadtteilC0..1Extension(string)
useΣ ?!0..1codeBinding
typeS Σ1..1codeBindingPattern
textΣ0..1string
id0..1string
id0..1string
extensionC0..0Extension
url1..1uriAuto Value
valueStringstring
id0..1string
extensionC0..0Extension
url1..1uriAuto Value
valueStringstring
id0..1string
extensionC0..0Extension
url1..1uriAuto Value
valueStringstring
PostfachC0..0Extension(string)
value0..1System.String
cityS Σ1..1string
districtΣ0..0string
stateΣ0..1stringBinding
postalCodeS Σ0..1string
countryS Σ1..1stringBinding
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
StadtteilC0..1Extension(string)
useΣ ?!0..1codeBinding
typeS Σ1..1codeBindingPattern
textΣ0..1string
id0..1string
StrasseC0..0Extension(string)
HausnummerC0..0Extension(string)
AdresszusatzC0..0Extension(string)
id0..1string
extensionC0..0Extension
url1..1uriAuto Value
valueStringstring
value0..1System.String
cityS Σ1..1string
districtΣ0..0string
stateΣ0..1stringBinding
postalCodeS Σ0..1string
countryS Σ1..1stringBinding
id0..1string
extensionC0..*Extension
startΣ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
multipleBirthBooleanboolean
multipleBirthIntegerinteger
photo0..*Attachment
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
relationship0..*CodeableConceptBinding
name0..1HumanName
telecom0..*ContactPoint
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1stringBinding
periodΣ0..1Period
gender0..1codeBinding
organizationC0..1Reference(Organization)
period0..1Period
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
language1..1CodeableConceptBinding
preferred0..1boolean
generalPractitioner0..*Reference(Organization | Practitioner | PractitionerRole)
managingOrganizationΣ0..1Reference(Organization)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
otherΣ1..1Reference(Patient | RelatedPerson)
typeΣ1..1codeBinding
Patient
ShortPatient, der eine medizinische Leistung in Anspruch nimmt
Definition

Diese Ressource beschreibt eine Person, die eine oder mehrere medizinische Leistungen in Anspruch nimmt.

Cardinality0..*
AliasSubjectOfCare Client Resident
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()
  • pat-de-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
    gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
Mappings
  • rim: Entity. Role, or Act
  • rim: Patient[classCode=PAT]
  • cda: ClinicalDocument.recordTarget.patientRole
Patient.id
ShortLogical 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.

Cardinality0..1
Typestring
SummaryTrue
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.

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

Cardinality1..1
TypeMeta
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Patient.meta.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.meta.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.meta.versionId
ShortVersion 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.

Cardinality0..1
Typeid
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Patient.meta.lastUpdated
ShortWhen the resource version last changed
Definition

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

Cardinality0..1
Typeinstant
SummaryTrue
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.

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

Cardinality0..1
Typeuri
SummaryTrue
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.

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

Cardinality1..*
Typecanonical(StructureDefinition)
SummaryTrue
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.

Slicing

Unordered, Open, by $this(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Patient.meta.profile:kvdigitalProfil
ShortProfiles 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.

Cardinality1..1
Typecanonical(StructureDefinition)
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient|1.0.0
Patient.meta.security
ShortSecurity Labels applied to this resource
Definition

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

Cardinality0..*
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

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

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

Cardinality0..*
TypeCoding
Binding

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

CommonTags (example)

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

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

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Patient.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
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).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Patient.text
ShortText summary of the resource, for human interpretation
Definition

In diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind.

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
Patient.contained
ShortContained, inline 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.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
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.

Mappings
  • rim: N/A
Patient.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.modifierExtension
ShortExtensions that cannot be ignored
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).

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, user content
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

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.

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
Patient.identifier
ShortIdentifier des Patienten
Definition

An identifier for this patient.

Cardinality0..*
TypeIdentifier
Must SupportTrue
SummaryTrue
Requirements

Patients are almost always assigned specific numerical identifiers.

Slicing

Unordered, Open, by type(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: PID-3
  • rim: id
  • cda: .id
Patient.identifier:pid
ShortAn identifier intended for computation
Definition

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

Cardinality0..*
TypeIdentifierPid
SummaryTrue
Requirements

Patients are almost always assigned specific numerical identifiers.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: PID-3
  • rim: id
  • cda: .id
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
Patient.identifier:pid.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:pid.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:pid.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

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

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
Patient.identifier:pid.type
ShortDescription of identifier
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

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

IdentifierTypeDeBasis (extensible)

SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code": "MR"
    }
  ]
}
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
Patient.identifier:pid.type.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:pid.type.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:pid.type.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality1..1
TypeCoding
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
  "code": "MR"
}
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Patient.identifier:pid.type.coding.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:pid.type.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:pid.type.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality1..1
Typeuri
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
http://terminology.hl7.org/CodeSystem/v2-0203
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Patient.identifier:pid.type.coding.version
ShortVersion of the system - if relevant
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Patient.identifier:pid.type.coding.code
ShortSymbol in syntax defined by the system
Definition

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

Cardinality1..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
MR
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Patient.identifier:pid.type.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
Medical record number
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Patient.identifier:pid.type.coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

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

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Patient.identifier:pid.type.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
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.

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
Patient.identifier:pid.system
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality1..1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Patient.identifier:pid.value
ShortThe value that is unique
Definition

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

Cardinality1..1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Patient.identifier:pid.period
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Patient.identifier:pid.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Patient.identifier:versichertenId_GKV
ShortIdentifier eGK
Definition

Versichertennummer der elektronischen Gesundheitskarte (eGK)

Cardinality0..1
TypeIdentifierKvid10
Must SupportTrue
SummaryTrue
Requirements

Patients are almost always assigned specific numerical identifiers.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: PID-3
  • rim: id
  • cda: .id
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
Patient.identifier:versichertenId_GKV.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:versichertenId_GKV.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:versichertenId_GKV.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

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

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
Patient.identifier:versichertenId_GKV.type
ShortDescription of identifier
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

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

IdentifierTypeDeBasis (extensible)

Must SupportTrue
SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://fhir.de/CodeSystem/identifier-type-de-basis",
      "code": "GKV"
    }
  ]
}
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
Patient.identifier:versichertenId_GKV.type.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:versichertenId_GKV.type.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:versichertenId_GKV.type.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality1..1
TypeCoding
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "system": "http://fhir.de/CodeSystem/identifier-type-de-basis",
  "code": "GKV"
}
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Patient.identifier:versichertenId_GKV.type.coding.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:versichertenId_GKV.type.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:versichertenId_GKV.type.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Auto Value
http://fhir.de/CodeSystem/identifier-type-de-basis
Pattern
http://fhir.de/CodeSystem/identifier-type-de-basis
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Patient.identifier:versichertenId_GKV.type.coding.version
ShortVersion of the system - if relevant
Definition

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

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Patient.identifier:versichertenId_GKV.type.coding.code
ShortSymbol in syntax defined by the system
Definition

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

Cardinality1..1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Auto Value
GKV
Pattern
GKV
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Patient.identifier:versichertenId_GKV.type.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
Gesetzliche Krankenversicherung
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Patient.identifier:versichertenId_GKV.type.coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

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

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Patient.identifier:versichertenId_GKV.type.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
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.

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
Patient.identifier:versichertenId_GKV.system
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Auto Value
http://fhir.de/sid/gkv/kvid-10
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Patient.identifier:versichertenId_GKV.value
ShortThe value that is unique
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • kvid-1: Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen
    matches('^[A-Z][0-9]{9}$')
ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Patient.identifier:versichertenId_GKV.period
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Patient.identifier:versichertenId_GKV.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Patient.identifier:versichertennummer_pkv
ShortAn identifier intended for computation
Definition

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

Cardinality0..1
TypeIdentifierPkv
SummaryTrue
Requirements

Patients are almost always assigned specific numerical identifiers.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: PID-3
  • rim: id
  • cda: .id
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
Patient.identifier:versichertennummer_pkv.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:versichertennummer_pkv.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:versichertennummer_pkv.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

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

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Auto Value
secondary
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
Patient.identifier:versichertennummer_pkv.type
ShortDescription of identifier
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

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

IdentifierTypeDeBasis (extensible)

SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type",
      "code": "pkv-nr"
    }
  ]
}
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
Patient.identifier:versichertennummer_pkv.type.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:versichertennummer_pkv.type.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:versichertennummer_pkv.type.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality2..2
TypeCoding
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type",
  "code": "pkv-nr"
}
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Patient.identifier:versichertennummer_pkv.type.coding.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:versichertennummer_pkv.type.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:versichertennummer_pkv.type.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality1..1
Typeuri
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Patient.identifier:versichertennummer_pkv.type.coding.version
ShortVersion of the system - if relevant
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Patient.identifier:versichertennummer_pkv.type.coding.code
ShortSymbol in syntax defined by the system
Definition

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

Cardinality1..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
pkv-nr
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Patient.identifier:versichertennummer_pkv.type.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
Private Krankenversicherung
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Patient.identifier:versichertennummer_pkv.type.coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

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

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Patient.identifier:versichertennummer_pkv.type.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
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.

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
Patient.identifier:versichertennummer_pkv.system
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality0..1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Patient.identifier:versichertennummer_pkv.value
ShortThe value that is unique
Definition

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

Cardinality1..1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Patient.identifier:versichertennummer_pkv.period
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Patient.identifier:versichertennummer_pkv.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality1..1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Patient.identifier:versichertennummer_pkv.assigner.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:versichertennummer_pkv.assigner.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:versichertennummer_pkv.assigner.reference
ShortLiteral reference, Relative, internal or absolute URL
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

ConditionsThe cardinality or value of this element may be affected by these constraints: ref-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Patient.identifier:versichertennummer_pkv.assigner.type
ShortType the reference refers to (e.g. "Patient")
Definition

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

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

Cardinality0..1
Typeuri
Binding

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

ResourceType (extensible)

SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Patient.identifier:versichertennummer_pkv.assigner.identifier
ShortAn identifier intended for computation
Definition

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

Cardinality0..1
TypeIdentifierIknr
SummaryTrue
Comments

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

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

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

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

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
Patient.identifier:versichertennummer_pkv.assigner.display
ShortText alternative for the resource
Definition

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

Cardinality1..1
Typestring
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Patient.identifier:reisepassnummer
ShortIdentifier Reisepassnummer
Definition

Identifierprofil für die Reisepassnummer

Cardinality0..*
TypeKBV_PR_Base_Identifier_Reisepassnummer
SummaryTrue
Requirements

Patients are almost always assigned specific numerical identifiers.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: PID-3
  • rim: id
  • cda: .id
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
Patient.identifier:versichertennummer_kvk
ShortIdentifier KVK
Definition

Versichertennummer der Krankenversichertenkarte (KVK)

Cardinality0..1
TypeKBV_PR_Base_Identifier_KVK
Must SupportTrue
SummaryTrue
Requirements

Patients are almost always assigned specific numerical identifiers.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: PID-3
  • rim: id
  • cda: .id
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
Patient.identifier:versichertennummer_kvk.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:versichertennummer_kvk.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:versichertennummer_kvk.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

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

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
Patient.identifier:versichertennummer_kvk.type
ShortDescription of identifier
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

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

Identifier Type Codes (extensible)

Must SupportTrue
SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type",
      "code": "kvk"
    }
  ]
}
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
Patient.identifier:versichertennummer_kvk.type.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:versichertennummer_kvk.type.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:versichertennummer_kvk.type.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality1..1
TypeCoding
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type",
  "code": "kvk"
}
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Patient.identifier:versichertennummer_kvk.type.coding.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:versichertennummer_kvk.type.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:versichertennummer_kvk.type.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Auto Value
https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type
Pattern
https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Patient.identifier:versichertennummer_kvk.type.coding.version
ShortVersion of the system - if relevant
Definition

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

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Patient.identifier:versichertennummer_kvk.type.coding.code
ShortSymbol in syntax defined by the system
Definition

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

Cardinality1..1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Auto Value
kvk
Pattern
kvk
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Patient.identifier:versichertennummer_kvk.type.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
Krankenversichertenkarte
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Patient.identifier:versichertennummer_kvk.type.coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

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

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Patient.identifier:versichertennummer_kvk.type.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
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.

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
Patient.identifier:versichertennummer_kvk.system
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Auto Value
http://fhir.de/sid/gkv/kvk-versichertennummer
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Patient.identifier:versichertennummer_kvk.value
ShortThe value that is unique
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • kvk-1: Die Krankenversichertenkartenummer muss numerisch und 6- bis 12-stellig sein.
    matches('^[0-9]{6,12}$')
ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Patient.identifier:versichertennummer_kvk.period
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Patient.identifier:versichertennummer_kvk.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Patient.identifier:obsolet_versichertenId_PKV
ShortOBSOLET Identifier PKV Nicht mehr nutzen
Definition

OBSOLET Dieser Identifier wird durch einen gemeinsamen Identifier (VersichertenID_GKV und PKV) ersetzt bzw. der Identifier VersichertenID_GKV wird erweitert. Alte Instanzen, die den hier aufgeführten Identifier genutzt haben müssen nicht zwangsläufig geändert werden, da der neue Identifier auch die bereits existierenden Umsetzungen/Instanzen dieses Identifiers fehlerfrei miteinschließt . Diese Änderung wird allerdings erst mit der Version 1.5.0 der hl7-Basis vollständig realisiert. Aus diesem Grund bleibt der Identifier noch formal erhalten, allerdings sollte dieser nicht mehr aktiv genutzt werden.

Cardinality0..1
TypeIdentifierPkvVersichertenId10
SummaryTrue
Requirements

Patients are almost always assigned specific numerical identifiers.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: PID-3
  • rim: id
  • cda: .id
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
Patient.identifier:obsolet_versichertenId_PKV.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:obsolet_versichertenId_PKV.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:obsolet_versichertenId_PKV.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

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

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
Patient.identifier:obsolet_versichertenId_PKV.type
ShortDescription of identifier
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

IdentifierTypeDeBasis (extensible)

SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type",
      "code": "pkv-id"
    }
  ]
}
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
Patient.identifier:obsolet_versichertenId_PKV.type.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:obsolet_versichertenId_PKV.type.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:obsolet_versichertenId_PKV.type.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality2..2
TypeCoding
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type",
  "code": "pkv-id"
}
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Patient.identifier:obsolet_versichertenId_PKV.type.coding.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.identifier:obsolet_versichertenId_PKV.type.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.identifier:obsolet_versichertenId_PKV.type.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality0..1
Typeuri
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Patient.identifier:obsolet_versichertenId_PKV.type.coding.version
ShortVersion of the system - if relevant
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Patient.identifier:obsolet_versichertenId_PKV.type.coding.code
ShortSymbol in syntax defined by the system
Definition

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

Cardinality0..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
pkv-id
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Patient.identifier:obsolet_versichertenId_PKV.type.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
Privatversicherten-ID
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Patient.identifier:obsolet_versichertenId_PKV.type.coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

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

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Patient.identifier:obsolet_versichertenId_PKV.type.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
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.

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
Patient.identifier:obsolet_versichertenId_PKV.system
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality1..1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Auto Value
http://fhir.de/sid/pkv/kvid-10
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Patient.identifier:obsolet_versichertenId_PKV.value
ShortThe value that is unique
Definition

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

Cardinality1..1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Patient.identifier:obsolet_versichertenId_PKV.period
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Patient.identifier:obsolet_versichertenId_PKV.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Patient.active
ShortWhether this patient's record is in active use
Definition

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

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

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

Cardinality0..1
Typeboolean
ModifierTrue
SummaryTrue
Requirements

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

Comments

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

Meaning when missing

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: statusCode
  • cda: n/a
Patient.name
ShortName
Definition

Vollständiger Name der Person

Cardinality1..*
TypeHumanName
Must SupportTrue
SummaryTrue
Requirements

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

Comments

A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

Slicing

Unordered, Open, by use(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-5, PID-9
  • rim: name
  • cda: .patient.name
Patient.name:name
ShortPersonenname
Definition

Dieses Element beschreibt diverse Namensbestandteile einer Person.

Cardinality1..1
TypeKBV_PR_Base_Datatype_Name
Must SupportTrue
SummaryTrue
Requirements

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

Comments

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

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • hum-1: Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
    family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
  • hum-2: Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
    family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
  • hum-3: Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
    family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
  • hum-4: Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden
    prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())
Mappings
  • v2: PID-5, PID-9
  • rim: name
  • cda: .patient.name
  • rim: n/a
  • v2: XPN
  • rim: EN (actually, PN)
  • servd: ProviderName
Patient.name:name.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.name:name.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.name:name.use
Shortusual | official | temp | nickname | anonymous | old | maiden
Definition

Identifies the purpose for this name.

Cardinality1..1
Typecode
Binding

The use of a human name.

NameUse (required)

Must SupportTrue
ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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!)
Patient.name:name.text
ShortVollständiger Name
Definition

Vollständiger Name mit Vornamen und allen Vorsatzwörtern und Namenszusätzen. Der vollständige Name soll alle Namensteile in ihrer korrekten Reihenfolge abbilden.

Cardinality0..1
Typestring
SummaryTrue
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.

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
Patient.name:name.family
ShortFamilienname
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Aliassurname
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length87
Mappings
  • v2: XPN.1/FN.1
  • rim: ./part[partType = FAM]
  • servd: ./FamilyName
  • BDT: 3120 + 3100 + 3101
  • KVDT: 3100 + 3120 + 3101
Patient.name:name.family.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Patient.name:name.family.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Must SupportTrue
Aliasextensions, user content
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.

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()
Patient.name:name.family.extension:namenszusatz
ShortNamenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
Definition

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

Cardinality0..1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content
Comments

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

ConditionsThe 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
Patient.name:name.family.extension:namenszusatz.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.name:name.family.extension:namenszusatz.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.name:name.family.extension:namenszusatz.url
Shortidentifies the meaning of the extension
Definition

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

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

Auto Value
http://fhir.de/StructureDefinition/humanname-namenszusatz
Mappings
  • rim: N/A
Patient.name:name.family.extension:namenszusatz.value[x]
ShortNamenszusatz
Definition

Namenszusatz zum Nachnamen z.B. Gräfin, Prinz oder Fürst

Cardinality1..1
Typestring
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length20
Mappings
  • rim: N/A
Patient.name:name.family.extension:nachname
ShortNachname ohne Vor- und Zusätze
Definition

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

Cardinality0..1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content
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".

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.name:name.family.extension:nachname.extension
ShortExtension
Definition

An Extension

Cardinality0..0
TypeExtension
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()
Patient.name:name.family.extension:nachname.url
Shortidentifies the meaning of the extension
Definition

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

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

Auto Value
http://hl7.org/fhir/StructureDefinition/humanname-own-name
Mappings
  • rim: N/A
Patient.name:name.family.extension:nachname.value[x]
ShortValue of extension
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length45
Mappings
  • rim: N/A
Patient.name:name.family.extension:vorsatzwort
ShortVorsatzwort
Definition

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

Cardinality0..1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content
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.

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.name:name.family.extension:vorsatzwort.extension
ShortExtension
Definition

An Extension

Cardinality0..0
TypeExtension
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()
Patient.name:name.family.extension:vorsatzwort.url
Shortidentifies the meaning of the extension
Definition

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

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

Auto Value
http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
Mappings
  • rim: N/A
Patient.name:name.family.extension:vorsatzwort.value[x]
ShortValue of extension
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length20
Mappings
  • rim: N/A
Patient.name:name.family.value
ShortPrimitive value for string
Definition

The actual value

Cardinality0..1
TypeSystem.String
Maximum string length1048576
Patient.name:name.given
ShortVorname
Definition

Vorname der Person

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Aliasfirst name, middle name
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length45
Mappings
  • v2: XPN.2 + XPN.3
  • rim: ./part[partType = GIV]
  • servd: ./GivenNames
  • KVDT: 3102
  • BDT: 3102
Patient.name:name.prefix
ShortNamensteile vor dem Vornamen
Definition

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

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length20
Mappings
  • v2: XPN.5
  • rim: ./part[partType = PFX]
  • servd: ./TitleCode
  • KVDT: 3104
  • BDT: 3104
Patient.name:name.prefix.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Patient.name:name.prefix.extension
ShortAdditional content defined by implementations
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.

Cardinality1..1
TypeExtension
Must SupportTrue
Aliasextensions, user content
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.

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()
Patient.name:name.prefix.extension:prefix-qualifier
ShortLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
Definition

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

Cardinality1..1
TypeExtension(code)
Must SupportTrue
Aliasextensions, user content
Comments

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

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.name:name.prefix.extension:prefix-qualifier.extension
ShortExtension
Definition

An Extension

Cardinality0..0
TypeExtension
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()
Patient.name:name.prefix.extension:prefix-qualifier.url
Shortidentifies the meaning of the extension
Definition

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

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

Auto Value
http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Mappings
  • rim: N/A
Patient.name:name.prefix.extension:prefix-qualifier.value[x]
ShortValue of extension
Definition

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

Cardinality1..1
Typecode
Binding

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

EntityNamePartQualifier (required)

Must SupportTrue
Slicing

Unordered, Open, by $this(Type)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Patient.name:name.prefix.extension:prefix-qualifier.value[x]:valueCode
ShortValue of extension
Definition

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

Cardinality0..1
Typecode
Binding

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

EntityNamePartQualifier (required)

Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Auto Value
AC
Mappings
  • rim: N/A
Patient.name:name.prefix.value
ShortPrimitive value for string
Definition

The actual value

Cardinality0..1
TypeSystem.String
Maximum string length1048576
Patient.name:name.suffix
ShortNamensteile nach dem Nachnamen
Definition

Namensteile nach dem Nachnamen

Cardinality0..1
Typestring
SummaryTrue
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]
Patient.name:name.period
ShortTime period when name was/is in use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
Requirements

Allows names to be placed in historical context.

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
Patient.name:geburtsname
ShortGeburtsname
Definition

Geburtsname mit in Deutschland üblichen Erweiterungen

Cardinality0..1
TypeKBV_PR_Base_Datatype_Maiden_Name
SummaryTrue
Requirements

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

Comments

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

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • hum-1: Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
    family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
  • hum-2: Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
    family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
  • hum-3: Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
    family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
  • hum-4: Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden
    prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())
Mappings
  • v2: PID-5, PID-9
  • rim: name
  • cda: .patient.name
  • rim: n/a
  • v2: XPN
  • rim: EN (actually, PN)
  • servd: ProviderName
Patient.telecom
ShortKontaktdaten der Person
Definition

Dieses Element beschreibt die vorhandenen Kontaktmöglichkeiten.

Cardinality0..*
TypeKBV_PR_Base_Datatype_Contactpoint
Must SupportTrue
SummaryTrue
Requirements

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

Comments

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

Slicing

Unordered, Open, by system(Value)

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cpt-2: A system is required if a value is provided.
    value.empty() or system.exists()
Mappings
  • v2: PID-13, PID-14, PID-40
  • rim: telecom
  • cda: .telecom
  • rim: n/a
  • v2: XTN
  • rim: TEL
  • servd: ContactPoint
Patient.telecom:telefonnummer
ShortTelefonnummer der Person
Definition

Telefonnummer, unter der die Person erreichbar ist

Cardinality0..1
TypeKBV_PR_Base_Datatype_Contactpoint
Must SupportTrue
SummaryTrue
Requirements

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

Comments

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

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cpt-2: A system is required if a value is provided.
    value.empty() or system.exists()
Mappings
  • v2: PID-13, PID-14, PID-40
  • rim: telecom
  • cda: .telecom
  • rim: n/a
  • v2: XTN
  • rim: TEL
  • servd: ContactPoint
Patient.telecom:telefonnummer.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.telecom:telefonnummer.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.telecom:telefonnummer.system
Shortphone | fax | email | pager | url | sms | other
Definition

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

Cardinality1..1
Typecode
Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Must SupportTrue
SummaryTrue
ConditionsThe 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())
Auto Value
phone
Mappings
  • v2: XTN.3
  • rim: ./scheme
  • servd: ./ContactPointType
Patient.telecom:telefonnummer.value
ShortTelefonnummer
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length100
Mappings
  • v2: XTN.1 (or XTN.12)
  • rim: ./url
  • servd: ./Value
Patient.telecom:telefonnummer.use
Shorthome | work | temp | old | mobile - purpose of this contact point
Definition

Identifies the purpose for the contact point.

Cardinality0..1
Typecode
Binding

Use of contact point.

ContactPointUse (required)

ModifierTrue
SummaryTrue
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.

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
Patient.telecom:telefonnummer.rank
ShortSpecify 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.

Cardinality0..1
TypepositiveInt
SummaryTrue
Comments

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

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
Patient.telecom:telefonnummer.period
ShortTime period when the contact point was/is in use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
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
Patient.telecom:email
ShortE-Mail-Adresse der Person
Definition

E-Mail-Adresse, unter der die Person erreichbar ist

Cardinality0..1
TypeKBV_PR_Base_Datatype_Contactpoint
Must SupportTrue
SummaryTrue
Requirements

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

Comments

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

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cpt-2: A system is required if a value is provided.
    value.empty() or system.exists()
Mappings
  • v2: PID-13, PID-14, PID-40
  • rim: telecom
  • cda: .telecom
  • rim: n/a
  • v2: XTN
  • rim: TEL
  • servd: ContactPoint
Patient.telecom:email.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.telecom:email.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.telecom:email.system
Shortphone | fax | email | pager | url | sms | other
Definition

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

Cardinality1..1
Typecode
Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Must SupportTrue
SummaryTrue
ConditionsThe 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())
Auto Value
email
Mappings
  • v2: XTN.3
  • rim: ./scheme
  • servd: ./ContactPointType
Patient.telecom:email.value
ShortEmailadresse der Person
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length100
Mappings
  • v2: XTN.1 (or XTN.12)
  • rim: ./url
  • servd: ./Value
Patient.telecom:email.use
Shorthome | work | temp | old | mobile - purpose of this contact point
Definition

Identifies the purpose for the contact point.

Cardinality0..1
Typecode
Binding

Use of contact point.

ContactPointUse (required)

ModifierTrue
SummaryTrue
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.

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
Patient.telecom:email.rank
ShortSpecify 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.

Cardinality0..1
TypepositiveInt
SummaryTrue
Comments

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

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
Patient.telecom:email.period
ShortTime period when the contact point was/is in use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
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
Patient.gender
Shortmale | female | other | unknown
Definition

Das administrative Geschlecht eines Patienten, auf dessen Basis die Anrede festgelegt wird. male = Mann female = Frau other = Divers unknown = unbekannt

Cardinality1..1
Typecode
Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)

Must SupportTrue
SummaryTrue
Requirements

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

Comments

Im Falle von "other" muss in der Extension "other-amtlich" der Code "D" (für divers) oder "X" (für unbestimmt) eintragen werden!

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-8
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
  • cda: .patient.administrativeGenderCode
Patient.gender.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Patient.gender.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Must SupportTrue
Aliasextensions, user content
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.

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()
Patient.gender.extension:other-amtlich
ShortKonkretisierung des Geschlechts "other"
Definition

Falls bei gender "other" angegeben wurde, muss hier die entweder "D" für "divers" oder "X" für "unbestimmt" eingetragen werden, um eine amtliche Unterscheidung zu ermöglichen.

Cardinality0..1
TypeExtension(Coding)
Must SupportTrue
Aliasextensions, user content
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.

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.gender.extension:other-amtlich.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.gender.extension:other-amtlich.url
Shortidentifies the meaning of the extension
Definition

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

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

Auto Value
http://fhir.de/StructureDefinition/gender-amtlich-de
Mappings
  • rim: N/A
Patient.gender.extension:other-amtlich.value[x]
ShortCoding zum Geschlecht
Definition

Vorgegebenes Coding zur amtlichen Unterscheidung des Geschlechts im Falle von "other"

Cardinality1..1
TypeCoding
Binding

GenderOtherDE (required)

Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • gender-amtlich-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
    %resource.where(gender='other').exists()
Mappings
  • rim: N/A
Patient.gender.extension:other-amtlich.value[x].id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.gender.extension:other-amtlich.value[x].extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.gender.extension:other-amtlich.value[x].system
ShortIdentity of the terminology system
Definition

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

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Auto Value
http://fhir.de/CodeSystem/gender-amtlich-de
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Patient.gender.extension:other-amtlich.value[x].version
ShortVersion of the system - if relevant
Definition

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

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Patient.gender.extension:other-amtlich.value[x].code
ShortD | X
Definition

Für das Geschlecht "other" wird eine amtliche Unterscheidung zwischen "divers" (D) und "unbestimmt" (X) vorgenommen.

Cardinality1..1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Patient.gender.extension:other-amtlich.value[x].display
Shortdivers | unbestimmt
Definition

Für das Geschlecht "other" wird eine amtliche Unterscheidung zwischen "divers" und "unbestimmt" vorgenommen.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Patient.gender.extension:other-amtlich.value[x].userSelected
ShortIf this coding was chosen directly by the user
Definition

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

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Patient.gender.value
ShortPrimitive value for code
Definition

Primitive value for code

Cardinality0..1
TypeSystem.String
Patient.birthDate
ShortGeburtsdatum
Definition

Geburtsdatum der Person

Cardinality1..1
Typedate
Must SupportTrue
SummaryTrue
Requirements

Age of the individual drives many clinical processes.

Comments

Für ein gültiges Geburtsdatum muss min. das Geburtsjahr bekannt sein. Sollte dies nicht der Fall sein, muss die Extension data-absent-reason gesetzt werden.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-7
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
  • cda: .patient.birthTime
  • loinc: 21112-8
Patient.birthDate.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Patient.birthDate.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Must SupportTrue
Aliasextensions, user content
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.

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()
Patient.birthDate.extension:data-absent-reason
Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Definition

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

Cardinality0..1
TypeExtension(code)
Must SupportTrue
Aliasextensions, user content
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.

ConditionsThe 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
Patient.birthDate.extension:data-absent-reason.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.birthDate.extension:data-absent-reason.extension
ShortExtension
Definition

An Extension

Cardinality0..0
TypeExtension
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()
Patient.birthDate.extension:data-absent-reason.url
Shortidentifies the meaning of the extension
Definition

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

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

Auto Value
http://hl7.org/fhir/StructureDefinition/data-absent-reason
Mappings
  • rim: N/A
Patient.birthDate.extension:data-absent-reason.value[x]
ShortValue of extension
Definition

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

Cardinality1..1
Typecode
Binding

Used to specify why the normally expected content of the data element is missing.

DataAbsentReason (required)

Must SupportTrue
Slicing

Unordered, Open, by $this(Type)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Patient.birthDate.extension:data-absent-reason.value[x]:valueCode
ShortValue of extension
Definition

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

Cardinality0..1
Typecode
Binding

Used to specify why the normally expected content of the data element is missing.

DataAbsentReason (required)

Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Auto Value
unknown
Mappings
  • rim: N/A
Patient.birthDate.value
ShortPrimitive value for date
Definition

The actual value

Cardinality0..1
TypeSystem.Date
Patient.deceased[x]
ShortIndicates if the individual is deceased or not
Definition

Indicates if the individual is deceased or not.

Cardinality0..1
Typeboolean, dateTime
ModifierTrue
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-30 (bool) and PID-29 (datetime)
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
  • cda: n/a
Patient.address
ShortAnschrift der Person
Definition

Die postalische Strassenanschrift der Person

Cardinality0..*
TypeAddress
Must SupportTrue
SummaryTrue
Requirements

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

Comments

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

Slicing

Unordered, Open, by type(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-11
  • rim: addr
  • cda: .addr
Patient.address:Strassenanschrift
ShortEine Straßenadresse gemäß postalischer Konventionen
Definition

Hier können Angaben zur Straßenanschrift gemacht werden.

Cardinality0..1
TypeKBV_PR_Base_Datatype_Street_Address
Must SupportTrue
SummaryTrue
Requirements

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

Comments

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

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • add-1: Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden
    line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
  • add-2: Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden
    line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
  • add-3: Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden
    line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue())
  • add-4: Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein.
    line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty()
  • add-5: Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden
    line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())
  • add-6: Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden
    line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty()))
  • add-7: Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein.
    extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))
ExamplesBeispiel für einfache Adresse
{
  "use": "home",
  "type": "postal",
  "line": [
    "Musterweg 42"
  ],
  "city": "Musterhausen",
  "postalCode": "99999"
}
Mappings
  • v2: PID-11
  • rim: addr
  • cda: .addr
  • rim: n/a
  • v2: XAD
  • rim: AD
  • servd: Address
Patient.address:Strassenanschrift.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.address:Strassenanschrift.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.address:Strassenanschrift.extension:Stadtteil
ShortStadt- oder Ortsteil
Definition

A subsection of a municipality.

Cardinality0..1
TypeExtension(string)
Aliasextensions, user content
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.

ConditionsThe 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]
Patient.address:Strassenanschrift.use
Shorthome | work | temp | old | billing - purpose of this address
Definition

The purpose of this address.

Cardinality0..1
Typecode
Binding

The use of an address.

AddressUse (required)

ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
home
Mappings
  • v2: XAD.7
  • rim: unique(./use)
  • servd: ./AddressPurpose
Patient.address:Strassenanschrift.type
Shortpostal | 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.

Cardinality1..1
Typecode
Binding

The type of an address (physical / postal).

AddressType (required)

Must SupportTrue
SummaryTrue
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).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
both
ExamplesGeneral
both
Mappings
  • v2: XAD.18
  • rim: unique(./use)
  • vcard: address type parameter
  • BDT: 1202 (1=physical, 2=postal)
Patient.address:Strassenanschrift.text
ShortText 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
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
Patient.address:Strassenanschrift.line
ShortStraß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. Es wird empfohlen, dass die erste Zeile für Straße und Hausnummer, die zweite Zeile für den Zusatz und die dritte Zeile für den Stadtteil verwendet wird.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length97
ExamplesGeneral
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
Patient.address:Strassenanschrift.line.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Patient.address:Strassenanschrift.line.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Must SupportTrue
Aliasextensions, user content
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.

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()
Patient.address:Strassenanschrift.line.extension:Strasse
ShortStrassenname (ohne Hausnummer)
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.

Cardinality0..1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content
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.

ConditionsThe 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
Patient.address:Strassenanschrift.line.extension:Strasse.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.address:Strassenanschrift.line.extension:Strasse.extension
ShortExtension
Definition

An Extension

Cardinality0..0
TypeExtension
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()
Patient.address:Strassenanschrift.line.extension:Strasse.url
Shortidentifies the meaning of the extension
Definition

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

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

Auto Value
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Mappings
  • rim: N/A
Patient.address:Strassenanschrift.line.extension:Strasse.value[x]
ShortValue of extension
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length46
Mappings
  • rim: N/A
Patient.address:Strassenanschrift.line.extension:Hausnummer
ShortHausnummer
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.

Cardinality0..1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content
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.

ConditionsThe 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
Patient.address:Strassenanschrift.line.extension:Hausnummer.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.address:Strassenanschrift.line.extension:Hausnummer.extension
ShortExtension
Definition

An Extension

Cardinality0..0
TypeExtension
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()
Patient.address:Strassenanschrift.line.extension:Hausnummer.url
Shortidentifies the meaning of the extension
Definition

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

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

Auto Value
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Mappings
  • rim: N/A
Patient.address:Strassenanschrift.line.extension:Hausnummer.value[x]
ShortValue of extension
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length9
Mappings
  • rim: N/A
Patient.address:Strassenanschrift.line.extension:Adresszusatz
ShortAdresszusatz
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.

Cardinality0..1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content
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.

ConditionsThe 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
Patient.address:Strassenanschrift.line.extension:Adresszusatz.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.address:Strassenanschrift.line.extension:Adresszusatz.extension
ShortExtension
Definition

An Extension

Cardinality0..0
TypeExtension
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()
Patient.address:Strassenanschrift.line.extension:Adresszusatz.url
Shortidentifies the meaning of the extension
Definition

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

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

Auto Value
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
Mappings
  • rim: N/A
Patient.address:Strassenanschrift.line.extension:Adresszusatz.value[x]
ShortValue of extension
Definition

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

Cardinality1..1
Typestring
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length40
Mappings
  • rim: N/A
Patient.address:Strassenanschrift.line.extension:Postfach
ShortPostfach
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.

Cardinality0..0
TypeExtension(string)
Aliasextensions, user content
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.

ConditionsThe 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
Patient.address:Strassenanschrift.line.value
ShortPrimitive value for string
Definition

The actual value

Cardinality0..1
TypeSystem.String
Maximum string length1048576
Patient.address:Strassenanschrift.city
ShortName der Stadt
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
AliasMunicpality
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length40
ExamplesGeneral
Erewhon
Mappings
  • v2: XAD.3
  • rim: AD.part[parttype = CTY]
  • vcard: locality
  • servd: ./Jurisdiction
  • BDT: 3113 oder 3122 (Postfach)
  • KVDT: 3113 oder 3122 (Postfach)
Patient.address:Strassenanschrift.district
ShortDistrict name (aka county)
Definition

The name of the administrative area (county).

Cardinality0..0
Typestring
SummaryTrue
AliasCounty
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
Madison
Mappings
  • v2: XAD.9
  • rim: AD.part[parttype = CNT | CPA]
Patient.address:Strassenanschrift.state
ShortBundesland
Definition

Name (oder Kürzel) des Bundeslandes.

Cardinality0..1
Typestring
Binding

ValueSetISO31662DE (preferred)

SummaryTrue
AliasProvince, Territory
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
Patient.address:Strassenanschrift.postalCode
ShortPostleitzahl
Definition

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

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
AliasZip
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length5
ExamplesGeneral
9132
Mappings
  • v2: XAD.5
  • rim: AD.part[parttype = ZIP]
  • vcard: code
  • servd: ./PostalIdentificationCode
  • BDT: 3112 oder 3121 (Postfach)
  • KVDT: 3112 oder 3121 (Postfach)
Patient.address:Strassenanschrift.country
ShortStaat
Definition

Angabe des Staates als Länderkennzeichen nach DEUEV Anlage 8.

Cardinality1..1
Typestring
Binding

KBV_VS_Base_Deuev_Anlage_8 (extensible)

Must SupportTrue
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length3
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
Patient.address:Strassenanschrift.period
ShortTime period when address was/is in use
Definition

Time period when address was/is in use.

Cardinality0..1
TypePeriod
SummaryTrue
Requirements

Allows addresses to be placed in historical context.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
{
  "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
Patient.address:Strassenanschrift.period.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.address:Strassenanschrift.period.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.address:Strassenanschrift.period.start
ShortStarting time with inclusive boundary
Definition

The start of the period. The boundary is inclusive.

Cardinality0..1
TypedateTime
SummaryTrue
Comments

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

ConditionsThe 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
Patient.address:Strassenanschrift.period.end
ShortEnd 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.

Cardinality0..1
TypedateTime
SummaryTrue
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

ConditionsThe 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
Patient.address:Postfach
ShortHier können Angaben zu einem Postfach gemacht werden.
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ändischenOrt Adresse oder Adressen, die nicht durch Einlesen einer elektronischen Versichertenkarte erfasst wurden, sind abweichende Strukturen möglich. Die Verwendung der Extensions ist nicht verpflichtend.

Cardinality0..1
TypeKBV_PR_Base_Datatype_Post_Office_Box
Must SupportTrue
SummaryTrue
Requirements

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

Comments

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

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • add-1: Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden
    line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
  • add-2: Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden
    line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
  • add-3: Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden
    line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue())
  • add-4: Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein.
    line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty()
  • add-5: Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden
    line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())
  • add-6: Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden
    line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty()))
  • add-7: Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein.
    extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))
  • postBox-de-1: Die Extension 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox' darf nur einmal vorkommen.
    line.where($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').exists()).count()=1
ExamplesBeispiel für einfache Adresse
{
  "use": "home",
  "type": "postal",
  "line": [
    "Musterweg 42"
  ],
  "city": "Musterhausen",
  "postalCode": "99999"
}
Mappings
  • v2: PID-11
  • rim: addr
  • cda: .addr
  • rim: n/a
  • v2: XAD
  • rim: AD
  • servd: Address
Patient.address:Postfach.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.address:Postfach.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.address:Postfach.extension:Stadtteil
ShortStadt- oder Ortsteil
Definition

A subsection of a municipality.

Cardinality0..1
TypeExtension(string)
Aliasextensions, user content
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.

ConditionsThe 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]
Patient.address:Postfach.use
Shorthome | work | temp | old | billing - purpose of this address
Definition

The purpose of this address.

Cardinality0..1
Typecode
Binding

The use of an address.

AddressUse (required)

ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
home
Mappings
  • v2: XAD.7
  • rim: unique(./use)
  • servd: ./AddressPurpose
Patient.address:Postfach.type
Shortpostal | 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.

Cardinality1..1
Typecode
Binding

The type of an address (physical / postal).

AddressType (required)

Must SupportTrue
SummaryTrue
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).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
postal
ExamplesGeneral
both
Mappings
  • v2: XAD.18
  • rim: unique(./use)
  • vcard: address type parameter
  • BDT: 1202 (1=physical, 2=postal)
Patient.address:Postfach.text
ShortText 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
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
Patient.address:Postfach.line
ShortStraß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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length17
ExamplesGeneral
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
Patient.address:Postfach.line.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Patient.address:Postfach.line.extension
ShortAdditional content defined by implementations
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.

Cardinality1..*
TypeExtension
Must SupportTrue
Aliasextensions, user content
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.

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()
Patient.address:Postfach.line.extension:Strasse
ShortStrassenname (ohne Hausnummer)
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.

Cardinality0..0
TypeExtension(string)
Aliasextensions, user content
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.

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

Cardinality0..0
TypeExtension(string)
Aliasextensions, user content
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.

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

Cardinality0..0
TypeExtension(string)
Aliasextensions, user content
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.

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

Cardinality1..1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content
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.

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.address:Postfach.line.extension:Postfach.extension
ShortExtension
Definition

An Extension

Cardinality0..0
TypeExtension
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()
Patient.address:Postfach.line.extension:Postfach.url
Shortidentifies the meaning of the extension
Definition

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

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

Auto Value
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
Mappings
  • rim: N/A
Patient.address:Postfach.line.extension:Postfach.value[x]
ShortValue of extension
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length8
Mappings
  • rim: N/A
Patient.address:Postfach.line.value
ShortPrimitive value for string
Definition

The actual value

Cardinality0..1
TypeSystem.String
Maximum string length1048576
Patient.address:Postfach.city
ShortName of city, town etc.
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
AliasMunicpality
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length40
ExamplesGeneral
Erewhon
Mappings
  • v2: XAD.3
  • rim: AD.part[parttype = CTY]
  • vcard: locality
  • servd: ./Jurisdiction
  • BDT: 3113 oder 3122 (Postfach)
  • KVDT: 3113 oder 3122 (Postfach)
Patient.address:Postfach.district
ShortDistrict name (aka county)
Definition

The name of the administrative area (county).

Cardinality0..0
Typestring
SummaryTrue
AliasCounty
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
Madison
Mappings
  • v2: XAD.9
  • rim: AD.part[parttype = CNT | CPA]
Patient.address:Postfach.state
ShortBundesland
Definition

Name (oder Kürzel) des Bundeslandes.

Cardinality0..1
Typestring
Binding

ValueSetISO31662DE (preferred)

SummaryTrue
AliasProvince, Territory
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
Patient.address:Postfach.postalCode
ShortPostleitzahl
Definition

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

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
AliasZip
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length5
ExamplesGeneral
9132
Mappings
  • v2: XAD.5
  • rim: AD.part[parttype = ZIP]
  • vcard: code
  • servd: ./PostalIdentificationCode
  • BDT: 3112 oder 3121 (Postfach)
  • KVDT: 3112 oder 3121 (Postfach)
Patient.address:Postfach.country
ShortStaat
Definition

Angabe des Staates als Länderkennzeichen nach DEUEV Anlage 8.

Cardinality1..1
Typestring
Binding

KBV_VS_Base_Deuev_Anlage_8 (extensible)

Must SupportTrue
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Maximum string length3
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
Patient.address:Postfach.period
ShortTime period when address was/is in use
Definition

Time period when address was/is in use.

Cardinality0..1
TypePeriod
SummaryTrue
Requirements

Allows addresses to be placed in historical context.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
{
  "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
Patient.address:Postfach.period.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.address:Postfach.period.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.address:Postfach.period.start
ShortStarting time with inclusive boundary
Definition

The start of the period. The boundary is inclusive.

Cardinality0..1
TypedateTime
SummaryTrue
Comments

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

ConditionsThe 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
Patient.address:Postfach.period.end
ShortEnd 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.

Cardinality0..1
TypedateTime
SummaryTrue
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

ConditionsThe 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
Patient.maritalStatus
ShortPersonenstand
Definition

Hier wird der Personenstand (Familienstand) der behandelten Person angegeben.

Cardinality0..1
TypeCodeableConcept
Binding

The domestic partnership status of a person.

Marital Status Codes (extensible)

Requirements

Most, if not all systems capture it.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-16
  • rim: player[classCode=PSN]/maritalStatusCode
  • cda: .patient.maritalStatusCode
Patient.maritalStatus.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.maritalStatus.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.maritalStatus.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
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.

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
Patient.maritalStatus.coding.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.maritalStatus.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.maritalStatus.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality1..1
Typeuri
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Patient.maritalStatus.coding.version
ShortVersion of the system - if relevant
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Patient.maritalStatus.coding.code
ShortSymbol in syntax defined by the system
Definition

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

Cardinality1..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Patient.maritalStatus.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality1..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Patient.maritalStatus.coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

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

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Patient.maritalStatus.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
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.

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
Patient.multipleBirth[x]
ShortWhether patient is part of a multiple birth
Definition

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

Cardinality0..1
Typeboolean, integer
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-24 (bool), PID-25 (integer)
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
  • cda: n/a
Patient.photo
ShortImage of the patient
Definition

Image of the patient.

Cardinality0..*
TypeAttachment
Requirements

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

Comments

Guidelines:

  • Use id photos, not clinical photos.
  • Limit dimensions to thumbnail.
  • Keep byte count low to ease resource updates.
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-5 - needs a profile
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
  • cda: n/a
Patient.contact
ShortA contact party (e.g. guardian, partner, friend) for the patient
Definition

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

Cardinality0..*
TypeBackboneElement
Requirements

Need to track people you can contact about the patient.

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • pat-1: SHALL at least contain a contact's details or a reference to an organization
    name.exists() or telecom.exists() or address.exists() or organization.exists()
Mappings
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
  • cda: n/a
Patient.contact.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.contact.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.contact.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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

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.

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
Patient.contact.relationship
ShortThe kind of relationship
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

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

PatientContactRelationship (extensible)

Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-7, NK1-3
  • rim: code
  • cda: n/a
Patient.contact.name
ShortA name associated with the contact person
Definition

A name associated with the contact person.

Cardinality0..1
TypeHumanName
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-2
  • rim: name
  • cda: n/a
Patient.contact.telecom
ShortA contact detail for the person
Definition

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

Cardinality0..*
TypeContactPoint
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-5, NK1-6, NK1-40
  • rim: telecom
  • cda: n/a
Patient.contact.address
ShortAddress for the contact person
Definition

Address for the contact person.

Cardinality0..1
TypeAddress
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-4
  • rim: addr
  • cda: n/a
Patient.contact.address.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.contact.address.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.contact.address.use
Shorthome | work | temp | old | billing - purpose of this address
Definition

The purpose of this address.

Cardinality0..1
Typecode
Binding

The use of an address.

AddressUse (required)

ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
home
Mappings
  • v2: XAD.7
  • rim: unique(./use)
  • servd: ./AddressPurpose
Patient.contact.address.type
Shortpostal | 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.

Cardinality0..1
Typecode
Binding

The type of an address (physical / postal).

AddressType (required)

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
both
Mappings
  • v2: XAD.18
  • rim: unique(./use)
  • vcard: address type parameter
Patient.contact.address.text
ShortText 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
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
Patient.contact.address.line
ShortStreet name, number, direction & P.O. Box etc.
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Cardinality0..*
Typestring
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
137 Nowhere Street
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)
Patient.contact.address.city
ShortName of city, town etc.
Definition

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

Cardinality0..1
Typestring
SummaryTrue
AliasMunicpality
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
Erewhon
Mappings
  • v2: XAD.3
  • rim: AD.part[parttype = CTY]
  • vcard: locality
  • servd: ./Jurisdiction
Patient.contact.address.district
ShortDistrict name (aka county)
Definition

The name of the administrative area (county).

Cardinality0..1
Typestring
SummaryTrue
AliasCounty
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
Madison
Mappings
  • v2: XAD.9
  • rim: AD.part[parttype = CNT | CPA]
Patient.contact.address.state
ShortSub-unit of country (abbreviations ok)
Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Cardinality0..1
Typestring
SummaryTrue
AliasProvince, Territory
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
Patient.contact.address.postalCode
ShortPostal code for area
Definition

A postal code designating a region defined by the postal service.

Cardinality0..1
Typestring
SummaryTrue
AliasZip
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
9132
Mappings
  • v2: XAD.5
  • rim: AD.part[parttype = ZIP]
  • vcard: code
  • servd: ./PostalIdentificationCode
Patient.contact.address.country
ShortStaat
Definition

Angabe des Staates als Länderkennzeichen nach DEUEV Anlage 8.

Cardinality0..1
Typestring
Binding

KBV_VS_Base_Deuev_Anlage_8 (extensible)

SummaryTrue
Comments

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

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
Patient.contact.address.period
ShortTime period when address was/is in use
Definition

Time period when address was/is in use.

Cardinality0..1
TypePeriod
SummaryTrue
Requirements

Allows addresses to be placed in historical context.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
{
  "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
Patient.contact.gender
Shortmale | female | other | unknown
Definition

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

Cardinality0..1
Typecode
Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)

Requirements

Needed to address the person correctly.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-15
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
  • cda: n/a
Patient.contact.organization
ShortOrganization that is associated with the contact
Definition

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

Cardinality0..1
TypeReference(Organization)
Requirements

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

ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
  • rim: scoper
  • cda: n/a
Patient.contact.period
ShortThe period during which this contact person or organization is valid to be contacted relating to this patient
Definition

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

Cardinality0..1
TypePeriod
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: effectiveTime
  • cda: n/a
Patient.communication
ShortA language which may be used to communicate with the patient about his or her health
Definition

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

Cardinality0..*
TypeBackboneElement
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: LanguageCommunication
  • cda: patient.languageCommunication
Patient.communication.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.communication.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.communication.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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

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.

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
Patient.communication.language
ShortBevorzugte Sprache
Definition

Die Sprache, die zur Kommunikation mit dem Patienten über medizinische Themen verwendet werden kann.

Cardinality1..1
TypeCodeableConcept
Binding

A human language.

KBV_VS_Base_CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-15, LAN-2
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
  • cda: .languageCode
Patient.communication.preferred
ShortLanguage preference indicator
Definition

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

Cardinality0..1
Typeboolean
Requirements

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

Comments

This language is specifically identified for communicating healthcare information.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-15
  • rim: preferenceInd
  • cda: .preferenceInd
Patient.generalPractitioner
ShortPatient's nominated primary care provider
Definition

Patient's nominated care provider.

Cardinality0..*
TypeReference(Organization | Practitioner | PractitionerRole)
AliascareProvider
Comments

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

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PD1-4
  • rim: subjectOf.CareEvent.performer.AssignedEntity
  • cda: n/a
Patient.managingOrganization
ShortOrganization that is the custodian of the patient record
Definition

Organization that is the custodian of the patient record.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: scoper
  • cda: .providerOrganization
Patient.link
ShortLink to another patient resource that concerns the same actual person
Definition

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

Cardinality0..*
TypeBackboneElement
ModifierTrue
SummaryTrue
Requirements

There are multiple use cases:

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

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: outboundLink
  • cda: n/a
Patient.link.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Patient.link.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

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
Patient.link.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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

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.

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
Patient.link.other
ShortThe other patient or related person resource that the link refers to
Definition

The other patient resource that the link refers to.

Cardinality1..1
TypeReference(Patient | RelatedPerson)
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-3, MRG-1
  • rim: id
  • cda: n/a
Patient.link.type
Shortreplaced-by | replaces | refer | seealso
Definition

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

Cardinality1..1
Typecode
Binding

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

LinkType (required)

SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: typeCode
  • cda: n/a
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="KBV-PR-116117-TERMINSERVICE-TVS-TSYNCH-Patient" />
<status value="generated" />
--- We have skipped the narrative for better readability of the resource ---
</text>
<url value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient" />
<version value="1.0.0" />
<name value="KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient" />
<title value="KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient" />
<status value="active" />
<publisher value="kv.digital GmbH" />
<name value="kv.digital GmbH" />
<system value="url" />
<value value="https://www.kv.digital" />
</telecom>
</contact>
<description value="Diese Ressource beschreibt eine Person, die eine oder mehrere medizinische Leistungen in Anspruch nimmt." />
<copyright value="Im folgenden Profil können Codes aus den Code-Systemen SNOMED CT®, LOINC, Ucum, ATC, ICD-10-GM, ICD-10-WHO, OPS, Alpha-ID/Alpha-ID-SE und ICF enthalten sein, die dem folgenden Urheberrecht unterliegen: This material includes SNOMED CT® Clinical Terms® (SNOMED CT® CT®) which is used by permission of SNOMED CT® International. All rights reserved. SNOMED CT® CT®, was originally created by The College of American Pathologists. SNOMED CT® and SNOMED CT® CT are registered trademarks of SNOMED CT® International. Implementers of these artefacts must have the appropriate SNOMED CT® CT Affiliate license. This material contains content from LOINC (http://LOINC.org). LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://LOINC.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc. This product includes all or a portion of the UCUM table, UCUM codes, and UCUM definitions or is derived from it, subject to a license from Regenstrief Institute, Inc. and The UCUM Organization. Your use of the UCUM table, UCUM codes, UCUM definitions also is subject to this license, a copy of which is available at http://unitsofmeasure.org. The current complete UCUM table, UCUM Specification are available for download at http://unitsofmeasure.org. The UCUM table and UCUM codes are copyright © 1995-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. THE UCUM TABLE (IN ALL FORMATS), UCUM DEFINITIONS, AND SPECIFICATION ARE PROVIDED 'AS IS.' ANY EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Dieses Material enthält Inhalte aus ATC. Die Erstellung erfolgte unter Verwendung der Datenträger der amtlichen Fassung der ATCKlassifikation mit DDD des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICD-10-GM, ICD-10-WHO, OPS Alpha-ID ans Alpha-ID-SE. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICF. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Deutschen Instituts für Medizinische Dokumentation und Information (DIMDI). ICF-Kodes, -Begriffe und -Texte © Weltgesundheitsorganisation, übersetzt und herausgegeben durch das Deutsche Institut für Medizinische Dokumentation und Information von der International classification of functioning, disability and health - ICF, herausgegeben durch die Weltgesundheitsorganisation." />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Patient" />
<baseDefinition value="https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Patient|1.6.0" />
<derivation value="constraint" />
<element id="Patient">
<path value="Patient" />
<short value="Patient, der eine medizinische Leistung in Anspruch nimmt" />
<definition value="Diese Ressource beschreibt eine Person, die eine oder mehrere medizinische Leistungen in Anspruch nimmt." />
</element>
<element id="Patient.meta">
<path value="Patient.meta" />
<min value="1" />
</element>
<element id="Patient.meta.profile">
<path value="Patient.meta.profile" />
<type value="value" />
<path value="$this" />
</discriminator>
<rules value="open" />
</slicing>
<min value="1" />
</element>
<element id="Patient.meta.profile:kvdigitalProfil">
<path value="Patient.meta.profile" />
<sliceName value="kvdigitalProfil" />
<min value="1" />
<max value="1" />
<patternCanonical value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient|1.0.0" />
</element>
<element id="Patient.text">
<path value="Patient.text" />
<definition value="In diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind." />
</element>
<element id="Patient.identifier">
<path value="Patient.identifier" />
<short value="Identifier des Patienten" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertenId_GKV">
<path value="Patient.identifier" />
<sliceName value="versichertenId_GKV" />
<short value="Identifier eGK" />
<definition value="Versichertennummer der elektronischen Gesundheitskarte (eGK)" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertenId_GKV.type">
<path value="Patient.identifier.type" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertenId_GKV.type.coding">
<path value="Patient.identifier.type.coding" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertenId_GKV.type.coding.system">
<path value="Patient.identifier.type.coding.system" />
<fixedUri value="http://fhir.de/CodeSystem/identifier-type-de-basis" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertenId_GKV.type.coding.version">
<path value="Patient.identifier.type.coding.version" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertenId_GKV.type.coding.code">
<path value="Patient.identifier.type.coding.code" />
<fixedCode value="GKV" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertenId_GKV.type.coding.display">
<path value="Patient.identifier.type.coding.display" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertenId_GKV.system">
<path value="Patient.identifier.system" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertenId_GKV.value">
<path value="Patient.identifier.value" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertennummer_kvk">
<path value="Patient.identifier" />
<sliceName value="versichertennummer_kvk" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertennummer_kvk.type">
<path value="Patient.identifier.type" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertennummer_kvk.type.coding">
<path value="Patient.identifier.type.coding" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertennummer_kvk.type.coding.system">
<path value="Patient.identifier.type.coding.system" />
<fixedUri value="https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertennummer_kvk.type.coding.version">
<path value="Patient.identifier.type.coding.version" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertennummer_kvk.type.coding.code">
<path value="Patient.identifier.type.coding.code" />
<fixedCode value="kvk" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertennummer_kvk.type.coding.display">
<path value="Patient.identifier.type.coding.display" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertennummer_kvk.system">
<path value="Patient.identifier.system" />
<mustSupport value="true" />
</element>
<element id="Patient.identifier:versichertennummer_kvk.value">
<path value="Patient.identifier.value" />
<mustSupport value="true" />
</element>
<element id="Patient.name">
<path value="Patient.name" />
<short value="Name" />
<definition value="Vollständiger Name der Person" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name">
<path value="Patient.name" />
<sliceName value="name" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.use">
<path value="Patient.name.use" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.family">
<path value="Patient.name.family" />
<maxLength value="87" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.family.extension">
<path value="Patient.name.family.extension" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.family.extension:namenszusatz">
<path value="Patient.name.family.extension" />
<sliceName value="namenszusatz" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.family.extension:namenszusatz.value[x]">
<path value="Patient.name.family.extension.value[x]" />
<min value="1" />
<maxLength value="20" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.family.extension:nachname">
<path value="Patient.name.family.extension" />
<sliceName value="nachname" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.family.extension:nachname.value[x]">
<path value="Patient.name.family.extension.value[x]" />
<maxLength value="45" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.family.extension:vorsatzwort">
<path value="Patient.name.family.extension" />
<sliceName value="vorsatzwort" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.family.extension:vorsatzwort.value[x]">
<path value="Patient.name.family.extension.value[x]" />
<maxLength value="20" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.given">
<path value="Patient.name.given" />
<min value="1" />
<maxLength value="45" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.prefix">
<path value="Patient.name.prefix" />
<max value="1" />
<maxLength value="20" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.prefix.extension">
<path value="Patient.name.prefix.extension" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.prefix.extension:prefix-qualifier">
<path value="Patient.name.prefix.extension" />
<sliceName value="prefix-qualifier" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.prefix.extension:prefix-qualifier.value[x]">
<path value="Patient.name.prefix.extension.value[x]" />
<mustSupport value="true" />
</element>
<element id="Patient.name:name.prefix.extension:prefix-qualifier.value[x]:valueCode">
<path value="Patient.name.prefix.extension.value[x]" />
<sliceName value="valueCode" />
<mustSupport value="true" />
</element>
<element id="Patient.telecom">
<path value="Patient.telecom" />
<type value="value" />
<path value="system" />
</discriminator>
<rules value="open" />
</slicing>
<short value="Kontaktdaten der Person" />
<mustSupport value="true" />
</element>
<element id="Patient.telecom:telefonnummer">
<path value="Patient.telecom" />
<sliceName value="telefonnummer" />
<short value="Telefonnummer der Person" />
<definition value="Telefonnummer, unter der die Person erreichbar ist" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.telecom:telefonnummer.system">
<path value="Patient.telecom.system" />
<fixedCode value="phone" />
<mustSupport value="true" />
</element>
<element id="Patient.telecom:telefonnummer.value">
<path value="Patient.telecom.value" />
<short value="Telefonnummer" />
<maxLength value="100" />
<mustSupport value="true" />
</element>
<element id="Patient.telecom:email">
<path value="Patient.telecom" />
<sliceName value="email" />
<short value="E-Mail-Adresse der Person" />
<definition value="E-Mail-Adresse, unter der die Person erreichbar ist" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.telecom:email.system">
<path value="Patient.telecom.system" />
<fixedCode value="email" />
<mustSupport value="true" />
</element>
<element id="Patient.telecom:email.value">
<path value="Patient.telecom.value" />
<short value="Emailadresse der Person" />
<maxLength value="100" />
<mustSupport value="true" />
</element>
<element id="Patient.gender">
<path value="Patient.gender" />
<definition value="Das administrative Geschlecht eines Patienten, auf dessen Basis die Anrede festgelegt wird.\nmale = Mann\nfemale = Frau\nother = Divers\nunknown = unbekannt" />
<comment value="Im Falle von "other" muss in der Extension "other-amtlich" der Code "D" (für divers) oder "X" (für unbestimmt) eintragen werden!" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.gender.extension">
<path value="Patient.gender.extension" />
<mustSupport value="true" />
</element>
<element id="Patient.gender.extension:other-amtlich">
<path value="Patient.gender.extension" />
<sliceName value="other-amtlich" />
<short value="Konkretisierung des Geschlechts "other"" />
<definition value="Falls bei gender "other" angegeben wurde, muss hier die entweder "D" für "divers" oder "X" für "unbestimmt" eingetragen werden, um eine amtliche Unterscheidung zu ermöglichen." />
<mustSupport value="true" />
</element>
<element id="Patient.gender.extension:other-amtlich.value[x]">
<path value="Patient.gender.extension.value[x]" />
<short value="Coding zum Geschlecht" />
<definition value="Vorgegebenes Coding zur amtlichen Unterscheidung des Geschlechts im Falle von "other"" />
<mustSupport value="true" />
</element>
<element id="Patient.gender.extension:other-amtlich.value[x].system">
<path value="Patient.gender.extension.value[x].system" />
<min value="1" />
<fixedUri value="http://fhir.de/CodeSystem/gender-amtlich-de" />
<mustSupport value="true" />
</element>
<element id="Patient.gender.extension:other-amtlich.value[x].version">
<path value="Patient.gender.extension.value[x].version" />
<mustSupport value="true" />
</element>
<element id="Patient.gender.extension:other-amtlich.value[x].code">
<path value="Patient.gender.extension.value[x].code" />
<short value="D | X" />
<definition value="Für das Geschlecht "other" wird eine amtliche Unterscheidung zwischen "divers" (D) und "unbestimmt" (X) vorgenommen." />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.gender.extension:other-amtlich.value[x].display">
<path value="Patient.gender.extension.value[x].display" />
<short value="divers | unbestimmt" />
<definition value="Für das Geschlecht "other" wird eine amtliche Unterscheidung zwischen "divers" und "unbestimmt" vorgenommen." />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.birthDate">
<path value="Patient.birthDate" />
<short value="Geburtsdatum" />
<definition value="Geburtsdatum der Person" />
<comment value="Für ein gültiges Geburtsdatum muss min. das Geburtsjahr bekannt sein. Sollte dies nicht der Fall sein, muss die Extension data-absent-reason gesetzt werden." />
<mustSupport value="true" />
</element>
<element id="Patient.birthDate.extension">
<path value="Patient.birthDate.extension" />
<mustSupport value="true" />
</element>
<element id="Patient.birthDate.extension:data-absent-reason">
<path value="Patient.birthDate.extension" />
<sliceName value="data-absent-reason" />
<mustSupport value="true" />
</element>
<element id="Patient.birthDate.extension:data-absent-reason.value[x]">
<path value="Patient.birthDate.extension.value[x]" />
<mustSupport value="true" />
</element>
<element id="Patient.birthDate.extension:data-absent-reason.value[x]:valueCode">
<path value="Patient.birthDate.extension.value[x]" />
<sliceName value="valueCode" />
<mustSupport value="true" />
</element>
<element id="Patient.address">
<path value="Patient.address" />
<short value="Anschrift der Person" />
<definition value="Die postalische Strassenanschrift der Person" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Strassenanschrift">
<path value="Patient.address" />
<sliceName value="Strassenanschrift" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Strassenanschrift.type">
<path value="Patient.address.type" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Strassenanschrift.line">
<path value="Patient.address.line" />
<min value="1" />
<max value="1" />
<maxLength value="97" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Strassenanschrift.line.extension">
<path value="Patient.address.line.extension" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Strassenanschrift.line.extension:Strasse">
<path value="Patient.address.line.extension" />
<sliceName value="Strasse" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Strassenanschrift.line.extension:Strasse.value[x]">
<path value="Patient.address.line.extension.value[x]" />
<maxLength value="46" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Strassenanschrift.line.extension:Hausnummer">
<path value="Patient.address.line.extension" />
<sliceName value="Hausnummer" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Strassenanschrift.line.extension:Hausnummer.value[x]">
<path value="Patient.address.line.extension.value[x]" />
<maxLength value="9" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Strassenanschrift.line.extension:Adresszusatz">
<path value="Patient.address.line.extension" />
<sliceName value="Adresszusatz" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Strassenanschrift.line.extension:Adresszusatz.value[x]">
<path value="Patient.address.line.extension.value[x]" />
<maxLength value="40" />
</element>
<element id="Patient.address:Strassenanschrift.city">
<path value="Patient.address.city" />
<short value="Name der Stadt" />
<min value="1" />
<maxLength value="40" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Strassenanschrift.postalCode">
<path value="Patient.address.postalCode" />
<maxLength value="5" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Strassenanschrift.country">
<path value="Patient.address.country" />
<min value="1" />
<maxLength value="3" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Postfach">
<path value="Patient.address" />
<sliceName value="Postfach" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Postfach.type">
<path value="Patient.address.type" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Postfach.line">
<path value="Patient.address.line" />
<min value="1" />
<max value="1" />
<maxLength value="17" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Postfach.line.extension">
<path value="Patient.address.line.extension" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Postfach.line.extension:Postfach">
<path value="Patient.address.line.extension" />
<sliceName value="Postfach" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Postfach.line.extension:Postfach.value[x]">
<path value="Patient.address.line.extension.value[x]" />
<maxLength value="8" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Postfach.city">
<path value="Patient.address.city" />
<min value="1" />
<maxLength value="40" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Postfach.postalCode">
<path value="Patient.address.postalCode" />
<maxLength value="5" />
<mustSupport value="true" />
</element>
<element id="Patient.address:Postfach.country">
<path value="Patient.address.country" />
<min value="1" />
<maxLength value="3" />
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "KBV-PR-116117-TERMINSERVICE-TVS-TSYNCH-Patient",
"text": {
"status": "generated",
--- We have skipped the narrative for better readability of the resource ---
},
"url": "https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient",
"version": "1.0.0",
"name": "KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient",
"title": "KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient",
"status": "active",
"publisher": "kv.digital GmbH",
"contact": [
{
"name": "kv.digital GmbH",
"telecom": [
{
"system": "url",
"value": "https://www.kv.digital"
}
]
}
],
"description": "Diese Ressource beschreibt eine Person, die eine oder mehrere medizinische Leistungen in Anspruch nimmt.",
"copyright": "Im folgenden Profil können Codes aus den Code-Systemen SNOMED CT®, LOINC, Ucum, ATC, ICD-10-GM, ICD-10-WHO, OPS, Alpha-ID/Alpha-ID-SE und ICF enthalten sein, die dem folgenden Urheberrecht unterliegen: This material includes SNOMED CT® Clinical Terms® (SNOMED CT® CT®) which is used by permission of SNOMED CT® International. All rights reserved. SNOMED CT® CT®, was originally created by The College of American Pathologists. SNOMED CT® and SNOMED CT® CT are registered trademarks of SNOMED CT® International. Implementers of these artefacts must have the appropriate SNOMED CT® CT Affiliate license. This material contains content from LOINC (http://LOINC.org). LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://LOINC.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc. This product includes all or a portion of the UCUM table, UCUM codes, and UCUM definitions or is derived from it, subject to a license from Regenstrief Institute, Inc. and The UCUM Organization. Your use of the UCUM table, UCUM codes, UCUM definitions also is subject to this license, a copy of which is available at http://unitsofmeasure.org. The current complete UCUM table, UCUM Specification are available for download at http://unitsofmeasure.org. The UCUM table and UCUM codes are copyright © 1995-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. THE UCUM TABLE (IN ALL FORMATS), UCUM DEFINITIONS, AND SPECIFICATION ARE PROVIDED 'AS IS.' ANY EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Dieses Material enthält Inhalte aus ATC. Die Erstellung erfolgte unter Verwendung der Datenträger der amtlichen Fassung der ATCKlassifikation mit DDD des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICD-10-GM, ICD-10-WHO, OPS Alpha-ID ans Alpha-ID-SE. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICF. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Deutschen Instituts für Medizinische Dokumentation und Information (DIMDI). ICF-Kodes, -Begriffe und -Texte © Weltgesundheitsorganisation, übersetzt und herausgegeben durch das Deutsche Institut für Medizinische Dokumentation und Information von der International classification of functioning, disability and health - ICF, herausgegeben durch die Weltgesundheitsorganisation.",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Patient",
"baseDefinition": "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Patient|1.6.0",
"derivation": "constraint",
"element": [
{
"id": "Patient",
"path": "Patient",
"short": "Patient, der eine medizinische Leistung in Anspruch nimmt",
"definition": "Diese Ressource beschreibt eine Person, die eine oder mehrere medizinische Leistungen in Anspruch nimmt."
},
{
"id": "Patient.meta",
"path": "Patient.meta",
"min": 1
},
{
"id": "Patient.meta.profile",
"path": "Patient.meta.profile",
"slicing": {
{
"type": "value",
"path": "$this"
}
],
"rules": "open"
},
"min": 1
},
{
"id": "Patient.meta.profile:kvdigitalProfil",
"path": "Patient.meta.profile",
"sliceName": "kvdigitalProfil",
"min": 1,
"max": "1",
"patternCanonical": "https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient|1.0.0"
},
{
"id": "Patient.text",
"path": "Patient.text",
"definition": "In diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind."
},
{
"id": "Patient.identifier",
"path": "Patient.identifier",
"short": "Identifier des Patienten",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertenId_GKV",
"path": "Patient.identifier",
"sliceName": "versichertenId_GKV",
"short": "Identifier eGK",
"definition": "Versichertennummer der elektronischen Gesundheitskarte (eGK)",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertenId_GKV.type",
"path": "Patient.identifier.type",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertenId_GKV.type.coding",
"path": "Patient.identifier.type.coding",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertenId_GKV.type.coding.system",
"path": "Patient.identifier.type.coding.system",
"fixedUri": "http://fhir.de/CodeSystem/identifier-type-de-basis",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertenId_GKV.type.coding.version",
"path": "Patient.identifier.type.coding.version",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertenId_GKV.type.coding.code",
"path": "Patient.identifier.type.coding.code",
"fixedCode": "GKV",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertenId_GKV.type.coding.display",
"path": "Patient.identifier.type.coding.display",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.identifier:versichertenId_GKV.system",
"path": "Patient.identifier.system",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertenId_GKV.value",
"path": "Patient.identifier.value",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertennummer_kvk",
"path": "Patient.identifier",
"sliceName": "versichertennummer_kvk",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertennummer_kvk.type",
"path": "Patient.identifier.type",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertennummer_kvk.type.coding",
"path": "Patient.identifier.type.coding",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertennummer_kvk.type.coding.system",
"path": "Patient.identifier.type.coding.system",
"fixedUri": "https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertennummer_kvk.type.coding.version",
"path": "Patient.identifier.type.coding.version",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertennummer_kvk.type.coding.code",
"path": "Patient.identifier.type.coding.code",
"fixedCode": "kvk",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertennummer_kvk.type.coding.display",
"path": "Patient.identifier.type.coding.display",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.identifier:versichertennummer_kvk.system",
"path": "Patient.identifier.system",
"mustSupport": true
},
{
"id": "Patient.identifier:versichertennummer_kvk.value",
"path": "Patient.identifier.value",
"mustSupport": true
},
{
"id": "Patient.name",
"path": "Patient.name",
"short": "Name",
"definition": "Vollständiger Name der Person",
"mustSupport": true
},
{
"id": "Patient.name:name",
"path": "Patient.name",
"sliceName": "name",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.name:name.use",
"path": "Patient.name.use",
"mustSupport": true
},
{
"id": "Patient.name:name.family",
"path": "Patient.name.family",
"maxLength": 87,
"mustSupport": true
},
{
"id": "Patient.name:name.family.extension",
"path": "Patient.name.family.extension",
"mustSupport": true
},
{
"id": "Patient.name:name.family.extension:namenszusatz",
"path": "Patient.name.family.extension",
"sliceName": "namenszusatz",
"mustSupport": true
},
{
"id": "Patient.name:name.family.extension:namenszusatz.value[x]",
"path": "Patient.name.family.extension.value[x]",
"min": 1,
"maxLength": 20,
"mustSupport": true
},
{
"id": "Patient.name:name.family.extension:nachname",
"path": "Patient.name.family.extension",
"sliceName": "nachname",
"mustSupport": true
},
{
"id": "Patient.name:name.family.extension:nachname.value[x]",
"path": "Patient.name.family.extension.value[x]",
"maxLength": 45,
"mustSupport": true
},
{
"id": "Patient.name:name.family.extension:vorsatzwort",
"path": "Patient.name.family.extension",
"sliceName": "vorsatzwort",
"mustSupport": true
},
{
"id": "Patient.name:name.family.extension:vorsatzwort.value[x]",
"path": "Patient.name.family.extension.value[x]",
"maxLength": 20,
"mustSupport": true
},
{
"id": "Patient.name:name.given",
"path": "Patient.name.given",
"min": 1,
"maxLength": 45,
"mustSupport": true
},
{
"id": "Patient.name:name.prefix",
"path": "Patient.name.prefix",
"max": "1",
"maxLength": 20,
"mustSupport": true
},
{
"id": "Patient.name:name.prefix.extension",
"path": "Patient.name.prefix.extension",
"max": "1",
"mustSupport": true
},
{
"id": "Patient.name:name.prefix.extension:prefix-qualifier",
"path": "Patient.name.prefix.extension",
"sliceName": "prefix-qualifier",
"mustSupport": true
},
{
"id": "Patient.name:name.prefix.extension:prefix-qualifier.value[x]",
"path": "Patient.name.prefix.extension.value[x]",
"mustSupport": true
},
{
"id": "Patient.name:name.prefix.extension:prefix-qualifier.value[x]:valueCode",
"path": "Patient.name.prefix.extension.value[x]",
"sliceName": "valueCode",
"mustSupport": true
},
{
"id": "Patient.telecom",
"path": "Patient.telecom",
"slicing": {
{
"type": "value",
"path": "system"
}
],
"rules": "open"
},
"short": "Kontaktdaten der Person",
"mustSupport": true
},
{
"id": "Patient.telecom:telefonnummer",
"path": "Patient.telecom",
"sliceName": "telefonnummer",
"short": "Telefonnummer der Person",
"definition": "Telefonnummer, unter der die Person erreichbar ist",
"max": "1",
"mustSupport": true
},
{
"id": "Patient.telecom:telefonnummer.system",
"path": "Patient.telecom.system",
"fixedCode": "phone",
"mustSupport": true
},
{
"id": "Patient.telecom:telefonnummer.value",
"path": "Patient.telecom.value",
"short": "Telefonnummer",
"maxLength": 100,
"mustSupport": true
},
{
"id": "Patient.telecom:email",
"path": "Patient.telecom",
"sliceName": "email",
"short": "E-Mail-Adresse der Person",
"definition": "E-Mail-Adresse, unter der die Person erreichbar ist",
"max": "1",
"mustSupport": true
},
{
"id": "Patient.telecom:email.system",
"path": "Patient.telecom.system",
"fixedCode": "email",
"mustSupport": true
},
{
"id": "Patient.telecom:email.value",
"path": "Patient.telecom.value",
"short": "Emailadresse der Person",
"maxLength": 100,
"mustSupport": true
},
{
"id": "Patient.gender",
"path": "Patient.gender",
"definition": "Das administrative Geschlecht eines Patienten, auf dessen Basis die Anrede festgelegt wird.\nmale = Mann\nfemale = Frau\nother = Divers\nunknown = unbekannt",
"comment": "Im Falle von \"other\" muss in der Extension \"other-amtlich\" der Code \"D\" (für divers) oder \"X\" (für unbestimmt) eintragen werden!",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.gender.extension",
"path": "Patient.gender.extension",
"mustSupport": true
},
{
"id": "Patient.gender.extension:other-amtlich",
"path": "Patient.gender.extension",
"sliceName": "other-amtlich",
"short": "Konkretisierung des Geschlechts \"other\"",
"definition": "Falls bei gender \"other\" angegeben wurde, muss hier die entweder \"D\" für \"divers\" oder \"X\" für \"unbestimmt\" eingetragen werden, um eine amtliche Unterscheidung zu ermöglichen.",
"mustSupport": true
},
{
"id": "Patient.gender.extension:other-amtlich.value[x]",
"path": "Patient.gender.extension.value[x]",
"short": "Coding zum Geschlecht",
"definition": "Vorgegebenes Coding zur amtlichen Unterscheidung des Geschlechts im Falle von \"other\"",
"mustSupport": true
},
{
"id": "Patient.gender.extension:other-amtlich.value[x].system",
"path": "Patient.gender.extension.value[x].system",
"min": 1,
"fixedUri": "http://fhir.de/CodeSystem/gender-amtlich-de",
"mustSupport": true
},
{
"id": "Patient.gender.extension:other-amtlich.value[x].version",
"path": "Patient.gender.extension.value[x].version",
"mustSupport": true
},
{
"id": "Patient.gender.extension:other-amtlich.value[x].code",
"path": "Patient.gender.extension.value[x].code",
"short": "D | X",
"definition": "Für das Geschlecht \"other\" wird eine amtliche Unterscheidung zwischen \"divers\" (D) und \"unbestimmt\" (X) vorgenommen.",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.gender.extension:other-amtlich.value[x].display",
"path": "Patient.gender.extension.value[x].display",
"short": "divers | unbestimmt",
"definition": "Für das Geschlecht \"other\" wird eine amtliche Unterscheidung zwischen \"divers\" und \"unbestimmt\" vorgenommen.",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.birthDate",
"path": "Patient.birthDate",
"short": "Geburtsdatum",
"definition": "Geburtsdatum der Person",
"comment": "Für ein gültiges Geburtsdatum muss min. das Geburtsjahr bekannt sein. Sollte dies nicht der Fall sein, muss die Extension data-absent-reason gesetzt werden.",
"mustSupport": true
},
{
"id": "Patient.birthDate.extension",
"path": "Patient.birthDate.extension",
"mustSupport": true
},
{
"id": "Patient.birthDate.extension:data-absent-reason",
"path": "Patient.birthDate.extension",
"sliceName": "data-absent-reason",
"mustSupport": true
},
{
"id": "Patient.birthDate.extension:data-absent-reason.value[x]",
"path": "Patient.birthDate.extension.value[x]",
"mustSupport": true
},
{
"id": "Patient.birthDate.extension:data-absent-reason.value[x]:valueCode",
"path": "Patient.birthDate.extension.value[x]",
"sliceName": "valueCode",
"mustSupport": true
},
{
"id": "Patient.address",
"path": "Patient.address",
"short": "Anschrift der Person",
"definition": "Die postalische Strassenanschrift der Person",
"mustSupport": true
},
{
"id": "Patient.address:Strassenanschrift",
"path": "Patient.address",
"sliceName": "Strassenanschrift",
"max": "1",
"mustSupport": true
},
{
"id": "Patient.address:Strassenanschrift.type",
"path": "Patient.address.type",
"mustSupport": true
},
{
"id": "Patient.address:Strassenanschrift.line",
"path": "Patient.address.line",
"min": 1,
"max": "1",
"maxLength": 97,
"mustSupport": true
},
{
"id": "Patient.address:Strassenanschrift.line.extension",
"path": "Patient.address.line.extension",
"mustSupport": true
},
{
"id": "Patient.address:Strassenanschrift.line.extension:Strasse",
"path": "Patient.address.line.extension",
"sliceName": "Strasse",
"mustSupport": true
},
{
"id": "Patient.address:Strassenanschrift.line.extension:Strasse.value[x]",
"path": "Patient.address.line.extension.value[x]",
"maxLength": 46,
"mustSupport": true
},
{
"id": "Patient.address:Strassenanschrift.line.extension:Hausnummer",
"path": "Patient.address.line.extension",
"sliceName": "Hausnummer",
"mustSupport": true
},
{
"id": "Patient.address:Strassenanschrift.line.extension:Hausnummer.value[x]",
"path": "Patient.address.line.extension.value[x]",
"maxLength": 9,
"mustSupport": true
},
{
"id": "Patient.address:Strassenanschrift.line.extension:Adresszusatz",
"path": "Patient.address.line.extension",
"sliceName": "Adresszusatz",
"mustSupport": true
},
{
"id": "Patient.address:Strassenanschrift.line.extension:Adresszusatz.value[x]",
"path": "Patient.address.line.extension.value[x]",
"maxLength": 40
},
{
"id": "Patient.address:Strassenanschrift.city",
"path": "Patient.address.city",
"short": "Name der Stadt",
"min": 1,
"maxLength": 40,
"mustSupport": true
},
{
"id": "Patient.address:Strassenanschrift.postalCode",
"path": "Patient.address.postalCode",
"maxLength": 5,
"mustSupport": true
},
{
"id": "Patient.address:Strassenanschrift.country",
"path": "Patient.address.country",
"min": 1,
"maxLength": 3,
"mustSupport": true
},
{
"id": "Patient.address:Postfach",
"path": "Patient.address",
"sliceName": "Postfach",
"max": "1",
"mustSupport": true
},
{
"id": "Patient.address:Postfach.type",
"path": "Patient.address.type",
"mustSupport": true
},
{
"id": "Patient.address:Postfach.line",
"path": "Patient.address.line",
"min": 1,
"max": "1",
"maxLength": 17,
"mustSupport": true
},
{
"id": "Patient.address:Postfach.line.extension",
"path": "Patient.address.line.extension",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.address:Postfach.line.extension:Postfach",
"path": "Patient.address.line.extension",
"sliceName": "Postfach",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.address:Postfach.line.extension:Postfach.value[x]",
"path": "Patient.address.line.extension.value[x]",
"maxLength": 8,
"mustSupport": true
},
{
"id": "Patient.address:Postfach.city",
"path": "Patient.address.city",
"min": 1,
"maxLength": 40,
"mustSupport": true
},
{
"id": "Patient.address:Postfach.postalCode",
"path": "Patient.address.postalCode",
"maxLength": 5,
"mustSupport": true
},
{
"id": "Patient.address:Postfach.country",
"path": "Patient.address.country",
"min": 1,
"maxLength": 3,
"mustSupport": true
}
]
}
}

Anmerkungen

Das FHIR-Profil wurde so profiliert, dass es mit den Daten auf der eGK kompatibel ist; d.h., wenn Daten eines Patienten über dessen eGK ausgelesen werden, können diese direkt mit den Daten aus dem 116117 Terminservice abgeglichen werden. Als Grundlage hierfür dient das auf der Webseite der KBV veröffentlichte Dokument Anwendung der eGK: Technische Anlage zu Anlage 4a (BMV-Ä).


In der folgenden Tabelle finden sich Anmerkungen zu einzelnen Feldern.

Feld Anmerkung

Patient.name:name.given

Patient.name:name.family

Die Schnittstelle akzeptiert alle Zeichen nach ISO/IEC 8859-15 (auch Latin-9 genannt) mit Ausnahme von:
  • ! " = © § € ± # $ % & * + , . / : ; < > ? @ \ ^ _ ` { | } ~ „ ” » « ° ¶ ·
Folgende Zeichenketten sind außerdem NICHT erlaubt:
  • 0x ../ ..\ /* */ \n \t
Patient.telecom:telefonnummer.value Folgende Zeichen sind erlaubt:
  • Zahlen (0-9)
  • Leerzeichen sowie _ + -
Patient.birthDate Das Datum darf nicht in der Zukunft oder mehr als 150 Jahre in der Vergangenheit liegen.
Patient.address:Strassenanschrift.line.extension:Strasse.value Die Schnittstelle akzeptiert alle Zeichen nach ISO/IEC 8859-15 (auch Latin-9 genannt) mit Ausnahme von:
  • ! " = © § € ± # $ % & * + , / : ; < > ? @ \ ^ _ ` { | } ~ „ ” » « ° ¶ ·
Folgende Zeichenketten sind außerdem NICHT erlaubt:
  • 0x ../ ..\ /* */ \n \t
Patient.address:Strassenanschrift.line.extension:Hausnummer.value Dieses Feld kann folgende Zeichen enthalten:
  • Klein- und Großbuchstaben inkl. Umlaute und ß (A-Z, a-z, ÄÖÜ, äöü, ß)
  • Zahlen (0-9)
  • Leerzeichen sowie _ . ; , / ( ) - +
Patient.address.city Die Schnittstelle akzeptiert alle Zeichen nach ISO/IEC 8859-15 (auch Latin-9 genannt) mit Ausnahme von:
  • ! " = © § € ± # $ % & * + , : ; < > ? @ \ ^ _ ` { | } ~ „ ” » « ° ¶ ·
Folgende Zeichenketten sind außerdem NICHT erlaubt:
  • 0x ../ ..\ /* */ \n \t
Patient.address.postalCode Die Postleitzahl muss aus exakt 5 Zahlen (0-9) bestehen.

Folgende (mit einem Must-Support-Flag gekennzeichnete) Elemente werden von den Systemen des 116117 Terminservices gespeichert, verarbeitet und zurückgegeben:

  • identifier

    • identifier:versichertenId_GKV

    • identifier:versichertennummer_kvk

  • name:name.family:

    • name:name.family

      • name:name.family.extension:namenszusatz

      • name:name.family.extension:nachname

      • name:name.family.extension:vorsatzwort

    • name:name.given

    • name:name.prefix

      • name:name.prefix.extension:prefix-qualifier

  • telecom

    • telecom:telefonnummer

    • telecom:email

  • gender

    • gender.extension:other-amtlich

  • birthDate

    • birthDate.extension:data-absent-reason

  • address:Strassenanschrift:

    • address:Strassenanschrift.line

      • address:Strassenanschrift.line.extension:Strasse

      • address:Strassenanschrift.line.extension:Hausnummer

      • address:Strassenanschrift.line.extension:Adresszusatz

    • address:Strassenanschrift.city

    • address:Strassenanschrift.postalCode

    • address:Strassenanschrift.country

  • address:Postfach:

    • address:Postfach.line

      • address:Postfach.line.extension:Postfach

    • address:Postfach.city

    • address:Postfach.postalCode

    • address:Postfach.country


Terminology Bindings

Es sind KEINE Terminologien abweichend vom Basisprofil definiert.


Interaktionen

Es können KEINE Interaktionen auf dieser Ressource ausgeführt werden.


Beispiele

Alle Beispiele sind hier im vorliegenden Projekt zu finden.


<Patient xmlns="http://hl7.org/fhir">
<id value="9821b80b-76b7-4635-886b-1027e7a6cd14" />
<profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient|1.0.0" />
</meta>
<status value="extensions" />
--- We have skipped the narrative for better readability of the resource ---
</text>
<system value="http://fhir.de/CodeSystem/identifier-type-de-basis" />
<version value="1.4.0" />
<code value="GKV" />
<display value="Gesetzliche Krankenversicherung" />
</coding>
</type>
<system value="http://fhir.de/sid/gkv/kvid-10" />
<value value="A123456789" />
</identifier>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_Base_identifier_type" />
<version value="1.5.0" />
<code value="kvk" />
<display value="Krankenversichertenkarte" />
</coding>
</type>
<system value="http://fhir.de/sid/gkv/kvk-versichertennummer" />
<value value="987654321" />
</identifier>
<use value="official" />
<family value="Mustermensch">
<extension url="http://fhir.de/StructureDefinition/humanname-namenszusatz">
<valueString value="Gräfin" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name">
<valueString value="Mustermensch" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-prefix">
<valueString value="von" />
</extension>
</family>
<given value="Maxi" />
<prefix value="Prof.">
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier">
<valueCode value="AC" />
</extension>
</prefix>
</name>
<system value="phone" />
<value value="030123456789" />
</telecom>
<system value="email" />
<value value="m.mustermensch@gmail.com" />
</telecom>
<gender value="other">
<extension url="http://fhir.de/StructureDefinition/gender-amtlich-de">
<system value="http://fhir.de/CodeSystem/gender-amtlich-de" />
<code value="D" />
<display value="divers" />
</valueCoding>
</extension>
</gender>
<extension url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
<valueCode value="unknown" />
</extension>
</birthDate>
<type value="both" />
<line value="Musterstr. 1">
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber">
<valueString value="1" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName">
<valueString value="Musterstr." />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator">
<valueString value="3. OG Seitenflügel" />
</extension>
</line>
<city value="Darmstadt" />
<postalCode value="64283" />
<country value="D" />
</address>
<type value="postal" />
<line value="Postfach 112233">
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox">
<valueString value="112233" />
</extension>
</line>
<city value="Darmstadt" />
<postalCode value="64283" />
<country value="D" />
</address>
</Patient>
<Patient xmlns="http://hl7.org/fhir">
<id value="12571683-1966-4f87-86dc-e301487714bd" />
<profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Patient|1.0.0" />
</meta>
<status value="extensions" />
--- We have skipped the narrative for better readability of the resource ---
</text>
<use value="official" />
<family value="Mustermensch" />
<given value="Mini" />
</name>
<gender value="female" />
<birthDate value="2002" />
</Patient>