2025.2.0 - ci-build

IGTTPFHIRGatewayEPIX - Local Development build (v2025.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Person

Official URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/Person Version: 2025.2.0
Active as of 2026-02-05 Computable Name: Person

Copyright/Legal: Copyright 2020-2026 Unabhängige Treuhandstelle der Universitätsmedizin Greifswald

Allgemeines Personen-Profil. Repräsentiert die reale Person (MPI Eintrag), mit beliebig vielen Varianten/Schreibweisen. Letztere werden als Patienten-Identitäten abgebildet (=> Patient-Profil). Die Referenz-Identität wird als aktuell korrekte Variante festgelegt und durch die Angabe von link.assurance='level4' repräsentiert. Es existiert immer genau 1 Link mit diesem Assurance-Level.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person A generic person record
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated SΣ 0..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:customIdatValues S 0..* (Complex) Custom IDAT Values
URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues
... identifier S 1..* Identifier A human identifier for this person
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... name SΣ 0..* HumanName A name associated with the person
.... use ?!SΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:academic 0..* (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... value[x] S 1..1 code Value of extension
Binding: EntityNamePartQualifier (required)
Fixed Value: AC
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... Slices for telecom SΣ 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by pattern:$this
.... telecom:email SΣ 0..* ContactPoint A contact detail for the person
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... telecom:telefon SΣ 0..* ContactPoint A contact detail for the person
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date on which the person was born
... address S 0..* Address One or more addresses for the person
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... managingOrganization SΣ 1..1 Reference(Organization) Domäne
.... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... active ?!SΣ 0..1 boolean This person's record is in active use
... link S 1..* BackboneElement Link to a resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... target S 1..1 Reference(Patient) The resource to which this actual person is associated
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... assurance S 0..1 code level1 | level2 | level3 | level4
Binding: IdentityAssuranceLevel (required): The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Person.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Person.name.use Base required NameUse 📍4.0.1 FHIR Std.
Person.name.prefix.extension:academic.​value[x] Base required EntityNamePartQualifier 📦5.2.0 FHIR Extensions Pack v5.2
Person.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Person.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Person.telecom:telefon.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Person.telecom:telefon.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Person.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Person.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Person.managingOrganization.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Person.link.assurance Base required IdentityAssuranceLevel 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 error Person 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 error Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Person

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person A generic person record
... meta
.... lastUpdated S 0..1 instant When the resource version last changed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:customIdatValues S 0..* (Complex) Custom IDAT Values
URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues
... identifier S 1..* Identifier A human identifier for this person
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
.... use S 0..1 code usual | official | temp | nickname | anonymous | old | maiden
.... text 0..0 Text representation of the full name
.... family S 0..1 string Family name (often called 'Surname')
.... given S 0..* string Given names (not always 'first'). Includes middle names
.... prefix S 0..* string Parts that come before the name
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:academic 0..* (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... value[x] S 1..1 code Value of extension
Fixed Value: AC
.... suffix S 0..* string Parts that come after the name
... Slices for telecom S 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by pattern:$this
.... telecom:email S 0..* ContactPoint A contact detail for the person
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... value S 1..1 string The actual contact point details
.... telecom:telefon S 0..* ContactPoint A contact detail for the person
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value S 1..1 string The actual contact point details
... gender S 0..1 code male | female | other | unknown
... birthDate S 0..1 date The date on which the person was born
... address S 0..* Address One or more addresses for the person
.... text 0..0 Text representation of the address
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... district 0..0 District name (aka county)
.... state S 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode S 0..1 string Postal code for area
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period 0..0 Time period when address was/is in use
... photo 0..0 Image of the person
... managingOrganization S 1..1 Reference(Organization) Domäne
.... identifier S 1..1 Identifier Logical reference, when literal reference is not known
..... system S 0..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique
... active S 0..1 boolean This person's record is in active use
... link S 1..* BackboneElement Link to a resource that concerns the same actual person
.... target S 1..1 Reference(Patient) The resource to which this actual person is associated
..... reference S 1..1 string Literal reference, Relative, internal or absolute URL
.... assurance S 0..1 code level1 | level2 | level3 | level4

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person A generic person record
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:customIdatValues S 0..* (Complex) Custom IDAT Values
URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 1..* Identifier A human identifier for this person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... name SΣ 0..* HumanName A name associated with the person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:academic 0..* (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... value[x] S 1..1 code Value of extension
Binding: EntityNamePartQualifier (required)
Fixed Value: AC
..... value 0..1 string Primitive value for string
Max Length:1048576
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom SΣ 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by pattern:$this
.... telecom:email SΣ 0..* ContactPoint A contact detail for the person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:telefon SΣ 0..* ContactPoint A contact detail for the person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date on which the person was born
... address S 0..* Address One or more addresses for the person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... managingOrganization SΣ 1..1 Reference(Organization) Domäne
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display Σ 0..1 string Text alternative for the resource
... active ?!SΣ 0..1 boolean This person's record is in active use
... link S 1..* BackboneElement Link to a resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... target S 1..1 Reference(Patient) The resource to which this actual person is associated
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... assurance S 0..1 code level1 | level2 | level3 | level4
Binding: IdentityAssuranceLevel (required): The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Person.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Person.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Person.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Person.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Person.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Person.name.use Base required NameUse 📍4.0.1 FHIR Std.
Person.name.prefix.extension:academic.​value[x] Base required EntityNamePartQualifier 📦5.2.0 FHIR Extensions Pack v5.2
Person.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Person.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Person.telecom:telefon.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Person.telecom:telefon.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Person.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Person.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Person.address.type Base required AddressType 📍4.0.1 FHIR Std.
Person.managingOrganization.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Person.managingOrganization.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Person.managingOrganization.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Person.link.target.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Person.link.assurance Base required IdentityAssuranceLevel 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 error Person 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 error Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Person

Summary

Mandatory: 8 elements(4 nested mandatory elements)
Must-Support: 36 elements
Fixed: 1 element
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Person.telecom

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person A generic person record
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated SΣ 0..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:customIdatValues S 0..* (Complex) Custom IDAT Values
URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues
... identifier S 1..* Identifier A human identifier for this person
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... name SΣ 0..* HumanName A name associated with the person
.... use ?!SΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:academic 0..* (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... value[x] S 1..1 code Value of extension
Binding: EntityNamePartQualifier (required)
Fixed Value: AC
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... Slices for telecom SΣ 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by pattern:$this
.... telecom:email SΣ 0..* ContactPoint A contact detail for the person
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... telecom:telefon SΣ 0..* ContactPoint A contact detail for the person
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date on which the person was born
... address S 0..* Address One or more addresses for the person
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... managingOrganization SΣ 1..1 Reference(Organization) Domäne
.... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... active ?!SΣ 0..1 boolean This person's record is in active use
... link S 1..* BackboneElement Link to a resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... target S 1..1 Reference(Patient) The resource to which this actual person is associated
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... assurance S 0..1 code level1 | level2 | level3 | level4
Binding: IdentityAssuranceLevel (required): The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Person.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Person.name.use Base required NameUse 📍4.0.1 FHIR Std.
Person.name.prefix.extension:academic.​value[x] Base required EntityNamePartQualifier 📦5.2.0 FHIR Extensions Pack v5.2
Person.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Person.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Person.telecom:telefon.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Person.telecom:telefon.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Person.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Person.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Person.managingOrganization.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Person.link.assurance Base required IdentityAssuranceLevel 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 error Person 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 error Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Person

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person A generic person record
... meta
.... lastUpdated S 0..1 instant When the resource version last changed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:customIdatValues S 0..* (Complex) Custom IDAT Values
URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues
... identifier S 1..* Identifier A human identifier for this person
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
.... use S 0..1 code usual | official | temp | nickname | anonymous | old | maiden
.... text 0..0 Text representation of the full name
.... family S 0..1 string Family name (often called 'Surname')
.... given S 0..* string Given names (not always 'first'). Includes middle names
.... prefix S 0..* string Parts that come before the name
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:academic 0..* (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... value[x] S 1..1 code Value of extension
Fixed Value: AC
.... suffix S 0..* string Parts that come after the name
... Slices for telecom S 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by pattern:$this
.... telecom:email S 0..* ContactPoint A contact detail for the person
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... value S 1..1 string The actual contact point details
.... telecom:telefon S 0..* ContactPoint A contact detail for the person
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value S 1..1 string The actual contact point details
... gender S 0..1 code male | female | other | unknown
... birthDate S 0..1 date The date on which the person was born
... address S 0..* Address One or more addresses for the person
.... text 0..0 Text representation of the address
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... district 0..0 District name (aka county)
.... state S 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode S 0..1 string Postal code for area
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period 0..0 Time period when address was/is in use
... photo 0..0 Image of the person
... managingOrganization S 1..1 Reference(Organization) Domäne
.... identifier S 1..1 Identifier Logical reference, when literal reference is not known
..... system S 0..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique
... active S 0..1 boolean This person's record is in active use
... link S 1..* BackboneElement Link to a resource that concerns the same actual person
.... target S 1..1 Reference(Patient) The resource to which this actual person is associated
..... reference S 1..1 string Literal reference, Relative, internal or absolute URL
.... assurance S 0..1 code level1 | level2 | level3 | level4

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person A generic person record
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:customIdatValues S 0..* (Complex) Custom IDAT Values
URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 1..* Identifier A human identifier for this person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... name SΣ 0..* HumanName A name associated with the person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:academic 0..* (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... value[x] S 1..1 code Value of extension
Binding: EntityNamePartQualifier (required)
Fixed Value: AC
..... value 0..1 string Primitive value for string
Max Length:1048576
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom SΣ 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by pattern:$this
.... telecom:email SΣ 0..* ContactPoint A contact detail for the person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:telefon SΣ 0..* ContactPoint A contact detail for the person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date on which the person was born
... address S 0..* Address One or more addresses for the person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... managingOrganization SΣ 1..1 Reference(Organization) Domäne
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display Σ 0..1 string Text alternative for the resource
... active ?!SΣ 0..1 boolean This person's record is in active use
... link S 1..* BackboneElement Link to a resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... target S 1..1 Reference(Patient) The resource to which this actual person is associated
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... assurance S 0..1 code level1 | level2 | level3 | level4
Binding: IdentityAssuranceLevel (required): The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Person.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Person.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Person.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Person.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Person.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Person.name.use Base required NameUse 📍4.0.1 FHIR Std.
Person.name.prefix.extension:academic.​value[x] Base required EntityNamePartQualifier 📦5.2.0 FHIR Extensions Pack v5.2
Person.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Person.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Person.telecom:telefon.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Person.telecom:telefon.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Person.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Person.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Person.address.type Base required AddressType 📍4.0.1 FHIR Std.
Person.managingOrganization.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Person.managingOrganization.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Person.managingOrganization.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Person.link.target.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Person.link.assurance Base required IdentityAssuranceLevel 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 error Person 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 error Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Person

Summary

Mandatory: 8 elements(4 nested mandatory elements)
Must-Support: 36 elements
Fixed: 1 element
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Person.telecom

 

Other representations of profile: CSV, Excel, Schematron