Austrian Patient Summary (R4)
1.0.0 - STU1

Austrian Patient Summary (R4) - Downloaded Version 1.0.0 See the Directory of published versions

## Resource Profile: AT APS Patient

Official URL: https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-patient | Version: 1.0.0
Active as of 2026-02-17 | Computable Name: AtApsPatient

Patientendaten, inkl. Angabe von Kontaktpersonen, Hausarzt bzw. primäre Ansprechpartner.

Um die Vorgaben aus dem Umfeld von MyHealth@EU zu erfüllen, muss ein Vor- und Nachname angegeben werden.

Das AT APS-Profil für die Patient-Ressource ist vom entsprechenden Profil aus dem HL7® Austria FHIR® Core IG abgeleitet und stellt zusätzlich die Konformität gegenüber dem IPS-Profil sicher, indem die so genannte `imposeProfile`-Erweiterung verwendet wird. Deshalb ist die Angabe des Geburtsdatums erforderlich.

> Dieses Profil beinhaltet Abkürzungen (z.B. bPK = bereichsspezifisches Personenkennzeichen) aus dem HL7® AT Core Patient Profile.

> Die Beschreibung der Abkürzungen in dem Profil wird in diesem Ticket verfolgt: #147 und wird in der nächsten Version des APS IGs übernommen.

Usages:

- Use this Profile: AT APS Bundle
- Refer to this Profile: AT APS AllergyIntolerance, AT APS CarePlan, AT APS ClinicalImpression, AT APS Composition... Show 25 more, AT APS Condition, AT APS Consent, AT APS Device, AT APS DeviceUseStatement, AT APS DiagnosticReport, AT APS DocumentReference, AT APS Flag Alert, AT APS ImagingStudy, AT APS Immunization, AT APS Immunization, AT APS MedicationAdministration, AT APS MedicationDispense, AT APS MedicationRequest, AT APS MedicationStatement, AT APS Observation, AT APS Observation Alcohol Use, AT APS Observation Pregnancy Expected Delivery Date, AT APS Observation Pregnancy Outcome, AT APS Observation Pregnancy Status, AT APS Observation Results Radiology, AT APS Observation Tobacco Use, AT APS Observation Vital Signs, AT APS Patient, AT APS Procedure and AT APS Specimen
- Examples for this Profile: Patient/at-aps-example-patient-01
- CapabilityStatements using this Profile: AT APS CapabilityStatement (Server)

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | HL7ATCorePatient | AT APS Patient This profile also imposes the profile Patient (IPS)
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:citizenship |  | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Slices for extension |  |  |  | Content/Rules for all slices
extension:code |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "code"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: https://termgit.elga.gv.at/ValueSet/elga-laendercodes (extensible)
extension:period |  | 0..1 | Extension | Time period of citizenship
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "period"
value[x] |  | 1..1 | Period | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
extension:PatientReligion |  | 0..1 | (Complex) | Patient Religion URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-patient-religion
extension:birthPlace |  | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x] |  | 1..1 | HL7ATCoreAddress | Value of extension
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.code
identifier:All Slices |  |  |  | Content/Rules for all slices
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
assigner | Σ | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
identifier:socialSecurityNumber | Σ | 0..1 | Identifier | An identifier for this patient
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | OID for the Social Security Number in Austria Fixed Value: urn:oid:1.2.40.0.10.1.4.3.1
assigner | Σ | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Dachverband der österreichischen Sozialversicherungsträger
identifier:bPK | Σ | 0..* | Identifier | An identifier for this patient
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | OID for the bPK in Austria Fixed Value: urn:oid:1.2.40.0.10.2.1.1.149
assigner | Σ | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Bundesministerium für Inneres
identifier:localPatientId | Σ | 1..1 | Identifier | An identifier for this patient
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | Namespace that assigned the localPatientId. Example General: http://www.acme.com/identifiers/patient
assigner | Σ | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | Σ | 1..* | HumanName | A name associated with the patient
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family | Σ | 1..1 | string | Family name (often called 'Surname')
given | Σ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
gender | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Slices for extension |  |  |  | Content/Rules for all slices
extension:AdministrativeGenderAddition |  | 0..1 | Coding | Administrative Gender Addition URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-gender-administrativeGenderAddition Binding: https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension (required)
birthDate | Σ | 1..1 | date | The date of birth for the individual
Slices for deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Indicates if the individual is deceased or not
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not
Slices for multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
multipleBirth[x]:multipleBirthBoolean |  | 0..1 | boolean | Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger |  | 0..1 | integer | Whether patient is part of a multiple birth
generalPractitioner |  | 0..* | Reference(AT APS Organization | AT APS Practitioner | AT APS PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(AT APS Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(AT APS Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.extension:citizenship.​extension:code.value[x] | Base | extensible | https://termgit.elga.gv.at/ValueSet/elga-laendercodes | Not State | Unknown
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:socialSecurityNumber.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:bPK.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:localPatientId.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | 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 | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | 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 HL7ATCorePatient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | HL7ATCorePatient | AT APS Patient This profile also imposes the profile Patient (IPS)
identifier |  | 1..* | Identifier | An identifier for this patient
assigner |  | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:socialSecurityNumber |  | 0..1 | Identifier | An identifier for this patient
assigner |  | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
identifier:bPK |  | 0..* | Identifier | An identifier for this patient
assigner |  | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
identifier:localPatientId |  | 1..1 | Identifier | An identifier for this patient
assigner |  | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
name |  |  |  |
family |  | 1..1 | string | Family name (often called 'Surname')
given |  | 1..* | string | Given names (not always 'first'). Includes middle names
birthDate |  | 1..1 | date | The date of birth for the individual
contact |  |  |  |
organization |  | 0..1 | Reference(AT APS Organization) | Organization that is associated with the contact
generalPractitioner |  | 0..* | Reference(AT APS Organization | AT APS Practitioner | AT APS PractitionerRole) | Patient's nominated primary care provider
managingOrganization |  | 0..1 | Reference(AT APS Organization) | Organization that is the custodian of the patient record
link |  |  |  |
other |  | 1..1 | Reference(AT APS Patient | RelatedPerson) | The other patient or related person resource that the link refers to
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | HL7ATCorePatient | AT APS Patient This profile also imposes the profile Patient (IPS)
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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:citizenship |  | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
id |  | 0..1 | id | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code |  | 0..1 | Extension | Extension
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "code"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: https://termgit.elga.gv.at/ValueSet/elga-laendercodes (extensible)
extension:period |  | 0..1 | Extension | Time period of citizenship
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "period"
value[x] |  | 1..1 | Period | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
extension:PatientReligion |  | 0..1 | (Complex) | Patient Religion URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-patient-religion
extension:birthPlace |  | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
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/patient-birthPlace"
value[x] |  | 1..1 | HL7ATCoreAddress | Value of extension
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.code
identifier:All Slices |  |  |  | Content/Rules for all slices
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: https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier (extensible)
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 0..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(AT APS Organization) | Organization that issued id (may be just text)
identifier:socialSecurityNumber | Σ | 0..1 | Identifier | An identifier for this patient
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: https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
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 | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
system | Σ | 1..1 | uri | OID for the Social Security Number in Austria Fixed Value: urn:oid:1.2.40.0.10.1.4.3.1
value | Σ | 0..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(AT APS Organization) | Organization that issued id (may be just text)
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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Dachverband der österreichischen Sozialversicherungsträger
identifier:bPK | Σ | 0..* | Identifier | An identifier for this patient
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: https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
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 | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
system | Σ | 1..1 | uri | OID for the bPK in Austria Fixed Value: urn:oid:1.2.40.0.10.2.1.1.149
value | Σ | 0..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(AT APS Organization) | Organization that issued id (may be just text)
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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Bundesministerium für Inneres
identifier:localPatientId | Σ | 1..1 | Identifier | An identifier for this patient
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: https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
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 | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
system | Σ | 1..1 | uri | Namespace that assigned the localPatientId. Example General: http://www.acme.com/identifiers/patient
value | Σ | 0..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(AT APS Organization) | Organization that issued id (may be just text)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | Σ | 1..* | HumanName | A name associated with the patient
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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | Σ | 1..1 | string | Family name (often called 'Surname')
given | Σ | 1..* | 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 | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 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
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual
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 | Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | Σ | 0..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 | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:AdministrativeGenderAddition |  | 0..1 | Coding | Administrative Gender Addition URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-gender-administrativeGenderAddition Binding: https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension (required)
value |  | 0..1 | string | Primitive value for code
birthDate | Σ | 1..1 | date | The date of birth for the individual
Slices for deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Indicates if the individual is deceased or not
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not
address | Σ | 0..* | HL7ATCoreAddress | An address for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:municipalityCode |  | 0..1 | string | Address Municipality Code URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-municipalityCode
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
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ | 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
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:street |  | 0..1 | string | Name of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
extension:streetNumber |  | 0..1 | string | Number of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
extension:floorDoorNumber |  | 0..1 | string | Floor and/or door number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
extension:additionalInformation |  | 0..1 | string | Additional Information URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation
value |  | 0..1 | string | Primitive value for string Max Length:1048576
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a 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
coding | Σ | 0..* | Coding | Code defined by a terminology system
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 | Σ | 0..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
Slices for multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
multipleBirth[x]:multipleBirthBoolean |  | 0..1 | boolean | Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger |  | 0..1 | integer | Whether patient is part of a multiple birth
photo |  | 0..* | Attachment | Image of the patient
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
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
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
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 | Σ | 0..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
name |  | 0..1 | HumanName | A name associated with the contact 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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | Σ | 0..1 | string | Family name (often called 'Surname')
given | Σ | 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 | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 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
telecom |  | 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 | Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | Σ | 0..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
address |  | 0..1 | HL7ATCoreAddress | Address for the contact person
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:municipalityCode |  | 0..1 | string | Address Municipality Code URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-municipalityCode
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
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ | 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
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:street |  | 0..1 | string | Name of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
extension:streetNumber |  | 0..1 | string | Number of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
extension:floorDoorNumber |  | 0..1 | string | Floor and/or door number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
extension:additionalInformation |  | 0..1 | string | Additional Information URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation
value |  | 0..1 | string | Primitive value for string Max Length:1048576
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:AdministrativeGenderAddition |  | 0..1 | Coding | Administrative Gender Addition URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-gender-administrativeGenderAddition Binding: https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension (required)
value |  | 0..1 | string | Primitive value for code
organization | C | 0..1 | Reference(AT APS Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
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
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(AT APS Organization | AT APS Practitioner | AT APS PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(AT APS Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient 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
other | Σ | 1..1 | Reference(AT APS Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.extension:citizenship.​extension:code.value[x] | Base | extensible | https://termgit.elga.gv.at/ValueSet/elga-laendercodes | Not State | Unknown
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier.type | Base | extensible | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | Not State | Unknown
Patient.identifier:socialSecurityNumber.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:socialSecurityNumber.​type | Base | required | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | Not State | Unknown
Patient.identifier:socialSecurityNumber.​assigner.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std.
Patient.identifier:bPK.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:bPK.​type | Base | required | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | Not State | Unknown
Patient.identifier:bPK.​assigner.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std.
Patient.identifier:localPatientId.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:localPatientId.​type | Base | required | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | Not State | Unknown
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Patient.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Patient.maritalStatus | Base | extensible | MaritalStatus | 📦4.0.1 | FHIR Std.
Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📦4.0.1 | FHIR Std.
Patient.contact.name.​use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.contact.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Patient.contact.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Patient.contact.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Patient.contact.address.​type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | 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 | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | 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()`
pat-1 | error | Patient.contact | 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()`

This structure is derived from HL7ATCorePatient

Summary

Mandatory: 5 elements

Structures

This structure refers to these other structures:

- AT APS Organization (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-organization)
- AT APS Practitioner (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-practitioner)
- AT APS PractitionerRole (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-practitionerrole)
- AT APS Patient (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-patient)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | HL7ATCorePatient | AT APS Patient This profile also imposes the profile Patient (IPS)
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:citizenship |  | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Slices for extension |  |  |  | Content/Rules for all slices
extension:code |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "code"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: https://termgit.elga.gv.at/ValueSet/elga-laendercodes (extensible)
extension:period |  | 0..1 | Extension | Time period of citizenship
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "period"
value[x] |  | 1..1 | Period | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
extension:PatientReligion |  | 0..1 | (Complex) | Patient Religion URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-patient-religion
extension:birthPlace |  | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x] |  | 1..1 | HL7ATCoreAddress | Value of extension
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.code
identifier:All Slices |  |  |  | Content/Rules for all slices
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
assigner | Σ | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
identifier:socialSecurityNumber | Σ | 0..1 | Identifier | An identifier for this patient
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | OID for the Social Security Number in Austria Fixed Value: urn:oid:1.2.40.0.10.1.4.3.1
assigner | Σ | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Dachverband der österreichischen Sozialversicherungsträger
identifier:bPK | Σ | 0..* | Identifier | An identifier for this patient
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | OID for the bPK in Austria Fixed Value: urn:oid:1.2.40.0.10.2.1.1.149
assigner | Σ | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Bundesministerium für Inneres
identifier:localPatientId | Σ | 1..1 | Identifier | An identifier for this patient
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | Namespace that assigned the localPatientId. Example General: http://www.acme.com/identifiers/patient
assigner | Σ | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | Σ | 1..* | HumanName | A name associated with the patient
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family | Σ | 1..1 | string | Family name (often called 'Surname')
given | Σ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
gender | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Slices for extension |  |  |  | Content/Rules for all slices
extension:AdministrativeGenderAddition |  | 0..1 | Coding | Administrative Gender Addition URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-gender-administrativeGenderAddition Binding: https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension (required)
birthDate | Σ | 1..1 | date | The date of birth for the individual
Slices for deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Indicates if the individual is deceased or not
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not
Slices for multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
multipleBirth[x]:multipleBirthBoolean |  | 0..1 | boolean | Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger |  | 0..1 | integer | Whether patient is part of a multiple birth
generalPractitioner |  | 0..* | Reference(AT APS Organization | AT APS Practitioner | AT APS PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(AT APS Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(AT APS Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.extension:citizenship.​extension:code.value[x] | Base | extensible | https://termgit.elga.gv.at/ValueSet/elga-laendercodes | Not State | Unknown
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:socialSecurityNumber.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:bPK.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:localPatientId.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | 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 | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | 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 HL7ATCorePatient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | HL7ATCorePatient | AT APS Patient This profile also imposes the profile Patient (IPS)
identifier |  | 1..* | Identifier | An identifier for this patient
assigner |  | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:socialSecurityNumber |  | 0..1 | Identifier | An identifier for this patient
assigner |  | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
identifier:bPK |  | 0..* | Identifier | An identifier for this patient
assigner |  | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
identifier:localPatientId |  | 1..1 | Identifier | An identifier for this patient
assigner |  | 0..1 | Reference(AT APS Organization) | Organization that issued id (may be just text)
name |  |  |  |
family |  | 1..1 | string | Family name (often called 'Surname')
given |  | 1..* | string | Given names (not always 'first'). Includes middle names
birthDate |  | 1..1 | date | The date of birth for the individual
contact |  |  |  |
organization |  | 0..1 | Reference(AT APS Organization) | Organization that is associated with the contact
generalPractitioner |  | 0..* | Reference(AT APS Organization | AT APS Practitioner | AT APS PractitionerRole) | Patient's nominated primary care provider
managingOrganization |  | 0..1 | Reference(AT APS Organization) | Organization that is the custodian of the patient record
link |  |  |  |
other |  | 1..1 | Reference(AT APS Patient | RelatedPerson) | The other patient or related person resource that the link refers to
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | HL7ATCorePatient | AT APS Patient This profile also imposes the profile Patient (IPS)
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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:citizenship |  | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
id |  | 0..1 | id | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code |  | 0..1 | Extension | Extension
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "code"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: https://termgit.elga.gv.at/ValueSet/elga-laendercodes (extensible)
extension:period |  | 0..1 | Extension | Time period of citizenship
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "period"
value[x] |  | 1..1 | Period | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
extension:PatientReligion |  | 0..1 | (Complex) | Patient Religion URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-patient-religion
extension:birthPlace |  | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
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/patient-birthPlace"
value[x] |  | 1..1 | HL7ATCoreAddress | Value of extension
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.code
identifier:All Slices |  |  |  | Content/Rules for all slices
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: https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier (extensible)
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 0..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(AT APS Organization) | Organization that issued id (may be just text)
identifier:socialSecurityNumber | Σ | 0..1 | Identifier | An identifier for this patient
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: https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
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 | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
system | Σ | 1..1 | uri | OID for the Social Security Number in Austria Fixed Value: urn:oid:1.2.40.0.10.1.4.3.1
value | Σ | 0..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(AT APS Organization) | Organization that issued id (may be just text)
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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Dachverband der österreichischen Sozialversicherungsträger
identifier:bPK | Σ | 0..* | Identifier | An identifier for this patient
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: https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
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 | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
system | Σ | 1..1 | uri | OID for the bPK in Austria Fixed Value: urn:oid:1.2.40.0.10.2.1.1.149
value | Σ | 0..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(AT APS Organization) | Organization that issued id (may be just text)
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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Bundesministerium für Inneres
identifier:localPatientId | Σ | 1..1 | Identifier | An identifier for this patient
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: https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
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 | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
system | Σ | 1..1 | uri | Namespace that assigned the localPatientId. Example General: http://www.acme.com/identifiers/patient
value | Σ | 0..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(AT APS Organization) | Organization that issued id (may be just text)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | Σ | 1..* | HumanName | A name associated with the patient
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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | Σ | 1..1 | string | Family name (often called 'Surname')
given | Σ | 1..* | 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 | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 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
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual
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 | Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | Σ | 0..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 | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:AdministrativeGenderAddition |  | 0..1 | Coding | Administrative Gender Addition URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-gender-administrativeGenderAddition Binding: https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension (required)
value |  | 0..1 | string | Primitive value for code
birthDate | Σ | 1..1 | date | The date of birth for the individual
Slices for deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Indicates if the individual is deceased or not
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not
address | Σ | 0..* | HL7ATCoreAddress | An address for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:municipalityCode |  | 0..1 | string | Address Municipality Code URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-municipalityCode
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
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ | 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
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:street |  | 0..1 | string | Name of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
extension:streetNumber |  | 0..1 | string | Number of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
extension:floorDoorNumber |  | 0..1 | string | Floor and/or door number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
extension:additionalInformation |  | 0..1 | string | Additional Information URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation
value |  | 0..1 | string | Primitive value for string Max Length:1048576
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a 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
coding | Σ | 0..* | Coding | Code defined by a terminology system
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 | Σ | 0..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
Slices for multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
multipleBirth[x]:multipleBirthBoolean |  | 0..1 | boolean | Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger |  | 0..1 | integer | Whether patient is part of a multiple birth
photo |  | 0..* | Attachment | Image of the patient
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
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
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
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 | Σ | 0..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
name |  | 0..1 | HumanName | A name associated with the contact 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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | Σ | 0..1 | string | Family name (often called 'Surname')
given | Σ | 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 | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 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
telecom |  | 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 | Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | Σ | 0..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
address |  | 0..1 | HL7ATCoreAddress | Address for the contact person
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:municipalityCode |  | 0..1 | string | Address Municipality Code URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-municipalityCode
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
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ | 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
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:street |  | 0..1 | string | Name of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
extension:streetNumber |  | 0..1 | string | Number of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
extension:floorDoorNumber |  | 0..1 | string | Floor and/or door number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
extension:additionalInformation |  | 0..1 | string | Additional Information URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation
value |  | 0..1 | string | Primitive value for string Max Length:1048576
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:AdministrativeGenderAddition |  | 0..1 | Coding | Administrative Gender Addition URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-gender-administrativeGenderAddition Binding: https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension (required)
value |  | 0..1 | string | Primitive value for code
organization | C | 0..1 | Reference(AT APS Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
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
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(AT APS Organization | AT APS Practitioner | AT APS PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(AT APS Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient 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
other | Σ | 1..1 | Reference(AT APS Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.extension:citizenship.​extension:code.value[x] | Base | extensible | https://termgit.elga.gv.at/ValueSet/elga-laendercodes | Not State | Unknown
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier.type | Base | extensible | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | Not State | Unknown
Patient.identifier:socialSecurityNumber.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:socialSecurityNumber.​type | Base | required | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | Not State | Unknown
Patient.identifier:socialSecurityNumber.​assigner.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std.
Patient.identifier:bPK.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:bPK.​type | Base | required | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | Not State | Unknown
Patient.identifier:bPK.​assigner.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std.
Patient.identifier:localPatientId.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:localPatientId.​type | Base | required | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | Not State | Unknown
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Patient.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Patient.maritalStatus | Base | extensible | MaritalStatus | 📦4.0.1 | FHIR Std.
Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📦4.0.1 | FHIR Std.
Patient.contact.name.​use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.contact.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Patient.contact.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Patient.contact.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Patient.contact.address.​type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | 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 | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | 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()`
pat-1 | error | Patient.contact | 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()`

This structure is derived from HL7ATCorePatient

Summary

Mandatory: 5 elements

Structures

This structure refers to these other structures:

- AT APS Organization (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-organization)
- AT APS Practitioner (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-practitioner)
- AT APS PractitionerRole (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-practitionerrole)
- AT APS Patient (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-patient)

Other representations of profile: CSV, Excel, Schematron