ARS Implementierungsleitfaden

Patient

You need a license to run FQL queries

In diesem Profil werden Angaben zum Patienten gemacht. Für ARS dürfen nach §13 Abs. 4 IfSG ausschließlich pseudonymisierte Falldaten übermittelt werden. Zur Pseudonymbildung siehe Kapitel Pseudonymisierung.

Profil

Patient	I		Patient	There are no (further) constraints on this element Element id Patient Short description Information about an individual or animal receiving health care services Alternate names SubjectOfCare Client Resident Definition Demographics and other administrative information about an individual or animal receiving care or other health-related services. Data type Patient Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act rim: Patient[classCode=PAT] cda: ClinicalDocument.recordTarget.patientRole
id	S Σ	1..1	string	There are no (further) constraints on this element Element id Patient.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	S Σ	1..1	Meta	There are no (further) constraints on this element Element id Patient.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..0	string	There are no (further) constraints on this element Element id Patient.meta.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..0	Extension	There are no (further) constraints on this element Element id Patient.meta.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
versionId	Σ	0..0	id	There are no (further) constraints on this element Element id Patient.meta.versionId Short description Version specific identifier Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. Comments The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. Data type id Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
lastUpdated	Σ	0..0	instant	There are no (further) constraints on this element Element id Patient.meta.lastUpdated Short description When the resource version last changed Definition When the resource last changed - e.g. when the version changed. Comments This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
source	Σ	0..0	uri	There are no (further) constraints on this element Element id Patient.meta.source Short description Identifies where the resource comes from Definition A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. Comments In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
profile	S Σ	1..*	canonical(StructureDefinition)	Element id Patient.meta.profile Short description Profiles this resource claims to conform to Definition A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. Comments It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. Data type canonical(StructureDefinition) Sliced: Unordered, Closed, by $this(Pattern) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
arsProfile	S Σ	1..1	canonical(StructureDefinition)Pattern	Element id Patient.meta.profile:arsProfile Short description Profiles this resource claims to conform to Definition A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. Comments It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. Data type canonical(StructureDefinition) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern https://demis.rki.de/fhir/ars/StructureDefinition/Patient
security	Σ	0..0	CodingBinding	There are no (further) constraints on this element Element id Patient.meta.security Short description Security Labels applied to this resource Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. Comments The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Data type Coding Binding Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
tag	Σ	0..0	Coding	There are no (further) constraints on this element Element id Patient.meta.tag Short description Tags applied to this resource Definition Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Data type Coding Binding Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Patient.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Patient.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Patient.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Patient.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Patient.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Patient.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
identifier	S Σ	2..2	Identifier	Element id Patient.identifier Short description Patientenpseudonym Definition Ein Paar von UUIDs, die zusammen als Patientenpseudonym auftreten. Der Bildung der Pseudonyme liegt ein für ARS entwickeltes Konzept zugrunde. Das Konzept ist im Implementierungsleitfaden im Kapitel 'Pseudonymisierung' zu finden. Requirements Patients are almost always assigned specific numerical identifiers. Data type Identifier Sliced: Unordered, Closed, by system(Pattern) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: PID-3 rim: id cda: .id
rkiPatientPseudonym	S Σ	2..2	IdentifierSurveillancePatientPseudonym	Element id Patient.identifier:rkiPatientPseudonym Short description An identifier intended for computation Definition An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Requirements Patients are almost always assigned specific numerical identifiers. Data type IdentifierSurveillancePatientPseudonym Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: PID-3 rim: id cda: .id rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier
id		0..1	string	There are no (further) constraints on this element Element id Patient.identifier:rkiPatientPseudonym.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Patient.identifier:rkiPatientPseudonym.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Patient.identifier:rkiPatientPseudonym.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBindingPattern	There are no (further) constraints on this element Element id Patient.identifier:rkiPatientPseudonym.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "ANON" } ] } Mappings v2: CX.5 rim: Role.code or implied by context
system	S Σ	1..1	uriFixed Value	There are no (further) constraints on this element Element id Patient.identifier:rkiPatientPseudonym.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value https://demis.rki.de/fhir/sid/SurveillancePatientPseudonym Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	S Σ I	1..1	string	Element id Patient.identifier:rkiPatientPseudonym.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` pseudonymIsUUID: Die Patientenpseudonyme muessen als UUID uebergeben werden. `$this.toString().matches('^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$')` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Patient.identifier:rkiPatientPseudonym.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Patient.identifier:rkiPatientPseudonym.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
active	Σ ?!	0..0	boolean	There are no (further) constraints on this element Element id Patient.active Short description Whether this patient's record is in active use Definition Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. Requirements Need to be able to mark a patient record as not to be used because it was created in error. Comments If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status rim: statusCode cda: n/a
name	Σ	0..0	HumanName	There are no (further) constraints on this element Element id Patient.name Short description A name associated with the patient Definition A name associated with the individual. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Data type HumanName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-5, PID-9 rim: name cda: .patient.name
telecom	Σ	0..0	ContactPoint	There are no (further) constraints on this element Element id Patient.telecom Short description A contact detail for the individual Definition A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-13, PID-14, PID-40 rim: telecom cda: .telecom
gender	S Σ	1..1	codeBinding	There are no (further) constraints on this element Element id Patient.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Requirements Needed for identification of the individual, in combination with (at least) name and birth date. Comments The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. Data type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-8 rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender cda: .patient.administrativeGenderCode
id		0..1	string	There are no (further) constraints on this element Element id Patient.gender.id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references) Data type string
extension	I	0..*	Extension	Element id Patient.gender.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
other-amtlich	I	0..1	Extension(Coding)	Element id Patient.gender.extension:other-amtlich Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension(Coding) Extension URL http://fhir.de/StructureDefinition/gender-amtlich-de Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
value		0..1	System.String	There are no (further) constraints on this element Element id Patient.gender.value Short description Primitive value for code Definition Primitive value for code Data type System.String
birthDate	S Σ I	1..1	date	Element id Patient.birthDate Short description Geburtsdatum (YYYY-MM) Definition Geburtsdatum des Patienten, nur Angabe des Geburtsmonats und Geburtsjahres. Requirements Age of the individual drives many clinical processes. Comments At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` yearAndMonthOnlyBirthDate: Das Geburtsdatum darf lediglich Jahr und Monat der Geburt beinhalten `$this.toString().matches('^[0-9]{4}-[0-9]{2}\|[0-9]{4}$')` Mappings v2: PID-7 rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/birthTime cda: .patient.birthTime loinc: 21112-8
deceased[x]	Σ ?!	0..0		There are no (further) constraints on this element Element id Patient.deceased[x] Short description Indicates if the individual is deceased or not Definition Indicates if the individual is deceased or not. Requirements The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. Comments If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-30 (bool) and PID-29 (datetime) rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime cda: n/a
address	S Σ	0..1	Address	Element id Patient.address Short description Wohnort (3-stellige PLZ) Definition Die Angabe zum Wohnort des Patienten in Form der 3-stelligen Postleitzahl unter ist ausschließlich bei Diagnostik zu Chlamydia trachomatis relevant. Sollten Angaben für einen anderen Erreger als für Chlamydia trachomatis gemacht werden, wird diese nach Übermittlung an das RKI aus der Rohdatenbank entfernt und steht für die weitere Datenverarbeitung am RKI nicht zur Verfügung. Hintergrund für die Erhebung dieser Angaben ist die Integration des Chlamydien-Sentinels in die Übermittlung für ARS. Siehe auch Kapitel 'Integration von Sentinel-Systemen' im Implementierungsleitfaden. Requirements May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. Comments Patient may have multiple addresses with different uses or applicable periods. Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-11 rim: addr cda: .addr
id		0..1	string	There are no (further) constraints on this element Element id Patient.address.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Patient.address.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
use	Σ ?!	0..0	codeBinding	There are no (further) constraints on this element Element id Patient.address.use Short description home \| work \| temp \| old \| billing - purpose of this address Definition The purpose of this address. Requirements Allows an appropriate address to be chosen from a list of many. Comments Applications can assume that an address is current unless it explicitly says that it is temporary or old. Data type code Binding The use of an address. AddressUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General home Mappings v2: XAD.7 rim: unique(./use) servd: ./AddressPurpose
type	Σ	0..0	codeBinding	There are no (further) constraints on this element Element id Patient.address.type Short description postal \| physical \| both Definition Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Comments The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). Data type code Binding The type of an address (physical / postal). AddressType (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General both Mappings v2: XAD.18 rim: unique(./use) vcard: address type parameter
text	Σ	0..0	string	There are no (further) constraints on this element Element id Patient.address.text Short description Text representation of the address Definition Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street, Erewhon 9132 Mappings v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim: ./formatted vcard: address label parameter
line	Σ	0..0	string	There are no (further) constraints on this element Element id Patient.address.line Short description Street name, number, direction & P.O. Box etc. Definition This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street Mappings v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim: AD.part[parttype = AL] vcard: street servd: ./StreetAddress (newline delimitted)
city	Σ	0..0	string	There are no (further) constraints on this element Element id Patient.address.city Short description Name of city, town etc. Alternate names Municpality Definition The name of the city, town, suburb, village or other community or delivery center. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Erewhon Mappings v2: XAD.3 rim: AD.part[parttype = CTY] vcard: locality servd: ./Jurisdiction
district	Σ	0..0	string	There are no (further) constraints on this element Element id Patient.address.district Short description District name (aka county) Alternate names County Definition The name of the administrative area (county). Comments District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Madison Mappings v2: XAD.9 rim: AD.part[parttype = CNT \| CPA]
state	Σ	0..0	string	There are no (further) constraints on this element Element id Patient.address.state Short description Sub-unit of country (abbreviations ok) Alternate names Province, Territory Definition Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XAD.4 rim: AD.part[parttype = STA] vcard: region servd: ./Region
postalCode	Σ I	0..1	string	Element id Patient.address.postalCode Short description Postal code for area Alternate names Zip Definition A postal code designating a region defined by the postal service. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` threeDigitPostalCode: Die 'verkürzte' Postleitzahl muss aus den ersten 3 Ziffern der 'normalen' Postleitzahl bestehen `$this.toString().matches('^[0-9]{3}$')` Examples General 9132 Mappings v2: XAD.5 rim: AD.part[parttype = ZIP] vcard: code servd: ./PostalIdentificationCode
country	Σ	0..0	string	There are no (further) constraints on this element Element id Patient.address.country Short description Country (e.g. can be ISO 3166 2 or 3 letter code) Definition Country - a nation as commonly understood or generally accepted. Comments ISO 3166 3 letter codes can be used in place of a human readable country name. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XAD.6 rim: AD.part[parttype = CNT] vcard: country servd: ./Country
period	Σ	0..0	Period	There are no (further) constraints on this element Element id Patient.address.period Short description Time period when address was/is in use Definition Time period when address was/is in use. Requirements Allows addresses to be placed in historical context. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General { "start": "2010-03-23", "end": "2010-07-01" } Mappings v2: XAD.12 / XAD.13 + XAD.14 rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
maritalStatus		0..0	CodeableConceptBinding	There are no (further) constraints on this element Element id Patient.maritalStatus Short description Marital (civil) status of a patient Definition This field contains a patient's most recent marital (civil) status. Requirements Most, if not all systems capture it. Data type CodeableConcept Binding The domestic partnership status of a person. Marital Status Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-16 rim: player[classCode=PSN]/maritalStatusCode cda: .patient.maritalStatusCode
multipleBirth[x]		0..0		There are no (further) constraints on this element Element id Patient.multipleBirth[x] Short description Whether patient is part of a multiple birth Definition Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Comments Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-24 (bool), PID-25 (integer) rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda: n/a
photo		0..0	Attachment	There are no (further) constraints on this element Element id Patient.photo Short description Image of the patient Definition Image of the patient. Requirements Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Comments Guidelines: Use id photos, not clinical photos. Limit dimensions to thumbnail. Keep byte count low to ease resource updates. Data type Attachment Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: OBX-5 - needs a profile rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/desc cda: n/a
contact	I	0..0	BackboneElement	There are no (further) constraints on this element Element id Patient.contact Short description A contact party (e.g. guardian, partner, friend) for the patient Definition A contact party (e.g. guardian, partner, friend) for the patient. Requirements Need to track people you can contact about the patient. Comments Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` pat-1: SHALL at least contain a contact's details or a reference to an organization `name.exists() or telecom.exists() or address.exists() or organization.exists()` Mappings rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON] cda: n/a
communication		0..0	BackboneElement	There are no (further) constraints on this element Element id Patient.communication Short description A language which may be used to communicate with the patient about his or her health Definition A language which may be used to communicate with the patient about his or her health. Requirements If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. Comments If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: LanguageCommunication cda: patient.languageCommunication
generalPractitioner		0..0	Reference(Organization \| Practitioner \| PractitionerRole)	There are no (further) constraints on this element Element id Patient.generalPractitioner Short description Patient's nominated primary care provider Alternate names careProvider Definition Patient's nominated care provider. Comments This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. Data type Reference(Organization \| Practitioner \| PractitionerRole) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PD1-4 rim: subjectOf.CareEvent.performer.AssignedEntity cda: n/a
managingOrganization	Σ	0..0	Reference(Organization)	There are no (further) constraints on this element Element id Patient.managingOrganization Short description Organization that is the custodian of the patient record Definition Organization that is the custodian of the patient record. Requirements Need to know who recognizes this patient record, manages and updates it. Comments There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: scoper cda: .providerOrganization
link	Σ ?!	0..0	BackboneElement	There are no (further) constraints on this element Element id Patient.link Short description Link to another patient resource that concerns the same actual person Definition Link to another patient resource that concerns the same actual patient. Requirements There are multiple use cases: Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and Distribution of patient information across multiple servers. Comments There is no assumption that linked patient records have mutual links. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: outboundLink cda: n/a

Patient.identifier (Patientenpseudonym)

Ein Paar von UUIDs, die zusammen als Patientenpseudonym auftreten. Der Bildung der Pseudonyme liegt ein für ARS entwickeltes Konzept zugrunde. Das Konzept ist im Kapitel Pseudonymisierung zu finden.

Patient.birthDate (Geburtsdatum (YYYY-MM))

Geburtsdatum des Patienten, nur Angabe des Geburtsmonats und Geburtsjahres.

Patient.address (Wohnort (3-stellige PLZ))

Die Angabe zum Wohnort des Patienten in Form der 3-stelligen Postleitzahl unter ist ausschließlich bei Diagnostik zu Chlamydia trachomatis relevant. Sollten Angaben für einen anderen Erreger als für Chlamydia trachomatis gemacht werden, wird diese nach Übermittlung an das RKI aus der Rohdatenbank entfernt und steht für die weitere Datenverarbeitung am RKI nicht zur Verfügung. Hintergrund für die Erhebung dieser Angaben ist die Integration des Chlamydien-Sentinels in die Übermittlung für ARS. Siehe auch Kapitel Integration von Sentinel-Systemen.

Zusätzliche Regeln

You need a license to run FQL queries

Bindings

keine

You need a license to run FQL queries

Beispiel

Patient

id : 43511fe3-aa5f-73fb-7e59-2313ba0ca76c

meta

lastUpdated : 2025-05-02T11:22:00.382+00:00

profile : https://demis.rki.de/fhir/ars/StructureDefinition/Patient

identifier

system : https://demis.rki.de/fhir/sid/SurveillancePatientPseudonym

value : urn:uuid:fb28bf26-12ae-8f02-85c4-5c6d8b7f6a05

identifier

system : https://demis.rki.de/fhir/sid/SurveillancePatientPseudonym

value : urn:uuid:9a05f2d9-02d5-bb7c-3d46-cac3d7e59991

gender : male

birthDate : 1983-06

<Patient xmlns="http://hl7.org/fhir">
    <id value="43511fe3-aa5f-73fb-7e59-2313ba0ca76c" />
    <meta>
        <lastUpdated value="2025-05-02T11:22:00.382+00:00" />
        <profile value="https://demis.rki.de/fhir/ars/StructureDefinition/Patient" />
    </meta>
    <identifier>
        <system value="https://demis.rki.de/fhir/sid/SurveillancePatientPseudonym" />
        <value value="urn:uuid:fb28bf26-12ae-8f02-85c4-5c6d8b7f6a05" />
    </identifier>
    <identifier>
        <system value="https://demis.rki.de/fhir/sid/SurveillancePatientPseudonym" />
        <value value="urn:uuid:9a05f2d9-02d5-bb7c-3d46-cac3d7e59991" />
    </identifier>
    <gender value="male" />
    <birthDate value="1983-06" />
</Patient>

{
    "resourceType": "Patient",
    "id": "43511fe3-aa5f-73fb-7e59-2313ba0ca76c",
    "meta": {
        "lastUpdated": "05/02/2025 11:22:00",
        "profile":  [
            "https://demis.rki.de/fhir/ars/StructureDefinition/Patient"
        ]
    },
    "identifier":  [
        {
            "system": "https://demis.rki.de/fhir/sid/SurveillancePatientPseudonym",
            "value": "urn:uuid:fb28bf26-12ae-8f02-85c4-5c6d8b7f6a05"
        },
        {
            "system": "https://demis.rki.de/fhir/sid/SurveillancePatientPseudonym",
            "value": "urn:uuid:9a05f2d9-02d5-bb7c-3d46-cac3d7e59991"
        }
    ],
    "gender": "male",
    "birthDate": "1983-06"
}