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 IdPatient Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services.
| |
id | S Σ | 1..1 | System.String | There are no (further) constraints on this element Element IdPatient.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. System.String |
identifier | S Σ | 1..* | Identifier | Element IdPatient.identifier An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. Unordered, Open, by $this(Pattern) Constraints
|
VersichertenId-GKV | S Σ | 0..1 | Identifier-Profil für die 10-stellige Krankenversichertennummer | Element IdPatient.identifier:VersichertenId-GKV An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Patients are almost always assigned specific numerical identifiers. Identifier-Profil für die 10-stellige Krankenversichertennummer Constraints
{ "type": { "coding": [ { "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "code": "GKV" } ] } }
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.identifier:VersichertenId-GKV.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | S Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPatient.identifier:VersichertenId-GKV.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeDeBasis (extensible)Constraints
{ "coding": [ { "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "code": "GKV" } ] }
|
system | S Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element IdPatient.identifier:VersichertenId-GKV.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
http://fhir.de/sid/gkv/kvid-10
|
value | S Σ I | 1..1 | string | There are no (further) constraints on this element Element IdPatient.identifier:VersichertenId-GKV.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPatient.identifier:VersichertenId-GKV.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. 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.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPatient.identifier:VersichertenId-GKV.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
Patientennummer | S Σ | 1..* | Identifier-Profil für die Abbildung einer Patienten-ID | Element IdPatient.identifier:Patientennummer An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Patients are almost always assigned specific numerical identifiers. Identifier-Profil für die Abbildung einer Patienten-ID Constraints
{ "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "MR" } ] } }
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.identifier:Patientennummer.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | S Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPatient.identifier:Patientennummer.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeDeBasis (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "MR" } ] }
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPatient.identifier:Patientennummer.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.identifier:Patientennummer.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPatient.identifier:Patientennummer.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. 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.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPatient.identifier:Patientennummer.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
Versichertennummer_PKV | Σ | 0..1 | Identifier-Profil für die Abbildung einer Privatversichertennummer | Element IdPatient.identifier:Versichertennummer_PKV An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Patients are almost always assigned specific numerical identifiers. Identifier-Profil für die Abbildung einer Privatversichertennummer Constraints
{ "type": { "coding": [ { "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "code": "PKV" } ] } }
|
use | S Σ ?! | 0..1 | codeBindingFixed Value | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
secondary
|
type | S Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeDeBasis (extensible)Constraints
{ "coding": [ { "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "code": "PKV" } ] }
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. 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.
|
assigner | S Σ I | 1..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.assigner.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.assigner.type Type the reference refers to (e.g. "Patient") DefinitionThe 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). 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. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | Σ | 0..1 | Identifier-Profil für die Abbildung eines Institutionskennzeichens (IKNR) | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.assigner.identifier An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. 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). Identifier-Profil für die Abbildung eines Institutionskennzeichens (IKNR) Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.assigner.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.assigner.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeDeBasis (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "XX" } ] }
|
system | S Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.assigner.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
http://fhir.de/sid/arge-ik/iknr
|
value | S Σ I | 1..1 | string | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.assigner.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.assigner.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. 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.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.assigner.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
display | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.identifier:Versichertennummer_PKV.assigner.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
active | S Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element IdPatient.active Whether this patient's record is in active use DefinitionWhether 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. Need to be able to mark a patient record as not to be used because it was created in error. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.
|
name | S Σ | 1..* | HumanName | Element IdPatient.name A name associated with the patient DefinitionA name associated with the individual. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. 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. Unordered, Open, by $this(Pattern) Constraints
|
Name | S Σ I | 1..1 | HumanName, deutsches Basisprofil | Element IdPatient.name:Name Personenname DefinitionPersonenname mit in Deutschland üblichen Erweiterungen Need to be able to track the patient by multiple names. Examples are your official name and a partner name. 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. HumanName, deutsches Basisprofil Constraints
{ "use": "official" }
|
use | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.name:Name.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name. NameUse (required)Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.name:Name.text Text representation of the full name DefinitionSpecifies 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. A renderable, unencoded form. 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.
|
family | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.name:Name.family Familienname Alternate namessurname DefinitionDer vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPatient.name:Name.family.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
namenszusatz | S I | 0..1 | Extension(string) | There are no (further) constraints on this element Element IdPatient.name:Name.family.extension:namenszusatz Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") Alternate namesextensions, user content DefinitionNamenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst 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. http://fhir.de/StructureDefinition/humanname-namenszusatz Constraints
|
nachname | S I | 0..1 | Extension(string) | There are no (further) constraints on this element Element IdPatient.name:Name.family.extension:nachname Nachname ohne Vor- und Zusätze Alternate namesextensions, user content DefinitionNachname ohne Vor- und Zusätze. Dient z.B. der alphabetischen Einordnung des Namens. 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". http://hl7.org/fhir/StructureDefinition/humanname-own-name Constraints
|
vorsatzwort | S I | 0..1 | Extension(string) | There are no (further) constraints on this element Element IdPatient.name:Name.family.extension:vorsatzwort Vorsatzwort Alternate namesextensions, user content DefinitionVorsatzwort wie z.B.: von, van, zu Vgl. auch VSDM-Spezifikation der Gematik (Versichertenstammdatenmanagement, "eGK") 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. http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Constraints
|
given | S Σ | 1..* | string | There are no (further) constraints on this element Element IdPatient.name:Name.given Vorname Alternate namesfirst name, middle name DefinitionVorname der Person 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.
|
prefix | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPatient.name:Name.prefix Namensteile vor dem Vornamen DefinitionNamensteile vor dem Vornamen, z.B. akademischer Titel. Note that FHIR strings SHALL NOT exceed 1MB in size
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPatient.name:Name.prefix.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
prefix-qualifier | S I | 0..1 | Extension(code) | There are no (further) constraints on this element Element IdPatient.name:Name.prefix.extension:prefix-qualifier LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV Alternate namesextensions, user content DefinitionSpezialisierung der Art des Präfixes, z.B. "AC" für Akademische Titel Used to indicate additional information about the name part and how it should be used. http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdPatient.name:Name.prefix.extension:prefix-qualifier.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
| |
value[x] | 1..1 | BindingFixed Value | Element IdPatient.name:Name.prefix.extension:prefix-qualifier.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). 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
AC
| |
valueCode | code | There are no (further) constraints on this element Data Type | ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element IdPatient.name:Name.suffix Namensteile nach dem Nachnamen DefinitionNamensteile nach dem Nachnamen Note that FHIR strings SHALL NOT exceed 1MB in size
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPatient.name:Name.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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.
|
Geburtsname | S Σ I | 0..1 | HumanName, deutsches Basisprofil | Element IdPatient.name:Geburtsname Personenname DefinitionPersonenname mit in Deutschland üblichen Erweiterungen Need to be able to track the patient by multiple names. Examples are your official name and a partner name. 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. HumanName, deutsches Basisprofil Constraints
{ "use": "maiden" }
|
use | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.name:Geburtsname.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name. NameUse (required)Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.name:Geburtsname.text Text representation of the full name DefinitionSpecifies 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. A renderable, unencoded form. 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.
|
family | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.name:Geburtsname.family Familienname Alternate namessurname DefinitionDer vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPatient.name:Geburtsname.family.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
namenszusatz | S I | 0..1 | Extension(string) | There are no (further) constraints on this element Element IdPatient.name:Geburtsname.family.extension:namenszusatz Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") Alternate namesextensions, user content DefinitionNamenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst 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. http://fhir.de/StructureDefinition/humanname-namenszusatz Constraints
|
nachname | S I | 0..1 | Extension(string) | There are no (further) constraints on this element Element IdPatient.name:Geburtsname.family.extension:nachname Nachname ohne Vor- und Zusätze Alternate namesextensions, user content DefinitionNachname ohne Vor- und Zusätze. Dient z.B. der alphabetischen Einordnung des Namens. 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". http://hl7.org/fhir/StructureDefinition/humanname-own-name Constraints
|
vorsatzwort | S I | 0..1 | Extension(string) | There are no (further) constraints on this element Element IdPatient.name:Geburtsname.family.extension:vorsatzwort Vorsatzwort Alternate namesextensions, user content DefinitionVorsatzwort wie z.B.: von, van, zu Vgl. auch VSDM-Spezifikation der Gematik (Versichertenstammdatenmanagement, "eGK") 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. http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Constraints
|
given | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.name:Geburtsname.given Vorname Alternate namesfirst name, middle name DefinitionVorname der Person 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.
|
prefix | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.name:Geburtsname.prefix Namensteile vor dem Vornamen DefinitionNamensteile vor dem Vornamen, z.B. akademischer Titel. Note that FHIR strings SHALL NOT exceed 1MB in size
|
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element IdPatient.name:Geburtsname.suffix Namensteile nach dem Nachnamen DefinitionNamensteile nach dem Nachnamen Note that FHIR strings SHALL NOT exceed 1MB in size
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPatient.name:Geburtsname.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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.
|
telecom | Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdPatient.telecom A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. 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).
|
system | Σ I | 1..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdPatient.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies 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. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPatient.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. 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.
|
gender | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Needed for identification of the individual, in combination with (at least) name and birth date. 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. The gender of a person used for administrative purposes. AdministrativeGender (required)Constraints
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPatient.gender.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
Geschlecht-Administrativ | S I | 0..1 | Extension(Coding) | Element IdPatient.gender.extension:Geschlecht-Administrativ Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. http://fhir.de/StructureDefinition/gender-amtlich-de Constraints
|
birthDate | S Σ | 1..1 | date | There are no (further) constraints on this element Element IdPatient.birthDate The date of birth for the individual DefinitionThe date of birth for the individual. Age of the individual drives many clinical processes. 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).
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPatient.birthDate.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
Data-Absent-Reason | S I | 0..1 | Extension(code) | Element IdPatient.birthDate.extension:Data-Absent-Reason unknown | asked | temp | notasked | masked | unsupported | astext | error Alternate namesextensions, user content DefinitionProvides a reason why the expected value or elements in the element that is extended are missing. 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. http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdPatient.birthDate.extension:Data-Absent-Reason.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/data-absent-reason
| |
value[x] | S | 1..1 | BindingFixed Value | Element IdPatient.birthDate.extension:Data-Absent-Reason.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). Used to specify why the normally expected content of the data element is missing. DataAbsentReason (required)Constraints
unknown
|
valueCode | code | There are no (further) constraints on this element Data Type | ||
deceased[x] | Σ ?! | 0..1 | There are no (further) constraints on this element Element IdPatient.deceased[x] Indicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not. 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. 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.
| |
deceasedBoolean | boolean | There are no (further) constraints on this element Data Type | ||
deceasedDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
address | S Σ | 0..* | Address | Element IdPatient.address An address for the individual DefinitionAn address for the individual. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. 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. Unordered, Open, by $this(Pattern) Constraints
|
Strassenanschrift | S Σ I | 0..* | Adresse, deutsches Basisprofil | Element IdPatient.address:Strassenanschrift Eine Adresse gemäß postalischer Konventionen DefinitionEine 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. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. 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). Adresse, deutsches Basisprofil Constraints
{ "type": "both" }
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
Stadtteil | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.extension:Stadtteil Stadt- oder Ortsteil Alternate namesextensions, user content DefinitionA subsection of a municipality. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
type | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. 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). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.text Text representation of the address DefinitionSpecifies 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. A renderable, unencoded form. 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.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
line | S Σ | 1..3 | string | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.line Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung DefinitionDiese 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. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Beipiel für Adresszeile mit Extensions für Straße und Hausnummer Musterweg 42 Mappings
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.line.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
Strasse | S I | 0..1 | Extension(string) | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.line.extension:Strasse Strassenname (ohne Hausnummer) Alternate namesextensions, user content DefinitionStrassenname (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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints
|
Hausnummer | S I | 0..1 | Extension(string) | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.line.extension:Hausnummer Hausnummer Alternate namesextensions, user content DefinitionHausnummer, 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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints
|
Adresszusatz | S I | 0..1 | Extension(string) | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.line.extension:Adresszusatz Adresszusatz Alternate namesextensions, user content DefinitionZusä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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Constraints
|
Postfach | I | 0..0 | Extension(string) | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.line.extension:Postfach Postfach Alternate namesextensions, user content DefinitionPostfach-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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox Constraints
|
city | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
district | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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.
General Madison Mappings
|
state | Σ | 0..1 | stringBinding | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.state Bundesland Alternate namesProvince, Territory DefinitionName (oder Kürzel) des Bundeslandes. Note that FHIR strings SHALL NOT exceed 1MB in size ValueSetISO31662DE (preferred) Constraints
|
postalCode | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.postalCode Postleitzahl Alternate namesZip DefinitionPostleitzahl gemäß der im jeweiligen Land gültigen Konventionen Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | S Σ I | 1..1 | stringBinding | Element IdPatient.address:Strassenanschrift.country Staat DefinitionStaat (vorzugsweise als 2-Stelliger ISO-Ländercode). Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben ISO 3166 3 letter codes can be used in place of a human readable country name.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. 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.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
start | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.period.start Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known.
|
end | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdPatient.address:Strassenanschrift.period.end End time with inclusive boundary, if not ongoing DefinitionThe 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. 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.
|
Postfach | S Σ I | 0..* | Adresse, deutsches Basisprofil | Element IdPatient.address:Postfach Eine Adresse gemäß postalischer Konventionen DefinitionEine 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. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. 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). Adresse, deutsches Basisprofil Constraints
{ "type": "postal" }
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPatient.address:Postfach.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
Stadtteil | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element IdPatient.address:Postfach.extension:Stadtteil Stadt- oder Ortsteil Alternate namesextensions, user content DefinitionA subsection of a municipality. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.address:Postfach.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
type | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.address:Postfach.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. 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). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.address:Postfach.text Text representation of the address DefinitionSpecifies 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. A renderable, unencoded form. 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.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
line | S Σ | 1..3 | string | There are no (further) constraints on this element Element IdPatient.address:Postfach.line Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung DefinitionDiese 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. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Beipiel für Adresszeile mit Extensions für Straße und Hausnummer Musterweg 42 Mappings
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPatient.address:Postfach.line.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
Strasse | I | 0..0 | Extension(string) | There are no (further) constraints on this element Element IdPatient.address:Postfach.line.extension:Strasse Strassenname (ohne Hausnummer) Alternate namesextensions, user content DefinitionStrassenname (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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints
|
Hausnummer | I | 0..0 | Extension(string) | There are no (further) constraints on this element Element IdPatient.address:Postfach.line.extension:Hausnummer Hausnummer Alternate namesextensions, user content DefinitionHausnummer, 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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints
|
Adresszusatz | I | 0..0 | Extension(string) | There are no (further) constraints on this element Element IdPatient.address:Postfach.line.extension:Adresszusatz Adresszusatz Alternate namesextensions, user content DefinitionZusä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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Constraints
|
Postfach | S I | 0..1 | Extension(string) | There are no (further) constraints on this element Element IdPatient.address:Postfach.line.extension:Postfach Postfach Alternate namesextensions, user content DefinitionPostfach-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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox Constraints
|
city | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.address:Postfach.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
district | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.address:Postfach.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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.
General Madison Mappings
|
state | Σ | 0..1 | stringBinding | There are no (further) constraints on this element Element IdPatient.address:Postfach.state Bundesland Alternate namesProvince, Territory DefinitionName (oder Kürzel) des Bundeslandes. Note that FHIR strings SHALL NOT exceed 1MB in size ValueSetISO31662DE (preferred) Constraints
|
postalCode | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.address:Postfach.postalCode Postleitzahl Alternate namesZip DefinitionPostleitzahl gemäß der im jeweiligen Land gültigen Konventionen Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | S Σ I | 1..1 | stringBinding | Element IdPatient.address:Postfach.country Staat DefinitionStaat (vorzugsweise als 2-Stelliger ISO-Ländercode). Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben ISO 3166 3 letter codes can be used in place of a human readable country name.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPatient.address:Postfach.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. 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.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
start | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdPatient.address:Postfach.period.start Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known.
|
end | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdPatient.address:Postfach.period.end End time with inclusive boundary, if not ongoing DefinitionThe 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. 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.
|
maritalStatus | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPatient.maritalStatus Marital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status. Most, if not all systems capture it. 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. The domestic partnership status of a person. Marital Status Codes (extensible)Constraints
| |
multipleBirth[x] | 0..1 | There are no (further) constraints on this element Element IdPatient.multipleBirth[x] Whether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. 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).
| ||
multipleBirthBoolean | boolean | There are no (further) constraints on this element Data Type | ||
multipleBirthInteger | integer | There are no (further) constraints on this element Data Type | ||
photo | I | 0..* | Attachment | There are no (further) constraints on this element Element IdPatient.photo Image of the patient DefinitionImage of the patient. Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Guidelines:
|
contact | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPatient.contact A contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient. Need to track people you can contact about the patient. 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.
|
relationship | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdPatient.contact.relationship The kind of relationship DefinitionThe nature of the relationship between the patient and the contact person. Used to determine which contact person is the most relevant to approach, depending on circumstances. 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. The nature of the relationship between a patient and a contact person for that patient. PatientContactRelationship (extensible)Constraints
| |
name | 0..1 | HumanName | There are no (further) constraints on this element Element IdPatient.contact.name A name associated with the contact person DefinitionA name associated with the contact person. Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. 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.
| |
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdPatient.contact.telecom A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. 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.
|
address | 0..1 | Address | There are no (further) constraints on this element Element IdPatient.contact.address Address for the contact person DefinitionAddress for the contact person. Need to keep track where the contact person can be contacted per postal mail or visited. 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).
| |
gender | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.contact.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes. AdministrativeGender (required)Constraints
| |
organization | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPatient.contact.organization Organization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working. For guardians or business related contacts, the organization is relevant. 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.
|
period | I | 0..1 | Period | There are no (further) constraints on this element Element IdPatient.contact.period The period during which this contact person or organization is valid to be contacted relating to this patient DefinitionThe period during which this contact person or organization is valid to be contacted relating to this patient. 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.
|
communication | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPatient.communication A language which may be used to communicate with the patient about his or her health DefinitionA language which may be used to communicate with the patient about his or her health. 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. 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.
| |
language | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPatient.communication.language The language which can be used to communicate with the patient about his or her health DefinitionThe 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. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. 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. A human language. CommonLanguages (preferred)Constraints
| |
preferred | 0..1 | boolean | There are no (further) constraints on this element Element IdPatient.communication.preferred Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). 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. This language is specifically identified for communicating healthcare information.
| |
generalPractitioner | I | 0..* | Reference(Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element IdPatient.generalPractitioner Patient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider. 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. Reference(Organization | Practitioner | PractitionerRole) Constraints
|
managingOrganization | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPatient.managingOrganization Organization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record. Need to know who recognizes this patient record, manages and updates it. 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).
|
link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPatient.link Link to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient. There are multiple use cases:
There is no assumption that linked patient records have mutual links.
|
other | Σ I | 1..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element IdPatient.link.other The other patient or related person resource that the link refers to DefinitionThe other patient resource that the link refers to. Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Reference(Patient | RelatedPerson) Constraints
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.link.type replaced-by | replaces | refer | seealso DefinitionThe type of link between this patient resource and another patient resource. Note that FHIR strings SHALL NOT exceed 1MB in size The type of link between this patient resource and another patient resource. LinkType (required)Constraints
|
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 diePatient
-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/NamingSystem/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": "Graf" }, { "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" } ] }