NotifiedPerson (Patient) | C | | Patient | There are no (further) constraints on this element Element idPatient Short descriptionInformation 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.
Data typePatient 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 | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typestring |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.meta Short descriptionMetadata about the resource DefinitionThe 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 typeMeta 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 idPatient.implicitRules Short descriptionA set of rules under which this content was created DefinitionA 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.
CommentsAsserting 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 typeuri 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 idPatient.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage 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 typecode BindingCommonLanguages (preferred) Binding extensionsConstraints- 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 idPatient.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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.
CommentsContained 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 typeNarrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
contained | | 0..* | Resource | There are no (further) constraints on this element Element idPatient.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
CommentsThis 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 typeResource Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension Short descriptionAdditional 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 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.
CommentsThere 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 typeExtension 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 |
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPatient.identifier Short descriptionAn identifier for this patient DefinitionAn identifier for this patient.
RequirementsPatients are almost always assigned specific numerical identifiers.
Data typeIdentifier 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
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.active Short descriptionWhether 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.
RequirementsNeed to be able to mark a patient record as not to be used because it was created in error.
CommentsIf a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.
Meaning when missingThis resource is generally assumed to be active if no value is provided for the active element
Data typeboolean 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 | Σ C | 1..1 | HumannameDeBasis | Element idPatient.name Short descriptionName der Betroffenen Person DefinitionName der Betroffenen Person. Mindestens ein Vorname und der Nachname müssen angegeben werden.
RequirementsNeed to be able to track the patient by multiple names. Examples are your official name and a partner name.
CommentsNames may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
Data typeHumannameDeBasis ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - hum-1: Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue() - hum-2: Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue() - hum-3: Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue() - hum-4: Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden
prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue()) Mappings- v2: PID-5, PID-9
- rim: name
- cda: .patient.name
- rim: n/a
- v2: XPN
- rim: EN (actually, PN)
- servd: ProviderName
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.extension Short descriptionAdditional 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.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.name.use Short descriptionusual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name.
RequirementsAllows the appropriate name for a particular context of use to be selected from among a set of names.
CommentsApplications can assume that a name is current unless it explicitly says that it is temporary or old.
Data typecode BindingNameUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XPN.7, but often indicated by which field contains the name
- rim: unique(./use)
- servd: ./NamePurpose
- BDT: 1211 (in BDT als Freitext!)
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.text Short descriptionText 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.
RequirementsA renderable, unencoded form.
CommentsCan provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: implied by XPN.11
- rim: ./formatted
|
family | Σ | 1..1 | string | Element idPatient.name.family Short descriptionNachname der Betroffenen Person Alternate namessurname DefinitionNachname der Betroffenen Person. Es muss genau ein Nachname angegeben werden.
CommentsFamily Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XPN.1/FN.1
- rim: ./part[partType = FAM]
- servd: ./FamilyName
- BDT: 3120 + 3100 + 3101
- KVDT: 3120 + 3100 + 3101
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.family.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references)
Data typestring |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.family.extension Short descriptionAdditional 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 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.
CommentsThere 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 typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
namenszusatz | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name.family.extension:namenszusatz Short descriptionNamenszusatz 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
CommentsDie Extension wurde erstellt aufgrund der Anforderung, die auf der eGK vorhandenen Patientenstammdaten in FHIR abbilden zu können. Auf der eGK werden die Namensbestandteile "Namenszusatz" und "Vorsatzwort" getrennt vom Nachnamen gespeichert. Anhand der Liste der zulässigen Namenszusätze ist deutlich erkennbar, dass es sich hierbei sinngemäß um Adelstitel handelt.
Das Vorsatzwort kann durch die Core-Extension http://build.fhir.org/extension-humanname-own-name.html abgebildet werden, für den Namenszusatz ergibt sich jedoch die Notwendikeit einer nationalen Extension, da in andern Ländern Adelstitel entweder gar nicht oder als reguläres Namenspräfix erfasst werden.
Data typeExtension(string) Extension URLhttp://fhir.de/StructureDefinition/humanname-namenszusatz ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: n/a
- rim: N/A
- KVDT: 3100
- BDT: 3100
|
nachname | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name.family.extension:nachname Short descriptionNachname ohne Vor- und Zusätze Alternate namesextensions, user content DefinitionNachname ohne Vor- und Zusätze.
Dient z.B. der alphabetischen Einordnung des Namens.
CommentsIf the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".
Data typeExtension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/humanname-own-name ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- v2: FN.3
- rim: ENXP where Qualifiers = (BR)
- KVDT: 3101
- BDT: 3101
|
vorsatzwort | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name.family.extension:vorsatzwort Short descriptionVorsatzwort Alternate namesextensions, user content DefinitionVorsatzwort wie z.B.: von, van, zu
Vgl. auch VSDM-Spezifikation der Gematik (Versichertenstammdatenmanagement, "eGK")
CommentsAn example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.
Data typeExtension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/humanname-own-prefix ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- v2: FN.2
- rim: ENXP where Qualifiers = (VV, R)
- BDT: 3120
- KVDT: 3120
|
value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.name.family.value Short descriptionPrimitive value for string DefinitionData typeSystem.String Maximum string length1048576 |
given | Σ | 1..* | string | Element idPatient.name.given Short descriptionVorname der Betroffenen Person Alternate namesfirst name, middle name DefinitionVorname der Betroffenen Person. Es muss mindestens ein Vorname angegeben werden.
CommentsIf only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XPN.2 + XPN.3
- rim: ./part[partType = GIV]
- servd: ./GivenNames
- KVDT: 3102
- BDT: 3102
|
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.prefix Short descriptionNamensteile vor dem Vornamen DefinitionNamensteile vor dem Vornamen, z.B. akademischer Titel.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XPN.5
- rim: ./part[partType = PFX]
- servd: ./TitleCode
- KVDT: 3104
- BDT: 3104
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.prefix.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references)
Data typestring |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.prefix.extension Short descriptionAdditional 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 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.
CommentsThere 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 typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
prefix-qualifier | C | 0..* | Extension(code) | There are no (further) constraints on this element Element idPatient.name.prefix.extension:prefix-qualifier Short descriptionLS | 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
CommentsUsed to indicate additional information about the name part and how it should be used.
Data typeExtension(code) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.name.prefix.value Short descriptionPrimitive value for string DefinitionData typeSystem.String Maximum string length1048576 |
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.suffix Short descriptionNamensteile nach dem Nachnamen DefinitionNamensteile nach dem Nachnamen
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XPN/4
- rim: ./part[partType = SFX]
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name.period Short descriptionTime period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person.
RequirementsAllows names to be placed in historical context.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XPN.13 + XPN.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
telecom | Σ | 0..* | ContactPoint | Element idPatient.telecom Short descriptionKontaktangaben der Betroffenen Person DefinitionKontaktangaben der Betroffenen Person. Telefonnummern oder E-Mailadressen können angegeben werden.
RequirementsPeople have (primary) ways to contact them in some way such as phone, email.
CommentsA 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 typeContactPoint SlicingUnordered, Closed, by system(Value) 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
|
Email | Σ | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:Email Short descriptionA contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
RequirementsPeople have (primary) ways to contact them in some way such as phone, email.
CommentsA 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 typeContactPoint 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
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:Email.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom:Email.extension Short descriptionAdditional 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.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
system | Σ C | 1..1 | codeBindingFixed Value | Element idPatient.telecom:Email.system Short descriptionphone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact.
Data typecode BindingTelecommunications form for contact point.
ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Fixed valueemail Mappings- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:Email.value Short descriptionThe 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).
RequirementsNeed to support legacy numbers that are not in a tightly controlled format.
CommentsAdditional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.1 (or XTN.12)
- rim: ./url
- servd: ./Value
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom:Email.use Short descriptionhome | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point.
RequirementsNeed to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
CommentsApplications can assume that a contact is current unless it explicitly says that it is temporary or old.
Data typecode BindingContactPointUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.2 - but often indicated by field
- rim: unique(./use)
- servd: ./ContactPointPurpose
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:Email.rank Short descriptionSpecify 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.
CommentsNote that rank does not necessarily follow the order in which the contacts are represented in the instance.
Data typepositiveInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:Email.period Short descriptionTime period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: N/A
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
Phone | Σ | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:Phone Short descriptionA contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
RequirementsPeople have (primary) ways to contact them in some way such as phone, email.
CommentsA 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 typeContactPoint 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
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:Phone.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | Element idPatient.telecom:Phone.extension Short descriptionAdditional 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.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
system | Σ C | 1..1 | codeBindingFixed Value | Element idPatient.telecom:Phone.system Short descriptionphone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact.
Data typecode BindingTelecommunications form for contact point.
ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Fixed valuephone Mappings- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:Phone.value Short descriptionThe 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).
RequirementsNeed to support legacy numbers that are not in a tightly controlled format.
CommentsAdditional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.1 (or XTN.12)
- rim: ./url
- servd: ./Value
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom:Phone.use Short descriptionhome | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point.
RequirementsNeed to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
CommentsApplications can assume that a contact is current unless it explicitly says that it is temporary or old.
Data typecode BindingContactPointUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.2 - but often indicated by field
- rim: unique(./use)
- servd: ./ContactPointPurpose
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:Phone.rank Short descriptionSpecify 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.
CommentsNote that rank does not necessarily follow the order in which the contacts are represented in the instance.
Data typepositiveInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:Phone.period Short descriptionTime period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: N/A
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
gender | Σ | 1..1 | codeBinding | Element idPatient.gender Short descriptionGeschlecht der Betroffenen Person DefinitionGeschlecht der Betroffenen Person
RequirementsNeeded for identification of the individual, in combination with (at least) name and birth date.
CommentsThe 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 typecode BindingThe 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
|
birthDate | Σ | 1..1 | date | Element idPatient.birthDate Short descriptionGeburtsdatum der Betroffenen Person DefinitionGeburtsdatum der Betroffenen Person
RequirementsAge of the individual drives many clinical processes.
CommentsAt 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 typedate Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-7
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
- cda: .patient.birthTime
- loinc: 21112-8
|
deceased[x] | Σ ?! | 0..1 | | Element idPatient.deceased[x] Short descriptionAngabe ob die Betroffene Person verstorben ist DefinitionAngabe ob die Betroffene Person verstorben ist
RequirementsThe 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.
CommentsIf 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
|
deceasedBoolean | | | boolean | There are no (further) constraints on this element Data typeboolean |
deceasedDateTime | | | dateTime | There are no (further) constraints on this element Data typedateTime |
address | Σ C | 0..* | AddressDeBasis | Element idPatient.address Short descriptionAdresse der Betroffenen Person DefinitionAdresse der Betroffenen Person. Über die Extension "addressUse" kann angegeben werden, um welche Art von Adresse es sich handelt. Ist die Betroffene Person in einer Einrichtung untergebracht, kann über die Extension die Einrichtung angegeben werden.
RequirementsMay need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.
CommentsNote: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
Data typeAddressDeBasis ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - add-1: Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue()) - add-2: Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue()) - add-3: Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) - add-4: Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein.
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty() - add-5: Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue()) - add-6: Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty())) - add-7: Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein.
extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or line.where(extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').valueString=$this).exists() Examples Beispiel für einfache Adresse{
"use": "home",
"type": "postal",
"line": [
"Musterweg 42"
],
"city": "Musterhausen",
"postalCode": "99999"
} Mappings- v2: PID-11
- rim: addr
- cda: .addr
- rim: n/a
- v2: XAD
- rim: AD
- servd: Address
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | Element idPatient.address.extension Short descriptionAdditional 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.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
Stadtteil | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.extension:Stadtteil Short descriptionStadt- oder Ortsteil Alternate namesextensions, user content DefinitionA subsection of a municipality.
CommentsThere 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 typeExtension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: n/a
- rim: ADXP[partType=PRE]
|
addressUse | C | 0..* | Extension(Coding) | Element idPatient.address.extension:addressUse Short descriptionOptional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources.
CommentsThere 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 typeExtension(Coding) Extension URLhttps://demis.rki.de/fhir/StructureDefinition/AddressUse ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
facility | C | 0..* | Extension(Reference(Betroffenen-Einrichtung)) | Element idPatient.address.extension:facility Short descriptionOptional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources.
CommentsThere 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 typeExtension(Reference(Betroffenen-Einrichtung)) Extension URLhttps://demis.rki.de/fhir/StructureDefinition/FacilityAddressNotifiedPerson ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idPatient.address.use Short descriptionhome | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address.
RequirementsAllows an appropriate address to be chosen from a list of many.
CommentsApplications can assume that an address is current unless it explicitly says that it is temporary or old.
Data typecode BindingAddressUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples Generalhome Mappings- v2: XAD.7
- rim: unique(./use)
- servd: ./AddressPurpose
|
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.type Short descriptionpostal | 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.
CommentsThe 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 typecode BindingThe 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 Generalboth Mappings- v2: XAD.18
- rim: unique(./use)
- vcard: address type parameter
- BDT: 1202 (1=physical, 2=postal)
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.text Short descriptionText 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.
RequirementsA renderable, unencoded form.
CommentsCan 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 typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General137 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 | Σ | 1..1 | string | Element idPatient.address.line Short descriptionAnschriftenzeile DefinitionAnschriftenzeile. Die Angabe eines Postfaches ist nicht erlaubt.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General137 Nowhere Street Beipiel für Adresszeile mit Extensions für Straße und HausnummerMusterweg 42 Mappings- v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
- rim: AD.part[parttype = AL]
- vcard: street
- servd: ./StreetAddress (newline delimitted)
- KVDT: 3107 + 3109 + 3115 oder 3123
- BDT: 3107 + 3109 + 3115 oder 3123
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references)
Data typestring |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.line.extension Short descriptionAdditional 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 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.
CommentsThere 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 typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
Strasse | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:Strasse Short descriptionStrassenname (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.
CommentsThere 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 typeExtension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: ADXP[partType=STR]
- KVDT: 3107
- BDT: 3107
|
Hausnummer | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:Hausnummer Short descriptionHausnummer 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.
CommentsThere 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 typeExtension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: ADXP[partType=BNR]
- KVDT: 3109
- BDT: 3109
|
Adresszusatz | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:Adresszusatz Short descriptionAdresszusatz 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.
CommentsThere 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 typeExtension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: ADXP[partType=ADL]
- KVDT: 3115
- BDT: 3115
|
Postfach | C | 0..0 | Extension(string) | Element idPatient.address.line.extension:Postfach Short descriptionPostfach 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.
CommentsThere 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 typeExtension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: ADXP[partType=POB]
- KVDT: 3123
- BDT: 3123
|
value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.address.line.value Short descriptionPrimitive value for string DefinitionData typeSystem.String Maximum string length1048576 |
city | Σ | 1..1 | string | Element idPatient.address.city Short descriptionStadt Alternate namesMunicpality DefinitionData typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples GeneralErewhon Mappings- v2: XAD.3
- rim: AD.part[parttype = CTY]
- vcard: locality
- servd: ./Jurisdiction
- BDT: 3113 oder 3122 (Postfach)
- KVDT: 3113 oder 3122 (Postfach)
|
district | Σ | 0..0 | string | There are no (further) constraints on this element Element idPatient.address.district Short descriptionDistrict name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county).
CommentsDistrict 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 typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples GeneralMadison Mappings- v2: XAD.9
- rim: AD.part[parttype = CNT | CPA]
|
state | Σ | 0..1 | stringBinding | There are no (further) constraints on this element Element idPatient.address.state Short descriptionBundesland Alternate namesProvince, Territory DefinitionName (oder Kürzel) des Bundeslandes.
Data typestring BindingISO31662DE (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XAD.4
- rim: AD.part[parttype = STA]
- vcard: region
- servd: ./Region
|
postalCode | Σ | 1..1 | stringBinding | Element idPatient.address.postalCode Short descriptionPostleitzahl Alternate namesZip DefinitionPostleitzahl. Der Wert muss entsprechend des vom RKI definierten ValueSets (https://demis.rki.de/fhir/ValueSet/postalCode) im coding Element dargestellt werden.
Data typestring BindingPostalCode (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General9132 Mappings- v2: XAD.5
- rim: AD.part[parttype = ZIP]
- vcard: code
- servd: ./PostalIdentificationCode
- BDT: 3112 oder 3121 (Postfach)
- KVDT: 3112 oder 3121 (Postfach)
|
country | Σ | 1..1 | stringBinding | Element idPatient.address.country Short descriptionLand DefinitionLand. Der Wert muss entsprechend des vom RKI definierten ValueSets (https://demis.rki.de/fhir/ValueSet/country) im coding Element dargestellt werden.
CommentsISO 3166 3 letter codes can be used in place of a human readable country name.
Data typestring BindingCountry (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XAD.6
- rim: AD.part[parttype = CNT]
- vcard: country
- servd: ./Country
- BDT: 3114 oder 3124 (Postfach), abweichendes CodeSystem
- KVDT: 3114 oder 3124 (Postfach), abweichendes CodeSystem
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address.period Short descriptionTime period when address was/is in use DefinitionTime period when address was/is in use.
RequirementsAllows addresses to be placed in historical context.
Data typePeriod 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
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.period.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.period.extension Short descriptionAdditional 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.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.address.period.start Short descriptionStarting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive.
CommentsIf the low element is missing, the meaning is that the low boundary is not known.
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: per-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: DR.1
- rim: ./low
- BDT: 8226
|
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.address.period.end Short descriptionEnd 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.
CommentsThe high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Meaning when missingIf the end of the period is missing, it means that the period is ongoing
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: per-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: DR.2
- rim: ./high
- BDT: 8227
|
maritalStatus | | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatus Short descriptionMarital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status.
RequirementsMost, if not all systems capture it.
Data typeCodeableConcept BindingThe 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 idPatient.multipleBirth[x] Short descriptionWhether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
RequirementsFor disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.
CommentsWhere 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 idPatient.photo Short descriptionImage of the patient DefinitionRequirementsMany EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.
CommentsGuidelines:
- Use id photos, not clinical photos.
- Limit dimensions to thumbnail.
- Keep byte count low to ease resource updates.
Data typeAttachment 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 | C | 0..* | BackboneElement | Element idPatient.contact Short descriptionKontaktperson der Betroffenen Person DefinitionKontaktperson der Betroffenen Person
RequirementsNeed to track people you can contact about the patient.
CommentsContact 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 typeBackboneElement 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
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extension Short descriptionAdditional 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.
CommentsThere 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 typeExtension 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 |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
relationship | | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationship Short descriptionThe kind of relationship DefinitionThe nature of the relationship between the patient and the contact person.
RequirementsUsed to determine which contact person is the most relevant to approach, depending on circumstances.
Data typeCodeableConcept BindingThe nature of the relationship between a patient and a contact person for that patient.
PatientContactRelationship (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NK1-7, NK1-3
- rim: code
- cda: n/a
|
name | | 0..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact.name Short descriptionA name associated with the contact person DefinitionA name associated with the contact person.
RequirementsContact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.
Data typeHumanName Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NK1-2
- rim: name
- cda: n/a
|
telecom | | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecom Short descriptionA contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address.
RequirementsPeople have (primary) ways to contact them in some way such as phone, email.
CommentsContact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.
Data typeContactPoint Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NK1-5, NK1-6, NK1-40
- rim: telecom
- cda: n/a
|
address | | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact.address Short descriptionAddress for the contact person DefinitionAddress for the contact person.
RequirementsNeed to keep track where the contact person can be contacted per postal mail or visited.
Data typeAddress Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NK1-4
- rim: addr
- cda: n/a
|
gender | | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.gender Short descriptionmale | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
RequirementsNeeded to address the person correctly.
Data typecode BindingThe 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: NK1-15
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
- cda: n/a
|
organization | C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.contact.organization Short descriptionOrganization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working.
RequirementsFor guardians or business related contacts, the organization is relevant.
Data typeReference(Organization) ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
- rim: scoper
- cda: n/a
|
period | | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.period Short descriptionThe 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.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: effectiveTime
- cda: n/a
|
communication | | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.communication Short descriptionA 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.
RequirementsIf 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.
CommentsIf 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 typeBackboneElement 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..* | Reference(Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idPatient.generalPractitioner Short descriptionPatient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider.
CommentsThis 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 typeReference(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 idPatient.managingOrganization Short descriptionOrganization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record.
RequirementsNeed to know who recognizes this patient record, manages and updates it.
CommentsThere 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 typeReference(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 idPatient.link Short descriptionLink to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient.
RequirementsThere 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.
CommentsThere is no assumption that linked patient records have mutual links.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: outboundLink
- cda: n/a
|