Implementierungsleitfaden ISiK-Basismodul Stufe 2

Patient (Patient)

Die nachfolgenden Festlegungen spezifizieren die Abbildung von Minimalanforderungen für die Bereitstellung von administrativen Patientendaten im Rahmen des Bestätigungsverfahrens der gematik.

Motivation

Der Austausch administrativer Patientendaten ist eine der grundlegenden Funktionalitäten beim Datenaustausch in der klinischen Versorgung.

In FHIR werden sämtliche klinischen Ressourcen durch Verlinkung auf die Ressource 'Patient' in einen Patientenkontext gestellt.

Die Herstellung des korrekten Patientenkontextes durch Suchen der Patientenressource anhand von Eigenschaften wie Aufnahmenummer, Name oder Geburtsdatum, die Anzeige der zutreffenden Suchergebnisse und der Auswahl bzw. Bestätigung des richtigen Datensatzes durch den Anwender steht am Beginn der meisten klinischen Workflows.

Kompatibilität

Dieses Profil basiert auf dem Profil KBV_PR_Base_Patient der KBV Basisprofile.

Instanzen, die gegen ISiKPatient valide sind, sind auch valide gegen:

Profil KBV_PR_Base_Patient der KBV Basisprofile - v1.2.1
Profil Patient im International Patient Summary (IPS) - STU-1
Profil Patient der MI-Initiative - v2.0.0
- wenn in indentifier:pid.assigner eine Referenz auf eine Organisation angegeben wurde
- wenn in identifier:versichertenId_GKV.assigner die IK-NR der Krankenversicherung angegeben ist
Profil Patient der KBV Archiv- und Wechselschnittstelle - v1.2.0
- wenn die Ressource einen Narrative enthält und in den Metadaten die Canonical-URL des KBV-Profile angegeben wird

Instanzen, die gegen dieses Profil valide sind, sind nicht valide gegen:

Profil Patient der formularübergreifenden Vorgaben der KBV - v1.0.3 (eRezept/eAU)
Um die Kompatibilität herzustellen sind folgende Schritte erforderlich:
- es MUSS genau eine Adresse angegeben werden (Mehrfachangaben sind nicht erlaubt)
- folgende Elemente MÜSSEN entfernt werden:
  - active
  - identifier:pid
  - name:geburtsname
  - gender
Profil Patient Deutsches Elektronisches Melde- und Informationssystem für den Infektionsschutz (RKI) - v1.1.1
Aus Gründen der Datensparsamkeit bei der Übermittelung einer Meldung nach Infektionsschutzgesetz müssen bestimmte Datenelemente entfernt werden. Um die Kompatibilität herzustellen sind folgende Schritte erforderlich:
- es MUSS der offizielle Name der Person angegeben werden (Angabe des Geburtsnamen nicht erlaubt)
- es MUSS die Straßenanschrift der Person angegeben werden (Angabe einer Postfachadresse nicht erlaubt)
- innerhalb der Straßenanschrift der Person MÜSSEN alle Zustell- oder Abholangaben in eine Adresszeile abgebildet werden

FHIR-Profil

Name	Canonical
ISiKPatient	https://gematik.de/fhir/isik/v2/Basismodul/StructureDefinition/ISiKPatient

Patient	I		Patient	Element Id Patient Short description Information about an individual or animal receiving health care services Alternate names SubjectOfCare Client Resident Definition Demographics and other administrative information about an individual or animal receiving care or other health-related services. Data Type Patient Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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-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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` isik-pat-1:Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden `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
id	S Σ	0..1	System.String	There are no (further) constraints on this element Element Id Patient.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data Type System.String
identifier	S Σ	1..*	Identifier	Element Id Patient.identifier Short description An identifier for this patient Definition An identifier for this patient. Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier Sliced: Unordered, Open, by $this(Pattern) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - 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 w5:FiveWs.identifier v2:PID-3 rim:id cda:.id
VersichertenId-GKV	S Σ	0..1	Identifier-Profil für die 10-stellige Krankenversichertennummer	Element Id Patient.identifier:VersichertenId-GKV Short description An identifier intended for computation Definition An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier-Profil für die 10-stellige Krankenversichertennummer Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern { "type": { "coding": [ { "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "code": "GKV" } ] } } Mappings 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 w5:FiveWs.identifier v2:PID-3 rim:id cda:.id
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.identifier:VersichertenId-GKV.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	S Σ	1..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Patient.identifier:VersichertenId-GKV.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeDeBasis (extensible) 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 rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	S Σ	1..1	uriFixed Value	There are no (further) constraints on this element Element Id Patient.identifier:VersichertenId-GKV.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value http://fhir.de/sid/gkv/kvid-10 Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	S Σ I	1..1	string	There are no (further) constraints on this element Element Id Patient.identifier:VersichertenId-GKV.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. 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. Data Type string 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}$')` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.identifier:VersichertenId-GKV.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.identifier:VersichertenId-GKV.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
Patientennummer	S Σ	1..*	Identifier-Profil für die Abbildung einer Patienten-ID	Element Id Patient.identifier:Patientennummer Short description An identifier intended for computation Definition An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier-Profil für die Abbildung einer Patienten-ID Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern { "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "MR" } ] } } Mappings 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 w5:FiveWs.identifier v2:PID-3 rim:id cda:.id
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.identifier:Patientennummer.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	S Σ	1..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Patient.identifier:Patientennummer.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeDeBasis (extensible) 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 rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	S Σ	1..1	uri	There are no (further) constraints on this element Element Id Patient.identifier:Patientennummer.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	S Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.identifier:Patientennummer.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.identifier:Patientennummer.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.identifier:Patientennummer.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
Versichertennummer_PKV	Σ	0..1	Identifier-Profil für die Abbildung einer Privatversichertennummer	Element Id Patient.identifier:Versichertennummer_PKV Short description An identifier intended for computation Definition An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier-Profil für die Abbildung einer Privatversichertennummer Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern { "type": { "coding": [ { "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "code": "PKV" } ] } } Mappings 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 w5:FiveWs.identifier v2:PID-3 rim:id cda:.id
use	S Σ ?!	0..1	codeBindingFixed Value	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value secondary Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	S Σ	1..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeDeBasis (extensible) 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": "PKV" } ] } Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	S Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	S Σ I	1..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.assigner.reference Short description Literal 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. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.assigner.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier-Profil für die Abbildung eines Institutionskennzeichens (IKNR)	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.assigner.identifier Short description An identifier intended for computation Definition An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier-Profil für die Abbildung eines Institutionskennzeichens (IKNR) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - 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 rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.assigner.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.assigner.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeDeBasis (extensible) 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": "XX" } ] } Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	S Σ	1..1	uriFixed Value	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.assigner.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value http://fhir.de/sid/arge-ik/iknr Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	S Σ I	1..1	string	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.assigner.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ik-1:Eine IK muss 8- (ohne Prüfziffer) oder 9-stellig (mit Prüfziffer) sein `matches('[0-9]{8,9}')` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.assigner.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.assigner.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	S Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.identifier:Versichertennummer_PKV.assigner.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
active	S Σ ?!	0..1	boolean	There are no (further) constraints on this element Element Id Patient.active Short description Whether this patient's record is in active use Definition Whether this patient record is in active use. 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. 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. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:statusCode cda:n/a
name	S Σ	1..*	HumanName	Element Id Patient.name Short description A name associated with the patient Definition A name associated with the individual. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments In order to maintain the differntiations of name parts as given in the VSDM dataset or qualify prefixes as academic titles, vendors can opt to support the extensions specified in the German HumanName Base Profile https://simplifier.net/basisprofil-de-r4/humannamedebasis This is however not required within the scope of this specification. Data Type HumanName Sliced: Unordered, Open, by $this(Pattern) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name
Name	S Σ I	1..1	HumanName, deutsches Basisprofil	Element Id Patient.name:Name Short description Personenname Definition Personenname mit in Deutschland üblichen Erweiterungen 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. Data Type HumanName, deutsches Basisprofil Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hum-1:Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden `family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()` hum-2:Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden `family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()` hum-3:Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden `family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()` hum-4:Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden `prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())` Pattern { "use": "official" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name
use	S Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id Patient.name:Name.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose BDT:1211 (in BDT als Freitext!)
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.name:Name.text Short description Text representation of the full name Definition Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	S Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.name:Name.family Short description Familienname Alternate names surname Definition Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName BDT:3120 + 3100 + 3101 KVDT:3100 + 3120 + 3101
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.name:Name.family.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
namenszusatz	S I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:Name.family.extension:namenszusatz Short description Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") Alternate names extensions, user content Definition Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst Comments Die Extension wurde erstellt aufgrund der Anforderung, die auf der eGK vorhandenen Patientenstammdaten in FHIR abbilden zu können. Auf der eGK werden die Namensbestandteile "Namenszusatz" und "Vorsatzwort" getrennt vom Nachnamen gespeichert. Anhand der Liste der zulässigen Namenszusätze ist deutlich erkennbar, dass es sich hierbei sinngemäß um Adelstitel handelt. Das Vorsatzwort kann durch die Core-Extension own-prefix (Canonical: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix) abgebildet werden, für den Namenszusatz ergibt sich jedoch die Notwendikeit einer nationalen Extension, da in andern Ländern Adelstitel entweder gar nicht oder als reguläres Namenspräfix erfasst werden. Data Type Extension(string) Extension URL http://fhir.de/StructureDefinition/humanname-namenszusatz Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A KVDT:3100 BDT:3100
nachname	S I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:Name.family.extension:nachname Short description Nachname ohne Vor- und Zusätze Alternate names extensions, user content Definition Nachname ohne Vor- und Zusätze. Dient z.B. der alphabetischen Einordnung des Namens. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-name 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 v2:FN.3 rim:ENXP where Qualifiers = (BR) KVDT:3101 BDT:3101
vorsatzwort	S I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:Name.family.extension:vorsatzwort Short description Vorsatzwort Alternate names extensions, user content Definition Vorsatzwort wie z.B.: von, van, zu Vgl. auch VSDM-Spezifikation der Gematik (Versichertenstammdatenmanagement, "eGK") Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-prefix 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 v2:FN.2 rim:ENXP where Qualifiers = (VV, R) BDT:3120 KVDT:3120
given	S Σ	1..*	string	There are no (further) constraints on this element Element Id Patient.name:Name.given Short description Vorname Alternate names first name, middle name Definition Vorname der Person Comments If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames KVDT:3102 BDT:3102
prefix	S Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name:Name.prefix Short description Namensteile vor dem Vornamen Definition Namensteile vor dem Vornamen, z.B. akademischer Titel. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode KVDT:3104 BDT:3104
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.name:Name.prefix.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
prefix-qualifier	S I	0..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.name:Name.prefix.extension:prefix-qualifier Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition Spezialisierung der Art des Präfixes, z.B. "AC" für Akademische Titel Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier 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 rim:ENXP.qualifier
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:Name.prefix.extension:prefix-qualifier.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Mappings rim:N/A
value[x]		1..1	BindingFixed Value	Element Id Patient.name:Name.prefix.extension:prefix-qualifier.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding 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) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value AC Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
suffix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name:Name.suffix Short description Namensteile nach dem Nachnamen Definition Namensteile nach dem Nachnamen Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX]
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.name:Name.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
Geburtsname	S Σ I	0..1	HumanName, deutsches Basisprofil	Element Id Patient.name:Geburtsname Short description Personenname Definition Personenname mit in Deutschland üblichen Erweiterungen 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. Data Type HumanName, deutsches Basisprofil Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hum-1:Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden `family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()` hum-2:Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden `family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()` hum-3:Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden `family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()` hum-4:Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden `prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())` Pattern { "use": "maiden" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name
use	S Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id Patient.name:Geburtsname.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose BDT:1211 (in BDT als Freitext!)
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.name:Geburtsname.text Short description Text representation of the full name Definition Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	S Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.name:Geburtsname.family Short description Familienname Alternate names surname Definition Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName BDT:3120 + 3100 + 3101 KVDT:3100 + 3120 + 3101
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.name:Geburtsname.family.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
namenszusatz	S I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:Geburtsname.family.extension:namenszusatz Short description Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") Alternate names extensions, user content Definition Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst Comments Die Extension wurde erstellt aufgrund der Anforderung, die auf der eGK vorhandenen Patientenstammdaten in FHIR abbilden zu können. Auf der eGK werden die Namensbestandteile "Namenszusatz" und "Vorsatzwort" getrennt vom Nachnamen gespeichert. Anhand der Liste der zulässigen Namenszusätze ist deutlich erkennbar, dass es sich hierbei sinngemäß um Adelstitel handelt. Das Vorsatzwort kann durch die Core-Extension own-prefix (Canonical: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix) abgebildet werden, für den Namenszusatz ergibt sich jedoch die Notwendikeit einer nationalen Extension, da in andern Ländern Adelstitel entweder gar nicht oder als reguläres Namenspräfix erfasst werden. Data Type Extension(string) Extension URL http://fhir.de/StructureDefinition/humanname-namenszusatz Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A KVDT:3100 BDT:3100
nachname	S I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:Geburtsname.family.extension:nachname Short description Nachname ohne Vor- und Zusätze Alternate names extensions, user content Definition Nachname ohne Vor- und Zusätze. Dient z.B. der alphabetischen Einordnung des Namens. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-name 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 v2:FN.3 rim:ENXP where Qualifiers = (BR) KVDT:3101 BDT:3101
vorsatzwort	S I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:Geburtsname.family.extension:vorsatzwort Short description Vorsatzwort Alternate names extensions, user content Definition Vorsatzwort wie z.B.: von, van, zu Vgl. auch VSDM-Spezifikation der Gematik (Versichertenstammdatenmanagement, "eGK") Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-prefix 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 v2:FN.2 rim:ENXP where Qualifiers = (VV, R) BDT:3120 KVDT:3120
given	Σ	0..0	string	There are no (further) constraints on this element Element Id Patient.name:Geburtsname.given Short description Vorname Alternate names first name, middle name Definition Vorname der Person Comments If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames KVDT:3102 BDT:3102
prefix	Σ	0..0	string	There are no (further) constraints on this element Element Id Patient.name:Geburtsname.prefix Short description Namensteile vor dem Vornamen Definition Namensteile vor dem Vornamen, z.B. akademischer Titel. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode KVDT:3104 BDT:3104
suffix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name:Geburtsname.suffix Short description Namensteile nach dem Nachnamen Definition Namensteile nach dem Nachnamen Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX]
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.name:Geburtsname.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
telecom	Σ I	0..*	ContactPoint	There are no (further) constraints on this element Element Id Patient.telecom Short description A contact detail for the individual Definition A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address 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). Data Type ContactPoint 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 rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom
system	Σ I	1..1	codeBinding	There are no (further) constraints on this element Element Id Patient.telecom.system Short description phone \| fax \| email \| pager \| url \| sms \| other Definition Telecommunications form for contact point - what communications system is required to make use of the contact. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.3 rim:./scheme servd:./ContactPointType
value	Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.telecom.value Short description The actual contact point details Definition The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.1 (or XTN.12) rim:./url servd:./Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.telecom.use Short description home \| work \| temp \| old \| mobile - purpose of this contact point Definition Identifies the purpose for the contact point. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data Type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.2 - but often indicated by field rim:unique(./use) servd:./ContactPointPurpose
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element Id Patient.telecom.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data Type positiveInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:n/a
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.telecom.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:N/A rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
gender	S Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Patient.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Requirements Needed for identification of the individual, in combination with (at least) name and birth date. Comments The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. Data Type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-8 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender cda:.patient.administrativeGenderCode
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.gender.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
Geschlecht-Administrativ	S I	0..1	Extension(Coding)	Element Id Patient.gender.extension:Geschlecht-Administrativ Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(Coding) Extension URL http://fhir.de/StructureDefinition/gender-amtlich-de 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
birthDate	S Σ	1..1	date	There are no (further) constraints on this element Element Id Patient.birthDate Short description The date of birth for the individual Definition The date of birth for the individual. Requirements Age of the individual drives many clinical processes. Comments At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). Data Type date Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-7 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/birthTime cda:.patient.birthTime loinc:21112-8
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.birthDate.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
Data-Absent-Reason	S I	0..1	Extension(code)	Element Id Patient.birthDate.extension:Data-Absent-Reason Short description unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error Alternate names extensions, user content Definition Provides a reason why the expected value or elements in the element that is extended are missing. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/data-absent-reason 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 rim:ANY.nullFlavor
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.birthDate.extension:Data-Absent-Reason.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/data-absent-reason Mappings rim:N/A
value[x]	S	1..1	BindingFixed Value	Element Id Patient.birthDate.extension:Data-Absent-Reason.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding Used to specify why the normally expected content of the data element is missing. DataAbsentReason (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value unknown Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
deceased[x]	Σ ?!	0..1		There are no (further) constraints on this element Element Id Patient.deceased[x] Short description Indicates if the individual is deceased or not Definition Indicates if the individual is deceased or not. Requirements The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. Comments If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-30 (bool) and PID-29 (datetime) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime cda:n/a
deceasedBoolean			boolean	There are no (further) constraints on this element Data Type boolean
deceasedDateTime			dateTime	There are no (further) constraints on this element Data Type dateTime
address	S Σ	0..*	Address	Element Id Patient.address Short description An address for the individual Definition An address for the individual. Requirements May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. Comments In order to differentiate between post box addresses and physical addresses, street names and house numbers, and to add city district names, vendors can opt to support the extensions as suggested in the German Address Base Profile http://fhir.de/StructureDefinition/address-de-basis. Such differentiations are however not required within the scope of this specification. Data Type Address Sliced: Unordered, Open, by $this(Pattern) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD rim:AD servd:Address v2:PID-11 rim:addr cda:.addr
Strassenanschrift	S Σ I	0..*	Adresse, deutsches Basisprofil	Element Id Patient.address:Strassenanschrift Short description Eine Adresse gemäß postalischer Konventionen Definition Eine Adresse gemäß postalischer Konventionen (im Gegensatz zu bspw. GPS-Koordinaten). Die Adresse kann sowohl zur Zustellung von Postsendungen oder zum Aufsuchen von Orten, die keine gültige Postadresse haben, verwendet werden. Die verwendeten Extensions in diesem Profil bilden die Struktur der Adresse ab, wie sie im VSDM-Format der elektronischen Versichertenkarte verwendet wird. Insbesondere bei ausländischen Adresse oder Adressen, die nicht durch Einlesen einer elektronischen Versichertenkarte erfasst wurden, sind abweichende Strukturen möglich. Die Verwendung der Extensions ist nicht verpflichtend. Requirements 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). Data Type Adresse, deutsches Basisprofil 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))` Pattern { "type": "both" } Mappings rim:n/a v2:XAD rim:AD servd:Address v2:PID-11 rim:addr cda:.addr
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
Stadtteil	S I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.extension:Stadtteil Short description Stadt- oder Ortsteil Alternate names extensions, user content Definition A subsection of a municipality. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct 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 rim:ADXP[partType=PRE]
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.use Short description home \| work \| temp \| old \| billing - purpose of this address Definition The purpose of this address. Requirements Allows an appropriate address to be chosen from a list of many. Comments Applications can assume that an address is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of an address. AddressUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General home Mappings rim:n/a v2:XAD.7 rim:unique(./use) servd:./AddressPurpose
type	S Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.type Short description postal \| physical \| both Definition Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Comments The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). Data Type code Binding The type of an address (physical / postal). AddressType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General both Mappings rim:n/a v2:XAD.18 rim:unique(./use) vcard:address type parameter BDT:1202 (1=physical, 2=postal)
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.text Short description Text representation of the address Definition Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street, Erewhon 9132 Mappings rim:n/a v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim:./formatted vcard:address label parameter
line	S Σ	1..3	string	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.line Short description Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung Definition Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street Beipiel für Adresszeile mit Extensions für Straße und Hausnummer Musterweg 42 Mappings rim:n/a v2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim:AD.part[parttype = AL] vcard:street servd:./StreetAddress (newline delimitted) KVDT:3107 + 3109 + 3115 oder 3123 BDT:3107 + 3109 + 3115 oder 3123
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.line.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
Strasse	S I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.line.extension:Strasse Short description Strassenname (ohne Hausnummer) Alternate names extensions, user content Definition Strassenname (ohne Hausnummer) Bei Angabe einer Strasse in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName 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 rim:ADXP[partType=STR] KVDT:3107 BDT:3107
Hausnummer	S I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.line.extension:Hausnummer Short description Hausnummer Alternate names extensions, user content Definition Hausnummer, sowie Zusätze (Appartmentnummer, Etage...) Bei Angabe einer Hausnummer in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber 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 rim:ADXP[partType=BNR] KVDT:3109 BDT:3109
Adresszusatz	S I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.line.extension:Adresszusatz Short description Adresszusatz Alternate names extensions, user content Definition Zusätzliche Informationen, wie z.B. "3. Etage", "Appartment C" Bei Angabe einer Zusatzinformation in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator 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 rim:ADXP[partType=ADL] KVDT:3115 BDT:3115
Postfach	I	0..0	Extension(string)	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.line.extension:Postfach Short description Postfach Alternate names extensions, user content Definition Postfach-Adresse. Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. Eine Postfach-Adresse darf nicht in Verbindung mit Address.type "physical" oder "both" verwendet werden. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox 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 rim:ADXP[partType=POB] KVDT:3123 BDT:3123
city	S Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.city Short description Name of city, town etc. Alternate names Municpality Definition The name of the city, town, suburb, village or other community or delivery center. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Erewhon Mappings rim:n/a v2:XAD.3 rim:AD.part[parttype = CTY] vcard:locality servd:./Jurisdiction BDT:3113 oder 3122 (Postfach) KVDT:3113 oder 3122 (Postfach)
district	Σ	0..0	string	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.district Short description District name (aka county) Alternate names County Definition The name of the administrative area (county). Comments District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Madison Mappings rim:n/a v2:XAD.9 rim:AD.part[parttype = CNT \| CPA]
state	Σ	0..1	stringBinding	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.state Short description Bundesland Alternate names Province, Territory Definition Name (oder Kürzel) des Bundeslandes. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Binding ValueSetISO31662DE (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.4 rim:AD.part[parttype = STA] vcard:region servd:./Region
postalCode	S Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.postalCode Short description Postleitzahl Alternate names Zip Definition Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 9132 Mappings rim:n/a v2:XAD.5 rim:AD.part[parttype = ZIP] vcard:code servd:./PostalIdentificationCode BDT:3112 oder 3121 (Postfach) KVDT:3112 oder 3121 (Postfach)
country	S Σ I	1..1	stringBinding	Element Id Patient.address:Strassenanschrift.country Short description Staat Definition Staat (vorzugsweise als 2-Stelliger ISO-Ländercode). Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben Comments ISO 3166 3 letter codes can be used in place of a human readable country name. Data Type string Binding Iso3166-1-2 (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` address-cnt-2or3-char:The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. `country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))` Mappings rim:n/a v2:XAD.6 rim:AD.part[parttype = CNT] vcard:country servd:./Country BDT:3114 oder 3124 (Postfach), abweichendes CodeSystem KVDT:3114 oder 3124 (Postfach), abweichendes CodeSystem
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.period Short description Time period when address was/is in use Definition Time period when address was/is in use. Requirements Allows addresses to be placed in historical context. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Examples General { "start": "2010-03-23", "end": "2010-07-01" } Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XAD.12 / XAD.13 + XAD.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
start	Σ I	0..1	dateTime	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.period.start Short description Starting time with inclusive boundary Definition The start of the period. The boundary is inclusive. Comments If the low element is missing, the meaning is that the low boundary is not known. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:DR.1 rim:./low BDT:8226
end	Σ I	0..1	dateTime	There are no (further) constraints on this element Element Id Patient.address:Strassenanschrift.period.end Short description End time with inclusive boundary, if not ongoing Definition The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. Comments The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:DR.2 rim:./high BDT:8227
Postfach	S Σ I	0..*	Adresse, deutsches Basisprofil	Element Id Patient.address:Postfach Short description Eine Adresse gemäß postalischer Konventionen Definition Eine Adresse gemäß postalischer Konventionen (im Gegensatz zu bspw. GPS-Koordinaten). Die Adresse kann sowohl zur Zustellung von Postsendungen oder zum Aufsuchen von Orten, die keine gültige Postadresse haben, verwendet werden. Die verwendeten Extensions in diesem Profil bilden die Struktur der Adresse ab, wie sie im VSDM-Format der elektronischen Versichertenkarte verwendet wird. Insbesondere bei ausländischen Adresse oder Adressen, die nicht durch Einlesen einer elektronischen Versichertenkarte erfasst wurden, sind abweichende Strukturen möglich. Die Verwendung der Extensions ist nicht verpflichtend. Requirements 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). Data Type Adresse, deutsches Basisprofil 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))` Pattern { "type": "postal" } Mappings rim:n/a v2:XAD rim:AD servd:Address v2:PID-11 rim:addr cda:.addr
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.address:Postfach.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
Stadtteil	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address:Postfach.extension:Stadtteil Short description Stadt- oder Ortsteil Alternate names extensions, user content Definition A subsection of a municipality. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct 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 rim:ADXP[partType=PRE]
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.address:Postfach.use Short description home \| work \| temp \| old \| billing - purpose of this address Definition The purpose of this address. Requirements Allows an appropriate address to be chosen from a list of many. Comments Applications can assume that an address is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of an address. AddressUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General home Mappings rim:n/a v2:XAD.7 rim:unique(./use) servd:./AddressPurpose
type	S Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Patient.address:Postfach.type Short description postal \| physical \| both Definition Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Comments The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). Data Type code Binding The type of an address (physical / postal). AddressType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General both Mappings rim:n/a v2:XAD.18 rim:unique(./use) vcard:address type parameter BDT:1202 (1=physical, 2=postal)
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address:Postfach.text Short description Text representation of the address Definition Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street, Erewhon 9132 Mappings rim:n/a v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim:./formatted vcard:address label parameter
line	S Σ	1..3	string	There are no (further) constraints on this element Element Id Patient.address:Postfach.line Short description Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung Definition Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street Beipiel für Adresszeile mit Extensions für Straße und Hausnummer Musterweg 42 Mappings rim:n/a v2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim:AD.part[parttype = AL] vcard:street servd:./StreetAddress (newline delimitted) KVDT:3107 + 3109 + 3115 oder 3123 BDT:3107 + 3109 + 3115 oder 3123
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.address:Postfach.line.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
Strasse	I	0..0	Extension(string)	There are no (further) constraints on this element Element Id Patient.address:Postfach.line.extension:Strasse Short description Strassenname (ohne Hausnummer) Alternate names extensions, user content Definition Strassenname (ohne Hausnummer) Bei Angabe einer Strasse in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName 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 rim:ADXP[partType=STR] KVDT:3107 BDT:3107
Hausnummer	I	0..0	Extension(string)	There are no (further) constraints on this element Element Id Patient.address:Postfach.line.extension:Hausnummer Short description Hausnummer Alternate names extensions, user content Definition Hausnummer, sowie Zusätze (Appartmentnummer, Etage...) Bei Angabe einer Hausnummer in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber 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 rim:ADXP[partType=BNR] KVDT:3109 BDT:3109
Adresszusatz	I	0..0	Extension(string)	There are no (further) constraints on this element Element Id Patient.address:Postfach.line.extension:Adresszusatz Short description Adresszusatz Alternate names extensions, user content Definition Zusätzliche Informationen, wie z.B. "3. Etage", "Appartment C" Bei Angabe einer Zusatzinformation in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator 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 rim:ADXP[partType=ADL] KVDT:3115 BDT:3115
Postfach	S I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address:Postfach.line.extension:Postfach Short description Postfach Alternate names extensions, user content Definition Postfach-Adresse. Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. Eine Postfach-Adresse darf nicht in Verbindung mit Address.type "physical" oder "both" verwendet werden. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox 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 rim:ADXP[partType=POB] KVDT:3123 BDT:3123
city	S Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.address:Postfach.city Short description Name of city, town etc. Alternate names Municpality Definition The name of the city, town, suburb, village or other community or delivery center. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Erewhon Mappings rim:n/a v2:XAD.3 rim:AD.part[parttype = CTY] vcard:locality servd:./Jurisdiction BDT:3113 oder 3122 (Postfach) KVDT:3113 oder 3122 (Postfach)
district	Σ	0..0	string	There are no (further) constraints on this element Element Id Patient.address:Postfach.district Short description District name (aka county) Alternate names County Definition The name of the administrative area (county). Comments District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Madison Mappings rim:n/a v2:XAD.9 rim:AD.part[parttype = CNT \| CPA]
state	Σ	0..1	stringBinding	There are no (further) constraints on this element Element Id Patient.address:Postfach.state Short description Bundesland Alternate names Province, Territory Definition Name (oder Kürzel) des Bundeslandes. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Binding ValueSetISO31662DE (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.4 rim:AD.part[parttype = STA] vcard:region servd:./Region
postalCode	S Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.address:Postfach.postalCode Short description Postleitzahl Alternate names Zip Definition Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 9132 Mappings rim:n/a v2:XAD.5 rim:AD.part[parttype = ZIP] vcard:code servd:./PostalIdentificationCode BDT:3112 oder 3121 (Postfach) KVDT:3112 oder 3121 (Postfach)
country	S Σ I	1..1	stringBinding	Element Id Patient.address:Postfach.country Short description Staat Definition Staat (vorzugsweise als 2-Stelliger ISO-Ländercode). Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben Comments ISO 3166 3 letter codes can be used in place of a human readable country name. Data Type string Binding Iso3166-1-2 (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` address-cnt-2or3-char:The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. `country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))` Mappings rim:n/a v2:XAD.6 rim:AD.part[parttype = CNT] vcard:country servd:./Country BDT:3114 oder 3124 (Postfach), abweichendes CodeSystem KVDT:3114 oder 3124 (Postfach), abweichendes CodeSystem
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.address:Postfach.period Short description Time period when address was/is in use Definition Time period when address was/is in use. Requirements Allows addresses to be placed in historical context. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Examples General { "start": "2010-03-23", "end": "2010-07-01" } Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XAD.12 / XAD.13 + XAD.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
start	Σ I	0..1	dateTime	There are no (further) constraints on this element Element Id Patient.address:Postfach.period.start Short description Starting time with inclusive boundary Definition The start of the period. The boundary is inclusive. Comments If the low element is missing, the meaning is that the low boundary is not known. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:DR.1 rim:./low BDT:8226
end	Σ I	0..1	dateTime	There are no (further) constraints on this element Element Id Patient.address:Postfach.period.end Short description End time with inclusive boundary, if not ongoing Definition The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. Comments The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:DR.2 rim:./high BDT:8227
maritalStatus		0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Patient.maritalStatus Short description Marital (civil) status of a patient Definition This field contains a patient's most recent marital (civil) status. Requirements Most, if not all systems capture it. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding The domestic partnership status of a person. Marital Status Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PID-16 rim:player[classCode=PSN]/maritalStatusCode cda:.patient.maritalStatusCode
multipleBirth[x]		0..1		There are no (further) constraints on this element Element Id Patient.multipleBirth[x] Short description Whether patient is part of a multiple birth Definition Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Comments Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in 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 rim:n/a v2:PID-24 (bool), PID-25 (integer) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda:n/a
multipleBirthBoolean			boolean	There are no (further) constraints on this element Data Type boolean
multipleBirthInteger			integer	There are no (further) constraints on this element Data Type integer
photo	I	0..*	Attachment	There are no (further) constraints on this element Element Id Patient.photo Short description Image of the patient Definition Image of the patient. Requirements Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Comments Guidelines: Use id photos, not clinical photos. Limit dimensions to thumbnail. Keep byte count low to ease resource updates. Data Type Attachment Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` att-1:If the Attachment has data, it SHALL have a contentType `data.empty() or contentType.exists()` Mappings rim:n/a v2:ED/RP rim:ED v2:OBX-5 - needs a profile rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/desc cda:n/a
contact	I	0..*	BackboneElement	There are no (further) constraints on this element Element Id Patient.contact Short description A contact party (e.g. guardian, partner, friend) for the patient Definition A contact party (e.g. guardian, partner, friend) for the patient. Requirements Need to track people you can contact about the patient. Comments Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. Data Type BackboneElement 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:n/a rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON] cda:n/a
relationship		0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Patient.contact.relationship Short description The kind of relationship Definition The nature of the relationship between the patient and the contact person. Requirements Used to determine which contact person is the most relevant to approach, depending on circumstances. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding The nature of the relationship between a patient and a contact person for that patient. PatientContactRelationship (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:NK1-7, NK1-3 rim:code cda:n/a
name		0..1	HumanName	There are no (further) constraints on this element Element Id Patient.contact.name Short description A name associated with the contact person Definition A name associated with the contact person. Requirements Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. Comments 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 might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. Data Type HumanName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:NK1-2 rim:name cda:n/a
telecom	I	0..*	ContactPoint	There are no (further) constraints on this element Element Id Patient.contact.telecom Short description A contact detail for the person Definition A contact detail for the person, e.g. a telephone number or an email address. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. Data Type ContactPoint 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 rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a
address		0..1	Address	There are no (further) constraints on this element Element Id Patient.contact.address Short description Address for the contact person Definition Address for the contact person. Requirements Need to keep track where the contact person can be contacted per postal mail or visited. Comments Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). Data Type Address Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD rim:AD servd:Address v2:NK1-4 rim:addr cda:n/a
gender		0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:NK1-15 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender cda:n/a
organization	I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.contact.organization Short description Organization that is associated with the contact Definition Organization on behalf of which the contact is acting or for which the contact is working. Requirements For guardians or business related contacts, the organization is relevant. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:NK1-13, NK1-30, NK1-31, NK1-32, NK1-41 rim:scoper cda:n/a
period	I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.period Short description The period during which this contact person or organization is valid to be contacted relating to this patient Definition The period during which this contact person or organization is valid to be contacted relating to this patient. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] rim:effectiveTime cda:n/a
communication		0..*	BackboneElement	There are no (further) constraints on this element Element Id Patient.communication Short description A 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. 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:LanguageCommunication cda:patient.languageCommunication
language		1..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Patient.communication.language Short description The language which can be used to communicate with the patient about his or her health Definition The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. Requirements Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. Comments The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Data Type CodeableConcept Binding A human language. CommonLanguages (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PID-15, LAN-2 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/languageCommunication/code cda:.languageCode
preferred		0..1	boolean	There are no (further) constraints on this element Element Id Patient.communication.preferred Short description Language preference indicator Definition Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). Requirements People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. Comments This language is specifically identified for communicating healthcare information. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-15 rim:preferenceInd cda:.preferenceInd
generalPractitioner	I	0..*	Reference(Organization \| Practitioner \| PractitionerRole)	There are no (further) constraints on this element Element Id Patient.generalPractitioner Short description Patient's nominated primary care provider Alternate names careProvider Definition Patient's nominated care provider. Comments This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/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. Data Type Reference(Organization \| Practitioner \| PractitionerRole) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:PD1-4 rim:subjectOf.CareEvent.performer.AssignedEntity cda:n/a
managingOrganization	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.managingOrganization Short description Organization that is the custodian of the patient record Definition Organization that is the custodian of the patient record. Requirements Need to know who recognizes this patient record, manages and updates it. Comments There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:scoper cda:.providerOrganization
link	Σ ?!	0..*	BackboneElement	There are no (further) constraints on this element Element Id Patient.link Short description Link to another patient resource that concerns the same actual person Definition Link to another patient resource that concerns the same actual patient. Requirements There are multiple 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:outboundLink cda:n/a
other	Σ I	1..1	Reference(Patient \| RelatedPerson)	There are no (further) constraints on this element Element Id Patient.link.other Short description The other patient or related person resource that the link refers to Definition The other patient resource that the link refers to. Comments Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Data Type Reference(Patient \| RelatedPerson) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:PID-3, MRG-1 rim:id cda:n/a
type	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Patient.link.type Short description replaced-by \| replaces \| refer \| seealso Definition The type of link between this patient resource and another patient resource. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The type of link between this patient resource and another patient resource. LinkType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:typeCode cda:n/a

Folgende FHIRPath-Constraints sind im Profil zu beachten:

key	severity	human	expression
isik-pat-1	error	Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden	gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
address-cnt-2or3-char	warning	The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.	country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
address-cnt-2or3-char	warning	The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.	country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Anmerkungen zu Must-Support-Feldern

`Patient.active`

Bedeutung: Indikator "Patientdatensatz ist in aktiver Benutzung"

Hinweise: Siehe Beschreibung in der FHIR Kernspezifikation

`Patient.identifier:versichertenId_GKV`

Bedeutung: Versicherten ID der gesetzlichen Krankenkasse

Hinweise: Siehe Beschreibung der Deutschen Basisprofile

`Patient.identifier:pid`

Bedeutung: Organisationsinterner Patienten-Identifier

Hinweise: Siehe Beschreibung der Deutschen Basisprofile

`Patient.identifier:versicherungsnummer_pkv`

Bedeutung: Versicherten Nr., falls versichert bei einer privaten Krankenkasse

Hinweise: Siehe Beschreibung der Deutschen Basisprofile

`Patient.name:name`

Bedeutung: Vollständiger Name

Hinweise: Siehe Beschreibung der Deutschen Basisprofile

`Patient.name:geburtsname`

Bedeutung: Geburtsname des Patienten (nur Nachname)

Hinweise: Siehe Beschreibung der Deutschen Basisprofile

`Patient.address:Strassenanschrift`

Bedeutung: Straßenadresse

Hinweise: Siehe Beschreibung der Deutschen Basisprofile

`Patient.address:Postfach`

Bedeutung: Postfachadresse

Hinweise: Siehe Beschreibung der Deutschen Basisprofile

`Patient.gender`

Bedeutung: Administratives Geschlecht

Hinweise: Siehe Beschreibung der Deutschen Basisprofile

`Patient.birthdate`

Bedeutung: Geburtsdatum

Hinweise: Siehe Beschreibung der Deutschen Basisprofile

Stornierung von Patienten

Im Rahmen des ISiK Basismoduls SOLLTE die Stornierung eines Patienten entweder durch das Löschen der Patienten-Ressource oder der Verwendung des Feldes Patient.active abgebildet werden. Dies ist abhängig davon, wie die Stornierung im bestätigungsrelevanten System umgesetzt ist. Im letzteren Fall wird die Stornierung durch das Setzen von Patient.active auf false gekennzeichnet.

Interaktionen

Für die Ressource Patient MUSS die REST-Interaktion "READ" implementiert werden.

Für die Ressource Patient KANN die REST-Interaktion "POST" implementiert werden. Diese Interaktion dient für die Vorabübermittelung von (unverifizierten und/oder unvollständigen) Patientenstammdaten.

Das bestätigungsrelevante System SOLLTE die übermittelte Patient-Ressource löschen oder als inaktiv kennzeichnen, insoweit Geschäftsregeln oder andere Gründe dazu führen, dass die Patient-Ressource nicht permanent im System angelegt wird (z.B. keine Bestätigung durch die Anwender*in des Systems oder keine Aufnahme der Patient*in).

Folgende Suchparameter sind für das Bestätigungsverfahren relevant, auch in Kombination:

Der Suchparameter "_id" MUSS unterstützt werden:

Beispiele:

GET [base]/Patient?_id=103270

Anwendungshinweise: Weitere Informationen zur Suche nach "_id" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".

Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.
Der Suchparameter "identifier" MUSS unterstützt werden:

Beispiele:

GET [base]/Patient?identifier=http://fhir.krankenhaus.example|1032702

GET [base]/Patient?identifier=1032702

Anwendungshinweise: Weitere Informationen zur Suche nach "Patient.identifier" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".

Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.
Der Suchparameter "given" MUSS unterstützt werden:

Beispiele:

GET [base]/Patient?given=Erika

Anwendungshinweise: Weitere Informationen zur Suche nach "Patient.name.given" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".

Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.
Der Suchparameter "family" MUSS unterstützt werden:

Beispiele:

GET [base]/Patient?family=Musterfrau

Anwendungshinweise: Weitere Informationen zur Suche nach "Patient.name.family" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".

Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.
Der Suchparameter "birthdate" MUSS unterstützt werden:

Beispiele:

GET [base]/Patient?birthdate=1964-12-08

Anwendungshinweise: Weitere Informationen zur Suche nach "Patient.birthDate" finden sich in der FHIR-Basisspezifikation - Abschnitt "Date Search".
Der Suchparameter "gender" MUSS unterstützt werden:

Beispiele:

GET [base]/Patient?gender=female

Anwendungshinweise: Weitere Informationen zur Suche nach "Patient.gender" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".

Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.
Der Suchparameter "name" KANN unterstützt werden:

Beispiele:

GET [base]/Patient?name=Erika

GET [base]/Patient?name=Musterfrau

Anwendungshinweise: Weitere Informationen zur Suche nach "Patient.name" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".
Der Suchparameter "_profile" KANN unterstützt werden:

Beispiele:

GET [base]/Patient?_profile=https://gematik.de/fhir/isik/v2/Basismodul/StructureDefinition/ISiKPatient

Anwendungshinweise: Weitere Informationen zur Suche nach "_profile" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter "address" KANN unterstützt werden:

Beispiele

GET [base]/Patient?address=Berlin

Anwendungshinweise: Weitere Informationen zur Suche nach "Patient.address" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".

Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.
Der Suchparameter "address-city" KANN unterstützt werden:

Beispiele:

GET [base]/Patient?address-city=Berlin

Anwendungshinweise: Weitere Informationen zur Suche nach "Patient.address.city" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".

Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.
Der Suchparameter "address-country" KANN unterstützt werden:

Beispiele:

GET [base]/Patient?address-country=DE

Anwendungshinweise: Weitere Informationen zur Suche nach "Patient.address.country" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".

Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.
Der Suchparameter "address-postalcode" KANN unterstützt werden:

Beispiele:

GET [base]/Patient?address-postalcode=10117

Anwendungshinweise: Weitere Informationen zur Suche nach "Patient.address.postalCode" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".

Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.
Der Suchparameter "active" KANN unterstützt werden:

Beispiele:

GET [base]/Patient?active=true

Anwendungshinweise: Weitere Informationen zur Suche nach "Patient.active" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".

Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.
Der Suchparameter "telecom" KANN unterstützt werden:

Beispiele:

GET [base]/Patient?telecom=phone|+49152236898

Anwendungshinweise: Weitere Informationen zur Suche nach "Patient.telecom" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".

Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

Beispiele

Valides Minimalbeispiel Patient:

{
    "resourceType": "Patient",
    "id": "PatientinMusterfrau",
    "meta": {
        "profile":  [
            "https://gematik.de/fhir/isik/v2/Basismodul/StructureDefinition/ISiKPatient"
        ]
    },
    "identifier":  [
        {
            "type": {
                "coding":  [
                    {
                        "system": "http://fhir.de/CodeSystem/identifier-type-de-basis",
                        "code": "GKV"
                    }
                ]
            },
            "system": "http://fhir.de/sid/gkv/kvid-10",
            "value": "A123456789"
        },
        {
            "type": {
                "coding":  [
                    {
                        "code": "MR",
                        "system": "http://terminology.hl7.org/CodeSystem/v2-0203"
                    }
                ]
            },
            "system": "https://fhir.krankenhaus.example/sid/PID",
            "value": "TestPID"
        },
        {
            "use": "secondary",
            "type": {
                "coding":  [
                    {
                        "code": "PKV",
                        "system": "http://fhir.de/CodeSystem/identifier-type-de-basis"
                    }
                ]
            },
            "value": "1234567890",
            "assigner": {
                "display": "Test PKV AG"
            }
        }
    ],
    "name":  [
        {
            "use": "official",
            "family": "Fürstin von Musterfrau",
            "_family": {
                "extension":  [
                    {
                        "url": "http://fhir.de/StructureDefinition/humanname-namenszusatz",
                        "valueString": "Fürstin"
                    },
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
                        "valueString": "Musterfrau"
                    },
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix",
                        "valueString": "von"
                    }
                ]
            },
            "given":  [
                "Erika"
            ],
            "prefix":  [
                "Dr."
            ],
            "_prefix":  [
                {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
                            "valueCode": "AC"
                        }
                    ]
                }
            ]
        },
        {
            "use": "maiden",
            "family": "Gabler",
            "_family": {
                "extension":  [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
                        "valueString": "Gabler"
                    }
                ]
            }
        }
    ],
    "active": true,
    "gender": "female",
    "birthDate": "1964-08-12",
    "address":  [
        {
            "type": "both",
            "line":  [
                "Musterweg 2",
                "3. Etage"
            ],
            "_line":  [
                {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
                            "valueString": "Musterweg"
                        },
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
                            "valueString": "2"
                        }
                    ]
                },
                {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator",
                            "valueString": "3. Etage"
                        }
                    ]
                }
            ],
            "city": "Musterhausen",
            "postalCode": "98764",
            "country": "DE"
        },
        {
            "type": "postal",
            "line":  [
                "Postfach 8 15"
            ],
            "_line":  [
                {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox",
                            "valueString": "Postfach 8 15"
                        }
                    ]
                }
            ],
            "city": "Musterhausen",
            "postalCode": "98764",
            "country": "DE"
        }
    ]
}